@mysten/sui 2.5.1 → 2.6.0

package/dist/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","names":[],"sources":["../src/version.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\n// This file is generated by genversion.mjs. Do not edit it directly.\n\nexport const PACKAGE_VERSION = '2.5.1';\nexport const TARGETED_RPC_VERSION = '1.68.0';\n"],"mappings":";AAKA,MAAa,kBAAkB;AAC/B,MAAa,uBAAuB"}
+{"version":3,"file":"version.mjs","names":[],"sources":["../src/version.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\n// This file is generated by genversion.mjs. Do not edit it directly.\n\nexport const PACKAGE_VERSION = '2.6.0';\nexport const TARGETED_RPC_VERSION = '1.68.0';\n"],"mappings":";AAKA,MAAa,kBAAkB;AAC/B,MAAa,uBAAuB"}

package/dist/zklogin/bcs.d.mts

@@ -1,31 +1,31 @@
-import * as _mysten_bcs817 from "@mysten/bcs";
+import * as _mysten_bcs810 from "@mysten/bcs";
 import { InferBcsInput } from "@mysten/bcs";
 
 //#region src/zklogin/bcs.d.ts
-declare const zkLoginSignature: _mysten_bcs817.BcsStruct<{
-  inputs: _mysten_bcs817.BcsStruct<{
-    proofPoints: _mysten_bcs817.BcsStruct<{
-      a: _mysten_bcs817.BcsType<string[], Iterable<string> & {
+declare const zkLoginSignature: _mysten_bcs810.BcsStruct<{
+  inputs: _mysten_bcs810.BcsStruct<{
+    proofPoints: _mysten_bcs810.BcsStruct<{
+      a: _mysten_bcs810.BcsType<string[], Iterable<string> & {
         length: number;
       }, string>;
-      b: _mysten_bcs817.BcsType<string[][], Iterable<Iterable<string> & {
+      b: _mysten_bcs810.BcsType<string[][], Iterable<Iterable<string> & {
         length: number;
       }> & {
         length: number;
       }, string>;
-      c: _mysten_bcs817.BcsType<string[], Iterable<string> & {
+      c: _mysten_bcs810.BcsType<string[], Iterable<string> & {
         length: number;
       }, string>;
     }, string>;
-    issBase64Details: _mysten_bcs817.BcsStruct<{
-      value: _mysten_bcs817.BcsType<string, string, "string">;
-      indexMod4: _mysten_bcs817.BcsType<number, number, "u8">;
+    issBase64Details: _mysten_bcs810.BcsStruct<{
+      value: _mysten_bcs810.BcsType<string, string, "string">;
+      indexMod4: _mysten_bcs810.BcsType<number, number, "u8">;
     }, string>;
-    headerBase64: _mysten_bcs817.BcsType<string, string, "string">;
-    addressSeed: _mysten_bcs817.BcsType<string, string, "string">;
+    headerBase64: _mysten_bcs810.BcsType<string, string, "string">;
+    addressSeed: _mysten_bcs810.BcsType<string, string, "string">;
   }, string>;
-  maxEpoch: _mysten_bcs817.BcsType<string, string | number | bigint, "u64">;
-  userSignature: _mysten_bcs817.BcsType<Uint8Array<ArrayBufferLike>, Iterable<number>, "vector<u8>">;
+  maxEpoch: _mysten_bcs810.BcsType<string, string | number | bigint, "u64">;
+  userSignature: _mysten_bcs810.BcsType<Uint8Array<ArrayBufferLike>, Iterable<number>, "vector<u8>">;
 }, string>;
 type ZkLoginSignature = InferBcsInput<typeof zkLoginSignature>;
 type ZkLoginSignatureInputs = ZkLoginSignature['inputs'];

package/package.json

@@ -3,7 +3,7 @@
   "author": "Mysten Labs <build@mystenlabs.com>",
   "description": "Sui TypeScript API",
   "homepage": "https://sdk.mystenlabs.com",
-  "version": "2.5.1",
+  "version": "2.6.0",
   "license": "Apache-2.0",
   "sideEffects": false,
   "files": [

package/src/client/core-resolver.ts

@@ -112,7 +112,12 @@ async function setGasBudget(transactionData: TransactionDataBuilder, client: Cli
 // The current default is just picking _all_ coins we can which may not be ideal.
 async function setGasPayment(transactionData: TransactionDataBuilder, client: ClientWithCoreApi) {
 	if (!transactionData.gasData.payment) {
-		const gasPayer = transactionData.gasData.owner ?? transactionData.sender!;
+		const gasPayer = transactionData.gasData.owner ?? transactionData.sender;
+		if (!gasPayer) {
+			throw new Error('Either a gas owner or sender must be set to determine gas payment.');
+		}
+
+		const normalizedGasPayer = normalizeSuiAddress(gasPayer);
 		let usesGasCoin = false;
 		let withdrawals = 0n;
 
@@ -127,7 +132,7 @@ async function setGasPayment(transactionData: TransactionDataBuilder, client: Cl
 						? transactionData.sender
 						: gasPayer;
 
-					if (withdrawalOwner === gasPayer) {
+					if (withdrawalOwner && normalizeSuiAddress(withdrawalOwner) === normalizedGasPayer) {
 						if (input.FundsWithdrawal.reservation.$kind === 'MaxAmountU64') {
 							withdrawals += BigInt(input.FundsWithdrawal.reservation.MaxAmountU64);
 						}
@@ -139,13 +144,9 @@ async function setGasPayment(transactionData: TransactionDataBuilder, client: Cl
 		});
 
 		const [suiBalance, coins] = await Promise.all([
-			usesGasCoin || !transactionData.gasData.owner
-				? null
-				: client.core.getBalance({
-						owner: transactionData.gasData.owner,
-					}),
+			usesGasCoin ? null : client.core.getBalance({ owner: gasPayer }),
 			client.core.listCoins({
-				owner: transactionData.gasData.owner || transactionData.sender!,
+				owner: gasPayer,
 				coinType: SUI_TYPE_ARG,
 			}),
 		]);

package/src/client/core.ts

@@ -39,11 +39,11 @@ export abstract class CoreClient extends BaseClient implements SuiClientTypes.Tr
 		});
 	}
 
-	abstract getObjects<Include extends SuiClientTypes.ObjectInclude = object>(
+	abstract getObjects<Include extends SuiClientTypes.ObjectInclude = {}>(
 		options: SuiClientTypes.GetObjectsOptions<Include>,
 	): Promise<SuiClientTypes.GetObjectsResponse<Include>>;
 
-	async getObject<Include extends SuiClientTypes.ObjectInclude = object>(
+	async getObject<Include extends SuiClientTypes.ObjectInclude = {}>(
 		options: SuiClientTypes.GetObjectOptions<Include>,
 	): Promise<SuiClientTypes.GetObjectResponse<Include>> {
 		const { objectId } = options;
@@ -64,7 +64,7 @@ export abstract class CoreClient extends BaseClient implements SuiClientTypes.Tr
 		options: SuiClientTypes.ListCoinsOptions,
 	): Promise<SuiClientTypes.ListCoinsResponse>;
 
-	abstract listOwnedObjects<Include extends SuiClientTypes.ObjectInclude = object>(
+	abstract listOwnedObjects<Include extends SuiClientTypes.ObjectInclude = {}>(
 		options: SuiClientTypes.ListOwnedObjectsOptions<Include>,
 	): Promise<SuiClientTypes.ListOwnedObjectsResponse<Include>>;
 
@@ -80,15 +80,15 @@ export abstract class CoreClient extends BaseClient implements SuiClientTypes.Tr
 		options: SuiClientTypes.GetCoinMetadataOptions,
 	): Promise<SuiClientTypes.GetCoinMetadataResponse>;
 
-	abstract getTransaction<Include extends SuiClientTypes.TransactionInclude = object>(
+	abstract getTransaction<Include extends SuiClientTypes.TransactionInclude = {}>(
 		options: SuiClientTypes.GetTransactionOptions<Include>,
 	): Promise<SuiClientTypes.TransactionResult<Include>>;
 
-	abstract executeTransaction<Include extends SuiClientTypes.TransactionInclude = object>(
+	abstract executeTransaction<Include extends SuiClientTypes.TransactionInclude = {}>(
 		options: SuiClientTypes.ExecuteTransactionOptions<Include>,
 	): Promise<SuiClientTypes.TransactionResult<Include>>;
 
-	abstract simulateTransaction<Include extends SuiClientTypes.SimulateTransactionInclude = object>(
+	abstract simulateTransaction<Include extends SuiClientTypes.SimulateTransactionInclude = {}>(
 		options: SuiClientTypes.SimulateTransactionOptions<Include>,
 	): Promise<SuiClientTypes.SimulateTransactionResult<Include>>;
 
@@ -151,8 +151,22 @@ export abstract class CoreClient extends BaseClient implements SuiClientTypes.Tr
 		const fieldType = parseStructTag(fieldObject.type);
 		const content = await fieldObject.content;
 
+		const nameTypeParam = fieldType.typeParams[0];
+		const isDynamicObject =
+			typeof nameTypeParam !== 'string' &&
+			nameTypeParam.module === 'dynamic_object_field' &&
+			nameTypeParam.name === 'Wrapper';
+
+		const valueBcs = content.slice(SUI_ADDRESS_LENGTH + options.name.bcs.length);
+
+		const valueType =
+			typeof fieldType.typeParams[1] === 'string'
+				? fieldType.typeParams[1]
+				: normalizeStructTag(fieldType.typeParams[1]);
+
 		return {
 			dynamicField: {
+				$kind: isDynamicObject ? 'DynamicObject' : 'DynamicField',
 				fieldId: fieldObject.objectId,
 				digest: fieldObject.digest,
 				version: fieldObject.version,
@@ -160,23 +174,19 @@ export abstract class CoreClient extends BaseClient implements SuiClientTypes.Tr
 				previousTransaction: fieldObject.previousTransaction,
 				name: {
 					type:
-						typeof fieldType.typeParams[0] === 'string'
-							? fieldType.typeParams[0]
-							: normalizeStructTag(fieldType.typeParams[0]),
+						typeof nameTypeParam === 'string' ? nameTypeParam : normalizeStructTag(nameTypeParam),
 					bcs: options.name.bcs,
 				},
 				value: {
-					type:
-						typeof fieldType.typeParams[1] === 'string'
-							? fieldType.typeParams[1]
-							: normalizeStructTag(fieldType.typeParams[1]),
-					bcs: content.slice(SUI_ADDRESS_LENGTH + options.name.bcs.length),
+					type: valueType,
+					bcs: valueBcs,
 				},
-			},
+				childId: isDynamicObject ? bcs.Address.parse(valueBcs) : undefined,
+			} as SuiClientTypes.GetDynamicFieldResponse['dynamicField'],
 		};
 	}
 
-	async getDynamicObjectField<Include extends SuiClientTypes.ObjectInclude = object>(
+	async getDynamicObjectField<Include extends SuiClientTypes.ObjectInclude = {}>(
 		options: SuiClientTypes.GetDynamicObjectFieldOptions<Include>,
 	): Promise<SuiClientTypes.GetDynamicObjectFieldResponse<Include>> {
 		const resolvedNameType = (
@@ -196,7 +206,7 @@ export abstract class CoreClient extends BaseClient implements SuiClientTypes.Tr
 		});
 
 		const { object } = await this.getObject({
-			objectId: bcs.Address.parse(dynamicField.value.bcs),
+			objectId: dynamicField.childId!,
 			signal: options.signal,
 			include: options.include,
 		});
@@ -204,7 +214,7 @@ export abstract class CoreClient extends BaseClient implements SuiClientTypes.Tr
 		return { object };
 	}
 
-	async waitForTransaction<Include extends SuiClientTypes.TransactionInclude = object>(
+	async waitForTransaction<Include extends SuiClientTypes.TransactionInclude = {}>(
 		options: SuiClientTypes.WaitForTransactionOptions<Include>,
 	): Promise<SuiClientTypes.TransactionResult<Include>> {
 		const { signal, timeout = 60 * 1000, include } = options;

package/src/client/types.ts

@@ -58,9 +58,32 @@ export namespace SuiClientTypes {
 	}
 
 	export interface ObjectInclude {
+		/**
+		 * Include the BCS-encoded Move struct content of the object.
+		 *
+		 * Returns the raw bytes of the object's Move struct fields — pass directly to
+		 * generated BCS types (e.g., `MyStruct.parse(object.content)`).
+		 */
 		content?: boolean;
+		/**
+		 * Include the digest of the transaction that last mutated this object.
+		 */
 		previousTransaction?: boolean;
+		/**
+		 * Include the full BCS-encoded object envelope. Rarely needed — most metadata
+		 * (owner, version, type) is already available as fields on the object response.
+		 *
+		 * Parse with `bcs.Object.parse(object.objectBcs)` from `@mysten/sui/bcs`.
+		 * Do not pass to a Move struct parser — use `content` for that instead.
+		 */
 		objectBcs?: boolean;
+		/**
+		 * Include the JSON representation of the object's Move struct content.
+		 *
+		 * **Warning:** The exact shape and field names of this data may vary between different
+		 * API implementations (JSON-RPC vs gRPC or GraphQL). For consistent data across APIs,
+		 * use the `content` field and parse the BCS data directly.
+		 */
 		json?: boolean;
 	}
 
@@ -68,14 +91,14 @@ export namespace SuiClientTypes {
 		Include extends ObjectInclude = {},
 	> extends CoreClientMethodOptions {
 		objectIds: string[];
-		include?: Include;
+		include?: Include & ObjectInclude;
 	}
 
 	export interface GetObjectOptions<
 		Include extends ObjectInclude = {},
 	> extends CoreClientMethodOptions {
 		objectId: string;
-		include?: Include;
+		include?: Include & ObjectInclude;
 	}
 
 	export interface ListOwnedObjectsOptions<
@@ -85,7 +108,7 @@ export namespace SuiClientTypes {
 		limit?: number;
 		cursor?: string | null;
 		type?: string;
-		include?: Include;
+		include?: Include & ObjectInclude;
 	}
 
 	export interface ListCoinsOptions extends CoreClientMethodOptions {
@@ -133,8 +156,10 @@ export namespace SuiClientTypes {
 		digest: string;
 		owner: ObjectOwner;
 		type: string;
+		/** BCS-encoded Move struct content — pass to generated BCS type parsers. */
 		content: Include extends { content: true } ? Uint8Array<ArrayBuffer> : undefined;
 		previousTransaction: Include extends { previousTransaction: true } ? string | null : undefined;
+		/** Full BCS-encoded object envelope — parse with `bcs.Object` not a struct parser. */
 		objectBcs: Include extends { objectBcs: true } ? Uint8Array<ArrayBuffer> : undefined;
 		/**
 		 * The JSON representation of the object's Move struct content.
@@ -162,6 +187,13 @@ export namespace SuiClientTypes {
 		valueType: string;
 	} & ({ $kind: 'DynamicField'; childId?: never } | { $kind: 'DynamicObject'; childId: string });
 
+	export type DynamicField = DynamicFieldEntry & {
+		value: DynamicFieldValue;
+		version: string;
+		digest: string;
+		previousTransaction: string | null;
+	};
+
 	export interface ListDynamicFieldsResponse {
 		hasNextPage: boolean;
 		cursor: string | null;
@@ -169,15 +201,7 @@ export namespace SuiClientTypes {
 	}
 
 	export interface GetDynamicFieldResponse {
-		dynamicField: {
-			name: DynamicFieldName;
-			value: DynamicFieldValue;
-			fieldId: string;
-			version: string;
-			digest: string;
-			type: string;
-			previousTransaction: string | null;
-		};
+		dynamicField: DynamicField;
 	}
 
 	export interface GetDynamicObjectFieldOptions<
@@ -185,7 +209,7 @@ export namespace SuiClientTypes {
 	> extends CoreClientMethodOptions {
 		parentId: string;
 		name: DynamicFieldName;
-		include?: Include;
+		include?: Include & ObjectInclude;
 	}
 
 	export interface GetDynamicObjectFieldResponse<out Include extends ObjectInclude = {}> {
@@ -313,15 +337,22 @@ export namespace SuiClientTypes {
 		  };
 
 	export interface TransactionInclude {
+		/** Include balance changes caused by the transaction. */
 		balanceChanges?: boolean;
+		/** Include parsed transaction effects (gas used, changed objects, status, etc.). */
 		effects?: boolean;
+		/** Include events emitted by the transaction. */
 		events?: boolean;
+		/** Include a map of object IDs to their types for all changed objects. */
 		objectTypes?: boolean;
+		/** Include the parsed transaction data (sender, gas config, inputs, commands). */
 		transaction?: boolean;
+		/** Include the raw BCS-encoded transaction bytes. */
 		bcs?: boolean;
 	}
 
 	export interface SimulateTransactionInclude extends TransactionInclude {
+		/** Include return values and mutated references from each command (simulation only). */
 		commandResults?: boolean;
 	}
 
@@ -346,7 +377,7 @@ export namespace SuiClientTypes {
 		Include extends TransactionInclude = {},
 	> extends CoreClientMethodOptions {
 		digest: string;
-		include?: Include;
+		include?: Include & TransactionInclude;
 	}
 
 	export type WaitForTransactionOptions<Include extends TransactionInclude = {}> =
@@ -364,7 +395,7 @@ export namespace SuiClientTypes {
 		Include extends TransactionInclude = {},
 	> extends CoreClientMethodOptions {
 		result: TransactionResult<any>;
-		include?: Include;
+		include?: Include & TransactionInclude;
 		timeout?: number;
 		digest?: never;
 	}
@@ -374,7 +405,7 @@ export namespace SuiClientTypes {
 	> extends CoreClientMethodOptions {
 		transaction: Uint8Array;
 		signatures: string[];
-		include?: Include;
+		include?: Include & TransactionInclude;
 	}
 
 	export interface SignAndExecuteTransactionOptions<
@@ -383,14 +414,14 @@ export namespace SuiClientTypes {
 		transaction: Uint8Array | TransactionInstance;
 		signer: Signer;
 		additionalSignatures?: string[];
-		include?: Include;
+		include?: Include & TransactionInclude;
 	}
 
 	export interface SimulateTransactionOptions<
 		Include extends SimulateTransactionInclude = {},
 	> extends CoreClientMethodOptions {
 		transaction: Uint8Array | TransactionInstance;
-		include?: Include;
+		include?: Include & SimulateTransactionInclude;
 	}
 
 	export interface GetReferenceGasPriceOptions extends CoreClientMethodOptions {}
@@ -816,6 +847,14 @@ export namespace SuiClientTypes {
 		sender: string;
 		eventType: string;
 		bcs: Uint8Array;
+		/**
+		 * The JSON representation of the event's Move struct data.
+		 *
+		 * **Warning:** The exact shape and field names of this data may vary between different
+		 * API implementations (JSON-RPC vs gRPC or GraphQL). For consistent data across APIs use
+		 * the `bcs` field and parse the BCS data directly.
+		 */
+		json: Record<string, unknown> | null;
 	}
 
 	export interface MoveAbort {

package/src/graphql/client.ts

@@ -9,6 +9,10 @@ import { BaseClient } from '../client/index.js';
 import type { SuiClientTypes } from '../client/index.js';
 import { GraphQLCoreClient } from './core.js';
 import type { TypedDocumentString } from './generated/queries.js';
+import { GetDynamicFieldsDocument } from './generated/queries.js';
+import { fromBase64 } from '@mysten/utils';
+import { normalizeStructTag } from '../utils/sui-types.js';
+import { deriveDynamicFieldID } from '../utils/dynamic-fields.js';
 import type { TransactionPlugin } from '../transactions/index.js';
 
 export type GraphQLDocument<
@@ -66,6 +70,21 @@ export function isSuiGraphQLClient(client: unknown): client is SuiGraphQLClient
 	);
 }
 
+export interface DynamicFieldInclude {
+	value?: boolean;
+}
+
+export type DynamicFieldEntryWithValue<Include extends DynamicFieldInclude = {}> =
+	SuiClientTypes.DynamicFieldEntry & {
+		value: Include extends { value: true } ? SuiClientTypes.DynamicFieldValue : undefined;
+	};
+
+export interface ListDynamicFieldsWithValueResponse<Include extends DynamicFieldInclude = {}> {
+	hasNextPage: boolean;
+	cursor: string | null;
+	dynamicFields: DynamicFieldEntryWithValue<Include>[];
+}
+
 export class SuiGraphQLClient<Queries extends Record<string, GraphQLDocument> = {}>
 	extends BaseClient
 	implements SuiClientTypes.TransportMethods
@@ -220,10 +239,83 @@ export class SuiGraphQLClient<Queries extends Record<string, GraphQLDocument> =
 		return this.core.getReferenceGasPrice();
 	}
 
-	listDynamicFields(
-		input: SuiClientTypes.ListDynamicFieldsOptions,
-	): Promise<SuiClientTypes.ListDynamicFieldsResponse> {
-		return this.core.listDynamicFields(input);
+	async listDynamicFields<Include extends DynamicFieldInclude = {}>(
+		input: SuiClientTypes.ListDynamicFieldsOptions & { include?: Include & DynamicFieldInclude },
+	): Promise<ListDynamicFieldsWithValueResponse<Include>> {
+		const includeValue = input.include?.value ?? false;
+
+		const { data, errors } = await this.query({
+			query: GetDynamicFieldsDocument,
+			variables: {
+				parentId: input.parentId,
+				first: input.limit,
+				cursor: input.cursor,
+				includeValue,
+			},
+		});
+
+		if (errors?.length) {
+			throw errors.length === 1
+				? new Error(errors[0].message)
+				: new AggregateError(errors.map((e) => new Error(e.message)));
+		}
+
+		const result = data?.address?.dynamicFields;
+		if (!result) {
+			throw new Error('Missing response data');
+		}
+
+		return {
+			dynamicFields: result.nodes.map((dynamicField): DynamicFieldEntryWithValue<Include> => {
+				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!;
+
+				let value: SuiClientTypes.DynamicFieldValue | undefined;
+				if (includeValue) {
+					let valueBcs: Uint8Array;
+					if (dynamicField.value?.__typename === 'MoveValue') {
+						valueBcs = fromBase64(dynamicField.value.bcs ?? '');
+					} else if (dynamicField.value?.__typename === 'MoveObject') {
+						valueBcs = fromBase64(dynamicField.value.contents?.bcs ?? '');
+					} else {
+						valueBcs = new Uint8Array();
+					}
+					value = { type: valueType, bcs: valueBcs };
+				}
+
+				return {
+					$kind: isDynamicObject ? 'DynamicObject' : 'DynamicField',
+					fieldId: deriveDynamicFieldID(
+						input.parentId,
+						derivedNameType,
+						fromBase64(dynamicField.name?.bcs!),
+					),
+					type: normalizeStructTag(
+						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}>`,
+					),
+					name: {
+						type: dynamicField.name?.type?.repr!,
+						bcs: fromBase64(dynamicField.name?.bcs!),
+					},
+					valueType,
+					childId:
+						isDynamicObject && dynamicField.value?.__typename === 'MoveObject'
+							? dynamicField.value.address
+							: undefined,
+					value: (includeValue ? value : undefined) as DynamicFieldEntryWithValue<Include>['value'],
+				} as DynamicFieldEntryWithValue<Include>;
+			}),
+			cursor: result.pageInfo.endCursor ?? null,
+			hasNextPage: result.pageInfo.hasNextPage,
+		};
 	}
 
 	getDynamicField(