0xsquid / axelar-local-gmp-examples

Minimal sample for axelar-local-dev

Axelar cross-chain dApp examples

Introduction

This repo provides the code for several example dApps in the Axelar Local Development Environment. Examples contain both JavaScript and Solidity smart contract code.

Note: Some example folders in this repo are not documented below.

One-time setup

Install nodejs. Run node -v to check your installation.

Version 16 is required. If needed you can switch your node version (or lower, if you are on a higher version) via

sudo npm i -g n
sudo n v16.15.0

Clone this repo:

git clone https://github.com/axelarnetwork/axelar-local-gmp-examples.git

Build contracts and tests:

npm update && npm install
npm run build

Deploy and test each example

In order to run the examples against the local emulator, cd to axelar-local-gmp-examples and run

node scripts/createLocal

Leave this node running on a separate terminal before deploying and testing the dApps.

Each example has several arguments as described below:

Variable	Valid Values	Default	Example	Notes
network	local, testnet	no default	local
source-chain	Moonbeam, Avalanche, Fantom, Ethereum, and Polygon	Avalanche	"Moonbeam" or 'Moonbeam'	case-sensitive
destination-chain	Moonbeam, Avalanche, Fantom, Ethereum, and Polygon	Fantom	"Avalanche" or 'Avalanche'	case-sensitive
message for call-contract	any string	Hello ${destination.name} from ${source.name}, it is ${new Date().toLocaleTimeString()}.	'Hello World'
message for nonced-execution and send-ack	any string	Hello, the time is ${time}.	'Hello World'
amount	integer or float	10	53	Any non-integer is rounded down to the nearest integer.
account	any wallet address	no default	0xBa86A5719722B02a5D5e388999C25f3333c7A9fb	case-sensitive.

Run the deploy and test code specific to each example described below.

To use defaults, substitute ${} for any or all of the variables.

Call contract

Relay a message from source-chain to destination-chain.

Deploy:

node scripts/deploy examples/call-contract [local|testnet]

Run the test:

node scripts/test examples/call-contract [local|testnet] ${"source-chain"} ${"destination-chain"} ${'message'}

Example

node scripts/deploy examples/call-contract local
node scripts/test examples/call-contract local "Moonbeam" "Avalanche" 'Hello World'

Output:

--- Initially ---
value at Avalanche is
--- After ---
value at Avalanche is Hello World

Call contract with token

Send aUSDC from source-chain to destination-chain and distribute it equally among all accounts specified.

Deploy:

node scripts/deploy examples/call-contract-with-token [local|testnet]

Run the test:

node scripts/test examples/call-contract-with-token [local|testnet] ${"source-chain"} ${"destination-chain"} ${amount} ${account} ${account2} ...

Example

node scripts/deploy examples/call-contract-with-token local
node scripts/test examples/call-contract-with-token local "Moonbeam" "Ethereum" 100 0xBa86A5719722B02a5D5e388999C25f3333c7A9fb

Output:

--- Initially ---
0xBa86A5719722B02a5D5e388999C25f3333c7A9fb has 100 aUSDC
--- After ---
0xBa86A5719722B02a5D5e388999C25f3333c7A9fb has 199 aUSDC

Cross-chain token

Mints some token at source-chain and send it to destination-chain.

Deploy:

node scripts/deploy examples/cross-chain-token [local|testnet]

Run the test:

node scripts/test examples/cross-chain-token [local|testnet] ${"source-chain"} ${"destination-chain"} ${amount}

Example

node scripts/deploy examples/cross-chain-token local
node scripts/test examples/cross-chain-token local "Ethereum" "Fantom" 1

Output:

--- Initially ---
Balance at Ethereum is 0
Balance at Fantom is 0
--- After getting some token on the source chain ---
Balance at Ethereum is 1
Balance at Fantom is 0
--- After ---
Balance at Ethereum is 0
Balance at Fantom is 1

Deposit address, send token

Two different examples. Send aUSDC from source-chain to destination-chain:

1. deposit-address: get an Axelar deposit address.
2. send-token: call an Axelar Gateway contract.

No smart contract to deploy for these examples.

If running on testnet then ensure that 0xBa86A5719722B02a5D5e388999C25f3333c7A9fb is funded with aUSDC.

