@0xobelisk/sui-cli 1.1.5 → 1.1.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xobelisk/sui-cli",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "Tookit for interacting with move eps framework",
   "keywords": [
     "sui",
@@ -41,16 +41,14 @@
     "execa": "^7.0.0",
     "glob": "^8.0.3",
     "path": "^0.12.7",
-    "prettier": "^2.8.4",
-    "prettier-plugin-rust": "^0.1.9",
     "sqlite": "^5.1.1",
     "sqlite3": "^5.1.7",
     "typescript": "5.1.6",
     "yargs": "^17.7.1",
     "zod": "^3.22.3",
     "zod-validation-error": "^1.3.0",
-    "@0xobelisk/sui-common": "1.1.6",
-    "@0xobelisk/sui-client": "1.1.4"
+    "@0xobelisk/sui-client": "1.1.7",
+    "@0xobelisk/sui-common": "1.1.7"
   },
   "devDependencies": {
     "@types/ejs": "^3.1.1",
@@ -60,7 +58,10 @@
     "ts-node": "^10.9.1",
     "tsup": "^6.7.0",
     "tsx": "^3.12.6",
-    "vitest": "0.31.4"
+    "vitest": "0.31.4",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "prettier": "3.3.3"
   },
   "scripts": {
     "build": "pnpm run type-check && pnpm run build:js",
@@ -69,6 +70,9 @@
     "clean:js": "rimraf dist",
     "dev": "tsup --watch",
     "lint": "eslint . --ext .ts",
-    "type-check": "tsc --noEmit"
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "type-check": "tsc --noEmit",
+    "validate": "pnpm format:check && pnpm type-check"
   }
 }

package/src/commands/build.ts

@@ -5,59 +5,59 @@ import { DubheConfig, loadConfig } from '@0xobelisk/sui-common';
 import { switchEnv, updateDubheDependency } from '../utils';
 
 type Options = {
-	'config-path': string;
-	network: any;
-	'dump-bytecode-as-base64'?: boolean;
+  'config-path': string;
+  network: any;
+  'dump-bytecode-as-base64'?: boolean;
 };
 
 const commandModule: CommandModule<Options, Options> = {
-	command: 'build',
-	describe: 'Run tests in Dubhe contracts',
-	builder(yargs) {
-		return yargs.options({
-			'config-path': {
-				type: 'string',
-				default: 'dubhe.config.ts',
-				description: 'Options to pass to forge test',
-			},
-			network: {
-				type: 'string',
-				default: 'localnet',
-				choices: ['mainnet', 'testnet', 'devnet', 'localnet'],
-				desc: 'Node network (mainnet/testnet/devnet/localnet)',
-			},
-			'dump-bytecode-as-base64': {
-				type: 'boolean',
-				default: false,
-				desc: 'Dump bytecode as base64',
-			},
-		});
-	},
+  command: 'build',
+  describe: 'Run tests in Dubhe contracts',
+  builder(yargs) {
+    return yargs.options({
+      'config-path': {
+        type: 'string',
+        default: 'dubhe.config.ts',
+        description: 'Options to pass to forge test'
+      },
+      network: {
+        type: 'string',
+        default: 'localnet',
+        choices: ['mainnet', 'testnet', 'devnet', 'localnet'],
+        desc: 'Node network (mainnet/testnet/devnet/localnet)'
+      },
+      'dump-bytecode-as-base64': {
+        type: 'boolean',
+        default: false,
+        desc: 'Dump bytecode as base64'
+      }
+    });
+  },
 
-	async handler({
-		'config-path': configPath,
-		network,
-		'dump-bytecode-as-base64': dumpBytecodeAsBase64,
-	}) {
-		// Start an internal anvil process if no world address is provided
-		try {
-			console.log('🚀 Running move build');
-			const dubheConfig = (await loadConfig(configPath)) as DubheConfig;
-			const path = process.cwd();
-			const projectPath = `${path}/contracts/${dubheConfig.name}`;
-			await switchEnv(network);
-			await updateDubheDependency(projectPath + '/Move.toml', network);
-			const command = `sui move build --path ${projectPath} ${
-				dumpBytecodeAsBase64 ? ` --dump-bytecode-as-base64` : ''
-			}`;
-			const output = execSync(command, { encoding: 'utf-8' });
-			console.log(output);
-		} catch (error: any) {
-			console.error(chalk.red('Error executing sui move build:'));
-			console.log(error.stdout);
-			process.exit(0);
-		}
-	},
+  async handler({
+    'config-path': configPath,
+    network,
+    'dump-bytecode-as-base64': dumpBytecodeAsBase64
+  }) {
+    // Start an internal anvil process if no world address is provided
+    try {
+      console.log('🚀 Running move build');
+      const dubheConfig = (await loadConfig(configPath)) as DubheConfig;
+      const path = process.cwd();
+      const projectPath = `${path}/contracts/${dubheConfig.name}`;
+      await switchEnv(network);
+      await updateDubheDependency(projectPath + '/Move.toml', network);
+      const command = `sui move build --path ${projectPath} ${
+        dumpBytecodeAsBase64 ? ` --dump-bytecode-as-base64` : ''
+      }`;
+      const output = execSync(command, { encoding: 'utf-8' });
+      console.log(output);
+    } catch (error: any) {
+      console.error(chalk.red('Error executing sui move build:'));
+      console.log(error.stdout);
+      process.exit(0);
+    }
+  }
 };
 
 export default commandModule;

