Add getter to codegen bcs types (#797)

Author: hayes-mysten

packages/codegen/src/generate-utils.ts

@@ -2,16 +2,36 @@
 // SPDX-License-Identifier: Apache-2.0
 
 export const utilsContent = /* ts */ `
-import { bcs, BcsType, TypeTag, TypeTagSerializer, BcsStruct, BcsEnum, BcsTuple } from '@mysten/sui/bcs';
+import {
+	bcs,
+	BcsType,
+	TypeTag,
+	TypeTagSerializer,
+	BcsStruct,
+	BcsEnum,
+	BcsTuple,
+} from '@mysten/sui/bcs';
 import { normalizeSuiAddress } from '@mysten/sui/utils';
 import { TransactionArgument, isArgument } from '@mysten/sui/transactions';
+import { ClientWithCoreApi, SuiClientTypes } from '@mysten/sui/client';
 
 const MOVE_STDLIB_ADDRESS = normalizeSuiAddress('0x1');
 const SUI_FRAMEWORK_ADDRESS = normalizeSuiAddress('0x2');
-const SUI_SYSTEM_ADDRESS = normalizeSuiAddress('0x3');
 
 export type RawTransactionArgument<T> = T | TransactionArgument;
 
+export interface GetOptions<
+	Include extends Omit<SuiClientTypes.ObjectInclude, 'content'> = {},
+> extends SuiClientTypes.GetObjectOptions<Include> {
+	client: ClientWithCoreApi;
+}
+
+export interface GetManyOptions<
+	Include extends Omit<SuiClientTypes.ObjectInclude, 'content'> = {},
+> extends SuiClientTypes.GetObjectsOptions<Include> {
+	client: ClientWithCoreApi;
+}
+
 export function getPureBcsSchema(typeTag: string | TypeTag): BcsType<any> | null {
 	const parsedTag = typeof typeTag === 'string' ? TypeTagSerializer.parseFromStr(typeTag) : typeTag;
 
@@ -36,7 +56,7 @@ export function getPureBcsSchema(typeTag: string | TypeTag): BcsType<any> | null
 		return type ? bcs.vector(type) : null;
 	} else if ('struct' in parsedTag) {
 		const structTag = parsedTag.struct;
-		const pkg = normalizeSuiAddress(parsedTag.struct.address);
+		const pkg = normalizeSuiAddress(structTag.address);
 
 		if (pkg === MOVE_STDLIB_ADDRESS) {
 			if (
@@ -47,20 +67,28 @@ export function getPureBcsSchema(typeTag: string | TypeTag): BcsType<any> | null
 			}
 
 			if (structTag.module === 'option' && structTag.name === 'Option') {
-				const type = getPureBcsSchema(structTag.typeParams[0]!);
+				const type = getPureBcsSchema(structTag.typeParams[0]);
 				return type ? bcs.option(type) : null;
 			}
 		}
 
-		if (pkg === SUI_FRAMEWORK_ADDRESS && structTag.module === 'object' && (structTag.name === 'ID' || structTag.name === 'UID')) {
+		if (
+			pkg === SUI_FRAMEWORK_ADDRESS &&
+			structTag.module === 'object' &&
+			(structTag.name === 'ID' || structTag.name === 'UID')
+		) {
 			return bcs.Address;
 		}
 	}
 
 	return null;
 }
 
-export function normalizeMoveArguments(args: unknown[] | object, argTypes: string[], parameterNames?: string[]) {
+export function normalizeMoveArguments(
+	args: unknown[] | object,
+	argTypes: readonly (string | null)[],
+	parameterNames?: string[],
+) {
 	const argLen = Array.isArray(args) ? args.length : Object.keys(args).length;
 	if (parameterNames && argLen !== parameterNames.length) {
 		throw new Error(
@@ -72,30 +100,32 @@ export function normalizeMoveArguments(args: unknown[] | object, argTypes: strin
 
 	let index = 0;
 	for (const [i, argType] of argTypes.entries()) {
-		if (argType === \`\${SUI_FRAMEWORK_ADDRESS}::deny_list::DenyList\`) {
-			normalizedArgs.push((tx) => tx.object.denyList());
+		if (argType === '0x2::clock::Clock') {
+			normalizedArgs.push((tx) => tx.object.clock());
 			continue;
 		}
 
-		if (argType === \`\${SUI_FRAMEWORK_ADDRESS}::random::Random\`) {
+		if (argType === '0x2::random::Random') {
 			normalizedArgs.push((tx) => tx.object.random());
 			continue;
 		}
 
-		if (argType === \`\${SUI_FRAMEWORK_ADDRESS}::clock::Clock\`) {
-			normalizedArgs.push((tx) => tx.object.clock());
+		if (argType === '0x2::deny_list::DenyList') {
+			normalizedArgs.push((tx) => tx.object.denyList());
 			continue;
 		}
 
-		if (argType === \`\${SUI_SYSTEM_ADDRESS}::sui_system::SuiSystemState\`) {
+		if (argType === '0x3::sui_system::SuiSystemState') {
 			normalizedArgs.push((tx) => tx.object.system());
 			continue;
 		}
 
-		let arg
+		let arg;
 		if (Array.isArray(args)) {
 			if (index >= args.length) {
-				throw new Error(\`Invalid number of arguments, expected at least \${index + 1}, got \${args.length}\`);
+				throw new Error(
+					\`Invalid number of arguments, expected at least \${index + 1}, got \${args.length}\`,
+				);
 			}
 			arg = args[index];
 		} else {
@@ -117,8 +147,8 @@ export function normalizeMoveArguments(args: unknown[] | object, argTypes: strin
 			continue;
 		}
 
-		const type = argTypes[i]!;
-		const bcsType = getPureBcsSchema(type);
+		const type = argTypes[i];
+		const bcsType = type === null ? null : getPureBcsSchema(type);
 
 		if (bcsType) {
 			const bytes = bcsType.serialize(arg as never);
@@ -138,7 +168,47 @@ export function normalizeMoveArguments(args: unknown[] | object, argTypes: strin
 export class MoveStruct<
 	T extends Record<string, BcsType<any>>,
 	const Name extends string = string,
-> extends BcsStruct<T, Name> {}
+> extends BcsStruct<T, Name> {
+	async get<Include extends Omit<SuiClientTypes.ObjectInclude, 'content'> = {}>({
+		objectId,
+		...options
+	}: GetOptions<Include>): Promise<
+		SuiClientTypes.Object<Include & { content: true }> & { json: BcsStruct<T>['$inferType'] }
+	> {
+		const [res] = await this.getMany<Include>({
+			...options,
+			objectIds: [objectId],
+		});
+
+		return res;
+	}
+
+	async getMany<Include extends Omit<SuiClientTypes.ObjectInclude, 'content'> = {}>({
+		client,
+		...options
+	}: GetManyOptions<Include>): Promise<
+		Array<SuiClientTypes.Object<Include & { content: true }> & { json: BcsStruct<T>['$inferType'] }>
+	> {
+		const response = (await client.core.getObjects({
+			...options,
+			include: {
+				...options.include,
+				content: true,
+			},
+		})) as SuiClientTypes.GetObjectsResponse<Include & { content: true }>;
+
+		return response.objects.map((obj) => {
+			if (obj instanceof Error) {
+				throw obj;
+			}
+
+			return {
+				...obj,
+				json: this.parse(obj.content),
+			};
+		});
+	}
+}
 
 export class MoveEnum<
 	T extends Record<string, BcsType<any> | null>,

packages/codegen/src/move-module-builder.ts

@@ -607,9 +607,11 @@ export class MoveModuleBuilder extends FileBuilder {
 									resolveAddress: (address) => this.#resolveAddress(address),
 								}),
 							)
-							.map((tag) => (tag.includes('{') ? `\`${tag}\`` : `'${tag}'`))
+							.map((tag) =>
+								tag === 'null' ? 'null' : tag.includes('{') ? `\`${tag}\`` : `'${tag}'`,
+							)
 							.join(',\n')}
