chore(sui): gh workflow for testing sui commands

.github/actions/setup-sui/action.yaml

@@ -0,0 +1,67 @@
+name: Setup Sui CLI
+description: 'Setup Sui CLI and install dependencies'
+
+inputs:
+  SUI_VERSION:
+    description: 'The version of Sui CLI to install'
+    required: true
+
+runs:
+  using: 'composite'
+
+  steps:
+    - name: Debug Action Input
+      shell: bash
+      run: echo "SUI_VERSION=${{ inputs.SUI_VERSION }}"
+
+    - name: Install Dependencies
+      shell: bash
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libpq-dev
+
+    - name: Cache Sui binaries
+      id: cache-sui
+      uses: actions/cache@v4
+      with:
+        path: sui-cli/sui-binaries/
+        key: sui-${{ inputs.SUI_VERSION }}
+
+    - name: Download and Install Sui
+      shell: bash
+      if: steps.cache-sui.outputs.cache-hit != 'true'
+      run: |
+        mkdir -p sui-cli && cd sui-cli
+        curl -L -o sui-${{ inputs.SUI_VERSION }}-ubuntu-x86_64.tgz https://github.com/MystenLabs/sui/releases/download/${{ inputs.SUI_VERSION }}/sui-${{ inputs.SUI_VERSION }}-ubuntu-x86_64.tgz
+        tar -xvf sui-${{ inputs.SUI_VERSION }}-ubuntu-x86_64.tgz
+        mkdir -p sui-binaries
+        mv ./sui ./sui-binaries/
+        mv ./sui-debug ./sui-binaries/
+        mv ./sui-test-validator ./sui-binaries/
+        rm -rf sui-${{ inputs.SUI_VERSION }}-ubuntu-x86_64.tgz
+
+    - name: Save Sui binaries
+      if: steps.cache-sui.outputs.cache-hit != 'true'
+      id: cache-sui-save
+      uses: actions/cache@v4
+      with:
+        path: sui-cli/sui-binaries/
+        key: sui-${{ inputs.SUI_VERSION }}
+
+    - name: Add Sui binaries to PATH
+      shell: bash
+      run: |
+        sudo cp ./sui-cli/sui-binaries/sui /usr/local/bin/sui
+        sudo cp ./sui-cli/sui-binaries/sui-debug /usr/local/bin/sui-debug
+        sudo cp ./sui-cli/sui-binaries/sui-test-validator /usr/local/bin/sui-test-validator
+
+    - name: Setup Sui Wallet
+      shell: bash
+      run: |
+        echo -e "y\n\n1" | sui client envs
+        sui client new-address secp256k1 wallet
+        sui client switch --address wallet
+        SUI_PRIVATE_KEY=$(sui keytool export --key-identity wallet --json | jq .exportedPrivateKey | sed 's/"//g')
+        SUI_ADDRESS=$(sui keytool export --key-identity wallet --json | jq .key.suiAddress | sed 's/"//g')
+        echo "SUI_PRIVATE_KEY=${SUI_PRIVATE_KEY}" >> $GITHUB_ENV
+        echo "SUI_ADDRESS=${SUI_ADDRESS}" >> $GITHUB_ENV

.github/workflows/test.yaml → .github/workflows/test-evm.yaml

@@ -1,9 +1,9 @@
-name: Test
+name: Test Evm
 
 on: pull_request
 
 jobs:
-  test:
+  test-evm:
     runs-on: blacksmith-2vcpu-ubuntu-2204
 
     steps:

.github/workflows/test-sui.yaml