package/src/commands/call.ts

@@ -4,87 +4,87 @@ import { callHandler } from '../utils';
 import { loadConfig, DubheConfig } from '@0xobelisk/sui-common';
 
 type Options = {
-	network: 'mainnet' | 'testnet' | 'devnet' | 'localnet';
-	module: string;
-	function: string;
-	'config-path'?: string;
-	'package-id'?: string;
-	'metadata-path'?: string;
-	params?: any[];
+  network: 'mainnet' | 'testnet' | 'devnet' | 'localnet';
+  module: string;
+  function: string;
+  'config-path'?: string;
+  'package-id'?: string;
+  'metadata-path'?: string;
+  params?: any[];
 };
 
 /**
  * CLI command for calling a function in a module
  */
 const commandModule: CommandModule<Options, Options> = {
-	command: 'call',
+  command: 'call',
 
-	describe: 'Call a function in a module',
+  describe: 'Call a function in a module',
 
-	builder: {
-		network: {
-			type: 'string',
-			choices: ['mainnet', 'testnet', 'devnet', 'localnet'],
-			desc: 'Node network (mainnet/testnet/devnet/localnet)',
-			default: 'localnet',
-		},
-		module: {
-			type: 'string',
-			desc: 'Module name',
-			demandOption: true,
-		},
-		function: {
-			type: 'string',
-			desc: 'Function name',
-			demandOption: true,
-		},
-		'config-path': {
-			type: 'string',
-			default: 'dubhe.config.ts',
-			desc: 'Configuration file path',
-		},
-		'package-id': {
-			type: 'string',
-			desc: 'Package ID (optional)',
-		},
-		'metadata-path': {
-			type: 'string',
-			desc: 'Path to metadata JSON file (optional)',
-		},
-		params: {
-			type: 'array',
-			desc: 'Params for the function',
-			string: true,
-		},
-	},
+  builder: {
+    network: {
+      type: 'string',
+      choices: ['mainnet', 'testnet', 'devnet', 'localnet'],
+      desc: 'Node network (mainnet/testnet/devnet/localnet)',
+      default: 'localnet'
+    },
+    module: {
+      type: 'string',
+      desc: 'Module name',
+      demandOption: true
+    },
+    function: {
+      type: 'string',
+      desc: 'Function name',
+      demandOption: true
+    },
+    'config-path': {
+      type: 'string',
+      default: 'dubhe.config.ts',
+      desc: 'Configuration file path'
+    },
+    'package-id': {
+      type: 'string',
+      desc: 'Package ID (optional)'
+    },
+    'metadata-path': {
+      type: 'string',
+      desc: 'Path to metadata JSON file (optional)'
+    },
+    params: {
+      type: 'array',
+      desc: 'Params for the function',
+      string: true
+    }
+  },
 
-	async handler({
-		network,
-		'config-path': configPath,
-		module: moduleName,
-		function: funcName,
-		'package-id': packageId,
-		'metadata-path': metadataPath,
-		params,
-	}) {
-		try {
-			const dubheConfig = (await loadConfig(configPath)) as DubheConfig;
+  async handler({
+    network,
+    'config-path': configPath,
+    module: moduleName,
+    function: funcName,
+    'package-id': packageId,
+    'metadata-path': metadataPath,
+    params
+  }) {
+    try {
+      const dubheConfig = (await loadConfig(configPath)) as DubheConfig;
 
-			await callHandler({
-				dubheConfig,
-				moduleName,
-				funcName,
-				network,
-				packageId,
-				metadataFilePath: metadataPath,
-				params,
-			});
-		} catch (error: any) {
-			logError(error);
-			process.exit(1);
-		}
-		process.exit(0);
-	},
+      await callHandler({
+        dubheConfig,
+        moduleName,
+        funcName,
+        network,
+        packageId,
+        metadataFilePath: metadataPath,
+        params
+      });
+    } catch (error: any) {
+      logError(error);
+      process.exit(1);
+    }
+    process.exit(0);
+  }
 };
 
 export default commandModule;

package/src/commands/checkBalance.ts

