@mysten/sui 2.24.0 → 2.26.0

package/src/grpc/core.ts

@@ -1,8 +1,14 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import type { CoreClientOptions, SuiClientTypes } from '../client/index.js';
-import { CoreClient, formatMoveAbortMessage, SimulationError } from '../client/index.js';
+import type { CoreClientOptions, ObjectErrorReason, SuiClientTypes } from '../client/index.js';
+import {
+	CoreClient,
+	formatMoveAbortMessage,
+	ObjectError,
+	SimulationError,
+	TransactionError,
+} from '../client/index.js';
 import { raceSignal } from '../client/mvr.js';
 import type { SuiGrpcClient } from './client.js';
 import type { Owner } from './proto/sui/rpc/v2/owner.js';
@@ -55,6 +61,7 @@ import type { QueryEnd, QueryOptions } from './proto/sui/rpc/v2/query_options.js
 import { Ordering, QueryEndReason } from './proto/sui/rpc/v2/query_options.js';
 import type { ResolvedPagination } from '../client/query-filters.js';
 import { RpcError } from '@protobuf-ts/runtime-rpc';
+import { GrpcStatusCode } from '@protobuf-ts/grpcweb-transport';
 import {
 	resolveEventFilter,
 	resolvePagination,
@@ -69,8 +76,8 @@ export interface GrpcCoreClientOptions extends CoreClientOptions {
 
 function isNameServiceResolutionMiss(error: unknown): boolean {
 	if (!(error instanceof RpcError)) return false;
-	if (error.code === 'NOT_FOUND') return true;
-	if (error.code !== 'RESOURCE_EXHAUSTED') return false;
+	if (error.code === GrpcStatusCode[GrpcStatusCode.NOT_FOUND]) return true;
+	if (error.code !== GrpcStatusCode[GrpcStatusCode.RESOURCE_EXHAUSTED]) return false;
 
 	try {
 		// The gRPC service currently reports expired names as RESOURCE_EXHAUSTED without a
@@ -124,51 +131,62 @@ export class GrpcCoreClient extends CoreClient {
 			);
 
 			results.push(
-				...response.response.objects.map((object): SuiClientTypes.Object<Include> | Error => {
-					if (object.result.oneofKind === 'error') {
-						// TODO: improve error handling
-						return new Error(object.result.error.message);
-					}
-
-					if (object.result.oneofKind !== 'object') {
-						return new Error('Unexpected result type');
-					}
-
-					const bcsContent = object.result.object.contents?.value ?? undefined;
-					const objectBcs = object.result.object.bcs?.value ?? undefined;
-
-					// Package objects have type "package" which is not a struct tag, so don't normalize it
-					const objectType = object.result.object.objectType;
-					const type =
-						objectType && objectType.includes('::')
-							? normalizeStructTag(objectType)
-							: (objectType ?? '');
-
-					const jsonContent = options.include?.json
-						? object.result.object.json
-							? (Value.toJson(object.result.object.json) as Record<string, unknown>)
-							: null
-						: undefined;
-
-					const displayData = mapDisplayProto(
-						options.include?.display,
-						object.result.object.display,
-					);
-
-					return {
-						objectId: object.result.object.objectId!,
-						version: object.result.object.version?.toString()!,
-						digest: object.result.object.digest!,
-						content: bcsContent as SuiClientTypes.Object<Include>['content'],
-						owner: mapOwner(object.result.object.owner)!,
-						type,
-						previousTransaction: (object.result.object.previousTransaction ??
-							undefined) as SuiClientTypes.Object<Include>['previousTransaction'],
-						objectBcs: objectBcs as SuiClientTypes.Object<Include>['objectBcs'],
-						json: jsonContent as SuiClientTypes.Object<Include>['json'],
-						display: displayData as SuiClientTypes.Object<Include>['display'],
-					};
-				}),
+				...response.response.objects.map(
+					(object, index): SuiClientTypes.Object<Include> | ObjectError => {
+						if (object.result.oneofKind === 'error') {
+							const error = object.result.error;
+							const reason: ObjectErrorReason =
+								error.code === GrpcStatusCode.NOT_FOUND ? 'notFound' : 'unknown';
+							return new ObjectError(String(error.code), error.message, {
+								cause: error,
+								reason,
+								objectId: batch[index],
+							});
+						}
+
+						if (object.result.oneofKind !== 'object') {
+							return new ObjectError('unknown', 'Unexpected result type', {
+								reason: 'unknown',
+								objectId: batch[index],
+							});
+						}
+
+						const bcsContent = object.result.object.contents?.value ?? undefined;
+						const objectBcs = object.result.object.bcs?.value ?? undefined;
+
+						// Package objects have type "package" which is not a struct tag, so don't normalize it
+						const objectType = object.result.object.objectType;
+						const type =
+							objectType && objectType.includes('::')
+								? normalizeStructTag(objectType)
+								: (objectType ?? '');
+
+						const jsonContent = options.include?.json
+							? object.result.object.json
+								? (Value.toJson(object.result.object.json) as Record<string, unknown>)
+								: null
+							: undefined;
+
+						const displayData = mapDisplayProto(
+							options.include?.display,
+							object.result.object.display,
+						);
+
+						return {
+							objectId: object.result.object.objectId!,
+							version: object.result.object.version?.toString()!,
+							digest: object.result.object.digest!,
+							content: bcsContent as SuiClientTypes.Object<Include>['content'],
+							owner: mapOwner(object.result.object.owner)!,
+							type,
+							previousTransaction: (object.result.object.previousTransaction ??
+								undefined) as SuiClientTypes.Object<Include>['previousTransaction'],
+							objectBcs: objectBcs as SuiClientTypes.Object<Include>['objectBcs'],
+							json: jsonContent as SuiClientTypes.Object<Include>['json'],
+							display: displayData as SuiClientTypes.Object<Include>['display'],
+						};
+					},
+				),
 			);
 		}
 
@@ -362,25 +380,32 @@ export class GrpcCoreClient extends CoreClient {
 	async getTransaction<Include extends SuiClientTypes.TransactionInclude = {}>(
 		options: SuiClientTypes.GetTransactionOptions<Include>,
 	): Promise<SuiClientTypes.TransactionResult<Include>> {
-		const { response } = await this.#client.ledgerService.getTransaction(
-			{
-				digest: options.digest,
-				readMask: {
-					paths: transactionReadMaskPaths(options.include),
+		try {
+			const { response } = await this.#client.ledgerService.getTransaction(
+				{
+					digest: options.digest,
+					readMask: {
+						paths: transactionReadMaskPaths(options.include),
+					},
 				},
-			},
-			{ abort: options.signal },
-		);
+				{ abort: options.signal },
+			);
 
-		if (!response.transaction) {
-			throw new Error(`Transaction ${options.digest} not found`);
-		}
+			if (!response.transaction) {
+				throw new TransactionError('notFound', options.digest);
+			}
 
-		return withProtoJson(
-			parseGrpcTransactionResponse(response.transaction, { include: options.include }),
-			options.include,
-			() => ExecutedTransaction.toJson(response.transaction!),
-		);
+			return withProtoJson(
+				parseGrpcTransactionResponse(response.transaction, { include: options.include }),
+				options.include,
+				() => ExecutedTransaction.toJson(response.transaction!),
+			);
+		} catch (error) {
+			if (error instanceof RpcError && error.code === GrpcStatusCode[GrpcStatusCode.NOT_FOUND]) {
+				throw new TransactionError('notFound', options.digest, { cause: error });
+			}
+			throw error;
+		}
 	}
 	async executeTransaction<Include extends SuiClientTypes.TransactionInclude = {}>(
 		options: SuiClientTypes.ExecuteTransactionOptions<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

@@ -10,6 +10,7 @@ import type {
 	EventId,
 	ExecutionStatus as JsonRpcExecutionStatus,
 	ObjectOwner,
+	ObjectResponseError,
 	SuiMoveAbilitySet,
 	SuiMoveAbort,
 	SuiMoveNormalizedType,
@@ -26,6 +27,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';
@@ -35,16 +37,73 @@ 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';
-import { ObjectError } from '../client/errors.js';
+import { ObjectError, TransactionError } from '../client/errors.js';
 import {
 	formatMoveAbortMessage,
 	parseTransactionBcs,
 	parseTransactionEffectsBcs,
 } from '../client/index.js';
 import type { SuiJsonRpcClient } from './client.js';
+import { JsonRpcError } from './errors.js';
 
 const MAX_GAS = 50_000_000_000;
 
+function mapJsonRpcObjectError(
+	response: ObjectResponseError,
+	requestedObjectId?: string,
+): ObjectError {
+	switch (response.code) {
+		case 'notExists':
+			return new ObjectError(response.code, `Object ${response.object_id} does not exist`, {
+				cause: response,
+				reason: 'notFound',
+				objectId: requestedObjectId ?? response.object_id,
+			});
+		case 'dynamicFieldNotFound':
+			return new ObjectError(
+				response.code,
+				`Dynamic field not found for object ${response.parent_object_id}`,
+				{
+					cause: response,
+					reason: 'notFound',
+					objectId: requestedObjectId ?? response.parent_object_id,
+				},
+			);
+		case 'deleted':
+			return new ObjectError(response.code, `Object ${response.object_id} has been deleted`, {
+				cause: response,
+				reason: 'deleted',
+				objectId: requestedObjectId ?? response.object_id,
+			});
+		case 'displayError':
+			return new ObjectError(response.code, `Display error: ${response.error}`, {
+				cause: response,
+				reason: 'unknown',
+				objectId: requestedObjectId,
+			});
+		case 'unknown':
+		default:
+			return new ObjectError(
+				response.code,
+				`Unknown error while loading object${requestedObjectId ? ` ${requestedObjectId}` : ''}`,
+				{
+					cause: response,
+					reason: 'unknown',
+					objectId: requestedObjectId,
+				},
+			);
+	}
+}
+
+function isJsonRpcTransactionNotFound(error: unknown, digest: string): boolean {
+	if (!(error instanceof JsonRpcError) || error.code !== -32602) return false;
+
+	return (
+		error.message === `Invalid Params: Transaction ${digest} not found` ||
+		error.message === `Could not find the referenced transaction [TransactionDigest(${digest})].`
+	);
+}
+
 function parseJsonRpcExecutionStatus(
 	status: JsonRpcExecutionStatus,
 	abortError?: SuiMoveAbort | null,
@@ -159,7 +218,7 @@ export class JSONRpcCoreClient extends CoreClient {
 
 			for (const [idx, object] of objects.entries()) {
 				if (object.error) {
-					results.push(ObjectError.fromResponse(object.error, batch[idx]));
+					results.push(mapJsonRpcObjectError(object.error, batch[idx]));
 				} else {
 					results.push(parseObject(object.data!, options.include));
 				}
@@ -210,7 +269,7 @@ export class JSONRpcCoreClient extends CoreClient {
 		return {
 			objects: objects.data.map((result) => {
 				if (result.error) {
-					throw ObjectError.fromResponse(result.error);
+					throw mapJsonRpcObjectError(result.error);
 				}
 
 				return parseObject(result.data!, options.include);
@@ -282,7 +341,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,
@@ -337,22 +398,29 @@ export class JSONRpcCoreClient extends CoreClient {
 	async getTransaction<Include extends SuiClientTypes.TransactionInclude = {}>(
 		options: SuiClientTypes.GetTransactionOptions<Include>,
 	): Promise<SuiClientTypes.TransactionResult<Include>> {
-		const transaction = await this.#jsonRpcClient.getTransactionBlock({
-			digest: options.digest,
-			options: {
-				// showRawInput is always needed to extract signatures from SenderSignedData
-				showRawInput: true,
-				// showEffects is always needed to get status
-				showEffects: true,
-				showObjectChanges: options.include?.objectTypes ?? false,
-				showRawEffects: options.include?.effects ?? false,
-				showEvents: options.include?.events ?? false,
-				showBalanceChanges: options.include?.balanceChanges ?? false,
-			},
-			signal: options.signal,
-		});
+		try {
+			const transaction = await this.#jsonRpcClient.getTransactionBlock({
+				digest: options.digest,
+				options: {
+					// showRawInput is always needed to extract signatures from SenderSignedData
+					showRawInput: true,
+					// showEffects is always needed to get status
+					showEffects: true,
+					showObjectChanges: options.include?.objectTypes ?? false,
+					showRawEffects: options.include?.effects ?? false,
+					showEvents: options.include?.events ?? false,
+					showBalanceChanges: options.include?.balanceChanges ?? false,
+				},
+				signal: options.signal,
+			});
 
-		return parseTransaction(transaction, options.include);
+			return parseTransaction(transaction, options.include);
+		} catch (error) {
+			if (isJsonRpcTransactionNotFound(error, options.digest)) {
+				throw new TransactionError('notFound', options.digest, { cause: error });
+			}
+			throw error;
+		}
 	}
 	/**
 	 * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient`
@@ -402,7 +470,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 +697,7 @@ export class JSONRpcCoreClient extends CoreClient {
 			parentId: options.parentId,
 			limit: options.limit,
 			cursor: options.cursor,
+			signal: options.signal,
 		});
 
 		return {
@@ -775,6 +846,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 +901,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 +933,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.26.0';