@mysten/sui 1.26.1 → 1.27.1

package/src/client/types/params.ts

@@ -28,6 +28,7 @@ export interface DevInspectTransactionBlockParams {
 	epoch?: string | null | undefined;
 	/** Additional arguments including gas_budget, gas_objects, gas_sponsor and skip_checks. */
 	additionalArgs?: RpcTypes.DevInspectArgs | null | undefined;
+	signal?: AbortSignal;
 }
 /**
  * Return transaction execution effects including the gas cost summary, while the effects are not
@@ -35,6 +36,7 @@ export interface DevInspectTransactionBlockParams {
  */
 export interface DryRunTransactionBlockParams {
 	transactionBlock: Uint8Array | string;
+	signal?: AbortSignal;
 }
 /**
  * Execute the transaction and wait for results if desired. Request types: 1. WaitForEffectsCert: waits
@@ -58,13 +60,17 @@ export interface ExecuteTransactionBlockParams {
 	options?: RpcTypes.SuiTransactionBlockResponseOptions | null | undefined;
 	/** @deprecated requestType will be ignored by JSON RPC in the future */
 	requestType?: RpcTypes.ExecuteTransactionRequestType | null | undefined;
+	signal?: AbortSignal;
 }
 /** Return the first four bytes of the chain's genesis checkpoint digest. */
-export interface GetChainIdentifierParams {}
+export interface GetChainIdentifierParams {
+	signal?: AbortSignal;
+}
 /** Return a checkpoint */
 export interface GetCheckpointParams {
 	/** Checkpoint identifier, can use either checkpoint digest, or checkpoint sequence number as input. */
 	id: RpcTypes.CheckpointId;
+	signal?: AbortSignal;
 }
 /** Return paginated list of checkpoints */
 export interface GetCheckpointsParams {
@@ -77,40 +83,49 @@ export interface GetCheckpointsParams {
 	limit?: number | null | undefined;
 	/** query result ordering, default to false (ascending order), oldest record first. */
 	descendingOrder: boolean;
+	signal?: AbortSignal;
 }
 /** Return transaction events. */
 export interface GetEventsParams {
 	/** the event query criteria. */
 	transactionDigest: string;
+	signal?: AbortSignal;
 }
 /** Return the sequence number of the latest checkpoint that has been executed */
-export interface GetLatestCheckpointSequenceNumberParams {}
+export interface GetLatestCheckpointSequenceNumberParams {
+	signal?: AbortSignal;
+}
 /** Return the argument types of a Move function, based on normalized Type. */
 export interface GetMoveFunctionArgTypesParams {
 	package: string;
 	module: string;
 	function: string;
+	signal?: AbortSignal;
 }
 /** Return a structured representation of Move function */
 export interface GetNormalizedMoveFunctionParams {
 	package: string;
 	module: string;
 	function: string;
+	signal?: AbortSignal;
 }
 /** Return a structured representation of Move module */
 export interface GetNormalizedMoveModuleParams {
 	package: string;
 	module: string;
+	signal?: AbortSignal;
 }
 /** Return structured representations of all modules in the given package */
 export interface GetNormalizedMoveModulesByPackageParams {
 	package: string;
+	signal?: AbortSignal;
 }
 /** Return a structured representation of Move struct */
 export interface GetNormalizedMoveStructParams {
 	package: string;
 	module: string;
 	struct: string;
+	signal?: AbortSignal;
 }
 /** Return the object information for a specified object */
 export interface GetObjectParams {
@@ -118,6 +133,7 @@ export interface GetObjectParams {
 	id: string;
 	/** options for specifying the content to be returned */
 	options?: RpcTypes.SuiObjectDataOptions | null | undefined;
+	signal?: AbortSignal;
 }
 /**
  * Return the protocol config table for the given version number. If the version number is not
@@ -129,15 +145,19 @@ export interface GetProtocolConfigParams {
 	 * will be returned.
 	 */
 	version?: string | null | undefined;
+	signal?: AbortSignal;
 }
 /** Return the total number of transaction blocks known to the server. */
-export interface GetTotalTransactionBlocksParams {}
+export interface GetTotalTransactionBlocksParams {
+	signal?: AbortSignal;
+}
 /** Return the transaction response object. */
 export interface GetTransactionBlockParams {
 	/** the digest of the queried transaction */
 	digest: string;
 	/** options for specifying the content to be returned */
 	options?: RpcTypes.SuiTransactionBlockResponseOptions | null | undefined;
+	signal?: AbortSignal;
 }
 /** Return the object data for a list of objects */
 export interface MultiGetObjectsParams {
@@ -145,6 +165,7 @@ export interface MultiGetObjectsParams {
 	ids: string[];
 	/** options for specifying the content to be returned */
 	options?: RpcTypes.SuiObjectDataOptions | null | undefined;
+	signal?: AbortSignal;
 }
 /**
  * Returns an ordered list of transaction responses The method will throw an error if the input
@@ -155,6 +176,7 @@ export interface MultiGetTransactionBlocksParams {
 	digests: string[];
 	/** config options to control which fields to fetch */
 	options?: RpcTypes.SuiTransactionBlockResponseOptions | null | undefined;
+	signal?: AbortSignal;
 }
 /**
  * Note there is no software-level guarantee/SLA that objects with past versions can be retrieved by
@@ -168,6 +190,7 @@ export interface TryGetPastObjectParams {
 	version: number;
 	/** options for specifying the content to be returned */
 	options?: RpcTypes.SuiObjectDataOptions | null | undefined;
+	signal?: AbortSignal;
 }
 /**
  * Note there is no software-level guarantee/SLA that objects with past versions can be retrieved by
@@ -179,6 +202,7 @@ export interface TryMultiGetPastObjectsParams {
 	pastObjects: RpcTypes.GetPastObjectRequest[];
 	/** options for specifying the content to be returned */
 	options?: RpcTypes.SuiObjectDataOptions | null | undefined;
