Sui Deployment Guide

Prerequisites

Install Sui CLI: brew install sui

A Sui keypair can be created as follows.

Using Sui CLI:

sui client new-address secp256k1 wallet

# Export private key in bech32 format
sui keytool export --key-identity wallet

Using the script

node sui/generate-keypair.js

Set PRIVATE_KEY="suiprivkey..." in your .env file. Other private key types are supported via --privateKeyType and --signatureScheme flags.

If you want to run against a local Sui network, then create a axelar-chains-config/info/local.json config containing:

{
    "chains": {
        "sui": {
            "name": "Sui",
            "axelarId": "sui",
            "networkType": "localnet",
            "chainType": "sui",
            "tokenSymbol": "SUI",
            "rpc": "http://127.0.0.1:9000",
            "faucetUrl": "http://127.0.0.1:9123",
            "contracts": {
                "AxelarGateway": {}
            }
        }
    }
}

Use the -e local (or ENV=local in the .env config) flag with scripts to run against the local network.

Deployment

To get test SUI coins to your address via a faucet.

node sui/faucet.js

The following packages need to be deployed in order because they are referenced by other packages.

Utils

node sui/deploy-contract.js deploy Utils

Version Control

node sui/deploy-contract.js deploy VersionControl

AxelarGateway

By querying the signer set from the Amplifier contract (this only works if Amplifier contracts have been setup):

node sui/deploy-contract.js deploy AxelarGateway

Note: the minimumRotationDelay is in seconds unit. The default value is 24 * 60 * 60 (1 day).

Use --help flag to see other setup params that can be overridden.

For testing convenience, you can use the secp256k1 wallet as the signer set for the gateway.

node sui/deploy-contract.js deploy AxelarGateway --signers wallet --nonce test

You can also provide a JSON object with a full signer set:

node sui/deploy-contract.js deploy AxelarGateway -e testnet --signers '{"signers": [{"pub_key": "0x020194ead85b350d90472117e6122cf1764d93bf17d6de4b51b03d19afc4d6302b", "weight": 1}], "threshold": 1, "nonce": "0x0000000000000000000000000000000000000000000000000000000000000000"}'

Gas Service

node sui/deploy-contract.js deploy GasService

Abi

node sui/deploy-contract.js deploy Abi

Operators

node sui/deploy-contract.js deploy Operators

Operators Post Deployment

Gas Collector Configuration

To allow the operator to collect or refund gas, the GasCollector cap must be stored in the Operators contract:

node sui/operators.js storeCap

Operator Management

Assign Operator role to given address:

node sui/operators.js add <operator address>

Governance

node sui/deploy-contract.js deploy Governance

Relayer Discovery

node sui/deploy-contract.js deploy RelayerDiscovery

ITS

node sui/deploy-contract.js deploy ITS

Squid

node sui/deploy-contract.js deploy Squid

Example

node sui/deploy-contract.js deploy Example

Contract Upgrades

Upgrade Procedures

For example, to update the gateway run the following command:

node sui/deploy-contract.js upgrade AxelarGateway <policy>

policy should be one of the following:

any_upgrade: Allow any upgrade.
code_upgrade: Upgrade policy to just add code. https://docs.sui.io/references/framework/sui-framework/package#function-only_additive_upgrades
dep_upgrade: Upgrade policy to just change dependencies. https://docs.sui.io/references/framework/sui-framework/package#function-only_dep_upgrades

Provide --txFilePath with --offline to generate tx data file for offline signing.

Multisig Operations

To create a Multisig, follow the documentation here.

Get test SUI coins to your multisig address via a faucet:

sui client faucet --address <multisig address>

Get public keys for all wallets:

sui keytool list

Get private key of wallet using wallet alias or address:

sui keytool export --key-identity <alias/wallet address>

Get tx data for testing:

sui client transfer-sui --to <recipient address> --amount 1 --sui-coin-object-id <sui coin object id> --serialize-unsigned-transaction --gas-budget 77047880

To get sui coin object id

sui client gas <multisig address>

Sign transaction block for multisig:

node sui/multisig.js --txBlockPath <path to unsigned tx block> --signatureFilePath <path to store signature> --action sign --offline

example txBlock file:

{
    "bytes": "AAACACBC5cSnnYJrDEn9nSW1BDzPLLAbUJbYOeJnUgYl/b90..."
}

Combine signature files:

node sui/multisig.js --txBlockPath <path to unsigned tx block> --signatureFilePath <path to store combined signature> --action combine --offline --signatures <paths to files containing signatures>

Execute combined signature:

This command will broadcast the signature to the network

node sui/multisig.js --txBlockPath <path to unsigned tx block> --action execute --combinedSignPath <path to combined signature>

use --multisigKey multisigKey to override existing multisig info in chains config

example for adding multisig info to chains config:

{
    "sui": {
        "name": "Sui",
        "axelarId": "sui",
        "networkType": "testnet",
        "tokenSymbol": "SUI",
        "rpc": "https://fullnode.testnet.sui.io:443",
        "contracts": {},
        "multisig": {
            "threshold": 2,
            "signers": [
                {
                    "publicKey": "AIqrCb324p6Qd4srkqCzn9NJHS7W17tA7r3t7Ur6aYN",
                    "weight": 1,
                    "schemeType": "ed25519"
                },
                .
                .
                .
            ]
        }
    }
}

Contract Interactions

Call Contract

node sui/gateway.js call-contract ethereum 0xba76c6980428A0b10CFC5d8ccb61949677A61233 0x1234

Pay Gas

The syntax is node sui/gas-service.js payGas --amount <amount> <destinationChain> <destinationAddress> <channelId> <payload>

node sui/gas-service.js payGas --amount 0.1 ethereum 0x6f24A47Fc8AE5441Eb47EFfC3665e70e69Ac3F05 0xba76c6980428A0b10CFC5d8ccb61949677A61233 0x1234

Collect Gas

node sui/gas-service.js collectGas --amount 0.1 --receiver <receiver address>

Approve Messages

If the gateway was deployed using the wallet, you can submit a message approval with it

node sui/gateway.js approve --proof wallet --currentNonce test ethereum 0x0x32034b47cb29d162d9d803cc405356f4ac0ec07fe847ace431385fe8acf3e6e5-1 0x4F4495243837681061C4743b74B3eEdf548D56A5 0xa84d27bd6c9680e52e93779b8977bbcb73273b88f52a84d8dd8af1c3301341d7 0x47173285a8d7341e5e972fc677286384f802f8ef42a5ec5f03bbfa254cb01fad

Rotate Gateway Signers

If gateway was deployed with the wallet as the verifier, and you want to rotate to the Amplifier verifiers, do

node sui/gateway.js rotate --proof wallet --currentNonce test

If you want to rotate to the wallet again but with a new nonce, do

node sui/gateway.js rotate --signers wallet --proof wallet --currentNonce test --newNonce test2

Use the same nonce for --currentNonce as the --nonce when deploying the gateway.

To submit a proof constructed on Amplifier, run the following with the multisig session id,

node sui/gateway.js submitProof [multisig session id]

Transfer Object

Please note shared objects cannot be transferred via this script.

node sui/transfer-object.js --objectId <object id to be transferred> --recipient <recipient address>

node sui/transfer-object.js --contractName <Can be checked from config> --objectName <picked from config> --recipient <recipient address>

Coins Management

List of coins in the wallet:

node sui/tokens.js list

Merge the coins:

node sui/tokens.js merge --coin-type <coin type to merge>

If coin type is not provided, it will merge all the coins.

Split the coins:

node sui/tokens.js split --amount <amount> --coin-type <coin type to split> --transfer <recipient address>

Note:

If coin type is not provided, it will split all the coins.
If transfer address is not provided, it will split the coins in the same wallet. Otherwise, it will transfer the splitted coins to the provided address.

Setup Trusted Addresses

Add trusted address

node sui/its.js setup-trusted-address <sourceChain>,<sourceChain2>,... <sourceAddress>

or Add all evm chains that have ITS contract deployed

node sui/its.js setup-trusted-address all-evm <sourceAddress>

Remove trusted address

node sui/its.js remove-trusted-address <sourceChain>,<sourceChain2>,...

Examples

GMP Example Guide
ITS Example Guide

Troubleshooting

Move build error during the deployment step

Delete the node_modules folder and package-lock.json file and then run npm install again.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Sui Deployment Guide

Table of Contents

Prerequisites

Deployment

Utils

Version Control

AxelarGateway

Gas Service

Abi

Operators

Operators Post Deployment

Gas Collector Configuration

Operator Management

Governance

Relayer Discovery

ITS

Squid

Example

Contract Upgrades

Upgrade Procedures

Multisig Operations

Contract Interactions

Call Contract

Pay Gas

Collect Gas

Approve Messages

Rotate Gateway Signers

Transfer Object

Coins Management

Setup Trusted Addresses

Examples

Troubleshooting

Files

README.md

Latest commit

History

README.md

File metadata and controls

Sui Deployment Guide

Table of Contents

Prerequisites

Deployment

Utils

Version Control

AxelarGateway

Gas Service

Abi

Operators

Operators Post Deployment

Gas Collector Configuration

Operator Management

Governance

Relayer Discovery

ITS

Squid

Example

Contract Upgrades

Upgrade Procedures

Multisig Operations

Contract Interactions

Call Contract

Pay Gas

Collect Gas

Approve Messages

Rotate Gateway Signers

Transfer Object

Coins Management

Setup Trusted Addresses

Examples

Troubleshooting