@mysten/sui 2.24.0 → 2.25.0

package/src/graphql/client.ts

@@ -249,8 +249,28 @@ export class SuiGraphQLClient<Queries extends Record<string, GraphQLDocument> =
 		return this.core.simulateTransaction(input);
 	}
 
-	getReferenceGasPrice(): Promise<SuiClientTypes.GetReferenceGasPriceResponse> {
-		return this.core.getReferenceGasPrice();
+	getReferenceGasPrice(
+		input?: SuiClientTypes.GetReferenceGasPriceOptions,
+	): Promise<SuiClientTypes.GetReferenceGasPriceResponse> {
+		return this.core.getReferenceGasPrice(input);
+	}
+
+	getCurrentSystemState(
+		input?: SuiClientTypes.GetCurrentSystemStateOptions,
+	): Promise<SuiClientTypes.GetCurrentSystemStateResponse> {
+		return this.core.getCurrentSystemState(input);
+	}
+
+	getProtocolConfig(
+		input?: SuiClientTypes.GetProtocolConfigOptions,
+	): Promise<SuiClientTypes.GetProtocolConfigResponse> {
+		return this.core.getProtocolConfig(input);
+	}
+
+	getChainIdentifier(
+		input?: SuiClientTypes.GetChainIdentifierOptions,
+	): Promise<SuiClientTypes.GetChainIdentifierResponse> {
+		return this.core.getChainIdentifier(input);
 	}
 
 	async listDynamicFields<Include extends DynamicFieldInclude = {}>(
@@ -260,6 +280,7 @@ export class SuiGraphQLClient<Queries extends Record<string, GraphQLDocument> =
 
 		const { data, errors } = await this.query({
 			query: GetDynamicFieldsDocument,
+			signal: input.signal,
 			variables: {
 				parentId: input.parentId,
 				first: input.limit,
@@ -338,6 +359,12 @@ export class SuiGraphQLClient<Queries extends Record<string, GraphQLDocument> =
 		return this.core.getDynamicField(input);
 	}
 
+	getDynamicObjectField<Include extends SuiClientTypes.ObjectInclude = {}>(
+		input: SuiClientTypes.GetDynamicObjectFieldOptions<Include>,
+	): Promise<SuiClientTypes.GetDynamicObjectFieldResponse<Include>> {
+		return this.core.getDynamicObjectField(input);
+	}
+
 	listTransactions<Include extends SuiClientTypes.TransactionInclude = {}>(
 		input: SuiClientTypes.ListTransactionsOptions<Include>,
 	): Promise<SuiClientTypes.ListTransactionsResponse<Include>> {

package/src/graphql/core.ts

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { CoreClient } from '../client/core.js';
+import { raceSignal } from '../client/mvr.js';
 import type { SuiClientTypes } from '../client/types.js';
 import { SUI_TYPE_ARG } from '../utils/constants.js';
 import type { GraphQLQueryOptions, SuiGraphQLClient } from './client.js';
@@ -109,6 +110,7 @@ export class GraphQLCoreClient extends CoreClient {
 			const page = await this.#graphqlQuery(
 				{
 					query: MultiGetObjectsDocument,
+					signal: options.signal,
 					variables: {
 						objectKeys: batch.map((address) => ({ address })),
 						includeContent: options.include?.content ?? false,
@@ -187,12 +189,16 @@ export class GraphQLCoreClient extends CoreClient {
 		const objects = await this.#graphqlQuery(
 			{
 				query: GetOwnedObjectsDocument,
+				signal: options.signal,
 				variables: {
 					owner: options.owner,
 					limit: options.limit,
 					cursor: options.cursor,
 					filter: options.type
-						? { type: (await this.mvr.resolveType({ type: options.type })).type }
+						? {
+								type: (await this.mvr.resolveType({ type: options.type, signal: options.signal }))
+									.type,
+							}
 						: undefined,
 					includeContent: options.include?.content ?? false,
 					includePreviousTransaction: options.include?.previousTransaction ?? false,
@@ -242,11 +248,12 @@ export class GraphQLCoreClient extends CoreClient {
 		const coins = await this.#graphqlQuery(
 			{
 				query: GetCoinsDocument,
+				signal: options.signal,
 				variables: {
 					owner: options.owner,
 					cursor: options.cursor,
 					first: options.limit,
-					type: `0x2::coin::Coin<${(await this.mvr.resolveType({ type: coinType })).type}>`,
+					type: `0x2::coin::Coin<${(await this.mvr.resolveType({ type: coinType, signal: options.signal })).type}>`,
 				},
 			},
 			(result) => result.address?.objects,
@@ -275,9 +282,10 @@ export class GraphQLCoreClient extends CoreClient {
 		const result = await this.#graphqlQuery(
 			{
 				query: GetBalanceDocument,
+				signal: options.signal,
 				variables: {
 					owner: options.owner,
-					coinType: (await this.mvr.resolveType({ type: coinType })).type,
+					coinType: (await this.mvr.resolveType({ type: coinType, signal: options.signal })).type,
 				},
 			},
 			(result) => result.address?.balance,
@@ -298,10 +306,13 @@ export class GraphQLCoreClient extends CoreClient {
 	async getCoinMetadata(
 		options: SuiClientTypes.GetCoinMetadataOptions,
 	): Promise<SuiClientTypes.GetCoinMetadataResponse> {
-		const coinType = (await this.mvr.resolveType({ type: options.coinType })).type;
+		const coinType = (
+			await this.mvr.resolveType({ type: options.coinType, signal: options.signal })
+		).type;
 
 		const { data, errors } = await this.#graphqlClient.query({
 			query: GetCoinMetadataDocument,
+			signal: options.signal,
 			variables: {
 				coinType,
 			},
@@ -331,6 +342,7 @@ export class GraphQLCoreClient extends CoreClient {
 		const balances = await this.#graphqlQuery(
 			{
 				query: GetAllBalancesDocument,
+				signal: options.signal,
 				variables: {
 					owner: options.owner,
 					limit: options.limit,
@@ -361,6 +373,7 @@ export class GraphQLCoreClient extends CoreClient {
 		const result = await this.#graphqlQuery(
 			{
 				query: GetTransactionBlockDocument,
+				signal: options.signal,
 				variables: {
 					digest: options.digest,
 					includeTransaction: options.include?.transaction ?? false,
@@ -382,6 +395,7 @@ export class GraphQLCoreClient extends CoreClient {
 		const result = await this.#graphqlQuery(
 			{
 				query: ExecuteTransactionDocument,
+				signal: options.signal,
 				variables: {
 					transactionDataBcs: toBase64(options.transaction),
 					signatures: options.signatures,
@@ -417,6 +431,7 @@ export class GraphQLCoreClient extends CoreClient {
 		const result = await this.#graphqlQuery(
 			{
 				query: SimulateTransactionDocument,
+				signal: options.signal,
 				variables: {
 					transaction:
 						options.transaction instanceof Uint8Array
@@ -470,10 +485,13 @@ export class GraphQLCoreClient extends CoreClient {
 			};
 		}
 	}
-	async getReferenceGasPrice(): Promise<SuiClientTypes.GetReferenceGasPriceResponse> {
+	async getReferenceGasPrice(
+		options?: SuiClientTypes.GetReferenceGasPriceOptions,
+	): Promise<SuiClientTypes.GetReferenceGasPriceResponse> {
 		const result = await this.#graphqlQuery(
 			{
 				query: GetReferenceGasPriceDocument,
+				signal: options?.signal,
 			},
 			(result) => result.epoch?.referenceGasPrice,
 		);
@@ -483,10 +501,13 @@ export class GraphQLCoreClient extends CoreClient {
 		};
 	}
 
-	async getProtocolConfig(): Promise<SuiClientTypes.GetProtocolConfigResponse> {
+	async getProtocolConfig(
+		options?: SuiClientTypes.GetProtocolConfigOptions,
+	): Promise<SuiClientTypes.GetProtocolConfigResponse> {
 		const result = await this.#graphqlQuery(
 			{
 				query: GetProtocolConfigDocument,
+				signal: options?.signal,
 			},
 			(result) => result.epoch?.protocolConfigs,
 		);
@@ -509,10 +530,13 @@ export class GraphQLCoreClient extends CoreClient {
 		};
 	}
 
-	async getCurrentSystemState(): Promise<SuiClientTypes.GetCurrentSystemStateResponse> {
+	async getCurrentSystemState(
+		options?: SuiClientTypes.GetCurrentSystemStateOptions,
+	): Promise<SuiClientTypes.GetCurrentSystemStateResponse> {
 		const result = await this.#graphqlQuery(
 			{
 				query: GetCurrentSystemStateDocument,
+				signal: options?.signal,
 			},
 			(result) => result.epoch,
 		);
@@ -744,6 +768,7 @@ export class GraphQLCoreClient extends CoreClient {
 
 		const { data } = await this.#graphqlClient.query({
 			query: VerifyZkLoginSignatureDocument,
+			signal: options.signal,
 			variables: {
 				bytes: options.bytes,
 				signature: options.signature,
@@ -797,8 +822,11 @@ export class GraphQLCoreClient extends CoreClient {
 		const moveFunction = await this.#graphqlQuery(
 			{
 				query: GetMoveFunctionDocument,
+				signal: options.signal,
 				variables: {
-					package: (await this.mvr.resolvePackage({ package: options.packageId })).package,
+					package: (
+						await this.mvr.resolvePackage({ package: options.packageId, signal: options.signal })
+					).package,
 					module: options.moduleName,
 					function: options.name,
 				},
@@ -856,9 +884,11 @@ export class GraphQLCoreClient extends CoreClient {
 	}
 
 	async getChainIdentifier(
-		_options?: SuiClientTypes.GetChainIdentifierOptions,
+		options?: SuiClientTypes.GetChainIdentifierOptions,
 	): Promise<SuiClientTypes.GetChainIdentifierResponse> {
-		return this.cache.read(['chainIdentifier'], async () => {
+		// The result is cached and shared across callers, so the underlying request must
+		// not carry any single caller's signal. Isolate cancellation per-caller instead.
+		const cached = this.cache.read(['chainIdentifier'], async () => {
 			const checkpoint = await this.#graphqlQuery(
 				{
 					query: GetChainIdentifierDocument,
@@ -872,6 +902,8 @@ export class GraphQLCoreClient extends CoreClient {
 				chainIdentifier: checkpoint.digest,
 			};
 		});
+
+		return raceSignal(Promise.resolve(cached), options?.signal);
 	}
 
 	resolveTransactionPlugin() {

package/src/graphql/generated/schema.graphql

@@ -1225,7 +1225,7 @@ type EndOfEpochTransaction {
 	transactions(first: Int, after: String, last: Int, before: String): EndOfEpochTransactionKindConnection
 }
 
-union EndOfEpochTransactionKind = ChangeEpochTransaction | AuthenticatorStateCreateTransaction | AuthenticatorStateExpireTransaction | RandomnessStateCreateTransaction | CoinDenyListStateCreateTransaction | StoreExecutionTimeObservationsTransaction | BridgeStateCreateTransaction | BridgeCommitteeInitTransaction | AccumulatorRootCreateTransaction | CoinRegistryCreateTransaction | DisplayRegistryCreateTransaction | AddressAliasStateCreateTransaction | WriteAccumulatorStorageCostTransaction
+union EndOfEpochTransactionKind = ChangeEpochTransaction | AuthenticatorStateCreateTransaction | AuthenticatorStateExpireTransaction | RandomnessStateCreateTransaction | CoinDenyListStateCreateTransaction | StoreExecutionTimeObservationsTransaction | BridgeStateCreateTransaction | BridgeCommitteeInitTransaction | AccumulatorRootCreateTransaction | CoinRegistryCreateTransaction | DisplayRegistryCreateTransaction | AddressAliasStateCreateTransaction | WriteAccumulatorStorageCostTransaction | ForwardingAddressRegistryCreateTransaction
 
 type EndOfEpochTransactionKindConnection {
 	"""
@@ -1578,6 +1578,16 @@ type FeatureFlag {
 }
 
 
+"""
+System transaction for creating the forwarding address registry.
+"""
+type ForwardingAddressRegistryCreateTransaction {
+	"""
+	A workaround to define an empty variant of a GraphQL union.
+	"""
+	_: Boolean
+}
+
 """
 Access to the gas inputs, after they have been smashed into one coin. The gas coin can only be used by reference, except for with `TransferObjectsTransaction` that can accept it by value.
 """

package/src/graphql/generated/tada-env.ts

@@ -3697,6 +3697,10 @@ const introspection = {
             "kind": "OBJECT",
             "name": "DisplayRegistryCreateTransaction"
           },
+          {
+            "kind": "OBJECT",
+            "name": "ForwardingAddressRegistryCreateTransaction"
+          },
           {
             "kind": "OBJECT",
             "name": "RandomnessStateCreateTransaction"
@@ -4551,6 +4555,22 @@ const introspection = {
         ],
         "interfaces": []
       },
+      {
+        "kind": "OBJECT",
+        "name": "ForwardingAddressRegistryCreateTransaction",
+        "fields": [
+          {
+            "name": "_",
+            "type": {
+              "kind": "SCALAR",
+              "name": "Boolean"
+            },
+            "args": [],
+            "isDeprecated": false
+          }
+        ],
+        "interfaces": []
+      },
       {
         "kind": "OBJECT",
         "name": "GasCoin",

package/src/grpc/client.ts

@@ -246,8 +246,28 @@ export class SuiGrpcClient extends BaseClient implements SuiClientTypes.Transpor
 		return this.core.simulateTransaction(input) as Promise<GrpcSimulateTransactionResult<Include>>;
 	}
 
-	getReferenceGasPrice(): Promise<SuiClientTypes.GetReferenceGasPriceResponse> {
-		return this.core.getReferenceGasPrice();
+	getReferenceGasPrice(
+		input?: SuiClientTypes.GetReferenceGasPriceOptions,
+	): Promise<SuiClientTypes.GetReferenceGasPriceResponse> {
+		return this.core.getReferenceGasPrice(input);
+	}
+
+	getCurrentSystemState(
+		input?: SuiClientTypes.GetCurrentSystemStateOptions,
+	): Promise<SuiClientTypes.GetCurrentSystemStateResponse> {
+		return this.core.getCurrentSystemState(input);
+	}
+
+	getProtocolConfig(
+		input?: SuiClientTypes.GetProtocolConfigOptions,
+	): Promise<SuiClientTypes.GetProtocolConfigResponse> {
+		return this.core.getProtocolConfig(input);
+	}
+
+	getChainIdentifier(
+		input?: SuiClientTypes.GetChainIdentifierOptions,
+	): Promise<SuiClientTypes.GetChainIdentifierResponse> {
+		return this.core.getChainIdentifier(input);
 	}
 
 	async listDynamicFields<Include extends DynamicFieldInclude = {}>(
@@ -305,6 +325,12 @@ export class SuiGrpcClient extends BaseClient implements SuiClientTypes.Transpor
 		return this.core.getDynamicField(input);
 	}
 
+	getDynamicObjectField<Include extends SuiClientTypes.ObjectInclude = {}>(
+		input: SuiClientTypes.GetDynamicObjectFieldOptions<Include>,
+	): Promise<SuiClientTypes.GetDynamicObjectFieldResponse<Include>> {
+		return this.core.getDynamicObjectField(input);
+	}
+
 	listTransactions<Include extends SuiClientTypes.TransactionInclude = {}>(
 		input: SuiClientTypes.ListTransactionsOptions<Include>,
 	): Promise<SuiClientTypes.ListTransactionsResponse<Include>> {

package/src/jsonRpc/client.ts

@@ -220,6 +220,7 @@ export class SuiJsonRpcClient extends BaseClient {
 			coinType = (
 				await this.core.mvr.resolveType({
 					type: coinType,
+					signal,
 				})
 			).type;
 		}
@@ -272,6 +273,7 @@ export class SuiJsonRpcClient extends BaseClient {
 			coinType = (
 				await this.core.mvr.resolveType({
 					type: coinType,
+					signal,
 				})
 			).type;
 		}
@@ -309,6 +311,7 @@ export class SuiJsonRpcClient extends BaseClient {
 			coinType = (
 				await this.core.mvr.resolveType({
 					type: coinType,
+					signal,
 				})
 			).type;
 		}
@@ -330,6 +333,7 @@ export class SuiJsonRpcClient extends BaseClient {
 			coinType = (
 				await this.core.mvr.resolveType({
 					type: coinType,
+					signal,
 				})
 			).type;
 		}
@@ -371,6 +375,7 @@ export class SuiJsonRpcClient extends BaseClient {
 			pkg = (
 				await this.core.mvr.resolvePackage({
 					package: pkg,
+					signal,
 				})
 			).package;
 		}
@@ -396,6 +401,7 @@ export class SuiJsonRpcClient extends BaseClient {
 			pkg = (
 				await this.core.mvr.resolvePackage({
 					package: pkg,
+					signal,
 				})
 			).package;
 		}
@@ -421,6 +427,7 @@ export class SuiJsonRpcClient extends BaseClient {
 			pkg = (
 				await this.core.mvr.resolvePackage({
 					package: pkg,
+					signal,
 				})
 			).package;
 		}
@@ -447,6 +454,7 @@ export class SuiJsonRpcClient extends BaseClient {
 			pkg = (
 				await this.core.mvr.resolvePackage({
 					package: pkg,
+					signal,
 				})
 			).package;
 		}
@@ -473,6 +481,7 @@ export class SuiJsonRpcClient extends BaseClient {
 			pkg = (
 				await this.core.mvr.resolvePackage({
 					package: pkg,
+					signal,
 				})
 			).package;
 		}
@@ -506,6 +515,7 @@ export class SuiJsonRpcClient extends BaseClient {
 				package: (
 					await this.core.mvr.resolvePackage({
 						package: filter.MoveModule.package,
+						signal: input.signal,
 					})
 				).package,
 			};
@@ -513,6 +523,7 @@ export class SuiJsonRpcClient extends BaseClient {
 			filter.StructType = (
 				await this.core.mvr.resolveType({
 					type: filter.StructType,
+					signal: input.signal,
 				})
 			).type;
 		}
@@ -603,6 +614,7 @@ export class SuiJsonRpcClient extends BaseClient {
 					package: (
 						await this.core.mvr.resolvePackage({
 							package: filter.MoveFunction.package,
+							signal,
 						})
 					).package,
 				},
@@ -820,6 +832,7 @@ export class SuiJsonRpcClient extends BaseClient {
 				MoveEventType: (
 					await this.core.mvr.resolveType({
 						type: query.MoveEventType,
+						signal,
 					})
 				).type,
 			};
@@ -833,6 +846,7 @@ export class SuiJsonRpcClient extends BaseClient {
 					package: (
 						await this.core.mvr.resolvePackage({
 							package: query.MoveEventModule.package,
+							signal,
 						})
 					).package,
 				},
@@ -847,6 +861,7 @@ export class SuiJsonRpcClient extends BaseClient {
 					package: (
 						await this.core.mvr.resolvePackage({
 							package: query.MoveModule.package,
+							signal,
 						})
 					).package,
 				},

package/src/jsonRpc/core.ts

@@ -26,6 +26,7 @@ import {
 	resolveTransactionFilter,
 	validateTransactionQuery,
 } from '../client/query-filters.js';
+import { raceSignal } from '../client/mvr.js';
 import { Transaction } from '../transactions/Transaction.js';
 import { computeGasBudget, coreClientResolveTransactionPlugin } from '../client/core-resolver.js';
 import { TransactionDataBuilder } from '../transactions/TransactionData.js';
@@ -282,7 +283,9 @@ export class JSONRpcCoreClient extends CoreClient {
 	async getCoinMetadata(
 		options: SuiClientTypes.GetCoinMetadataOptions,
 	): Promise<SuiClientTypes.GetCoinMetadataResponse> {
-		const coinType = (await this.mvr.resolveType({ type: options.coinType })).type;
+		const coinType = (
+			await this.mvr.resolveType({ type: options.coinType, signal: options.signal })
+		).type;
 
 		const result = await this.#jsonRpcClient.getCoinMetadata({
 			coinType,
@@ -402,7 +405,9 @@ export class JSONRpcCoreClient extends CoreClient {
 					overrides: {
 						gasData: {
 							budget: data.gasData.budget ?? String(MAX_GAS),
-							price: data.gasData.price ?? String(await this.#jsonRpcClient.getReferenceGasPrice()),
+							price:
+								data.gasData.price ??
+								String(await this.#jsonRpcClient.getReferenceGasPrice({ signal: options.signal })),
 							payment: data.gasData.payment ?? [],
 						},
 					},
@@ -627,6 +632,7 @@ export class JSONRpcCoreClient extends CoreClient {
 			parentId: options.parentId,
 			limit: options.limit,
 			cursor: options.cursor,
+			signal: options.signal,
 		});
 
 		return {
@@ -775,6 +781,7 @@ export class JSONRpcCoreClient extends CoreClient {
 	 */
 	async verifyZkLoginSignature(options: SuiClientTypes.VerifyZkLoginSignatureOptions) {
 		const result = await this.#jsonRpcClient.verifyZkLoginSignature({
+			signal: options.signal,
 			bytes: options.bytes,
 			signature: options.signature,
 			intentScope: options.intentScope,
@@ -829,12 +836,14 @@ export class JSONRpcCoreClient extends CoreClient {
 	async getMoveFunction(
 		options: SuiClientTypes.GetMoveFunctionOptions,
 	): Promise<SuiClientTypes.GetMoveFunctionResponse> {
-		const resolvedPackageId = (await this.mvr.resolvePackage({ package: options.packageId }))
-			.package;
+		const resolvedPackageId = (
+			await this.mvr.resolvePackage({ package: options.packageId, signal: options.signal })
+		).package;
 		const result = await this.#jsonRpcClient.getNormalizedMoveFunction({
 			package: resolvedPackageId,
 			module: options.moduleName,
 			function: options.name,
+			signal: options.signal,
 		});
 
 		return {
@@ -859,14 +868,18 @@ export class JSONRpcCoreClient extends CoreClient {
 	 * from `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
 	 */
 	async getChainIdentifier(
-		_options?: SuiClientTypes.GetChainIdentifierOptions,
+		options?: SuiClientTypes.GetChainIdentifierOptions,
 	): Promise<SuiClientTypes.GetChainIdentifierResponse> {
-		return this.cache.read(['chainIdentifier'], async () => {
+		// The result is cached and shared across callers, so the underlying request must
+		// not carry any single caller's signal. Isolate cancellation per-caller instead.
+		const cached = this.cache.read(['chainIdentifier'], async () => {
 			const checkpoint = await this.#jsonRpcClient.getCheckpoint({ id: '0' });
 			return {
 				chainIdentifier: checkpoint.digest,
 			};
 		});
+
+		return raceSignal(Promise.resolve(cached), options?.signal);
 	}
 }
 

package/src/version.ts

@@ -3,4 +3,4 @@
 
 // This file is generated by genversion.mjs. Do not edit it directly.
 
-export const PACKAGE_VERSION = '2.24.0';
+export const PACKAGE_VERSION = '2.25.0';