@@ -0,0 +1,148 @@
+name: Test Sui
+
+on: pull_request
+
+jobs:
+  test-sui:
+    runs-on: blacksmith-2vcpu-ubuntu-2204
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install Node.js
+        uses: useblacksmith/setup-node@v5
+        with:
+          node-version: 18.x
+          cache: 'npm'
+
+      - name: Install
+        run: npm ci
+
+      - name: Read SUI_VERSION from JSON
+        id: read-json
+        run: |
+          SUI_VERSION=$(jq -r '.SUI_VERSION' sui/version.json)
+          echo "SUI_VERSION=${SUI_VERSION}" >> $GITHUB_ENV
+
+      - name: Setup Sui CLI and install dependencies
+        uses: ./.github/actions/setup-sui
+        with:
+          SUI_VERSION: ${{ env.SUI_VERSION }}
+
+      - name: Spin up Sui Network
+        run: nohup sh -c "sui-test-validator" > nohup.out 2> nohup.err < /dev/null &
+
+      - name: Sleep for 30 seconds
+        run: sleep 30s
+        shell: bash
+
+      - name: Setup Sui Local Network
+        run: |
+          sui client new-env --alias local --rpc http://127.0.0.1:9000
+          sui client switch --env local
+
+      - name: Prepare local.json
+        run: |
+          echo '{
+                "sui": {
+                    "name": "Sui",
+                    "axelarId": "sui",
+                    "networkType": "localnet",
+                    "tokenSymbol": "SUI",
+                    "rpc": "http://127.0.0.1:9000",
+                    "faucetUrl": "http://127.0.0.1:9123",
+                    "contracts": {}
+                }
+            }' > ./axelar-chains-config/info/local.json
+
+      # Create .env file with default hardhat private key that's prefunded
+      - name: Prepare .env
+        run: |
+          echo "PRIVATE_KEY=$SUI_PRIVATE_KEY" >> .env
+          echo 'ENV=local' >> .env
+          echo 'SKIP_EXISTING = true' >> .env
+
+      - name: Display local.json
+        run: cat ./axelar-chains-config/info/local.json
+
+      - name: Request SUI from faucet
+        run: node sui/faucet.js
+
+      ###### Command: Deploy Contract ######
+
+      - name: Deploy AxelarGateway
+        run: node sui/deploy-contract deploy AxelarGateway --signers wallet
+
+      - name: Deploy GasService
+        run: node sui/deploy-contract deploy GasService
+
+      - name: Deploy Operators
+        run: node sui/deploy-contract deploy Operators
+
+      - name: Deploy Example
+        run: node sui/deploy-contract deploy Example
+
+      ###### Command: Gas Service ######
+
+      - name: Pay Gas
+        run: node sui/gas-service.js payGas --amount 100 ethereum 0x6f24A47Fc8AE5441Eb47EFfC3665e70e69Ac3F05 0xba76c6980428A0b10CFC5d8ccb61949677A61233 0x1234
+
+      - name: Refund Gas
+        run: node sui/gas-service.js refund 0x32034b47cb29d162d9d803cc405356f4ac0ec07fe847ace431385fe8acf3e6e5-2 --amount 1
+
+      - name: Collect Gas
+        run: node sui/gas-service.js collectGas --amount 0.1
+
+      ###### Command: Gateway ######
+      - name: Gateway Approve
+        run: node sui/gateway.js approve --proof wallet ethereum 0x32034b47cb29d162d9d803cc405356f4ac0ec07fe847ace431385fe8acf3e6e5-2 0x4F4495243837681061C4743b74B3eEdf548D56A5 0x6ce0d81b412abca2770eddb1549c9fcff721889c3aab1203dc93866db22ecc4b 0x56570de287d73cd1cb6092bb8fdee6173974955fdef345ae579ee9f475ea7432
+
+      - name: Gateway Call Contract
+        run: node sui/gateway.js call-contract ethereum 0x4F4495243837681061C4743b74B3eEdf548D56A5 0x1234
+
+      - name: Gateway Rotate Signers
+        run: node sui/gateway.js rotate --signers wallet --proof wallet --newNonce test2
+
+      ###### Command: GMP ######
+
+      - name: Execute Outgoing Call Contract
+        run: node sui/gmp.js sendCall ethereum 0x6f24A47Fc8AE5441Eb47EFfC3665e70e69Ac3F05 0.1 0x1234
+
+      - name: Execute Incoming Call Contract
+        run: |
+          channel_id=$(cat axelar-chains-config/info/local.json | jq '.sui.contracts.Example.objects.ChannelId' | sed 's/"//g')
+          echo "Channel ID: $channel_id"
+          node sui/gateway.js approve --proof wallet ethereum 0x32034b47cb29d162d9d803cc405356f4ac0ec07fe847ace431385fe8acf3e6e5-3 0x4F4495243837681061C4743b74B3eEdf548D56A5 $channel_id 0x56570de287d73cd1cb6092bb8fdee6173974955fdef345ae579ee9f475ea7432
+          node sui/gmp.js execute ethereum 0x32034b47cb29d162d9d803cc405356f4ac0ec07fe847ace431385fe8acf3e6e5-3 0x4F4495243837681061C4743b74B3eEdf548D56A5 0x1234
+
+      ###### Command: Operators ######
+
+      - name: Store Capability Object in Operators
+        run: node sui/operators.js storeCap
+
+      - name: Add Operator
+        run: node sui/operators.js add $SUI_ADDRESS
+
+      - name: Collect Gas with Operator
+        run: node sui/operators.js collectGas --amount 1
+
+      - name: Refund Gas with Operator
+        run: node sui/operators.js refund 0x32034b47cb29d162d9d803cc405356f4ac0ec07fe847ace431385fe8acf3e6e5-2 --amount 1
+
+      - name: Remove Operator
+        run: node sui/operators.js remove $SUI_ADDRESS
+
+      ###### Command: Generate Keypair ######
+      - name: Generate Keypair
+        run: node sui/generate-keypair.js
+
+      ###### Command: Multisig ######
+
+      # TODO: Add multisig tests
+
+      ###### Command: Transfer Object ######
+      - name: Transfer Object
+        run: |
+          object_id=$(sui client objects --json | jq -r '.[-1].data.objectId')
+          node sui/transfer-object.js --objectId $object_id --recipient 0xdd7c964ff032273889eb6029a29314413b461629c45c0442c6f9cf8342450c12

