@mysten/sui 2.3.2 → 2.5.0

package/src/client/types.ts

@@ -155,15 +155,17 @@ export namespace SuiClientTypes {
 		balance: string;
 	}
 
+	export type DynamicFieldEntry = {
+		fieldId: string;
+		type: string;
+		name: DynamicFieldName;
+		valueType: string;
+	} & ({ $kind: 'DynamicField'; childId?: never } | { $kind: 'DynamicObject'; childId: string });
+
 	export interface ListDynamicFieldsResponse {
 		hasNextPage: boolean;
 		cursor: string | null;
-		dynamicFields: {
-			fieldId: string;
-			type: string;
-			name: DynamicFieldName;
-			valueType: string;
-		}[];
+		dynamicFields: DynamicFieldEntry[];
 	}
 
 	export interface GetDynamicFieldResponse {

package/src/graphql/core.ts

@@ -571,19 +571,25 @@ export class GraphQLCoreClient extends CoreClient {
 		);
 
 		return {
-			dynamicFields: result.nodes.map((dynamicField) => {
+			dynamicFields: result.nodes.map((dynamicField): SuiClientTypes.DynamicFieldEntry => {
 				const valueType =
 					dynamicField.value?.__typename === 'MoveObject'
 						? dynamicField.value.contents?.type?.repr!
 						: dynamicField.value?.type?.repr!;
+				const isDynamicObject = dynamicField.value?.__typename === 'MoveObject';
+				const derivedNameType = isDynamicObject
+					? `0x2::dynamic_object_field::Wrapper<${dynamicField.name?.type?.repr}>`
+					: dynamicField.name?.type?.repr!;
+
 				return {
+					$kind: isDynamicObject ? 'DynamicObject' : 'DynamicField',
 					fieldId: deriveDynamicFieldID(
 						options.parentId,
-						dynamicField.name?.type?.repr!,
+						derivedNameType,
 						fromBase64(dynamicField.name?.bcs!),
 					),
 					type: normalizeStructTag(
-						dynamicField.value?.__typename === 'MoveObject'
+						isDynamicObject
 							? `0x2::dynamic_field::Field<0x2::dynamic_object_field::Wrapper<${dynamicField.name?.type?.repr}>,0x2::object::ID>`
 							: `0x2::dynamic_field::Field<${dynamicField.name?.type?.repr},${valueType}>`,
 					),
@@ -592,7 +598,11 @@ export class GraphQLCoreClient extends CoreClient {
 						bcs: fromBase64(dynamicField.name?.bcs!),
 					},
 					valueType,
-				};
+					childId:
+						isDynamicObject && dynamicField.value?.__typename === 'MoveObject'
+							? dynamicField.value.address
+							: undefined,
+				} as SuiClientTypes.DynamicFieldEntry;
 			}),
 			cursor: result.pageInfo.endCursor ?? null,
 			hasNextPage: result.pageInfo.hasNextPage,

package/src/graphql/generated/queries.ts

@@ -4648,7 +4648,7 @@ export type GetDynamicFieldsQueryVariables = Exact<{
 
 
 export type GetDynamicFieldsQuery = { __typename?: 'Query', address?: { __typename?: 'Address', dynamicFields?: { __typename?: 'DynamicFieldConnection', pageInfo: { __typename?: 'PageInfo', hasNextPage: boolean, endCursor?: string | null }, nodes: Array<{ __typename?: 'DynamicField', name?: { __typename?: 'MoveValue', bcs?: string | null, type?: { __typename?: 'MoveType', repr: string } | null } | null, value?:
-          | { __typename: 'MoveObject', contents?: { __typename?: 'MoveValue', type?: { __typename?: 'MoveType', repr: string } | null } | null }
+          | { __typename: 'MoveObject', address: string, contents?: { __typename?: 'MoveValue', type?: { __typename?: 'MoveType', repr: string } | null } | null }
           | { __typename: 'MoveValue', type?: { __typename?: 'MoveType', repr: string } | null }
          | null }> } | null } | null };
 
@@ -5147,6 +5147,7 @@ export const GetDynamicFieldsDocument = new TypedDocumentString(`
             }
           }
           ... on MoveObject {
+            address
             contents {
               type {
                 repr

package/src/graphql/queries/getDynamicFields.graphql

@@ -23,6 +23,7 @@ query getDynamicFields($parentId: SuiAddress!, $first: Int, $cursor: String) {
 						}
 					}
 					... on MoveObject {
+						address
 						contents {
 							type {
 								repr

package/src/grpc/core.ts

@@ -566,26 +566,30 @@ export class GrpcCoreClient extends CoreClient {
 			pageToken: options.cursor ? fromBase64(options.cursor) : undefined,
 			pageSize: options.limit,
 			readMask: {
-				paths: ['field_id', 'name', 'value_type', 'kind'],
+				paths: ['field_id', 'name', 'value_type', 'kind', 'child_id'],
 			},
 		});
 
 		return {
-			dynamicFields: response.response.dynamicFields.map((field) => {
-				const isDynamicObject = field.kind === DynamicField_DynamicFieldKind.OBJECT;
-				const fieldType = isDynamicObject
-					? `0x2::dynamic_field::Field<0x2::dynamic_object_field::Wrapper<${field.name?.name!}>,0x2::object::ID>`
-					: `0x2::dynamic_field::Field<${field.name?.name!},${field.valueType!}>`;
-				return {
-					fieldId: field.fieldId!,
-					name: {
-						type: field.name?.name!,
-						bcs: field.name?.value!,
-					},
-					valueType: field.valueType!,
-					type: normalizeStructTag(fieldType),
-				};
-			}),
+			dynamicFields: response.response.dynamicFields.map(
+				(field): SuiClientTypes.DynamicFieldEntry => {
+					const isDynamicObject = field.kind === DynamicField_DynamicFieldKind.OBJECT;
+					const fieldType = isDynamicObject
+						? `0x2::dynamic_field::Field<0x2::dynamic_object_field::Wrapper<${field.name?.name!}>,0x2::object::ID>`
+						: `0x2::dynamic_field::Field<${field.name?.name!},${field.valueType!}>`;
+					return {
+						$kind: isDynamicObject ? 'DynamicObject' : 'DynamicField',
+						fieldId: field.fieldId!,
+						name: {
+							type: field.name?.name!,
+							bcs: field.name?.value!,
+						},
+						valueType: field.valueType!,
+						type: normalizeStructTag(fieldType),
+						childId: field.childId,
+					} as SuiClientTypes.DynamicFieldEntry;
+				},
+			),
 			cursor: response.response.nextPageToken ? toBase64(response.response.nextPageToken) : null,
 			hasNextPage: response.response.nextPageToken !== undefined,
 		};

package/src/jsonRpc/core.ts

@@ -22,6 +22,7 @@ import { coreClientResolveTransactionPlugin } from '../client/core-resolver.js';
 import { TransactionDataBuilder } from '../transactions/TransactionData.js';
 import { chunk } from '@mysten/utils';
 import { normalizeSuiAddress, normalizeStructTag } from '../utils/sui-types.js';
+import { deriveDynamicFieldID } from '../utils/dynamic-fields.js';
 import { SUI_FRAMEWORK_ADDRESS, SUI_SYSTEM_ADDRESS } from '../utils/constants.js';
 import { CoreClient } from '../client/core.js';
 import type { SuiClientTypes } from '../client/types.js';
@@ -503,21 +504,27 @@ export class JSONRpcCoreClient extends CoreClient {
 		});
 
 		return {
-			dynamicFields: dynamicFields.data.map((dynamicField) => {
+			dynamicFields: dynamicFields.data.map((dynamicField): SuiClientTypes.DynamicFieldEntry => {
 				const isDynamicObject = dynamicField.type === 'DynamicObject';
 				const fullType = isDynamicObject
 					? `0x2::dynamic_field::Field<0x2::dynamic_object_field::Wrapper<${dynamicField.name.type}>, 0x2::object::ID>`
 					: `0x2::dynamic_field::Field<${dynamicField.name.type}, ${dynamicField.objectType}>`;
 
+				const bcsBytes = fromBase64(dynamicField.bcsName);
+				const derivedNameType = isDynamicObject
+					? `0x2::dynamic_object_field::Wrapper<${dynamicField.name.type}>`
+					: dynamicField.name.type;
 				return {
-					fieldId: dynamicField.objectId,
+					$kind: isDynamicObject ? 'DynamicObject' : 'DynamicField',
+					fieldId: deriveDynamicFieldID(options.parentId, derivedNameType, bcsBytes),
 					type: normalizeStructTag(fullType),
 					name: {
 						type: dynamicField.name.type,
-						bcs: fromBase64(dynamicField.bcsName),
+						bcs: bcsBytes,
 					},
 					valueType: dynamicField.objectType,
-				};
+					childId: isDynamicObject ? dynamicField.objectId : undefined,
+				} as SuiClientTypes.DynamicFieldEntry;
 			}),
 			hasNextPage: dynamicFields.hasNextPage,
 			cursor: dynamicFields.nextCursor,

package/src/utils/index.ts

@@ -3,6 +3,7 @@
 
 export { formatAddress, formatDigest } from './format.js';
 export {
+	isValidStructTag,
 	isValidSuiAddress,
 	isValidSuiObjectId,
 	isValidTransactionDigest,

package/src/utils/move-registry.ts

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { isValidSuiNSName } from './suins.js';
+import { isValidStructTag } from './sui-types.js';
 
 /** The pattern to find an optionally versioned name */
 const NAME_PATTERN = /^([a-z0-9]+(?:-[a-z0-9]+)*)$/;
@@ -29,8 +30,7 @@ export const isValidNamedPackage = (name: string): boolean => {
 };
 
 /**
- * Checks if a type contains valid named packages.
- * This DOES NOT check if the type is a valid Move type.
+ * Checks if a type contains valid named packages and is a valid Move struct tag.
  */
 export const isValidNamedType = (type: string): boolean => {
 	// split our type by all possible type delimeters.
@@ -38,6 +38,5 @@ export const isValidNamedType = (type: string): boolean => {
 	for (const t of splitType) {
 		if (t.includes(NAME_SEPARATOR) && !isValidNamedPackage(t)) return false;
 	}
-	// TODO: Add `isValidStructTag` check once it's introduced.
-	return true;
+	return isValidStructTag(type);
 };

package/src/utils/sui-types.ts

@@ -32,6 +32,63 @@ export function isValidSuiObjectId(value: string): boolean {
 	return isValidSuiAddress(value);
 }
 
+const MOVE_IDENTIFIER_REGEX = /^[a-zA-Z][a-zA-Z0-9_]*$/;
+
+export function isValidMoveIdentifier(name: string): boolean {
+	return MOVE_IDENTIFIER_REGEX.test(name);
+}
+
+const PRIMITIVE_TYPE_TAGS = [
+	'bool',
+	'u8',
+	'u16',
+	'u32',
+	'u64',
+	'u128',
+	'u256',
+	'address',
+	'signer',
+];
+
+const VECTOR_TYPE_REGEX = /^vector<(.+)>$/;
+
+function isValidTypeTag(type: string): boolean {
+	if (PRIMITIVE_TYPE_TAGS.includes(type)) return true;
+
+	const vectorMatch = type.match(VECTOR_TYPE_REGEX);
+	if (vectorMatch) return isValidTypeTag(vectorMatch[1]);
+
+	if (type.includes('::')) return isValidStructTag(type);
+
+	return false;
+}
+
+function isValidParsedStructTag(tag: StructTag): boolean {
+	if (!isValidSuiAddress(tag.address) && !isValidNamedPackage(tag.address)) {
+		return false;
+	}
+
+	if (!isValidMoveIdentifier(tag.module) || !isValidMoveIdentifier(tag.name)) {
+		return false;
+	}
+
+	return tag.typeParams.every((param) => {
+		if (typeof param === 'string') {
+			return isValidTypeTag(param);
+		}
+		return isValidParsedStructTag(param);
+	});
+}
+
+export function isValidStructTag(type: string): boolean {
+	try {
+		const tag = parseStructTag(type);
+		return isValidParsedStructTag(tag);
+	} catch {
+		return false;
+	}
+}
+
 export type StructTag = {
 	address: string;
 	module: string;
@@ -40,6 +97,21 @@ export type StructTag = {
 };
 
 function parseTypeTag(type: string): string | StructTag {
+	if (type.startsWith('vector<')) {
+		if (!type.endsWith('>')) {
+			throw new Error(`Invalid type tag: ${type}`);
+		}
+		const inner = type.slice(7, -1);
+		if (!inner) {
+			throw new Error(`Invalid type tag: ${type}`);
+		}
+		const parsed = parseTypeTag(inner);
+		if (typeof parsed === 'string') {
+			return `vector<${parsed}>`;
+		}
+		return `vector<${normalizeStructTag(parsed)}>`;
+	}
+
 	if (!type.includes('::')) return type;
 
 	return parseStructTag(type);

package/src/version.ts

@@ -3,5 +3,5 @@
 
 // This file is generated by genversion.mjs. Do not edit it directly.
 
-export const PACKAGE_VERSION = '2.3.2';
-export const TARGETED_RPC_VERSION = '1.66.0';
+export const PACKAGE_VERSION = '2.5.0';
+export const TARGETED_RPC_VERSION = '1.67.0';