[IMP-4] Add GMP Express Example (axelarnetwork#87)

* feat: add call-contract-with-token-express

* feat: implement `expressCallWithToken`

* chore: update readme

* Kiryl changes (axelarnetwork#88)

* chore: adding Kiryl changes

* chore: delete unused file

* chore: update deploy method (axelarnetwork#91)

* chore: update deploy method

* chore: update gasService address

* chore: update abi

* chore: update axelar-gmp-sdk-solidity to 3.1.1

* chore: update payload

---------

Co-authored-by: npty <[email protected]>

* chore: update sdk to 3.2.0

* chore: remove expressCallWithToken

* chore: update axelar-local-dev version

* chore: refactor deployment step

* chore: delete testnet.jsopn

* chore: use local testnet if exist

* chore: fix merge conflict

* chore: update axelar-local-dev and clean hardhat in build command

* chore: fix getGasPrice error

* chore: fix bug in execute script and remove unrelavant output

* chore: prevent listenForGMPEvent function to receive past event

* chore: fix bugs in utils.js

* chore: pass chains arguments to getChains function

* chore: update axelarjs-sdk version

* chore: use whitelisted address only for GMPE on testnet

* chore: fix import path for IAxelarExecutable

* chore: remove log

* chore: fix contract check

* chore: delete forecallable example because we have gmp express

* chore: delete forecall in test

* chore: delete non-exist example link in README.md

* chore: add gmp express example in the evm readme

* chore: update example command for express

* chore: fix nft-linker deployment failed

* chore: update whitelisted address for testnet

* chore: add npm install in readme

* chore: add compile smart contract step in readme

* chore: print usdc balance

* chore: check if testnet.json exists

* chore: remove execute function

---------

Co-authored-by: Canh Trinh <[email protected]>

Author: npty

README.md

@@ -12,12 +12,24 @@ Install [nodejs](https://nodejs.org/en/download/). Run `node -v` to check your i
 
 Support Node.js version 16.x and 18.x
 
-Clone this repo:
+1. Clone this repo:
 
 ```bash
 git clone https://github.com/axelarnetwork/axelar-examples.git
 ```
 
+2. Install dependencies:
+
+```bash
+npm install
+```
+
+3. Compile smart contracts:
+
+```bash
+npm run build
+```
+
 ## Set environment variables
 
 You can get started quickly with a random local key and `.env` file by running

examples-web/contracts/nft-linker/Proxy.sol

@@ -2,9 +2,9 @@
 
 pragma solidity 0.8.9;
 
-import {Proxy} from "@axelar-network/axelar-gmp-sdk-solidity/contracts/upgradable/Proxy.sol";
+import {BaseProxy} from "@axelar-network/axelar-gmp-sdk-solidity/contracts/upgradable/BaseProxy.sol";
 
-contract ExampleProxy is Proxy {
+contract ExampleProxy is BaseProxy {
     function contractId()
         internal
         pure

examples/aptos/call-contract/contracts/HelloWorld.sol

@@ -1,18 +1,18 @@
 //SPDX-License-Identifier: MIT
 pragma solidity >=0.8.9 <0.9.0;
 
-import { IAxelarExecutable } from '@axelar-network/axelar-cgp-solidity/contracts/interfaces/IAxelarExecutable.sol';
+import { AxelarExecutable } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/executable/AxelarExecutable.sol';
 import { IAxelarGateway } from '@axelar-network/axelar-cgp-solidity/contracts/interfaces/IAxelarGateway.sol';
 import { IAxelarGasService } from '@axelar-network/axelar-cgp-solidity/contracts/interfaces/IAxelarGasService.sol';
 
-contract HelloWorld is IAxelarExecutable {
+contract HelloWorld is AxelarExecutable {
     string public value;
     string public sourceChain;
     string public sourceAddress;
     IAxelarGasService gasService;
 
     constructor(address _gateway, address _gasReceiver)
-        IAxelarExecutable(_gateway)
+        AxelarExecutable(_gateway)
     {
         gasService = IAxelarGasService(_gasReceiver);
     }

examples/aptos/token-linker/index.js

@@ -1,27 +1,23 @@
 'use strict';
 
 const { HexString, CoinClient } = require('aptos');
-const {
-    getDefaultProvider,
-    Contract,
-    constants: { AddressZero },
-} = require('ethers');
+const { getDefaultProvider, Contract } = require('ethers');
 const {
     utils: { deployContract },
     AptosNetwork,
 } = require('@axelar-network/axelar-local-dev');
 
-const TokenLinker = rootRequire('./artifacts/examples/aptos-token-linker/contracts/AptosTokenLinker.sol/AptosTokenLinker.json');
+const TokenLinker = rootRequire('./artifacts/examples/aptos/token-linker/contracts/AptosTokenLinker.sol/AptosTokenLinker.json');
 const Token = require('@axelar-network/axelar-gmp-sdk-solidity/artifacts/contracts/test/ERC20MintableBurnable.sol/ERC20MintableBurnable.json');
 
 const aptosTokenLinkerAddress = process.env.APTOS_TOKEN_LINKER_ADDRESS;
 const ignoreDigits = 5;
 
 async function preDeploy() {
-    console.log(`Deploying token_linker for aptos.`);
+    console.log('Deploying token_linker for aptos.');
     const client = new AptosNetwork(process.env.APTOS_URL);
-    await client.deploy('examples/aptos-token-linker/modules/build/token_linker', ['token_linker.mv'], '0xa1');
-    console.log(`Deployed token_linker for aptos.`);
+    await client.deploy('examples/aptos/token-linker/modules/build/token_linker', ['token_linker.mv'], '0xa1');
+    console.log('Deployed token_linker for aptos.');
 }
 
 async function deploy(chain, wallet) {
@@ -54,7 +50,7 @@ async function execute(chains, wallet, options) {
         chain.contract = new Contract(chain.aptosTokenLinker, TokenLinker.abi, chain.wallet);
     }
 
-    const evm = options.getSourceChain(chains);
+    const evm = options.source;
     const amount1 = args[1] || BigInt(1e18);
     const amount2 = args[2] || BigInt(Math.floor(5e17 / 256 ** ignoreDigits));
 
@@ -84,7 +80,7 @@ async function execute(chains, wallet, options) {
 
     // Set the gasLimit to 3e5 (a safe overestimate) and get the gas price.
     const gasLimit = 3e5;
-    const gasPrice = 1
+    const gasPrice = 1;
 
     console.log(`Minting and Approving ${Number(amount1) / 1e18} ALT`);
 

examples/evm/Proxy.sol

@@ -2,9 +2,9 @@
 
 pragma solidity 0.8.9;
 
-import {Proxy} from '@axelar-network/axelar-gmp-sdk-solidity/contracts/upgradable/Proxy.sol';
+import {InitProxy} from '@axelar-network/axelar-gmp-sdk-solidity/contracts/upgradable/InitProxy.sol';
 
-contract ExampleProxy is Proxy {
+contract ExampleProxy is InitProxy {
     function contractId()
         internal
         pure

examples/evm/README.md

@@ -18,12 +18,8 @@ npm run build
 
 ## Advanced
 
--   [forecall](forecall)
--   [headers](headers)
--   [deposit-address](deposit-address)
+-   [call-contract-with-token-express](call-contract-with-token-express)
 -   [nft-linker](nft-linker)
 -   [nft-auctionhouse](nft-auctionhouse)
--   [nonced-execution](nonced-execution)
 -   [send-ack](send-ack)
 -   [cross-chain-token](cross-chain-token)
--   [cross-chain-lending](cross-chain-lending)

examples/evm/forecall/DistributionForecallable.sol examples/evm/call-contract-with-token-express/DistributionExpressExecutable.sol

@@ -1,55 +1,43 @@
 //SPDX-License-Identifier: MIT
 pragma solidity 0.8.9;
 
+import { AxelarExecutable } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/executable/AxelarExecutable.sol';
+import { ExpressExecutable } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/express/ExpressExecutable.sol';
 import { IAxelarGateway } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IAxelarGateway.sol';
 import { IERC20 } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IERC20.sol';
 import { IAxelarGasService } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IAxelarGasService.sol';
-import { ExpressExecutable } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/express/ExpressExecutable.sol';
 import { Upgradable } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/upgradable/Upgradable.sol';
-import { AddressToString } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/utils/AddressString.sol';
 
-contract DistributionForecallable is ExpressExecutable, Upgradable {
-    using AddressToString for address;
+contract DistributionExpressExecutable is ExpressExecutable {
     IAxelarGasService public immutable gasService;
 
     constructor(address gateway_, address gasReceiver_) ExpressExecutable(gateway_) {
         gasService = IAxelarGasService(gasReceiver_);
     }
 
-    function _sendToMany(
-        string memory destinationChain,
-        address[] calldata destinationAddresses,
-        string memory symbol,
-        uint256 amount,
-        uint256 feePercent
-    ) internal {
-        address tokenAddress = gateway.tokenAddresses(symbol);
-        IERC20(tokenAddress).transferFrom(msg.sender, address(this), amount);
-        IERC20(tokenAddress).approve(address(gateway), amount);
-        bytes memory payload = abi.encode(feePercent, destinationAddresses);
-        gateway.callContractWithToken(destinationChain, address(this).toString(), payload, symbol, amount);
-    }
-
     function sendToMany(
         string memory destinationChain,
+        string memory destinationAddress,
         address[] calldata destinationAddresses,
         string memory symbol,
         uint256 amount
     ) external payable {
-        _sendToMany(destinationChain, destinationAddresses, symbol, amount, 0);
-    }
-
-    function sendToManyForecall(
-        string memory destinationChain,
-        address[] calldata destinationAddresses,
-        string memory symbol,
-        uint256 amount,
-        uint64 feeNum,
-        uint64 feeDenom,
-        uint128 salt
-    ) external payable {
-        uint256 feePercent = feeNum + (uint256(feeDenom) << 64) + (uint256(salt) << 128);
-        _sendToMany(destinationChain, destinationAddresses, symbol, amount, feePercent);
+        address tokenAddress = gateway.tokenAddresses(symbol);
+        IERC20(tokenAddress).transferFrom(msg.sender, address(this), amount);
+        IERC20(tokenAddress).approve(address(gateway), amount);
+        bytes memory payload = abi.encode(destinationAddresses);
+        if (msg.value > 0) {
+            gasService.payNativeGasForExpressCallWithToken{ value: msg.value }(
+                address(this),
+                destinationChain,
+                destinationAddress,
+                payload,
+                symbol,
+                amount,
+                msg.sender
+            );
+        }
+        gateway.callContractWithToken(destinationChain, destinationAddress, payload, symbol, amount);
     }
 
     function _executeWithToken(
@@ -59,7 +47,7 @@ contract DistributionForecallable is ExpressExecutable, Upgradable {
         string calldata tokenSymbol,
         uint256 amount
     ) internal override {
-        (, address[] memory recipients) = abi.decode(payload, (uint256, address[]));
+        address[] memory recipients = abi.decode(payload, (address[]));
         address tokenAddress = gateway.tokenAddresses(tokenSymbol);
 
         uint256 sentAmount = amount / recipients.length;
@@ -68,15 +56,7 @@ contract DistributionForecallable is ExpressExecutable, Upgradable {
         }
     }
 
-    function amountPostFee(uint256 amount, bytes calldata payload) public pure returns (uint256) {
-        uint256 feePercent = abi.decode(payload, (uint256));
-        uint64 num = uint64(feePercent);
-        uint64 denom = uint64(feePercent >> 64);
-        if (denom == 0) return amount;
-        return amount - (amount * num) / denom;
-    }
-
     function contractId() external pure returns (bytes32) {
-        return keccak256('example');
+        return keccak256('distribution-proxy');
     }
 }

examples/evm/call-contract-with-token-express/README.md

@@ -0,0 +1,54 @@
+# Call contract with token
+
+This example allows you to send aUSDC from a source chain to a destination chain and distribute it equally among specified accounts.
+
+### Deployment
+
+To deploy the contract, run the following command:
+
+```bash
+npm run deploy evm/call-contract-with-token-express [local|testnet]
+```
+
+### Execution
+
+To execute the example, use the following command:
+
+```bash
+npm run execute evm/call-contract-with-token-express  [local|testnet] ${srcChain} ${destChain} ${amount} ${account} ${account2} ...
+```
+
+**Note**
+The GMP Express feature is already lived on our testnet. However, the following conditions need to be met:
+
+-   The contract address must be whitelisted by our executor service.
+-   We only support `aUSDC` token and the amount must be less than 500 aUSDC.
+
+Currently, our whitelisted contract addresses for this example are:
+
+-   Avalanche: `0x4E3b6C3d284361Eb4fA9aDE5831eEfF85578b72c`
+-   Polygon: `0xAb6dAb12aCCAe665A44E69d44bcfC6219A30Dd32`
+
+### Parameters
+
+-   `srcChain`: The blockchain network from which the aUSDC will be transferred. Valid values are Moonbeam, Avalanche, Fantom, Ethereum, and Polygon. Default value is Polygon
+-   `destChain`: The blockchain network to which the aUSDC will be transferred. Valid values are Moonbeam, Avalanche, Fantom, Ethereum, and Polygon. Default value is Avalanche.
+-   `amount`: The amount of aUSDC to be transferred and distributed among the specified accounts. Default value is 10.
+-   `account`: The address of the first account to receive aUSDC.
+-   `account2`: The address of the second account to receive aUSDC, and so on.
+
+## Example
+
+```bash
+npm run deploy evm/call-contract-with-token-express local
+npm run execute evm/call-contract-with-token-express local "Polygon" "Avalanche" 100 0xBa86A5719722B02a5D5e388999C25f3333c7A9fb
+```
+
+### Output:
+
+```
+--- Initially ---
+0xBa86A5719722B02a5D5e388999C25f3333c7A9fb has 100 aUSDC
+--- After ---
+0xBa86A5719722B02a5D5e388999C25f3333c7A9fb has 199 aUSDC
+```