feat: setup cosmos examples

.github/workflows/verify-cli-examples.yaml

@@ -3,20 +3,83 @@ name: Verify Cli Examples
 on: pull_request
 
 jobs:
-    test:
-        runs-on: ${{ matrix.os }}
-        strategy:
-            matrix:
-                os: [ubuntu-22.04]
-                arch: [amd64]
+    test-cosmos-examples:
+        runs-on: ubuntu-22.04
+        name: 'Test Cosmos Examples'
         steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+
+            - name: Setup Node
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 18
+                  cache: 'npm'
+
+            - name: Install Dependencies
+              run: npm ci
+
+            - name: Create .env file
+              run: |
+                  # Dummy private key created for testing purpose only, it is not secret
+                  npm run setup
+
+            - name: Compile EVM Smart Contracts
+              run: npm run build
+
+            - name: Override config/ci.json
+              run: |
+                  echo '{"aptos": {"enabled": false},"cosmos": {"enabled": true}}' > config/ci.json
+
+            - name: Test
+              run: |
+                  NODE_ENV=ci npm run test:cosmos
+
+    test-evm-examples:
+        runs-on: ubuntu-22.04
+        name: 'Test EVM Examples'
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+
             - name: Setup Node
-              uses: actions/setup-node@v3
+              uses: actions/setup-node@v4
               with:
                   node-version: 18
+                  cache: 'npm'
+
+            - name: Install Dependencies
+              run: npm ci
 
+            - name: Create .env file
+              run: |
+                  # Dummy private key created for testing purpose only, it is not secret
+                  npm run setup
+
+            - name: Compile EVM Smart Contracts
+              run: |
+                  npm run build
+
+            - name: Override config/ci.json
+              run: |
+                  echo '{"aptos": {"enabled": false},"cosmos": {"enabled": false}}' > config/ci.json
+
+            - name: Test
+              run: |
+                  NODE_ENV=ci npm run test:evm
+
+    test-aptos-examples:
+        runs-on: ubuntu-22.04
+        name: 'Test Aptos Examples'
+        steps:
             - name: Checkout code
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
+
+            - name: Setup Node
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 18
+                  cache: 'npm'
 
             - name: Prerequisites
               run: |
@@ -25,14 +88,18 @@ jobs:
                   chmod +x aptos
                   cp aptos /usr/local/bin
 
-            - name: Install
+            - name: Install Dependencies
               run: npm ci
 
             - name: Create .env file
               run: |
                   # Dummy private key created for testing purpose only, it is not secret
                   npm run setup
 
+            - name: Override config/ci.json
+              run: |
+                  echo '{"aptos": {"enabled": true},"cosmos": {"enabled": false}}' > config/ci.json
+
             - name: Compile EVM Smart Contracts
               run: |
                   npm run build
@@ -41,12 +108,8 @@ jobs:
               run: |
                   npm run build-aptos
 
-            - name: Override config/ci.json
-              run: |
-                  echo '{"aptos": {"enabled": true}}' > config/ci.json
-
             - name: Test
               run: |
                   nohup sh -c "aptos node run-local-testnet --with-faucet" > nohup.out 2> nohup.err < /dev/null &
-                  sleep 10
-                  NODE_ENV=ci npm run test
+                  sleep 30
+                  NODE_ENV=ci npm run test:aptos

.github/workflows/verify-web-examples.yaml

@@ -20,7 +20,7 @@ jobs:
 
             - name: Override config/ci.json
               run: |
-                  echo '{"aptos": {"enabled": false}}' > config/ci.json
+                  echo '{"aptos": {"enabled": false}, "cosmos": {"enabled": false}}' > config/ci.json
 
             - name: Install Dependencies for Cli Examples
               run: npm ci
@@ -33,7 +33,7 @@ jobs:
               run: |
                   # Dummy private key created for testing purpose only, it is not secret
                   npm run setup
-                  nohup npm run start &
+                  NODE_ENV=ci nohup npm run start &
                   sleep 5
 
             - name: Setup Web Examples
@@ -42,7 +42,7 @@ jobs:
                   npm ci
                   npm run setup
 
-            - name: Compile EVM Smart Contracts and Deploy
+            - name: Deploy
               run: |
                   cd examples-web
                   npm run deploy