@@ -2,29 +2,29 @@ import type { CommandModule } from 'yargs';
 import { checkBalanceHandler } from '../utils/checkBalance';
 
 type Options = {
-	network: 'mainnet' | 'testnet' | 'devnet' | 'localnet';
+  network: 'mainnet' | 'testnet' | 'devnet' | 'localnet';
 };
 
 const commandModule: CommandModule<Options, Options> = {
-	command: 'check-balance',
-	describe: 'Check the balance of the account',
-	builder: {
-		network: {
-			type: 'string',
-			choices: ['mainnet', 'testnet', 'devnet', 'localnet'],
-			desc: 'Network to check balance on',
-			default: 'localnet',
-		},
-	},
-	async handler({ network }) {
-		try {
-			await checkBalanceHandler(network);
-		} catch (error) {
-			console.error('Error checking balance:', error);
-			process.exit(1);
-		}
-		process.exit(0);
-	},
+  command: 'check-balance',
+  describe: 'Check the balance of the account',
+  builder: {
+    network: {
+      type: 'string',
+      choices: ['mainnet', 'testnet', 'devnet', 'localnet'],
+      desc: 'Network to check balance on',
+      default: 'localnet'
+    }
+  },
+  async handler({ network }) {
+    try {
+      await checkBalanceHandler(network);
+    } catch (error) {
+      console.error('Error checking balance:', error);
+      process.exit(1);
+    }
+    process.exit(0);
+  }
 };
 
 export default commandModule;

package/src/commands/configStore.ts

@@ -3,46 +3,42 @@ import { storeConfigHandler } from '../utils/storeConfig';
 import { loadConfig, DubheConfig } from '@0xobelisk/sui-common';
 
 type Options = {
-	'config-path': string;
-	network: 'mainnet' | 'testnet' | 'devnet' | 'localnet';
-	'output-ts-path': string;
+  'config-path': string;
+  network: 'mainnet' | 'testnet' | 'devnet' | 'localnet';
+  'output-ts-path': string;
 };
 
 const commandModule: CommandModule<Options, Options> = {
-	command: 'config-store',
+  command: 'config-store',
 
-	describe: 'Store configuration for the Dubhe project',
+  describe: 'Store configuration for the Dubhe project',
 
-	builder: {
-		'config-path': {
-			type: 'string',
-			default: 'dubhe.config.ts',
-			desc: 'Path to the config file',
-		},
-		network: {
-			type: 'string',
-			choices: ['mainnet', 'testnet', 'devnet', 'localnet'],
-			desc: 'Network to store config for',
-		},
-		'output-ts-path': {
-			type: 'string',
-			desc: 'Specify the output path for the generated TypeScript configuration file (e.g., ./src/config/generated.ts)',
-		},
-	},
-	async handler({
-		'config-path': configPath,
-		network,
-		'output-ts-path': outputTsPath,
-	}) {
-		try {
-			const dubheConfig = (await loadConfig(configPath)) as DubheConfig;
-			await storeConfigHandler(dubheConfig, network, outputTsPath);
-		} catch (error) {
-			console.error('Error storing config:', error);
-			process.exit(1);
-		}
-		process.exit(0);
-	},
+  builder: {
+    'config-path': {
+      type: 'string',
+      default: 'dubhe.config.ts',
+      desc: 'Path to the config file'
+    },
+    network: {
+      type: 'string',
+      choices: ['mainnet', 'testnet', 'devnet', 'localnet'],
+      desc: 'Network to store config for'
+    },
+    'output-ts-path': {
+      type: 'string',
+      desc: 'Specify the output path for the generated TypeScript configuration file (e.g., ./src/config/generated.ts)'
+    }
+  },
+  async handler({ 'config-path': configPath, network, 'output-ts-path': outputTsPath }) {
+    try {
+      const dubheConfig = (await loadConfig(configPath)) as DubheConfig;
+      await storeConfigHandler(dubheConfig, network, outputTsPath);
+    } catch (error) {
+      console.error('Error storing config:', error);
+      process.exit(1);
+    }
+    process.exit(0);
+  }
 };
 
 export default commandModule;

package/src/commands/faucet.ts

@@ -1,96 +1,88 @@
 import { Dubhe } from '@0xobelisk/sui-client';
 import type { CommandModule } from 'yargs';
 import { requestSuiFromFaucetV0, getFaucetHost } from '@mysten/sui/faucet';
