@0xobelisk/sui-cli 1.1.4 → 1.1.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xobelisk/sui-cli",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "description": "Tookit for interacting with move eps framework",
   "keywords": [
     "sui",
@@ -49,8 +49,8 @@
     "yargs": "^17.7.1",
     "zod": "^3.22.3",
     "zod-validation-error": "^1.3.0",
-    "@0xobelisk/sui-client": "1.1.4",
-    "@0xobelisk/sui-common": "1.1.5"
+    "@0xobelisk/sui-common": "1.1.6",
+    "@0xobelisk/sui-client": "1.1.4"
   },
   "devDependencies": {
     "@types/ejs": "^3.1.1",

package/src/commands/build.ts

@@ -2,9 +2,7 @@ import type { CommandModule } from 'yargs';
 import { execSync } from 'child_process';
 import chalk from 'chalk';
 import { DubheConfig, loadConfig } from '@0xobelisk/sui-common';
-import { switchEnv } from '../utils';
-import {generateCargoToml} from "./install";
-import {writeFileSync} from "fs";
+import { switchEnv, updateDubheDependency } from '../utils';
 
 type Options = {
 	'config-path': string;
@@ -48,8 +46,7 @@ const commandModule: CommandModule<Options, Options> = {
 			const path = process.cwd();
 			const projectPath = `${path}/contracts/${dubheConfig.name}`;
 			await switchEnv(network);
-			const cargoTomlContent = generateCargoToml(dubheConfig.dependencies, dubheConfig.name, network);
-			writeFileSync(`${projectPath}/Move.toml`, cargoTomlContent, { encoding: 'utf-8' });
+			await updateDubheDependency(projectPath + '/Move.toml', network);
 			const command = `sui move build --path ${projectPath} ${
 				dumpBytecodeAsBase64 ? ` --dump-bytecode-as-base64` : ''
 			}`;

package/src/commands/index.ts

@@ -15,7 +15,6 @@ import query from './query';
 import call from './call';
 import indexer from './indexer';
 import watch from './watch';
-import install from "./install";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Each command has different options
 export const commands: CommandModule<any, any>[] = [
@@ -34,5 +33,4 @@ export const commands: CommandModule<any, any>[] = [
 	configStore,
 	indexer,
 	watch,
-	install
 ];

package/src/commands/localnode.ts

@@ -1,33 +1,18 @@
 import type { CommandModule } from 'yargs';
 import { startLocalNode } from '../utils/startNode';
-import {DubheConfig, loadConfig} from "@0xobelisk/sui-common";
-import {dubheInstall} from "./install";
 
-type Options = {
-	'config-path': string;
-};
-
-const commandModule: CommandModule<Options, Options> = {
+const commandModule: CommandModule = {
 	command: 'node',
 
 	describe: 'Manage local Sui node',
 
 	builder(yargs) {
 		return yargs
-			.options({
-				'config-path': {
-					type: 'string',
-					default: 'dubhe.config.ts',
-					description: 'Path to the configuration file',
-				},
-			})
 	},
 
-	async handler({ 'config-path': configPath }) {
+	async handler() {
 		try {
-			const dubheConfig = (await loadConfig(configPath)) as DubheConfig;
-			await dubheInstall(dubheConfig, 'localnet');
-			await startLocalNode(dubheConfig);
+			await startLocalNode();
 		} catch (error) {
 			console.error('Error executing command:', error);
 			process.exit(1);

package/src/utils/publishHandler.ts

@@ -5,15 +5,13 @@ import { DubheCliError } from './errors';
 import {
 	saveContractData,
 	validatePrivateKey,
+	updateDubheDependency,
 	switchEnv,
 	delay,
 } from './utils';
 import { DubheConfig } from '@0xobelisk/sui-common';
 import * as fs from 'fs';
 import * as path from 'path';
-import {homedir} from "node:os";
-import {generateCargoToml, getRepoNameFromUrl} from "../commands/install";
-import {writeFileSync} from "fs";
 
 async function removeEnvContent(
 	filePath: string,
@@ -289,88 +287,116 @@ async function publishContract(
 	}
 }
 
+async function checkDubheFramework(projectPath: string): Promise<boolean> {
+	if (!fs.existsSync(projectPath)) {
+		console.log(chalk.yellow('\nℹ️ Dubhe Framework Files Not Found'));
+		console.log(chalk.yellow('  ├─ Expected Path:'), projectPath);
+		console.log(chalk.yellow('  ├─ To set up Dubhe Framework:'));
+		console.log(
+			chalk.yellow(
+				'  │  1. Create directory: mkdir -p contracts/dubhe-framework'
+			)
+		);
+		console.log(
+			chalk.yellow(
+				'  │  2. Clone repository: git clone https://github.com/0xobelisk/dubhe-framework contracts/dubhe-framework'
+			)
+		);
+		console.log(
+			chalk.yellow(
+				'  │  3. Or download from: https://github.com/0xobelisk/dubhe-framework'
+			)
+		);
+		console.log(chalk.yellow('  └─ After setup, restart the local node'));
+		return false;
+	}
+	return true;
+}
+
 export async function publishDubheFramework(
-	dubheConfig: DubheConfig,
 	dubhe: Dubhe,
 	network: 'mainnet' | 'testnet' | 'devnet' | 'localnet'
 ) {
+	const path = process.cwd();
+	const projectPath = `${path}/contracts/dubhe-framework`;
+
+	if (!(await checkDubheFramework(projectPath))) {
+		console.log(chalk.yellow('\n❗ Framework Deployment Skipped'));
+		return;
+	}
+
+	// const chainId = await client.getChainIdentifier();
 	const chainId =
 		await dubhe.suiInteractor.currentClient.getChainIdentifier();
-	for (const dependency of dubheConfig.dependencies) {
-		const projectName = getRepoNameFromUrl(dependency.git);
-		let projectPath = `${homedir()}/.dubhe/dependencies/${projectName}`
-		if (dependency.subdir) {
-			projectPath += `/${dependency.subdir}`;
-		}
-		console.log(`\n🚀 Initialize dependencies...`);
-		console.log(`  ├─ Project: ${projectPath}`);
-		if (!fs.existsSync(projectPath)) {
-			console.log(chalk.yellow('\nℹ️ Please install Dubhe Framework'));
-			console.log(chalk.yellow('\nℹ️ Execute the following command:'));
-			console.log(chalk.yellow(`pnpm dubhe install`));
-			continue;
-		}
+	await removeEnvContent(`${projectPath}/Move.lock`, network);
+	console.log('\n🚀 Starting Contract Publication...');
+	console.log(`  ├─ Project: ${projectPath}`);
+	console.log(`  ├─ Network: ${network}`);
 
-		await removeEnvContent(`${projectPath}/Move.lock`, network);
-		const [modules, dependencies] = buildContract(projectPath);
+	console.log(`  └─ Account: ${dubhe.getAddress()}`);
 
-		const tx = new Transaction();
-		const [upgradeCap] = tx.publish({ modules, dependencies });
-		tx.transferObjects([upgradeCap], dubhe.getAddress());
+	console.log('\n📦 Building Contract...');
+	const [modules, dependencies] = buildContract(projectPath);
 
-		let result;
-		try {
-			result = await dubhe.signAndSendTxn({ tx });
-		} catch (error: any) {
-			console.error(chalk.red('  └─ Publication failed'));
-			console.error(error.message);
-			process.exit(1);
-		}
+	console.log('\n🔄 Publishing Contract...');
+	const tx = new Transaction();
+	const [upgradeCap] = tx.publish({ modules, dependencies });
+	tx.transferObjects([upgradeCap], dubhe.getAddress());
 
-		if (result.effects?.status.status === 'failure') {
-			console.log(chalk.red('  └─ Publication failed'));
-			process.exit(1);
-		}
+	let result;
+	try {
+		result = await dubhe.signAndSendTxn({ tx });
+	} catch (error: any) {
+		console.error(chalk.red('  └─ Publication failed'));
+		console.error(error.message);
+		process.exit(1);
+	}
 
-		result.objectChanges!.map(async object => {
-			if (object.type === 'published') {
-				console.log(`  ├─ Package ID: ${object.packageId}`);
-				updateEnvFile(
-					`${projectPath}/Move.lock`,
-					network,
-					'publish',
-					chainId,
-					object.packageId
-				);
-
-				if (dependency.name === 'merak') {
-					await delay(2000);
-					const deployHookTx = new Transaction();
-					deployHookTx.moveCall({
-						target: `${object.packageId}::genesis::run`,
-						arguments: [deployHookTx.object('0x6')],
-					});
-
-					let deployHookResult;
-					try {
-						deployHookResult = await dubhe.signAndSendTxn({tx: deployHookTx});
-					} catch (error: any) {
-						console.error(chalk.red('  └─ Deploy hook execution failed'));
-						console.error(error.message);
-						process.exit(1);
-					}
-
-					if (deployHookResult.effects?.status.status === 'success') {
-						deployHookResult.objectChanges?.map(object => {
-							if (object.type === 'created' && object.objectType.includes('schema::Schema')) {
-								console.log(`  ├─ Schema ID: ${object.objectId}`);
-							}
-						});
-					}
-				}
-			}
-		});
+	if (result.effects?.status.status === 'failure') {
+		console.log(chalk.red('  └─ Publication failed'));
+		process.exit(1);
 	}
+
+	let version = 1;
+	let packageId = '';
+	let schemas: Record<string, string> = {};
+	let upgradeCapId = '';
+
+	result.objectChanges!.map(object => {
+		if (object.type === 'published') {
+			console.log(`  ├─ Package ID: ${object.packageId}`);
+			packageId = object.packageId;
+		}
+		if (
+			object.type === 'created' &&
+			object.objectType === '0x2::package::UpgradeCap'
+		) {
+			console.log(`  ├─ Upgrade Cap: ${object.objectId}`);
+			upgradeCapId = object.objectId;
+		}
+	});
+
+	console.log(`  └─ Transaction: ${result.digest}`);
+
+	updateEnvFile(
+		`${projectPath}/Move.lock`,
+		network,
+		'publish',
+		chainId,
+		packageId
+	);
+
+	saveContractData(
+		'dubhe-framework',
+		network,
+		packageId,
+		'',
+		upgradeCapId,
+		version,
+		schemas
+	);
+	await delay(1000);
+	console.log(chalk.green('\n✅ Dubhe Framework deployed successfully'));
 }
 
 export async function publishHandler(
@@ -398,10 +424,12 @@ in your contracts directory to use the default sui private key.`
 		networkType: network,
 	});
 
+	if (network === 'localnet') {
+		await publishDubheFramework(dubhe, network);
+	}
+
 	const path = process.cwd();
 	const projectPath = `${path}/contracts/${dubheConfig.name}`;
-	const cargoTomlContent = generateCargoToml(dubheConfig.dependencies, dubheConfig.name, network);
-	writeFileSync(`${projectPath}/Move.toml`, cargoTomlContent, { encoding: 'utf-8' });
-
+	await updateDubheDependency(`${projectPath}/Move.toml`, network);
 	await publishContract(dubhe, dubheConfig, network, projectPath, gasBudget);
 }

package/src/utils/startNode.ts

@@ -1,9 +1,8 @@
 import { execSync, spawn } from 'child_process';
 import chalk from 'chalk';
 import { printDubhe } from './printDubhe';
-import {delay, DubheCliError, publishDubheFramework, validatePrivateKey} from '../utils';
+import { delay, DubheCliError, validatePrivateKey } from '../utils';
 import { Dubhe } from '@0xobelisk/sui-client';
-import {DubheConfig} from "@0xobelisk/sui-common";
 
 function isSuiStartRunning(): boolean {
 	try {
@@ -71,7 +70,7 @@ async function printAccounts() {
 		)
 	);
 }
-export async function startLocalNode(dubheConfig: DubheConfig) {
+export async function startLocalNode() {
 	if (isSuiStartRunning()) {
 		console.log(chalk.yellow('\n⚠️  Warning: Local Node Already Running'));
 		console.log(chalk.yellow('  ├─ Cannot start a new instance'));
@@ -103,6 +102,7 @@ export async function startLocalNode(dubheConfig: DubheConfig) {
 		console.log('  └─ Force Regenesis: Yes');
 		console.log('  └─ HTTP server: http://127.0.0.1:9000/');
 		console.log('  └─ Faucet server: http://127.0.0.1:9123/');
+
 		await printAccounts();
 
 		await delay(2000);
@@ -114,13 +114,7 @@ export async function startLocalNode(dubheConfig: DubheConfig) {
 			throw new DubheCliError(`Please check your privateKey.`);
 		}
 
-		console.log(chalk.green('🎉 Local environment is ready!'))
-		const dubhe = new Dubhe({
-			secretKey: privateKeyFormat,
-			networkType: "localnet",
-		});
-
-		await publishDubheFramework(dubheConfig, dubhe, 'localnet');
+		console.log(chalk.green('🎉 Local environment is ready!'));
 
 		process.on('SIGINT', () => {
 			console.log(chalk.yellow('\n🔔 Stopping Local Node...'));
@@ -135,4 +129,4 @@ export async function startLocalNode(dubheConfig: DubheConfig) {
 		console.error(chalk.red(`  └─ Error: ${error.message}`));
 		process.exit(1);
 	}
-}
+}

package/src/commands/install.ts

@@ -1,126 +0,0 @@
-import type { CommandModule } from 'yargs';
-import { execSync } from 'child_process';
-import { DubheConfig, loadConfig } from '@0xobelisk/sui-common';
-import {existsSync, writeFileSync} from 'fs';
-import {homedir} from "node:os";
-import {join} from "path";
-import {readFileSync} from "node:fs";
-
-type Options = {
-	'config-path': string;
-	network: any;
-};
-
-export function getRepoNameFromUrl(url: string): string {
-	// Split the URL by '/' and filter out empty strings
-	const parts = url.split('/').filter(part => part.length > 0);
-
-	// Get the last part and remove any ${} syntax if present
-	const lastPart = parts[parts.length - 1];
-	return lastPart.replace(/^\${(.*)}$/, '$1');
-}
-
-export function generateCargoToml(
-	dependencies: DubheConfig['dependencies'],
-	projectName: string,
-	network: 'mainnet' | 'testnet' | 'devnet' | 'localnet'
-): string {
-	let cargoToml = `[package]\nname = "${projectName}"\nversion = "1.0.0"\nedition = "2024"\n\n[dependencies]\n`;
-	cargoToml += `Sui = { git = "https://github.com/MystenLabs/sui.git", subdir = "crates/sui-framework/packages/sui-framework", rev = "mainnet-v1.38.3" }\n`;
-
-	if (network === 'localnet') {
-		const dubhePath = `${homedir()}/.dubhe/dependencies/dubhe-framework`;
-		cargoToml += `Dubhe = { local = "${dubhePath}" }\n`;
-
-		dependencies.forEach(dep => {
-			const repoName = getRepoNameFromUrl(dep.git);
-			if (dep.name && dep.name.toLowerCase() === 'dubhe') {
-				return;
-			}
-
-			let localPath = `${homedir()}/.dubhe/dependencies/${repoName}`;
-			if (dep.subdir) {
-				localPath += `/${dep.subdir}`;
-			}
-			const depName = dep.name || repoName;
-			cargoToml += `${depName} = { local = "${localPath}" }\n`;
-
-			const moveTomlPath = join(localPath, 'Move.toml');
-			if (existsSync(moveTomlPath)) {
-				try {
-					let moveTomlContent = readFileSync(moveTomlPath, 'utf-8');
-					const dubheRegex = /Dubhe\s*=\s*{[^}]*}/g;
-					if (moveTomlContent.match(dubheRegex)) {
-						moveTomlContent = moveTomlContent.replace(
-							dubheRegex,
-							`Dubhe = { local = "${dubhePath}" }`
-						);
-						writeFileSync(moveTomlPath, moveTomlContent, 'utf-8');
-					}
-				} catch (error) {
-					console.error(`Failed to update Move.toml at ${moveTomlPath}: ${error}`);
-				}
-			}
-		});
-	} else {
-		dependencies.forEach(dep => {
-			const repoName = getRepoNameFromUrl(dep.git);
-			const depName = dep.name || repoName;
-			cargoToml += `${depName} = { git = "${dep.git}", rev = "${dep.rev}"`;
-			if (dep.subdir) {
-				cargoToml += `, subdir = "${dep.subdir}"`;
-			}
-			cargoToml += ` }\n`;
-		});
-	}
-	cargoToml += `\n[addresses]\nsui = "0x2"\n${projectName} = "0x0"\n`;
-	return cargoToml;
-}
-
-const commandModule: CommandModule<Options, Options> = {
-	command: 'install',
-	describe: 'Install a repository in Dubhe contracts',
-	builder(yargs) {
-		return yargs
-			.options({
-				'config-path': {
-					type: 'string',
-					default: 'dubhe.config.ts',
-					description: 'Path to the configuration file',
-				},
-			}).options({
-			'network': {
-				type: 'string',
-				default: 'localnet',
-				description: 'Path to the configuration file',
-			},
-		});
-
-	},
-	async handler({ 'config-path': configPath, network }) {
-		try {
-			const dubheConfig = (await loadConfig(configPath)) as DubheConfig;
-			await dubheInstall(dubheConfig, network);
-		} catch (error: any) {
-			console.error(`Error installing repository: ${error.message}`);
-			process.exit(1);
-		}
-	},
-};
-
-export async function dubheInstall(dubheConfig: DubheConfig, network: 'mainnet' | 'testnet' | 'devnet' | 'localnet') {
-	dubheConfig.dependencies.forEach(dependency => {
-		const projectName = getRepoNameFromUrl(dependency.git);
-		const dependencyPath = join(homedir(), '.dubhe', 'dependencies', projectName);
-		if (!existsSync(dependencyPath)) {
-			console.log(`🚀 Installing repository: ${dependency.git}`);
-			const command = `git clone --depth 1 --branch ${dependency.rev} ${dependency.git} ${dependencyPath}`;
-			execSync(command, { stdio: 'inherit', encoding: 'utf-8' });
-		}
-	});
-	const cargoTomlContent = generateCargoToml(dubheConfig.dependencies, dubheConfig.name, network);
-	const projectPath = `${process.cwd()}/contracts/${dubheConfig.name}/Move.toml`;
-	writeFileSync(projectPath, cargoTomlContent, { encoding: 'utf-8' });
-}
-
-export default commandModule;