feat(sui): support all contract deployment in deploy-contract script

common/utils.js

@@ -15,7 +15,19 @@ const {
 const { normalizeBech32 } = require('@cosmjs/encoding');
 
 function loadConfig(env) {
-    return require(`${__dirname}/../axelar-chains-config/info/${env}.json`);
+    const config = require(`${__dirname}/../axelar-chains-config/info/${env}.json`);
+
+    if (!config.sui) {
+        config.sui = {
+            networkType: env === 'local' ? 'localnet' : env,
+            name: 'Sui',
+            contracts: {
+                AxelarGateway: {},
+            },
+        };
+    }
+
+    return config;
 }
 
 function saveConfig(config, env) {

package.json

@@ -31,7 +31,8 @@
     "@mysten/sui": "^1.3.0",
     "@stellar/stellar-sdk": "^12.0.0-rc3",
     "axios": "^1.6.2",
-    "path": "^0.12.7"
+    "path": "^0.12.7",
+    "toml": "^3.0.0"
   },
   "devDependencies": {
     "@ledgerhq/hw-transport-node-hid": "^6.27.21",

sui/deploy-contract.js

@@ -7,13 +7,12 @@ const { Transaction } = require('@mysten/sui/transactions');
 const {
     utils: { arrayify },
 } = ethers;
-const { saveConfig, printInfo, validateParameters, writeJSON, getDomainSeparator } = require('../common');
+const { saveConfig, printInfo, validateParameters, writeJSON, getDomainSeparator, loadConfig } = require('../common');
 const { addBaseOptions, addOptionsToCommands } = require('./cli-utils');
 const { getWallet, printWalletInfo, broadcast } = require('./sign-utils');
 const { bytes32Struct, signersStruct } = require('./types-utils');
-const { upgradePackage, addDeployOptions, UPGRADE_POLICIES } = require('./deploy-utils');
+const { upgradePackage, UPGRADE_POLICIES } = require('./deploy-utils');
 const {
-    loadSuiConfig,
     getSigners,
     deployPackage,
     getObjectIdsByObjectTypes,
@@ -38,6 +37,30 @@ const {
  */
 const PACKAGE_DIRS = ['gas_service', 'test', 'axelar_gateway', 'operators'];
 
+/**
+ * Post-Deployment Functions Mapping
+ *
+ * This object maps each package name to a post-deployment function.
+ */
+const POST_DEPLOY_FUNCTIONS = {
+    GasService: postDeployGasService,
+    Test: postDeployTest,
+    Operators: postDeployOperators,
+    AxelarGateway: postDeployAxelarGateway,
+};
+
+/**
+ * Command Options Mapping
+ *
+ * This object maps each package name to a function that returns an array of command options.
+ */
+const CMD_OPTIONS = {
+    AxelarGateway: () => [...DEPLOY_CMD_OPTIONS, ...GATEWAY_CMD_OPTIONS],
+    GasService: () => DEPLOY_CMD_OPTIONS,
+    Test: () => DEPLOY_CMD_OPTIONS,
+    Operators: () => DEPLOY_CMD_OPTIONS,
+};
+
 /**
  * Supported Move Packages
  *
@@ -62,7 +85,8 @@ const supportedPackages = PACKAGE_DIRS.map((dir) => ({
  * Define post-deployment functions for each supported package below.
  */
 
-async function postDeployGasService(published, chain) {
+async function postDeployGasService(published, args) {
+    const { chain } = args;
     const [gasCollectorCapObjectId, gasServiceObjectId] = getObjectIdsByObjectTypes(published.publishTxn, [
         `${published.packageId}::gas_service::GasCollectorCap`,
         `${published.packageId}::gas_service::GasService`,
@@ -73,7 +97,8 @@ async function postDeployGasService(published, chain) {
     };
 }
 
-async function postDeployTest(published, config, chain, options) {
+async function postDeployTest(published, args) {
+    const { chain, config, options } = args;
     const [keypair, client] = getWallet(chain, options);
     const relayerDiscovery = config.sui.contracts.AxelarGateway?.objects?.RelayerDiscovery;
 
@@ -92,18 +117,20 @@ async function postDeployTest(published, config, chain, options) {
     printInfo('Register transaction', registerTx.digest);
 }
 
-async function postDeployOperators(published, chain) {
+async function postDeployOperators(published, args) {
+    const { chain } = args;
     const [operatorsObjectId, ownerCapObjectId] = getObjectIdsByObjectTypes(published.publishTxn, [
         `${published.packageId}::operators::Operators`,
         `${published.packageId}::operators::OwnerCap`,
     ]);
     chain.contracts.Operators.objects = {
-      Operators: operatorsObjectId,
-      OwnerCap: ownerCapObjectId,
+        Operators: operatorsObjectId,
+        OwnerCap: ownerCapObjectId,
     };
 }
 
-async function postDeployAxelarGateway(published, keypair, client, config, chain, options) {
+async function postDeployAxelarGateway(published, args) {
+    const { keypair, client, config, chain, options } = args;
     const { packageId, publishTxn } = published;
     const { minimumRotationDelay, policy, previousSigners } = options;
     const operator = options.operator || keypair.toSuiAddress();
@@ -178,30 +205,19 @@ async function postDeployAxelarGateway(published, keypair, client, config, chain
 async function deploy(keypair, client, supportedContract, config, chain, options) {
     const { packageDir, packageName } = supportedContract;
 
+    // Deploy package
     const published = await deployPackage(packageDir, client, keypair, options);
 
     printInfo(`Deployed ${packageName}`, published.publishTxn.digest);
 
+    // Update chain configuration with deployed contract address
     chain.contracts[packageName] = {
         address: published.packageId,
     };
 
-    switch (packageName) {
-        case 'GasService':
-            await postDeployGasService(published, chain);
-            break;
-        case 'AxelarGateway':
-            await postDeployAxelarGateway(published, keypair, client, config, chain, options);
-            break;
-        case 'Test':
-            await postDeployTest(published, config, chain, options);
-            break;
-        case 'Operators':
-            await postDeployOperators(published, chain);
-            break;
-        default:
-            throw new Error(`${packageName} is not supported.`);
-    }
+    // Execute post-deployment function
+    const executePostDeploymentFn = POST_DEPLOY_FUNCTIONS[packageName];
+    executePostDeploymentFn(published, { keypair, client, config, chain, options });
 
     printInfo(`${packageName} Configuration Updated`, JSON.stringify(chain.contracts[packageName], null, 2));
 }
@@ -232,7 +248,7 @@ async function upgrade(keypair, client, supportedPackage, policy, config, chain,
 }
 
 async function mainProcessor(args, options, processor) {
-    const config = loadSuiConfig(options.env);
+    const config = loadConfig(options.env);
     const [keypair, client] = getWallet(config.sui, options);
     await printWalletInfo(keypair, client, config.sui, options);
     await processor(keypair, client, ...args, config, config.sui, options);
@@ -249,6 +265,44 @@ async function mainProcessor(args, options, processor) {
     }
 }
 
+/**
+ * Command Options
+ *
+ * This section defines options for the command that are specific to each package.
+ */
+
+// Common deploy command options for all packages
+const DEPLOY_CMD_OPTIONS = [
+    new Option('--policy <policy>', 'upgrade policy for upgrade cap: For example, use "any_upgrade" to allow all types of upgrades')
+        .choices(['any_upgrade', 'code_upgrade', 'dep_upgrade'])
+        .default('any_upgrade'),
+];
+
+// Gateway deploy command options
+const GATEWAY_CMD_OPTIONS = [
+    new Option('--signers <signers>', 'JSON with the initial signer set').env('SIGNERS'),
+    new Option('--operator <operator>', 'operator for the gateway (defaults to the deployer address)').env('OPERATOR'),
+    new Option('--minimumRotationDelay <minimumRotationDelay>', 'minium delay for signer rotations (in second)')
+        .argParser((val) => parseInt(val) * 1000)
+        .default(24 * 60 * 60),
+    new Option('--domainSeparator <domainSeparator>', 'domain separator'),
+    new Option('--nonce <nonce>', 'nonce for the signer (defaults to HashZero)'),
+    new Option('--previousSigners <previousSigners>', 'number of previous signers to retain').default('15'),
+];
+
+const addDeployOptions = (program) => {
+    // Get the package name from the program name
+    const packageName = program.name();
+
+    // Find the corresponding options for the package
+    const options = CMD_OPTIONS[packageName]();
+
+    // Add the options to the program
+    options.forEach((option) => program.addOption(option));
+
+    return program;
+};
+
 if (require.main === module) {
     // 1st level command
     const program = new Command('deploy-contract').description('Deploy/Upgrade packages');
@@ -274,7 +328,7 @@ if (require.main === module) {
     const upgradeContractCmds = supportedPackages.map((supportedPackage) => {
         const { packageName } = supportedPackage;
         return new Command(packageName)
-            .description(`Deploy ${packageName} contract`)
+            .description(`Upgrade ${packageName} contract`)
             .command(`${packageName} <policy>`)
             .addOption(new Option('--sender <sender>', 'transaction sender'))
             .addOption(new Option('--digest <digest>', 'digest hash for upgrade'))

sui/deploy-test.js

@@ -1,6 +1,6 @@
-const { saveConfig, prompt, printInfo } = require('../common/utils');
+const { loadConfig, saveConfig, prompt, printInfo } = require('../common/utils');
 const { Command } = require('commander');
-const { loadSuiConfig, deployPackage, getBcsBytesByObjectId } = require('./utils');
+const { deployPackage, getBcsBytesByObjectId } = require('./utils');
 const { singletonStruct } = require('./types-utils');
 const { Transaction } = require('@mysten/sui/transactions');
 const { addBaseOptions } = require('./cli-utils');
@@ -54,7 +54,7 @@ async function processCommand(config, chain, options) {
 }
 
 async function mainProcessor(options, processor) {
-    const config = loadSuiConfig(options.env);
+    const config = loadConfig(options.env);
 
     await processor(config, config.sui, options);
     saveConfig(config, options.env);

sui/deploy-utils.js

@@ -2,7 +2,6 @@ const { bcs } = require('@mysten/bcs');
 const { fromB64 } = require('@mysten/bcs');
 const { printInfo, validateParameters } = require('../common/utils');
 const { getObjectIdsByObjectTypes, suiPackageAddress } = require('./utils');
-const { Option } = require('commander');
 const UPGRADE_POLICIES = {
     code_upgrade: 'only_additive_upgrades',
     dependency_upgrade: 'only_dep_upgrades',
@@ -79,40 +78,7 @@ async function upgradePackage(client, keypair, packageToUpgrade, contractConfig,
     }
 }
 
-const getDeployGatewayOptions = () => {
-    return [
-        new Option('--signers <signers>', 'JSON with the initial signer set').env('SIGNERS'),
-        new Option('--operator <operator>', 'operator for the gateway (defaults to the deployer address)').env('OPERATOR'),
-        new Option('--minimumRotationDelay <minimumRotationDelay>', 'minium delay for signer rotations (in second)')
-            .argParser((val) => parseInt(val) * 1000)
-            .default(24 * 60 * 60),
-        new Option('--domainSeparator <domainSeparator>', 'domain separator'),
-        new Option('--nonce <nonce>', 'nonce for the signer (defaults to HashZero)'),
-        new Option('--previousSigners <previousSigners>', 'number of previous signers to retain').default('15'),
-        new Option('--policy <policy>', 'upgrade policy for upgrade cap: For example, use "any_upgrade" to allow all types of upgrades')
-            .choices(['any_upgrade', 'code_upgrade', 'dep_upgrade'])
-            .default('any_upgrade'),
-    ];
-};
-
-const addDeployOptions = (program) => {
-    switch (program.name()) {
-        case 'AxelarGateway':
-            getDeployGatewayOptions().forEach((option) => program.addOption(option));
-            break;
-        case 'GasService':
-        case 'Operators':
-        case 'Test':
-            break;
-        default:
-            throw new Error(`Unsupported package: ${program.name()}. `);
-    }
-
-    return program;
-};
-
 module.exports = {
     UPGRADE_POLICIES,
     upgradePackage,
-    addDeployOptions,
 };

sui/gas-service.js

@@ -2,8 +2,9 @@ const { saveConfig, printInfo, printError } = require('../common/utils');
 const { Command } = require('commander');
 const { Transaction } = require('@mysten/sui/transactions');
 const { bcs } = require('@mysten/sui/bcs');
+const { loadConfig } = require('../common/utils');
 const { gasServiceStruct } = require('./types-utils');
-const { loadSuiConfig, getBcsBytesByObjectId } = require('./utils');
+const { getBcsBytesByObjectId } = require('./utils');
 const { ethers } = require('hardhat');
 const { getFormattedAmount } = require('./amount-utils');
 const {
@@ -160,7 +161,7 @@ async function processCommand(command, chain, args, options) {
 }
 
 async function mainProcessor(options, args, processor, command) {
-    const config = loadSuiConfig(options.env);
+    const config = loadConfig(options.env);
     await processor(command, config.sui, args, options);
     saveConfig(config, options.env);
 }

sui/gateway.js

@@ -8,10 +8,10 @@ const {
     constants: { HashZero },
 } = ethers;
 
+const { loadConfig } = require('../common/utils');
 const { addBaseOptions } = require('./cli-utils');
 const { getWallet, printWalletInfo, getRawPrivateKey, broadcast } = require('./sign-utils');
 const { bytes32Struct, signersStruct, messageToSignStruct, messageStruct, proofStruct } = require('./types-utils');
-const { loadSuiConfig } = require('./utils');
 const { getSigners } = require('./deploy-gateway');
 const secp256k1 = require('secp256k1');
 
@@ -218,7 +218,7 @@ async function rotateSigners(keypair, client, config, chain, args, options) {
 }
 
 async function mainProcessor(processor, args, options) {
-    const config = loadSuiConfig(options.env);
+    const config = loadConfig(options.env);
 
     const [keypair, client] = getWallet(config.sui, options);
     await printWalletInfo(keypair, client, config.sui, options);

sui/gmp.js

@@ -2,7 +2,8 @@ const { saveConfig, printInfo } = require('../common/utils');
 const { Command } = require('commander');
 const { Transaction } = require('@mysten/sui/transactions');
 const { bcs } = require('@mysten/sui/bcs');
-const { loadSuiConfig, getBcsBytesByObjectId } = require('./utils');
+const { getBcsBytesByObjectId } = require('./utils');
+const { loadConfig } = require('../common/utils');
 const { ethers } = require('hardhat');
 const {
     utils: { arrayify },
@@ -165,7 +166,7 @@ async function processCommand(command, chain, args, options) {
 }
 
 async function mainProcessor(command, options, args, processor) {
-    const config = loadSuiConfig(options.env);
+    const config = loadConfig(options.env);
     await processor(command, config.sui, args, options);
     saveConfig(config, options.env);
 }

sui/multisig.js

@@ -3,7 +3,7 @@ const { fromB64 } = require('@mysten/bcs');
 const { addBaseOptions } = require('./cli-utils');
 const { getWallet, getMultisig, signTransactionBlockBytes, broadcastSignature } = require('./sign-utils');
 const { getSignedTx, storeSignedTx } = require('../evm/sign-utils');
-const { loadSuiConfig } = require('./utils');
+const { loadConfig } = require('../common/utils');
 const { printInfo, validateParameters } = require('../common/utils');
 
 async function signTx(keypair, client, options) {
@@ -143,7 +143,7 @@ async function processCommand(chain, options) {
 }
 
 async function mainProcessor(options, processor) {
-    const config = loadSuiConfig(options.env);
+    const config = loadConfig(options.env);
     await processor(config.sui, options);
 }
 

sui/transfer-object.js

@@ -3,7 +3,7 @@ const { Command, Option } = require('commander');
 const { printInfo, validateParameters } = require('../common/utils');
 const { addExtendedOptions } = require('./cli-utils');
 const { getWallet, printWalletInfo } = require('./sign-utils');
-const { loadSuiConfig } = require('./utils');
+const { loadConfig } = require('../common/utils');
 
 async function processCommand(chain, options) {
     const [keypair, client] = getWallet(chain, options);
@@ -54,7 +54,7 @@ async function processCommand(chain, options) {
 }
 
 async function mainProcessor(options, processor) {
-    const config = loadSuiConfig(options.env);
+    const config = loadConfig(options.env);
     await processor(config.sui, options);
 }