Skip to content

Commit

Permalink
chore added readmes for code snippets
Browse files Browse the repository at this point in the history
  • Loading branch information
benjamin852 committed Apr 12, 2024
1 parent 9c0251d commit 0013444
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 0 deletions.
9 changes: 9 additions & 0 deletions examples/evm/multichain-game/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Multichain Game

This example demonstrates a simple guessing game where users can guess a number between 1-6 and stake some funds for each guess. If the correct number is guessed then you win the pot! The `MultichainGameReceiver` exists on a single chain and can hold a variety of different tokens. It pays back the winner playing the game via the `MultiChainGame` contract on one of the satellite chains the game is deployed on.

# Testnet
On testnet this can be tested from Celo chain where you can send WETH to the Polygon Mumbai testnet to conduct the swap on the Uniswap router.

## Local Test
Local testing with Axelar Local Dev is WIP.
7 changes: 7 additions & 0 deletions examples/evm/multichain-nft-mint/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Multichain Swap NFT Mint

This example demonstrates how to mint an NFT on a destination chain via a message triggered from your source chain. It encodes a function signature of the `safeMint()` function and `calls` the function signature on the destination chain.


## Local Test
Local testing with Axelar Local Dev is WIP.
9 changes: 9 additions & 0 deletions examples/evm/multichain-swap/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Multichain Swap Example

This example demonstrates how to interact with the Uniswap router to do a cross chain swap. The contract can send a gmp message and a token from one blockchain to another blockchain and that message will tell the uniswap router to swap the token that was sent for another token.

# Testnet
On testnet this can be tested from Celo chain where you can send WETH to the Polygon Mumbai testnet to conduct the swap on the Uniswap router.

## Local Test
Local testing with Axelar Local Dev is WIP.

0 comments on commit 0013444

Please sign in to comment.