-					] satisfies string[]\n`
+					] satisfies (string | null)[]\n`
 							: ''
 					}${hasAllParameterNames ? `const parameterNames = ${JSON.stringify(requiredParameters.map((param) => camelCase(param.name!)))}\n` : ''}
 					return (tx: ${transactionTypeName}) => tx.moveCall({

packages/codegen/src/render-types.ts

@@ -214,13 +214,33 @@ function renderDataType(type: Datatype, options: RenderTypeSignatureOptions): st
 	const address = options.resolveAddress(type.module.address);
 
 	if (options.format === 'typeTag') {
-		const typeArgs = type.type_arguments.map((type) => renderTypeSignature(type.argument, options));
+		if (address === SUI_FRAMEWORK_ADDRESS) {
+			if (type.module.name === 'clock' && type.name === 'Clock') return '0x2::clock::Clock';
+			if (type.module.name === 'random' && type.name === 'Random') return '0x2::random::Random';
+			if (type.module.name === 'deny_list' && type.name === 'DenyList')
+				return '0x2::deny_list::DenyList';
+			if (type.module.name === 'object' && (type.name === 'ID' || type.name === 'UID'))
+				return '0x2::object::ID';
+		}
+		if (address === SUI_SYSTEM_ADDRESS) {
+			if (type.module.name === 'sui_system' && type.name === 'SuiSystemState')
+				return '0x3::sui_system::SuiSystemState';
+		}
 
-		if (typeArgs.length === 0) {
-			return `${address === options.resolveAddress(options.summary.id.address) ? '${packageAddress}' : address}::${type.module.name}::${type.name}`;
+		if (address === MOVE_STDLIB_ADDRESS) {
+			if (
+				(type.module.name === 'ascii' || type.module.name === 'string') &&
+				type.name === 'String'
+			) {
+				return '0x1::string::String';
+			}
+			if (type.module.name === 'option' && type.name === 'Option') {
+				const innerType = renderTypeSignature(type.type_arguments[0].argument, options);
+				return `0x1::option::Option<${innerType}>`;
+			}
 		}
 
-		return `${address === options.resolveAddress(options.summary.id.address) ? '${packageAddress}' : address}::${type.module.name}::${type.name}<${typeArgs.join(', ')}>`;
+		return 'null';
 	}
 
 	if (address === MOVE_STDLIB_ADDRESS) {

packages/codegen/tests/generated/utils/index.ts

@@ -1,35 +1,29 @@
-# @generated by Move, please check-in and do not edit manually.
+# Generated by move; do not edit
+# This file should be checked in.
 
 [move]
-version = 3
-manifest_digest = "2AAADF5E2D5161A76F1DB68B03C99B92D3D615DEE2B0CF70EBCABD881BD78F2C"
-deps_digest = "3C4103934B1E040BB6B23F1D610B4EF9F2F1166A50A104EADCF77467C004C600"
-dependencies = [
-  { id = "Sui", name = "Sui" },
-  { id = "WAL", name = "WAL" },
-]
+version = 4
 
-[[move.package]]
-id = "MoveStdlib"
-source = { git = "https://github.com/MystenLabs/sui.git", rev = "testnet-v1.43.0", subdir = "crates/sui-framework/packages/move-stdlib" }
+[pinned.testnet.MoveStdlib]
+source = { git = "https://github.com/MystenLabs/sui.git", subdir = "crates/sui-framework/packages/move-stdlib", rev = "c18165e608c9ae379d6bdeebf2e068713ac43661" }
+use_environment = "testnet"
+manifest_digest = "C4FE4C91DE74CBF223B2E380AE40F592177D21870DC2D7EB6227D2D694E05363"
+deps = {}
 
-[[move.package]]
-id = "Sui"
-source = { git = "https://github.com/MystenLabs/sui.git", rev = "testnet-v1.43.0", subdir = "crates/sui-framework/packages/sui-framework" }
+[pinned.testnet.Sui]
+source = { git = "https://github.com/MystenLabs/sui.git", subdir = "crates/sui-framework/packages/sui-framework", rev = "c18165e608c9ae379d6bdeebf2e068713ac43661" }
+use_environment = "testnet"
+manifest_digest = "7AFB66695545775FBFBB2D3078ADFD084244D5002392E837FDE21D9EA1C6D01C"
+deps = { MoveStdlib = "MoveStdlib" }
 
-dependencies = [
-  { id = "MoveStdlib", name = "MoveStdlib" },
-]
-
-[[move.package]]
-id = "WAL"
+[pinned.testnet.WAL]
 source = { local = "../wal" }
+use_environment = "testnet"
+manifest_digest = "5CC8004F7BFF4027210DDAE6E00EB5076761A246D655F7CEDAF75D2E7CBDEC6F"
+deps = { Sui = "Sui" }
 
-dependencies = [
-  { id = "Sui", name = "Sui" },
-]
-
-[move.toolchain-version]
-compiler-version = "1.44.2"
-edition = "2024.beta"
-flavor = "sui"
+[pinned.testnet.Walrus]
+source = { root = true }
+use_environment = "testnet"
+manifest_digest = "8D383FB837A9A04B13466A48CC86B8AED9457885523DC25DA28C31ADEF3D6A39"
+deps = { Sui = "Sui", WAL = "WAL" }