-import {
-	SuiClient,
-	getFullnodeUrl,
-	GetBalanceParams,
-} from '@mysten/sui/client';
+import { SuiClient, getFullnodeUrl, GetBalanceParams } from '@mysten/sui/client';
 import { validatePrivateKey, DubheCliError } from '../utils';
 
 type Options = {
-	network: any;
-	recipient?: string;
+  network: any;
+  recipient?: string;
 };
 
 const commandModule: CommandModule<Options, Options> = {
-	command: 'faucet',
+  command: 'faucet',
 
-	describe: 'Interact with a Dubhe faucet',
+  describe: 'Interact with a Dubhe faucet',
 
-	builder(yargs) {
-		return yargs.options({
-			network: {
-				type: 'string',
-				desc: 'URL of the Dubhe faucet',
-				choices: ['testnet', 'devnet', 'localnet'],
-				default: 'localnet',
-			},
-			recipient: {
-				type: 'string',
-				desc: 'Sui address to fund',
-			},
-		});
-	},
+  builder(yargs) {
+    return yargs.options({
+      network: {
+        type: 'string',
+        desc: 'URL of the Dubhe faucet',
+        choices: ['testnet', 'devnet', 'localnet'],
+        default: 'localnet'
+      },
+      recipient: {
+        type: 'string',
+        desc: 'Sui address to fund'
+      }
+    });
+  },
 
-	async handler({ network, recipient }) {
-		let faucet_address = '';
-		if (recipient === undefined) {
-			const privateKey = process.env.PRIVATE_KEY;
-			if (!privateKey)
-				throw new DubheCliError(
-					`Missing PRIVATE_KEY environment variable.
+  async handler({ network, recipient }) {
+    let faucet_address = '';
+    if (recipient === undefined) {
+      const privateKey = process.env.PRIVATE_KEY;
+      if (!privateKey)
+        throw new DubheCliError(
+          `Missing PRIVATE_KEY environment variable.
     Run 'echo "PRIVATE_KEY=YOUR_PRIVATE_KEY" > .env'
     in your contracts directory to use the default sui private key.`
-				);
+        );
 
-			const privateKeyFormat = validatePrivateKey(privateKey);
-			if (privateKeyFormat === false) {
-				throw new DubheCliError(`Please check your PRIVATE_KEY.`);
-			}
-			const dubhe = new Dubhe({
-				secretKey: privateKeyFormat,
-			});
-			faucet_address = dubhe.getAddress();
-		} else {
-			faucet_address = recipient;
-		}
+      const privateKeyFormat = validatePrivateKey(privateKey);
+      if (privateKeyFormat === false) {
+        throw new DubheCliError(`Please check your PRIVATE_KEY.`);
+      }
+      const dubhe = new Dubhe({
+        secretKey: privateKeyFormat
+      });
+      faucet_address = dubhe.getAddress();
+    } else {
+      faucet_address = recipient;
+    }
 
-		console.log('\n🌊 Starting Faucet Operation...');
-		console.log(`  ├─ Network: ${network}`);
+    console.log('\n🌊 Starting Faucet Operation...');
+    console.log(`  ├─ Network: ${network}`);
 
-		if (recipient === undefined) {
-			console.log('  ├─ Using Environment PrivateKey');
-			console.log(`  ├─ Generated Address: ${faucet_address}`);
-		} else {
-			console.log(`  ├─ Using Provided Address: ${faucet_address}`);
-		}
+    if (recipient === undefined) {
+      console.log('  ├─ Using Environment PrivateKey');
+      console.log(`  ├─ Generated Address: ${faucet_address}`);
+    } else {
+      console.log(`  ├─ Using Provided Address: ${faucet_address}`);
+    }
 
-		console.log('  ├─ Requesting funds from faucet...');
-		await requestSuiFromFaucetV0({
-			host: getFaucetHost(network),
-			recipient: faucet_address,
-		});
+    console.log('  ├─ Requesting funds from faucet...');
+    await requestSuiFromFaucetV0({
+      host: getFaucetHost(network),
+      recipient: faucet_address
+    });
 
-		console.log('  └─ Checking balance...');
-		const client = new SuiClient({ url: getFullnodeUrl(network) });
-		let params = {
-			owner: faucet_address,
-		} as GetBalanceParams;
+    console.log('  └─ Checking balance...');
+    const client = new SuiClient({ url: getFullnodeUrl(network) });
+    let params = {
+      owner: faucet_address
+    } as GetBalanceParams;
 
-		const balance = await client.getBalance(params);
+    const balance = await client.getBalance(params);
 
-		console.log('\n💰 Account Summary');
-		console.log(`  ├─ Address: ${faucet_address}`);
-		console.log(
-			`  └─ Balance: ${(
-				Number(balance.totalBalance) / 1_000_000_000
-			).toFixed(4)} SUI`
-		);
+    console.log('\n💰 Account Summary');
+    console.log(`  ├─ Address: ${faucet_address}`);
+    console.log(`  └─ Balance: ${(Number(balance.totalBalance) / 1_000_000_000).toFixed(4)} SUI`);
 
-		console.log('\n✅ Faucet Operation Complete\n');
-		process.exit(0);
-	},
+    console.log('\n✅ Faucet Operation Complete\n');
+    process.exit(0);
+  }
 };
 
 export default commandModule;