.gitignore

@@ -3,7 +3,7 @@ build
 artifacts
 cache
 yarn-error.log
-local.json
+local*.json
 gasLogs.json
 scripts/deployConst.js
 
@@ -14,3 +14,4 @@ aptos-artifacts
 .vscode
 chain-config/*.json
 .aptos
+!./**/artifacts/send_receive.wasm

.mocharc.js

@@ -2,7 +2,6 @@
 
 module.exports = {
     recursive: true,
-    timeout: 20000,
+    timeout: 600000,
     slow: 15000,
-    file: ['examples/tests/checkExamples.js'],
 };

README.md

@@ -68,4 +68,5 @@ If not specified, this will print balances of the wallet for testnet.
 
 -   [Evm Examples](/examples/evm/)
 -   [Aptos Examples](/examples/aptos/)
+-   [Cosmos Examples](/examples/cosmos/)
 -   [Web Examples](/examples-web/)

build-wasm.sh

@@ -0,0 +1,6 @@
+# !/bin/bash
+
+docker run --rm -v "$(pwd)/examples/cosmos/call-contract/wasm-contract":/code \
+  --mount type=volume,source="$(basename "$(pwd)")_cache",target=/code/target \
+  --mount type=volume,source=registry_cache,target=/usr/local/cargo/registry \
+  cosmwasm/rust-optimizer:0.12.13

config/ci.json

@@ -1,5 +1,8 @@
 {
-  "aptos": {
-      "enabled": true
-  }
+    "aptos": {
+        "enabled": true
+    },
+    "cosmos": {
+        "enabled": false
+    }
 }

config/default.json

@@ -1,5 +1,8 @@
 {
     "aptos": {
         "enabled": false
+    },
+    "cosmos": {
+        "enabled": false
     }
 }

config/index.js

@@ -0,0 +1,10 @@
+const path = require('path');
+
+const configPath = {
+    localEvmChains: path.resolve(__dirname, '..', 'chain-config', 'local-evm.json'),
+    localCosmosChains: path.resolve(__dirname, '..', 'chain-config', 'local-cosmos.json'),
+};
+
+module.exports = {
+    configPath,
+};

examples-web/scripts/deploy-contracts.ts

@@ -1,8 +1,9 @@
 import "dotenv/config";
 import fs from "fs/promises";
+import { existsSync, mkdirSync } from "fs";
 import path from "path";
 import { Wallet } from "ethers";
-import chains from "../../chain-config/local.json";
+import { configPath } from "../../config";
 import { deploy as deployCallContract } from "./call-contract";
 import { deploy as deployCallContractWithToken } from "./call-contract-with-token";
 import { deploy as deployNftLinker } from "./nft-linker";
@@ -11,8 +12,11 @@ import { deploy as deployNftLinker } from "./nft-linker";
 const privateKey = process.env.NEXT_PUBLIC_EVM_PRIVATE_KEY as string;
 const wallet = new Wallet(privateKey);
 