+	signal?: AbortSignal;
 }
 /** Verify a zklogin signature for the given bytes, intent scope and author. */
 export interface VerifyZkLoginSignatureParams {
@@ -193,11 +217,13 @@ export interface VerifyZkLoginSignatureParams {
 	intentScope: RpcTypes.ZkLoginIntentScope;
 	/** The author of the signature. */
 	author: string;
+	signal?: AbortSignal;
 }
 /** Return the total coin balance for all coin type, owned by the address owner. */
 export interface GetAllBalancesParams {
 	/** the owner's Sui address */
 	owner: string;
+	signal?: AbortSignal;
 }
 /** Return all Coin objects owned by an address. */
 export interface GetAllCoinsParams {
@@ -207,6 +233,7 @@ export interface GetAllCoinsParams {
 	cursor?: string | null | undefined;
 	/** maximum number of items per page */
 	limit?: number | null | undefined;
+	signal?: AbortSignal;
 }
 /** Return the total coin balance for one coin type, owned by the address owner. */
 export interface GetBalanceParams {
@@ -217,6 +244,7 @@ export interface GetBalanceParams {
 	 * default to 0x2::sui::SUI if not specified.
 	 */
 	coinType?: string | null | undefined;
+	signal?: AbortSignal;
 }
 /**
  * Return metadata (e.g., symbol, decimals) for a coin. Note that if the coin's metadata was wrapped in
@@ -226,6 +254,7 @@ export interface GetBalanceParams {
 export interface GetCoinMetadataParams {
 	/** type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC) */
 	coinType: string;
+	signal?: AbortSignal;
 }
 /** Return all Coin<`coin_type`> objects owned by an address. */
 export interface GetCoinsParams {
@@ -240,11 +269,13 @@ export interface GetCoinsParams {
 	cursor?: string | null | undefined;
 	/** maximum number of items per page */
 	limit?: number | null | undefined;
+	signal?: AbortSignal;
 }
 /** Return the committee information for the asked `epoch`. */
 export interface GetCommitteeInfoParams {
 	/** The epoch of interest. If None, default to the latest epoch */
 	epoch?: string | null | undefined;
+	signal?: AbortSignal;
 }
 /** Return the dynamic field object information for a specified object */
 export interface GetDynamicFieldObjectParams {
@@ -252,6 +283,7 @@ export interface GetDynamicFieldObjectParams {
 	parentId: string;
 	/** The Name of the dynamic field */
 	name: RpcTypes.DynamicFieldName;
+	signal?: AbortSignal;
 }
 /** Return the list of dynamic field objects owned by an object. */
 export interface GetDynamicFieldsParams {
@@ -264,9 +296,12 @@ export interface GetDynamicFieldsParams {
 	cursor?: string | null | undefined;
 	/** Maximum item returned per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified. */
 	limit?: number | null | undefined;
+	signal?: AbortSignal;
 }
 /** Return the latest SUI system state object on-chain. */
-export interface GetLatestSuiSystemStateParams {}
+export interface GetLatestSuiSystemStateParams {
+	signal?: AbortSignal;
+}
 /**
  * Return the list of objects owned by an address. Note that if the address owns more than
  * `QUERY_MAX_RESULT_LIMIT` objects, the pagination is not accurate, because previous page may have
@@ -282,24 +317,32 @@ export type GetOwnedObjectsParams = {
 	cursor?: string | null | undefined;
 	/** Max number of items returned per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified. */
 	limit?: number | null | undefined;
+	signal?: AbortSignal;
 } & RpcTypes.SuiObjectResponseQuery;
 /** Return the reference gas price for the network */
-export interface GetReferenceGasPriceParams {}
+export interface GetReferenceGasPriceParams {
+	signal?: AbortSignal;
+}
 /** Return all [DelegatedStake]. */
 export interface GetStakesParams {
 	owner: string;
+	signal?: AbortSignal;
 }
 /** Return one or more [DelegatedStake]. If a Stake was withdrawn its status will be Unstaked. */
 export interface GetStakesByIdsParams {
 	stakedSuiIds: string[];
+	signal?: AbortSignal;
 }
 /** Return total supply for a coin */
 export interface GetTotalSupplyParams {
 	/** type name for the coin (e.g., 0x168da5bf1f48dafc111b0a488fa454aca95e0b5e::usdc::USDC) */
 	coinType: string;
+	signal?: AbortSignal;
 }
 /** Return the validator APY */
-export interface GetValidatorsApyParams {}
+export interface GetValidatorsApyParams {
+	signal?: AbortSignal;
+}
 /** Return list of events for a specified query criteria. */
 export interface QueryEventsParams {
 	/**
@@ -313,6 +356,7 @@ export interface QueryEventsParams {
 	limit?: number | null | undefined;
 	/** query result ordering, default to false (ascending order), oldest record first. */
 	order?: 'ascending' | 'descending' | null | undefined;
+	signal?: AbortSignal;
 }
 /** Return list of transactions for a specified query criteria. */
 export type QueryTransactionBlocksParams = {
@@ -325,11 +369,13 @@ export type QueryTransactionBlocksParams = {
 	limit?: number | null | undefined;
 	/** query result ordering, default to false (ascending order), oldest record first. */
 	order?: 'ascending' | 'descending' | null | undefined;
+	signal?: AbortSignal;
 } & RpcTypes.SuiTransactionBlockResponseQuery;
 /** Return the resolved address given resolver and name */
 export interface ResolveNameServiceAddressParams {
 	/** The name to resolve */
 	name: string;
+	signal?: AbortSignal;
 }
 /**
  * Return the resolved names given address, if multiple names are resolved, the first one is the
@@ -340,6 +386,7 @@ export interface ResolveNameServiceNamesParams {
 	address: string;
 	cursor?: string | null | undefined;
 	limit?: number | null | undefined;
+	signal?: AbortSignal;
 }
 /** Subscribe to a stream of Sui event */
 export interface SubscribeEventParams {
@@ -348,10 +395,12 @@ export interface SubscribeEventParams {
 	 * [Event filter](https://docs.sui.io/build/event_api#event-filters) documentation for examples.
 	 */
 	filter: RpcTypes.SuiEventFilter;
+	signal?: AbortSignal;
 }
 /** Subscribe to a stream of Sui transaction effects */
 export interface SubscribeTransactionParams {
 	filter: RpcTypes.TransactionFilter;
+	signal?: AbortSignal;
 }
 /** Create an unsigned batched transaction. */
 export interface UnsafeBatchTransactionParams {
@@ -368,6 +417,7 @@ export interface UnsafeBatchTransactionParams {
 	gasBudget: string;
 	/** Whether this is a regular transaction or a Dev Inspect Transaction */
 	txnBuilderMode?: RpcTypes.SuiTransactionBlockBuilderMode | null | undefined;
+	signal?: AbortSignal;
 }
 /** Create an unsigned transaction to merge multiple coins into one coin. */
 export interface UnsafeMergeCoinsParams {
@@ -387,6 +437,7 @@ export interface UnsafeMergeCoinsParams {
 	gas?: string | null | undefined;
 	/** the gas budget, the transaction will fail if the gas cost exceed the budget */
 	gasBudget: string;
+	signal?: AbortSignal;
 }
 /**
  * Create an unsigned transaction to execute a Move call on the network, by calling the specified
@@ -420,6 +471,7 @@ export interface UnsafeMoveCallParams {
 	 * `SuiTransactionBlockBuilderMode::Commit` when it's None.
 	 */
 	executionMode?: RpcTypes.SuiTransactionBlockBuilderMode | null | undefined;
+	signal?: AbortSignal;
 }
 /**
  * Send `Coin<T>` to a list of addresses, where `T` can be any coin type, following a list of amounts,
@@ -443,6 +495,7 @@ export interface UnsafePayParams {
 	gas?: string | null | undefined;
 	/** the gas budget, the transaction will fail if the gas cost exceed the budget */
 	gasBudget: string;
+	signal?: AbortSignal;
 }
 /**
  * Send all SUI coins to one recipient. This is for SUI coin only and does not require a separate gas
@@ -460,6 +513,7 @@ export interface UnsafePayAllSuiParams {
 	recipient: string;
 	/** the gas budget, the transaction will fail if the gas cost exceed the budget */
 	gasBudget: string;
+	signal?: AbortSignal;
 }
 /**
  * Send SUI coins to a list of addresses, following a list of amounts. This is for SUI coin only and
@@ -481,6 +535,7 @@ export interface UnsafePaySuiParams {
 	amounts: string[];
 	/** the gas budget, the transaction will fail if the gas cost exceed the budget */
 	gasBudget: string;
+	signal?: AbortSignal;
 }
 /** Create an unsigned transaction to publish a Move package. */
 export interface UnsafePublishParams {
@@ -497,6 +552,7 @@ export interface UnsafePublishParams {
 	gas?: string | null | undefined;
 	/** the gas budget, the transaction will fail if the gas cost exceed the budget */
 	gasBudget: string;
+	signal?: AbortSignal;
 }
 /** Add stake to a validator's staking pool using multiple coins and amount. */
 export interface UnsafeRequestAddStakeParams {
@@ -515,6 +571,7 @@ export interface UnsafeRequestAddStakeParams {
 	gas?: string | null | undefined;
 	/** the gas budget, the transaction will fail if the gas cost exceed the budget */
 	gasBudget: string;
+	signal?: AbortSignal;
 }
 /** Withdraw stake from a validator's staking pool. */
 export interface UnsafeRequestWithdrawStakeParams {
@@ -529,6 +586,7 @@ export interface UnsafeRequestWithdrawStakeParams {
 	gas?: string | null | undefined;
 	/** the gas budget, the transaction will fail if the gas cost exceed the budget */
 	gasBudget: string;
+	signal?: AbortSignal;
 }
 /** Create an unsigned transaction to split a coin object into multiple coins. */
 export interface UnsafeSplitCoinParams {
@@ -545,6 +603,7 @@ export interface UnsafeSplitCoinParams {
 	gas?: string | null | undefined;
 	/** the gas budget, the transaction will fail if the gas cost exceed the budget */
 	gasBudget: string;
+	signal?: AbortSignal;
 }
 /** Create an unsigned transaction to split a coin object into multiple equal-size coins. */
 export interface UnsafeSplitCoinEqualParams {
@@ -561,6 +620,7 @@ export interface UnsafeSplitCoinEqualParams {
 	gas?: string | null | undefined;
 	/** the gas budget, the transaction will fail if the gas cost exceed the budget */
 	gasBudget: string;
+	signal?: AbortSignal;
 }
 /**
  * Create an unsigned transaction to transfer an object from one address to another. The object's type
@@ -580,6 +640,7 @@ export interface UnsafeTransferObjectParams {
 	gasBudget: string;
 	/** the recipient's Sui address */
 	recipient: string;
+	signal?: AbortSignal;
 }
 /**
  * Create an unsigned transaction to send SUI coin object to a Sui address. The SUI object is also used
@@ -596,4 +657,5 @@ export interface UnsafeTransferSuiParams {
 	recipient: string;
 	/** the amount to be split out and transferred */
 	amount?: string | null | undefined;
+	signal?: AbortSignal;
 }

package/src/experimental/cache.ts

@@ -0,0 +1,64 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+export interface ClientCacheOptions {
+	prefix?: string[];
+	cache?: Map<string, unknown>;
+}
+
+export class ClientCache {
+	#prefix: string[];
+	#cache: Map<string, unknown>;
+
+	constructor({ prefix, cache }: ClientCacheOptions = {}) {
+		this.#prefix = prefix ?? [];
+		this.#cache = cache ?? new Map();
+	}
+
+	read<T>(key: [string, ...string[]], load: () => T | Promise<T>): T | Promise<T> {
+		const cacheKey = [this.#prefix, ...key].join(':');
+
+		if (this.#cache.has(cacheKey)) {
+			return this.#cache.get(cacheKey) as T;
+		}
+
+		const result = load();
+
+		this.#cache.set(cacheKey, result);
+
+		if (typeof result === 'object' && result !== null && 'then' in result) {
+			return Promise.resolve(result)
+				.then((v) => {
+					this.#cache.set(cacheKey, v);
+					return v as T;
+				})
+				.catch((err) => {
+					this.#cache.delete(cacheKey);
+					throw err;
+				});
+		}
+
+		return result as T;
+	}
+
+	clear(prefix?: string[]) {
+		const prefixKey = [...this.#prefix, ...(prefix ?? [])].join(':');
+		if (!prefixKey) {
+			this.#cache.clear();
+			return;
+		}
+
+		for (const key of this.#cache.keys()) {
+			if (key.startsWith(prefixKey)) {
+				this.#cache.delete(key);
+			}
+		}
+	}
+
+	scope(prefix: string | string[]) {
+		return new ClientCache({
+			prefix: [...this.#prefix, ...(Array.isArray(prefix) ? prefix : [prefix])],
+			cache: this.#cache,
+		});
+	}
+}

package/src/experimental/client.ts

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 /* eslint-disable @typescript-eslint/ban-types */
 
+import { ClientCache } from './cache.js';
 import type { Experimental_CoreClient } from './core.js';
 import type {
 	ClientWithExtensions,
@@ -11,8 +12,9 @@ import type {
 	UnionToIntersection,
 } from './types.js';
 
-export abstract class Experimental_SuiClient {
+export abstract class Experimental_BaseClient {
 	network: Experimental_SuiClientTypes.Network;
+	cache = new ClientCache();
 
 	constructor({ network }: Experimental_SuiClientTypes.SuiClientOptions) {
 		this.network = network;
@@ -40,7 +42,7 @@ export abstract class Experimental_SuiClient {
 					{
 						[K in keyof this]: this[K];
 					},
-					keyof Experimental_SuiClient
+					keyof Experimental_BaseClient
 				> &
 					UnionToIntersection<
 						{

package/src/experimental/core.ts

@@ -1,11 +1,14 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { Experimental_SuiClient } from './client.js';
+import { TypeTagSerializer } from '../bcs/type-tag-serializer.js';
+import { deriveDynamicFieldID } from '../utils/dynamic-fields.js';
+import { normalizeStructTag, parseStructTag, SUI_ADDRESS_LENGTH } from '../utils/sui-types.js';
+import { Experimental_BaseClient } from './client.js';
 import type { Experimental_SuiClientTypes } from './types.js';
 
 export abstract class Experimental_CoreClient
-	extends Experimental_SuiClient
+	extends Experimental_BaseClient
 	implements Experimental_SuiClientTypes.TransportMethods
 {
 	core = this;
@@ -43,4 +46,88 @@ export abstract class Experimental_CoreClient
 	): Promise<Experimental_SuiClientTypes.DryRunTransactionResponse>;
 
 	abstract getReferenceGasPrice(): Promise<Experimental_SuiClientTypes.GetReferenceGasPriceResponse>;
+
+	abstract getDynamicFields(
+		options: Experimental_SuiClientTypes.GetDynamicFieldsOptions,
+	): Promise<Experimental_SuiClientTypes.GetDynamicFieldsResponse>;
+
+	async getDynamicField(
+		options: Experimental_SuiClientTypes.GetDynamicFieldOptions,
+	): Promise<Experimental_SuiClientTypes.GetDynamicFieldResponse> {
+		const fieldId = deriveDynamicFieldID(
+			options.parentId,
+			TypeTagSerializer.parseFromStr(options.name.type),
+			options.name.bcs,
+		);
+		const {
+			objects: [fieldObject],
+		} = await this.getObjects({
+			objectIds: [fieldId],
+		});
+
+		if (fieldObject instanceof Error) {
+			throw fieldObject;
+		}
+
+		const fieldType = parseStructTag(fieldObject.type);
+
+		return {
+			dynamicField: {
+				id: fieldObject.id,
+				digest: fieldObject.digest,
+				version: fieldObject.version,
+				type: fieldObject.type,
+				name: {
+					type:
+						typeof fieldType.typeParams[0] === 'string'
+							? fieldType.typeParams[0]
+							: normalizeStructTag(fieldType.typeParams[0]),
+					bcs: options.name.bcs,
+				},
+				value: {
+					type:
+						typeof fieldType.typeParams[1] === 'string'
+							? fieldType.typeParams[1]
+							: normalizeStructTag(fieldType.typeParams[1]),
+					bcs: fieldObject.content.slice(SUI_ADDRESS_LENGTH + options.name.bcs.length),
+				},
+			},
+		};
+	}
+
+	async waitForTransaction({
+		signal,
+		timeout = 60 * 1000,
+		...input
+	}: {
+		/** An optional abort signal that can be used to cancel the wait. */
+		signal?: AbortSignal;
+		/** The amount of time to wait for transaction. Defaults to one minute. */
+		timeout?: number;
+	} & Experimental_SuiClientTypes.GetTransactionOptions): Promise<Experimental_SuiClientTypes.GetTransactionResponse> {
+		const abortSignal = signal
+			? AbortSignal.any([AbortSignal.timeout(timeout), signal])
+			: AbortSignal.timeout(timeout);
+
+		const abortPromise = new Promise((_, reject) => {
+			abortSignal.addEventListener('abort', () => reject(abortSignal.reason));
+		});
+
+		abortPromise.catch(() => {
+			// Swallow unhandled rejections that might be thrown after early return
+		});
+
+		// eslint-disable-next-line no-constant-condition
+		while (true) {
+			abortSignal.throwIfAborted();
+			try {
+				return await this.getTransaction({
+					...input,
+					signal: abortSignal,
+				});
+			} catch (e) {
+				await Promise.race([new Promise((resolve) => setTimeout(resolve, 2_000)), abortPromise]);
+			}
+		}
+	}
 }

package/src/experimental/index.ts

@@ -0,0 +1,20 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import { Experimental_BaseClient } from './client.js';
+import { Experimental_CoreClient } from './core.js';
+import type {
+	ClientWithExtensions,
+	Experimental_SuiClientTypes,
+	SuiClientRegistration,
+} from './types.js';
+
+export {
+	Experimental_BaseClient,
+	Experimental_CoreClient,
+	type ClientWithExtensions,
+	type Experimental_SuiClientTypes,
+	type SuiClientRegistration,
+};
+
+export { ClientCache, type ClientCacheOptions } from './cache.js';