package.json

@@ -5,7 +5,8 @@
   "main": "index.js",
   "scripts": {
     "lint": "eslint --fix '**/*.js'",
-    "prettier": "prettier --write '**/*.js' 'axelar-chains-config/info/*.json' 'package.json' 'evm/**/*.json' '.github/**/*.yaml'"
+    "prettier": "prettier --write '**/*.js' 'axelar-chains-config/info/*.json' 'package.json' 'evm/**/*.json' '.github/**/*.yaml'",
+    "test:sui": "mocha sui"
   },
   "repository": {
     "type": "git",
@@ -23,7 +24,7 @@
   "homepage": "https://github.com/axelarnetwork/axelar-contract-deployments#readme",
   "dependencies": {
     "@axelar-network/axelar-cgp-solidity": "6.3.1",
-    "@axelar-network/axelar-cgp-sui": "0.0.0-snapshot.218635e",
+    "@axelar-network/axelar-cgp-sui": "^0.4.1",
     "@axelar-network/axelar-gmp-sdk-solidity": "5.10.0",
     "@axelar-network/interchain-token-service": "1.2.4",
     "@cosmjs/cosmwasm-stargate": "^0.32.1",

sui/README.md

@@ -100,7 +100,7 @@ node sui/deploy-contract.js deploy GasService
 Deploy the test GMP package:
 
 ```bash
-node sui/deploy-contract.js deploy Test
+node sui/deploy-contract.js deploy Example
 ```
 
 Deploy the Operators package:

sui/deploy-contract.js

@@ -27,6 +27,7 @@ const {
     getSingletonChannelId,
     getItsChannelId,
     getSquidChannelId,
+    checkSuiVersionMatch,
 } = require('./utils');
 
 /**
@@ -42,7 +43,7 @@ const {
  * 2. Ensure the corresponding folder exists in the specified path
  *
  */
-const PACKAGE_DIRS = ['gas_service', 'test', 'axelar_gateway', 'operators', 'abi', 'governance', 'its', 'squid'];
+const PACKAGE_DIRS = ['gas_service', 'example', 'axelar_gateway', 'operators', 'abi', 'governance', 'its', 'squid'];
 
 /**
  * Package Mapping Object for Command Options and Post-Deployment Functions
@@ -51,7 +52,7 @@ const PACKAGE_CONFIGS = {
     cmdOptions: {
         AxelarGateway: () => GATEWAY_CMD_OPTIONS,
         GasService: () => [],
-        Test: () => [],
+        Example: () => [],
         Operators: () => [],
         Abi: () => [],
         Governance: () => [],
@@ -61,7 +62,7 @@ const PACKAGE_CONFIGS = {
     postDeployFunctions: {
         AxelarGateway: postDeployAxelarGateway,
         GasService: postDeployGasService,
-        Test: postDeployTest,
+        Example: postDeployExample,
         Operators: postDeployOperators,
         Abi: {},
         Governance: {},
@@ -105,16 +106,16 @@ async function postDeployGasService(published, keypair, client, config, chain, o
     };
 }
 
-async function postDeployTest(published, keypair, client, config, chain, options) {
+async function postDeployExample(published, keypair, client, config, chain, options) {
     const relayerDiscovery = config.sui.contracts.AxelarGateway?.objects?.RelayerDiscovery;
 
-    const [singletonObjectId] = getObjectIdsByObjectTypes(published.publishTxn, [`${published.packageId}::test::Singleton`]);
+    const [singletonObjectId] = getObjectIdsByObjectTypes(published.publishTxn, [`${published.packageId}::gmp::Singleton`]);
     const channelId = await getSingletonChannelId(client, singletonObjectId);
-    chain.contracts.Test.objects = { Singleton: singletonObjectId, ChannelId: channelId };
+    chain.contracts.Example.objects = { Singleton: singletonObjectId, ChannelId: channelId };
 
     const tx = new Transaction();
     tx.moveCall({
-        target: `${published.packageId}::test::register_transaction`,
+        target: `${published.packageId}::gmp::register_transaction`,
         arguments: [tx.object(relayerDiscovery), tx.object(singletonObjectId)],
     });
 
@@ -195,7 +196,7 @@ async function postDeployAxelarGateway(published, keypair, client, config, chain
 
     // Update chain configuration
     chain.contracts.AxelarGateway = {
-        address: packageId,
+        ...chain.contracts.AxelarGateway,
         objects: {
             Gateway: gateway,
             RelayerDiscovery: relayerDiscovery,
@@ -246,6 +247,9 @@ async function postDeploySquid(published, keypair, client, config, chain, option
 async function deploy(keypair, client, supportedContract, config, chain, options) {
     const { packageDir, packageName } = supportedContract;
 
+    // Print warning if version mismatch from defined version in version.json
+    checkSuiVersionMatch();
+
     // Deploy package
     const published = await deployPackage(packageDir, client, keypair, options);
 

sui/docs/gmp.md

@@ -57,7 +57,6 @@ This command will execute the message to the contract that associated with the g
 node sui/gmp.js execute ethereum 0x32034b47cb29d162d9d803cc405356f4ac0ec07fe847ace431385fe8acf3e6e5-2 0x4F4495243837681061C4743b74B3eEdf548D56A5 0x1234 --channelId 0xcd5d203ea2cf1139af83939e3f74114a31fe682cc90f73a0d2647956bc3e5acf
 ```
 
-
 Note:
 - `source`, `sourceAddress` and `messageId` needed to be matched with the approve command.
 - `payload` must be associated with the `payloadHash` in the approve command.