-const ethereumChain = chains.find((chain: any) => chain.name === "Ethereum") || chains[0] as any;
-const avalancheChain = chains.find((chain: any) => chain.name === "Avalanche") || chains[1] as any;
+const chains = require(configPath.localEvmChains);
+const ethereumChain =
+  chains.find((chain: any) => chain.name === "Ethereum") || (chains[0] as any);
+const avalancheChain =
+  chains.find((chain: any) => chain.name === "Avalanche") || (chains[1] as any);
 
 function print(chain: any) {
   console.log(`Deployed example contracts on ${chain.name}`);
@@ -22,26 +26,30 @@ function print(chain: any) {
 }
 
 async function main() {
-  const [chainA, chainB] = await deployCallContract(wallet, ethereumChain, avalancheChain)
-    .then(() => deployCallContractWithToken(wallet, ethereumChain, avalancheChain))
+  const [chainA, chainB] = await deployCallContract(
+    wallet,
+    ethereumChain,
+    avalancheChain
+  )
+    .then(() =>
+      deployCallContractWithToken(wallet, ethereumChain, avalancheChain)
+    )
     .then(() => deployNftLinker(wallet, ethereumChain, avalancheChain));
 
   print(chainA);
-  console.log("")
+  console.log("");
   print(chainB);
 
   // update chains
   const updatedChains = [chainA, chainB];
-  const _path = path.resolve(__dirname, '../../chain-config/local.json')
-  const publicPath = path.resolve(__dirname, '../public/chains.json')
-  await fs.writeFile(
-    _path,
-    JSON.stringify(updatedChains, null, 2)
-  );
-  await fs.writeFile(
-    publicPath,
-    JSON.stringify(updatedChains, null, 2)
-  );
+  const _path = path.resolve(configPath.localEvmChains);
+  const dirname = path.dirname(_path);
+  if (!existsSync(dirname)) {
+    await mkdirSync(dirname, { recursive: true });
+  }
+  const publicPath = path.resolve(__dirname, "../public/chains.json");
+  await fs.writeFile(_path, JSON.stringify(updatedChains, null, 2));
+  await fs.writeFile(publicPath, JSON.stringify(updatedChains, null, 2));
 }
 
 main();

examples-web/src/config/constants.ts

@@ -1,6 +1,6 @@
 import { getDefaultProvider, providers, Wallet } from "ethers";
 import testnetInfo from "@axelar-network/axelar-chains-config/info/testnet.json";
-import local from "../../../chain-config/local.json";
+import { configPath } from "../../../config";
 
 if (typeof window === "undefined") {
   require("dotenv").config();
@@ -15,13 +15,13 @@ function getWallet() {
 export const isTestnet = process.env.NEXT_PUBLIC_ENVIRONMENT === "testnet";
 export const wallet = getWallet();
 
-export const localChains = local as any;
+export const localChains = require(configPath.localEvmChains);
 
 const testnetChains = Object.entries(testnetInfo).map(([, value]) => {
   return value;
 });
 
-export const chains = isTestnet ? testnetChains : (local as any);
+export const chains = isTestnet ? testnetChains : localChains;
 
 export const srcChain = chains.find(
   (chain: any) => chain.name === "Ethereum"

examples/aptos/call-contract/index.js

@@ -9,7 +9,7 @@ const { AptosNetwork } = require('@axelar-network/axelar-local-dev-aptos');
 const HelloWorld = rootRequire('./artifacts/examples/aptos/call-contract/contracts/HelloWorld.sol/HelloWorld.json');
 const { defaultAbiCoder } = require('ethers/lib/utils');
 
-async function preDeploy() {
+async function deployOnAltChain() {
     console.log(`Deploying HelloWorld for Aptos.`);
     const client = new AptosNetwork(process.env.APTOS_URL);
     await client.deploy('examples/aptos/call-contract/modules/build/hello_world', ['hello_world.mv']);
@@ -65,7 +65,7 @@ async function execute(evmChain, wallet, options) {
 }
 
 module.exports = {
-    preDeploy,
+    deployOnAltChain,
     deploy,
     execute,
 };

examples/aptos/token-linker/index.js

@@ -18,7 +18,7 @@ async function isDeployedTokenLinker(client) {
     return resources.find((resource) => resource.type === `${aptosTokenLinkerAddress}::token_linker::State`);
 }
 
-async function preDeploy() {
+async function deployOnAltChain() {
     const client = new AptosNetwork(process.env.APTOS_URL);
     const isDeployed = await isDeployedTokenLinker(client);
 
@@ -122,7 +122,7 @@ async function execute(evmChain, wallet, options) {
 }
 
 module.exports = {
-    preDeploy,
+    deployOnAltChain,
     deploy,
     execute,
 };

examples/cosmos/README.md

@@ -0,0 +1,23 @@
+# Cosmos Examples
+
+## Prerequisite
+
+-   Docker running on your local machine.
+
+We will use this file to deploy to the wasm chain for this example.
+
+## Enable Cosmos in Config
+
+To start Axelar and Wasm chain when running `npm run start`, you've to set `cosmos: true` in [config/default.json](../../config/default.json).
+
+## Run the EVM chains with Axelar and Wasm Chain
+
+```
+npm run start
+```
+
+This will take about 5 mins to start on the first run, since it needs to download the axelar and wasm docker images, setup axelar axelars, and creating an IBC connection between Wasm and Axelar chain.
+
+## Basic
+
+-   [call-contract](call-contract)