Note: We use 0xBa86A5719722B02a5D5e388999C25f3333c7A9fb to deploy and test all examples. It's funded by default in the local environment when you run createLocal. To make sure that it's funded on all five supported testnets, run node/printBalances.

Run the deposit-address test:

node scripts/test examples/deposit-address [local|testnet] ${"source-chain"} ${"destination-chain"} ${amount}

Run the send-token test:

node scripts/test examples/send-token [local|testnet] ${"source-chain"} ${"destination-chain"} ${amount}

Example

node scripts/test examples/deposit-address local
node scripts/test examples/send-token local

Output:

--- Initially ---
Balance at Avalanche is 100000000
Balance at Fantom is 100000000
0xb54eA64537F3307907E06d3B93ccd4A3E711623f
--- After ---
Balance at Avalanche is 90000000
Balance at Fantom is 109000000

--- Initially ---
Balance of 0xBa86A5719722B02a5D5e388999C25f3333c7A9fb at Avalanche is 90000000
Balance of 0xBa86A5719722B02a5D5e388999C25f3333c7A9fb at Fantom is 109000000
--- After ---
Balance of 0xBa86A5719722B02a5D5e388999C25f3333c7A9fb at Avalanche is 80000000
Balance of 0xBa86A5719722B02a5D5e388999C25f3333c7A9fb at Fantom is 118000000

Headers

Informs destination-chain of the last header of source-chain.

Deploy:

node scripts/deploy examples/headers [local|testnet]

Run the test:

node scripts/test examples/headers [local|testnet] ${"source-chain"} ${"destination-chain"}

Example

node scripts/deploy examples/headers local
node scripts/test examples/headers local "Fantom" "Moonbeam"

Output:

Success!

NFT linker

Send the NFT that was originally minted at source-chain to destination-chain.

Deploy:

node scripts/deploy examples/nft-linker [local|testnet]

A single NFT is minted to the deployer (0xBa86A5719722B02a5D5e388999C25f3333c7A9fb) on each chain.

Run the test:

node scripts/test examples/nft-linker [local|testnet] ${"source-chain"} ${"destination-chain"}

It's not possible to send a duplicate NFT to a chain. The dApp fails when the NFT is already at the destination-chain.

Example

node scripts/deploy examples/nft-linker local
node scripts/test examples/nft-linker local "Avalanche" "Polygon"

Output:

--- Initially ---
Token that was originally minted at Moonbeam is at Moonbeam.
Token that was originally minted at Avalanche is at Avalanche.
Token that was originally minted at Fantom is at Fantom.
Token that was originally minted at Ethereum is at Ethereum.
Token that was originally minted at Polygon is at Polygon.
--- Then ---
Token that was originally minted at Moonbeam is at Moonbeam.
Token that was originally minted at Avalanche is at Polygon.
Token that was originally minted at Fantom is at Fantom.
Token that was originally minted at Ethereum is at Ethereum.
Token that was originally minted at Polygon is at Polygon.

Nonced execution

Send a message from source-chain to destination-chain.

Deploy:

node scripts/deploy examples/nonced-execution [local|testnet]

Run the test:

node scripts/test examples/nonced-execution [local|testnet] ${"source-chain"} ${"destination-chain"} ${'message'}

Example

node scripts/deploy examples/nonced-execution local
node scripts/test examples/nonced-execution local ${} ${} ${}

Output:

--- Initially ---
Last message sent from Avalanche@0xBa86A5719722B02a5D5e388999C25f3333c7A9fb to Fantom was "" with a nonce of -1.
--- After ---
Last message sent from Avalanche@0xBa86A5719722B02a5D5e388999C25f3333c7A9fb to Fantom was "Hello, the time is 1654191658288." with a nonce of 0.

Send ack

Send a message from source-chain to destination-chain.

Deploy:

node scripts/deploy examples/send-ack [local|testnet]

Run the test:

node scripts/test examples/send-ack [local|testnet] ${"source-chain"} ${"destination-chain"} ${'message'}

Example

node scripts/deploy examples/send-ack local
node scripts/test examples/send-ack local "Fantom" "Moonbeam" 'Received'

Output:

--- Initially ---
SendAckReceiverImplementation at Moonbeam has 0 messages and the last one is "".
--- After ---
SendAckReceiverImplementation at Moonbeam has 1 messages and the last one is "Received".