@0xobelisk/sui-cli 0.5.8 → 0.5.10

package/src/utils/upgradeHandler.ts

@@ -1,237 +1,248 @@
-import { TransactionBlock, UpgradePolicy } from "@mysten/sui.js/transactions";
-import { Ed25519Keypair } from "@mysten/sui.js/keypairs/ed25519";
-import { getFullnodeUrl, SuiClient } from "@mysten/sui.js/client";
-import { execSync } from "child_process";
-import chalk from "chalk";
-import { ObeliskCliError, UpgradeError } from "./errors";
+import { Obelisk } from '@0xobelisk/sui-client';
+import { Transaction, UpgradePolicy } from '@mysten/sui/transactions';
+import { getFullnodeUrl, SuiClient } from '@mysten/sui/client';
+import { execSync } from 'child_process';
+import chalk from 'chalk';
+import { ObeliskCliError, UpgradeError } from './errors';
 import {
-  updateVersionInFile,
-  getOldPackageId,
-  getVersion,
-  getWorldId,
-  getUpgradeCap,
-  saveContractData,
-  validatePrivateKey,
-  getAdminCap,
-} from "./utils";
+	updateVersionInFile,
+	getOldPackageId,
+	getVersion,
+	getWorldId,
+	getUpgradeCap,
+	saveContractData,
+	validatePrivateKey,
+	getAdminCap,
+} from './utils';
 
 type ObjectContent = {
-  type: string;
-  fields: Record<string, any>;
-  hasPublicTransfer: boolean;
-  dataType: string;
+	type: string;
+	fields: Record<string, any>;
+	hasPublicTransfer: boolean;
+	dataType: string;
 };
 
 export async function upgradeHandler(
-  name: string,
-  network: "mainnet" | "testnet" | "devnet" | "localnet",
-  schemaNames: string[]
+	name: string,
+	network: 'mainnet' | 'testnet' | 'devnet' | 'localnet',
+	schemaNames: string[]
 ) {
-  const path = process.cwd();
-  const projectPath = `${path}/contracts/${name}`;
-  const privateKey = process.env.PRIVATE_KEY;
-  if (!privateKey)
-    throw new ObeliskCliError(
-      `Missing PRIVATE_KEY environment variable.
+	const path = process.cwd();
+	const projectPath = `${path}/contracts/${name}`;
+	const privateKey = process.env.PRIVATE_KEY;
+	if (!privateKey)
+		throw new ObeliskCliError(
+			`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 ObeliskCliError(`Please check your privateKey.`);
-  }
-  const privateKeyRaw = Buffer.from(privateKeyFormat as string, "hex");
-  const keypair = Ed25519Keypair.fromSecretKey(privateKeyRaw);
-
-  const client = new SuiClient({
-    url: getFullnodeUrl(network),
-  });
-
-  let oldVersion = Number(await getVersion(projectPath, network));
-  let oldPackageId = await getOldPackageId(projectPath, network);
-  let worldId = await getWorldId(projectPath, network);
-  let upgradeCap = await getUpgradeCap(projectPath, network);
-  let adminCap = await getAdminCap(projectPath, network);
-
-  const newVersion = oldVersion + 1;
-  await updateVersionInFile(projectPath, newVersion.toString());
-
-  try {
-    let modules: any, dependencies: any, digest: any;
-    try {
-      const {
-        modules: extractedModules,
-        dependencies: extractedDependencies,
-        digest: extractedDigest,
-      } = JSON.parse(
-        execSync(
-          `sui move build --dump-bytecode-as-base64 --path ${path}/contracts/${name}`,
-          {
-            encoding: "utf-8",
-          }
-        )
-      );
-
-      modules = extractedModules;
-      dependencies = extractedDependencies;
-      digest = extractedDigest;
-    } catch (error: any) {
-      throw new UpgradeError(error.stdout);
-    }
-
-    const tx = new TransactionBlock();
-    const ticket = tx.moveCall({
-      target: "0x2::package::authorize_upgrade",
-      arguments: [
-        tx.object(upgradeCap),
-        tx.pure(UpgradePolicy.COMPATIBLE),
-        tx.pure(digest),
-      ],
-    });
-
-    const receipt = tx.upgrade({
-      modules,
-      dependencies,
-      packageId: oldPackageId,
-      ticket,
-    });
-
-    tx.moveCall({
-      target: "0x2::package::commit_upgrade",
-      arguments: [tx.object(upgradeCap), receipt],
-    });
-
-    tx.transferObjects(
-      [tx.object(upgradeCap)],
-      tx.pure(keypair.getPublicKey().toSuiAddress())
-    );
-
-    const result = await client.signAndExecuteTransactionBlock({
-      signer: keypair,
-      transactionBlock: tx,
-      options: {
-        showObjectChanges: true,
-      },
-    });
-
-    console.log("");
-    console.log(`${name} WorldId: ${worldId}`);
-
-    let newPackageId = "";
-    let newUpgradeCap = "";
-    result.objectChanges!.map((object) => {
-      if (object.type === "published") {
-        console.log(chalk.blue(`${name} PackageId: ${object.packageId}`));
-        newPackageId = object.packageId;
-      }
-      if (
-        object.type === "mutated" &&
-        object.objectType === "0x2::package::UpgradeCap"
-      ) {
-        console.log(chalk.blue(`${name} UpgradeCap: ${object.objectId}`));
-        newUpgradeCap = object.objectId;
-      }
-    });
-
-    console.log(chalk.green(`Upgrade Transaction Digest: ${result.digest}`));
-
-    saveContractData(
-      name,
-      network,
-      newPackageId,
-      worldId,
-      newUpgradeCap,
-      adminCap,
-      newVersion
-    );
-
-    oldPackageId = newPackageId;
-    upgradeCap = newUpgradeCap;
-    oldVersion = newVersion;
-
-    console.log("\nExecuting the migrate: ");
-    const delay = (ms: number) =>
-      new Promise((resolve) => setTimeout(resolve, ms));
-    await delay(5000);
-
-    const migrateTx = new TransactionBlock();
-    migrateTx.moveCall({
-      target: `${newPackageId}::world::migrate`,
-      arguments: [migrateTx.object(worldId), migrateTx.object(adminCap)],
-    });
-
-    let newWorldObject = await client.getObject({
-      id: worldId,
-      options: {
-        showContent: true,
-        showDisplay: true,
-        showType: true,
-        showOwner: true,
-      },
-    });
-    let newObjectContent = newWorldObject.data!.content as ObjectContent;
-
-    const uniqueSchema: string[] = schemaNames.filter(
-      (item) => !newObjectContent.fields["schema_names"].includes(item)
-    );
-
-    console.log("new schema:", uniqueSchema);
-    let needRegisterSchema = [];
-    for (const newSchema of uniqueSchema) {
-      migrateTx.moveCall({
-        target: `${newPackageId}::${newSchema}_schema::register`,
-        arguments: [migrateTx.object(worldId), migrateTx.object(adminCap)],
-      });
-      needRegisterSchema.push(`${newSchema}_schema`);
-    }
-    const migrateResult = await client.signAndExecuteTransactionBlock({
-      signer: keypair,
-      transactionBlock: migrateTx,
-      options: {
-        showEffects: true,
-      },
-    });
-
-    if (migrateResult.effects?.status.status === "success") {
-      console.log(
-        chalk.green(
-          `${name} migrate world success, new world version is: ${newObjectContent.fields["version"]}, package version is ${newVersion}`
-        )
-      );
-      if (needRegisterSchema.length !== 0) {
-        console.log(
-          chalk.green(
-            `new schema: ${needRegisterSchema.toString()} register success.`
-          )
-        );
-      }
-
-      console.log(
-        chalk.blue(
-          `\n${name} world schemas is ${newObjectContent.fields["schema_names"]}`
-        )
-      );
-    } else {
-      console.log(
-        chalk.red(
-          `${name} migrate world failed, world version is: ${newObjectContent.fields["version"]}, package version is ${newVersion}`
-        )
-      );
-    }
-  } catch (error: any) {
-    console.log(chalk.red("Upgrade failed!"));
-    console.error(error.message);
-
-    saveContractData(
-      name,
-      network,
-      oldPackageId,
-      worldId,
-      upgradeCap,
-      adminCap,
-      oldVersion
-    );
-    await updateVersionInFile(projectPath, oldVersion.toString());
-  }
+		);
+
+	const privateKeyFormat = validatePrivateKey(privateKey);
+	if (privateKeyFormat === false) {
+		throw new ObeliskCliError(`Please check your privateKey.`);
+	}
+	const obelisk = new Obelisk({
+		secretKey: privateKeyFormat,
+	});
+	const keypair = obelisk.getKeypair();
+
+	const client = new SuiClient({
+		url: getFullnodeUrl(network),
+	});
+
+	let oldVersion = Number(await getVersion(projectPath, network));
+	let oldPackageId = await getOldPackageId(projectPath, network);
+	let worldId = await getWorldId(projectPath, network);
+	let upgradeCap = await getUpgradeCap(projectPath, network);
+	let adminCap = await getAdminCap(projectPath, network);
+
+	const newVersion = oldVersion + 1;
+	await updateVersionInFile(projectPath, newVersion.toString());
+
+	try {
+		let modules: any, dependencies: any, digest: any;
+		try {
+			const {
+				modules: extractedModules,
+				dependencies: extractedDependencies,
+				digest: extractedDigest,
+			} = JSON.parse(
+				execSync(
+					`sui move build --dump-bytecode-as-base64 --path ${path}/contracts/${name}`,
+					{
+						encoding: 'utf-8',
+					}
+				)
+			);
+
+			modules = extractedModules;
+			dependencies = extractedDependencies;
+			digest = extractedDigest;
+		} catch (error: any) {
+			throw new UpgradeError(error.stdout);
+		}
+
+		const tx = new Transaction();
+		const ticket = tx.moveCall({
+			target: '0x2::package::authorize_upgrade',
+			arguments: [
+				tx.object(upgradeCap),
+				tx.pure.u8(UpgradePolicy.COMPATIBLE),
+				tx.object(digest),
+			],
+		});
+
+		const receipt = tx.upgrade({
+			modules,
+			dependencies,
+			package: oldPackageId,
+			ticket,
+		});
+
+		tx.moveCall({
+			target: '0x2::package::commit_upgrade',
+			arguments: [tx.object(upgradeCap), receipt],
+		});
+
+		tx.transferObjects(
+			[tx.object(upgradeCap)],
+			tx.pure(keypair.getPublicKey().toSuiAddress())
+		);
+
+		const result = await client.signAndExecuteTransaction({
+			signer: keypair,
+			transaction: tx,
+			options: {
+				showObjectChanges: true,
+			},
+		});
+
+		console.log('');
+		console.log(`${name} WorldId: ${worldId}`);
+
+		let newPackageId = '';
+		let newUpgradeCap = '';
+		result.objectChanges!.map(object => {
+			if (object.type === 'published') {
+				console.log(
+					chalk.blue(`${name} PackageId: ${object.packageId}`)
+				);
+				newPackageId = object.packageId;
+			}
+			if (
+				object.type === 'mutated' &&
+				object.objectType === '0x2::package::UpgradeCap'
+			) {
+				console.log(
+					chalk.blue(`${name} UpgradeCap: ${object.objectId}`)
+				);
+				newUpgradeCap = object.objectId;
+			}
+		});
+
+		console.log(
+			chalk.green(`Upgrade Transaction Digest: ${result.digest}`)
+		);
+
+		saveContractData(
+			name,
+			network,
+			newPackageId,
+			worldId,
+			newUpgradeCap,
+			adminCap,
+			newVersion
+		);
+
+		oldPackageId = newPackageId;
+		upgradeCap = newUpgradeCap;
+		oldVersion = newVersion;
+
+		console.log('\nExecuting the migrate: ');
+		const delay = (ms: number) =>
+			new Promise(resolve => setTimeout(resolve, ms));
+		await delay(5000);
+
+		const migrateTx = new Transaction();
+		migrateTx.moveCall({
+			target: `${newPackageId}::world::migrate`,
+			arguments: [migrateTx.object(worldId), migrateTx.object(adminCap)],
+		});
+
+		let newWorldObject = await client.getObject({
+			id: worldId,
+			options: {
+				showContent: true,
+				showDisplay: true,
+				showType: true,
+				showOwner: true,
+			},
+		});
+		let newObjectContent = newWorldObject.data!.content as ObjectContent;
+
+		const uniqueSchema: string[] = schemaNames.filter(
+			item => !newObjectContent.fields['schema_names'].includes(item)
+		);
+
+		console.log('new schema:', uniqueSchema);
+		let needRegisterSchema = [];
+		for (const newSchema of uniqueSchema) {
+			migrateTx.moveCall({
+				target: `${newPackageId}::${newSchema}_schema::register`,
+				arguments: [
+					migrateTx.object(worldId),
+					migrateTx.object(adminCap),
+				],
+			});
+			needRegisterSchema.push(`${newSchema}_schema`);
+		}
+		const migrateResult = await client.signAndExecuteTransaction({
+			signer: keypair,
+			transaction: migrateTx,
+			options: {
+				showEffects: true,
+			},
+		});
+
+		if (migrateResult.effects?.status.status === 'success') {
+			console.log(
+				chalk.green(
+					`${name} migrate world success, new world version is: ${newObjectContent.fields['version']}, package version is ${newVersion}`
+				)
+			);
+			if (needRegisterSchema.length !== 0) {
+				console.log(
+					chalk.green(
+						`new schema: ${needRegisterSchema.toString()} register success.`
+					)
+				);
+			}
+
+			console.log(
+				chalk.blue(
+					`\n${name} world schemas is ${newObjectContent.fields['schema_names']}`
+				)
+			);
+		} else {
+			console.log(
+				chalk.red(
+					`${name} migrate world failed, world version is: ${newObjectContent.fields['version']}, package version is ${newVersion}`
+				)
+			);
+		}
+	} catch (error: any) {
+		console.log(chalk.red('Upgrade failed!'));
+		console.error(error.message);
+
+		saveContractData(
+			name,
+			network,
+			oldPackageId,
+			worldId,
+			upgradeCap,
+			adminCap,
+			oldVersion
+		);
+		await updateVersionInFile(projectPath, oldVersion.toString());
+	}
 }

package/src/utils/utils.ts

@@ -1,10 +1,7 @@
 import * as fsAsync from 'fs/promises';
 import { mkdirSync, writeFileSync } from 'fs';
 import { dirname } from 'path';
-import {
-	SUI_PRIVATE_KEY_PREFIX,
-	decodeSuiPrivateKey,
-} from '@mysten/sui.js/cryptography';
+import { SUI_PRIVATE_KEY_PREFIX } from '@mysten/sui/cryptography';
 import { FsIibError } from './errors';
 
 export type DeploymentJsonType = {
@@ -17,7 +14,7 @@ export type DeploymentJsonType = {
 	version: number;
 };
 
-export function validatePrivateKey(privateKey: string): boolean | string {
+export function validatePrivateKey(privateKey: string): false | string {
 	if (privateKey.startsWith(SUI_PRIVATE_KEY_PREFIX)) {
 		if (privateKey.length === 70) {
 			return privateKey;