@mysten/sui 2.2.0 → 2.3.0

package/dist/zklogin/bcs.d.mts

@@ -1,31 +1,31 @@
-import * as _mysten_bcs1118 from "@mysten/bcs";
+import * as _mysten_bcs1111 from "@mysten/bcs";
 import { InferBcsInput } from "@mysten/bcs";
 
 //#region src/zklogin/bcs.d.ts
-declare const zkLoginSignature: _mysten_bcs1118.BcsStruct<{
-  inputs: _mysten_bcs1118.BcsStruct<{
-    proofPoints: _mysten_bcs1118.BcsStruct<{
-      a: _mysten_bcs1118.BcsType<string[], Iterable<string> & {
+declare const zkLoginSignature: _mysten_bcs1111.BcsStruct<{
+  inputs: _mysten_bcs1111.BcsStruct<{
+    proofPoints: _mysten_bcs1111.BcsStruct<{
+      a: _mysten_bcs1111.BcsType<string[], Iterable<string> & {
         length: number;
       }, string>;
-      b: _mysten_bcs1118.BcsType<string[][], Iterable<Iterable<string> & {
+      b: _mysten_bcs1111.BcsType<string[][], Iterable<Iterable<string> & {
         length: number;
       }> & {
         length: number;
       }, string>;
-      c: _mysten_bcs1118.BcsType<string[], Iterable<string> & {
+      c: _mysten_bcs1111.BcsType<string[], Iterable<string> & {
         length: number;
       }, string>;
     }, string>;
-    issBase64Details: _mysten_bcs1118.BcsStruct<{
-      value: _mysten_bcs1118.BcsType<string, string, "string">;
-      indexMod4: _mysten_bcs1118.BcsType<number, number, "u8">;
+    issBase64Details: _mysten_bcs1111.BcsStruct<{
+      value: _mysten_bcs1111.BcsType<string, string, "string">;
+      indexMod4: _mysten_bcs1111.BcsType<number, number, "u8">;
     }, string>;
-    headerBase64: _mysten_bcs1118.BcsType<string, string, "string">;
-    addressSeed: _mysten_bcs1118.BcsType<string, string, "string">;
+    headerBase64: _mysten_bcs1111.BcsType<string, string, "string">;
+    addressSeed: _mysten_bcs1111.BcsType<string, string, "string">;
   }, string>;
-  maxEpoch: _mysten_bcs1118.BcsType<string, string | number | bigint, "u64">;
-  userSignature: _mysten_bcs1118.BcsType<Uint8Array<ArrayBufferLike>, Iterable<number>, "vector<u8>">;
+  maxEpoch: _mysten_bcs1111.BcsType<string, string | number | bigint, "u64">;
+  userSignature: _mysten_bcs1111.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.2.0",
+  "version": "2.3.0",
   "license": "Apache-2.0",
   "sideEffects": false,
   "files": [
@@ -151,8 +151,8 @@
     "graphql": "^16.12.0",
     "poseidon-lite": "0.2.1",
     "valibot": "^1.2.0",
-    "@mysten/utils": "^0.3.0",
-    "@mysten/bcs": "^2.0.1"
+    "@mysten/bcs": "^2.0.1",
+    "@mysten/utils": "^0.3.0"
   },
   "scripts": {
     "clean": "rm -rf tsconfig.tsbuildinfo ./dist",

package/src/client/client.ts

@@ -35,12 +35,15 @@ export abstract class BaseClient {
 		const methodCache = new Map<string | symbol, Function>();
 
 		return new Proxy(this, {
-			get(target, prop) {
+			get(target, prop, receiver) {
 				if (typeof prop === 'string' && prop in extensions) {
 					return extensions[prop];
 				}
-				const value = Reflect.get(target, prop, target);
+				const value = Reflect.get(target, prop, receiver);
 				if (typeof value === 'function') {
+					if (prop === '$extend') {
+						return value.bind(receiver);
+					}
 					if (!methodCache.has(prop)) {
 						methodCache.set(prop, value.bind(target));
 					}

package/src/client/core-resolver.ts

@@ -8,6 +8,7 @@ import type { ClientWithCoreApi } from './core.js';
 import { ObjectRefSchema } from '../transactions/data/internal.js';
 import type { CallArg, Command } from '../transactions/data/internal.js';
 import type { SuiClientTypes } from './types.js';
+import { SimulationError } from './errors.js';
 import { Inputs } from '../transactions/Inputs.js';
 import { getPureBcsSchema, isTxContext } from '../transactions/serializer.js';
 import type { TransactionDataBuilder } from '../transactions/TransactionData.js';
@@ -87,13 +88,12 @@ async function setGasBudget(transactionData: TransactionDataBuilder, client: Cli
 	});
 
 	if (simulateResult.$kind === 'FailedTransaction') {
-		const errorMessage = simulateResult.FailedTransaction.status.error?.message ?? 'Unknown error';
-		throw new Error(
-			`Simulation failed, could not automatically determine a budget: ${errorMessage}`,
-			{
-				cause: simulateResult,
-			},
-		);
+		const executionError = simulateResult.FailedTransaction.status.error ?? undefined;
+		const errorMessage = executionError?.message ?? 'Unknown error';
+		throw new SimulationError(`Transaction resolution failed: ${errorMessage}`, {
+			cause: simulateResult,
+			executionError,
+		});
 	}
 
 	const gasUsed = simulateResult.Transaction.effects!.gasUsed;

package/src/client/errors.ts

@@ -2,9 +2,22 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { ObjectResponseError } from '../jsonRpc/index.js';
+import type { SuiClientTypes } from './types.js';
 
 export class SuiClientError extends Error {}
 
+export class SimulationError extends SuiClientError {
+	executionError?: SuiClientTypes.ExecutionError;
+
+	constructor(
+		message: string,
+		options?: { cause?: unknown; executionError?: SuiClientTypes.ExecutionError },
+	) {
+		super(message, { cause: options?.cause });
+		this.executionError = options?.executionError;
+	}
+}
+
 export class ObjectError extends SuiClientError {
 	code: string;
 

package/src/client/index.ts

@@ -22,5 +22,7 @@ export {
 	type ClientWithCoreApi,
 };
 
+export { SimulationError } from './errors.js';
+
 export { ClientCache, type ClientCacheOptions } from './cache.js';
 export { type NamedPackagesOverrides } from './mvr.js';

package/src/client/utils.ts

@@ -39,13 +39,24 @@ export function formatMoveAbortMessage(options: {
 	const parts: string[] = [];
 
 	if (command != null) {
-		parts.push(`Error in ${formatOrdinal(command + 1)} command`);
+		parts.push(`MoveAbort in ${formatOrdinal(command + 1)} command`);
+	} else {
+		parts.push('MoveAbort');
+	}
+
+	if (cleverError?.constantName) {
+		const errorStr = cleverError!.value
+			? `'${cleverError!.constantName}': ${cleverError!.value}`
+			: `'${cleverError!.constantName}'`;
+		parts.push(errorStr);
+	} else {
+		parts.push(`abort code: ${abortCode}`);
 	}
 
 	if (location?.package && location?.module) {
 		const pkg = location.package.startsWith('0x') ? location.package : `0x${location.package}`;
 		const locationParts = [pkg, location.module, location.functionName].filter(Boolean);
-		const locationStr = [`from '${locationParts.join('::')}'`];
+		const locationStr = [`in '${locationParts.join('::')}'`];
 
 		if (cleverError?.lineNumber != null) {
 			locationStr.push(`(line ${cleverError.lineNumber})`);
@@ -56,15 +67,6 @@ export function formatMoveAbortMessage(options: {
 		parts.push(locationStr.join(' '));
 	}
 
-	if (cleverError?.constantName) {
-		const abortStr = cleverError.value
-			? `abort '${cleverError.constantName}': ${cleverError.value}`
-			: `abort '${cleverError.constantName}'`;
-		parts.push(abortStr);
-	} else {
-		parts.push(`abort code: ${abortCode}`);
-	}
-
 	return parts.join(', ');
 }
 
@@ -118,19 +120,24 @@ function parseBcsExecutionError(failure: {
 	switch (error.$kind) {
 		case 'MoveAbort': {
 			const [location, abortCode] = error.MoveAbort;
+			const moveLocation = {
+				package: location.module.address,
+				module: location.module.name,
+				function: location.function,
+				functionName: location.functionName ?? undefined,
+				instruction: location.instruction,
+			};
 			return {
 				$kind: 'MoveAbort',
-				message: formatErrorMessage('MoveAbort', error.MoveAbort),
+				message: formatMoveAbortMessage({
+					command,
+					location: moveLocation,
+					abortCode: String(abortCode),
+				}),
 				command,
 				MoveAbort: {
 					abortCode: String(abortCode),
-					location: {
-						package: location.module.address,
-						module: location.module.name,
-						function: location.function,
-						functionName: location.functionName ?? undefined,
-						instruction: location.instruction,
-					},
+					location: moveLocation,
 				},
 			};
 		}

package/src/graphql/core.ts

@@ -34,11 +34,11 @@ import {
 	VerifyZkLoginSignatureDocument,
 	ZkLoginIntentScope,
 } from './generated/queries.js';
-import { ObjectError } from '../client/errors.js';
+import { ObjectError, SimulationError } from '../client/errors.js';
 import { chunk, fromBase64, toBase64 } from '@mysten/utils';
 import { normalizeStructTag, normalizeSuiAddress } from '../utils/sui-types.js';
 import { deriveDynamicFieldID } from '../utils/dynamic-fields.js';
-import { parseTransactionEffectsBcs } from '../client/utils.js';
+import { formatMoveAbortMessage, parseTransactionEffectsBcs } from '../client/utils.js';
 import type { OpenMoveTypeSignatureBody, OpenMoveTypeSignature } from './types.js';
 import {
 	transactionDataToGrpcTransaction,
@@ -407,8 +407,8 @@ export class GraphQLCoreClient extends CoreClient {
 			(result) => result.simulateTransaction,
 		);
 
-		if (result.error) {
-			throw new Error(result.error);
+		if (result.error && !result.effects?.transaction) {
+			throw new SimulationError(result.error);
 		}
 
 		const transactionResult = parseTransaction(result.effects?.transaction!, options.include);
@@ -747,14 +747,27 @@ export class GraphQLCoreClient extends CoreClient {
 				query: ResolveTransactionDocument,
 				variables: {
 					transaction: transactionJson,
-					doGasSelection: !options.onlyTransactionKind,
+					doGasSelection:
+						!options.onlyTransactionKind &&
+						(snapshot.gasData.budget == null || snapshot.gasData.payment == null),
 				},
 			});
 
 			handleGraphQLErrors(errors);
 
 			if (data?.simulateTransaction?.error) {
-				throw new Error(`Transaction resolution failed: ${data.simulateTransaction.error}`);
+				throw new SimulationError(
+					`Transaction resolution failed: ${data.simulateTransaction.error}`,
+				);
+			}
+
+			const transactionEffects = data?.simulateTransaction?.effects?.transaction?.effects;
+			if (!options.onlyTransactionKind && transactionEffects?.status === ExecutionStatus.Failure) {
+				const executionError = parseGraphQLExecutionError(transactionEffects.executionError);
+				const errorMessage = executionError?.message ?? 'Transaction failed';
+				throw new SimulationError(`Transaction resolution failed: ${errorMessage}`, {
+					executionError,
+				});
 			}
 
 			const resolvedTransactionBcs =
@@ -966,24 +979,47 @@ function parseNormalizedSuiMoveType(type: OpenMoveTypeSignature): SuiClientTypes
 function parseGraphQLExecutionError(
 	executionError: GraphQLExecutionError | null | undefined,
 ): SuiClientTypes.ExecutionError {
-	const message = executionError?.message ?? 'Transaction failed';
 	const name = mapGraphQLExecutionErrorKind(executionError);
 
 	if (name === 'MoveAbort' && executionError?.abortCode != null) {
+		const location = parseGraphQLMoveLocation(executionError);
+		const cleverError = parseGraphQLCleverError(executionError);
+		const commandMatch = executionError.message?.match(/in (\d+)\w* command/);
+		const command = commandMatch ? parseInt(commandMatch[1], 10) - 1 : undefined;
+
 		return {
 			$kind: 'MoveAbort',
-			message,
+			message: formatMoveAbortMessage({
+				command,
+				location: location
+					? {
+							package: location.package,
+							module: location.module,
+							functionName: location.functionName,
+							instruction: location.instruction,
+						}
+					: undefined,
+				abortCode: executionError.abortCode!,
+				cleverError: cleverError
+					? {
+							lineNumber: cleverError.lineNumber,
+							constantName: cleverError.constantName,
+							value: cleverError.value,
+						}
+					: undefined,
+			}),
+			command,
 			MoveAbort: {
 				abortCode: executionError.abortCode!,
-				location: parseGraphQLMoveLocation(executionError),
-				cleverError: parseGraphQLCleverError(executionError),
+				location,
+				cleverError,
 			},
 		};
 	}
 
 	return {
 		$kind: 'Unknown',
-		message,
+		message: executionError?.message ?? 'Transaction failed',
 		Unknown: null,
 	};
 }

package/src/graphql/generated/queries.ts

@@ -4795,7 +4795,7 @@ export type ResolveTransactionQueryVariables = Exact<{
 }>;
 
 
-export type ResolveTransactionQuery = { __typename?: 'Query', simulateTransaction: { __typename?: 'SimulationResult', error?: string | null, effects?: { __typename?: 'TransactionEffects', transaction?: { __typename?: 'Transaction', transactionBcs?: string | null } | null } | null } };
+export type ResolveTransactionQuery = { __typename?: 'Query', simulateTransaction: { __typename?: 'SimulationResult', error?: string | null, effects?: { __typename?: 'TransactionEffects', transaction?: { __typename?: 'Transaction', transactionBcs?: string | null, effects?: { __typename?: 'TransactionEffects', status?: ExecutionStatus | null, executionError?: { __typename?: 'ExecutionError', message: string, abortCode?: string | null, identifier?: string | null, constant?: string | null, sourceLineNumber?: number | null, instructionOffset?: number | null, module?: { __typename?: 'MoveModule', name: string, package?: { __typename?: 'MovePackage', address: string } | null } | null, function?: { __typename?: 'MoveFunction', name: string } | null } | null } | null } | null } | null } };
 
 export type VerifyZkLoginSignatureQueryVariables = Exact<{
   bytes: Scalars['Base64']['input'];
@@ -5568,6 +5568,26 @@ export const ResolveTransactionDocument = new TypedDocumentString(`
     effects {
       transaction {
         transactionBcs
+        effects {
+          status
+          executionError {
+            message
+            abortCode
+            identifier
+            constant
+            sourceLineNumber
+            instructionOffset
+            module {
+              name
+              package {
+                address
+              }
+            }
+            function {
+              name
+            }
+          }
+        }
       }
     }
   }

package/src/graphql/queries/transactions.graphql

@@ -150,6 +150,26 @@ query resolveTransaction($transaction: JSON!, $doGasSelection: Boolean = true) {
 		effects {
 			transaction {
 				transactionBcs
+				effects {
+					status
+					executionError {
+						message
+						abortCode
+						identifier
+						constant
+						sourceLineNumber
+						instructionOffset
+						module {
+							name
+							package {
+								address
+							}
+						}
+						function {
+							name
+						}
+					}
+				}
 			}
 		}
 	}

package/src/grpc/core.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { CoreClientOptions, SuiClientTypes } from '../client/index.js';
-import { CoreClient, formatMoveAbortMessage } from '../client/index.js';
+import { CoreClient, formatMoveAbortMessage, SimulationError } from '../client/index.js';
 import type { SuiGrpcClient } from './client.js';
 import type { Owner } from './proto/sui/rpc/v2/owner.js';
 import { Owner_OwnerKind } from './proto/sui/rpc/v2/owner.js';
@@ -733,13 +733,16 @@ export class GrpcCoreClient extends CoreClient {
 			try {
 				const result = await client.transactionExecutionService.simulateTransaction({
 					transaction: grpcTransaction,
-					doGasSelection: !options.onlyTransactionKind,
+					doGasSelection:
+						!options.onlyTransactionKind &&
+						(snapshot.gasData.budget == null || snapshot.gasData.payment == null),
 					readMask: {
 						paths: [
 							'transaction.transaction.sender',
 							'transaction.transaction.gas_payment',
 							'transaction.transaction.expiration',
 							'transaction.transaction.kind',
+							'transaction.effects.status',
 						],
 					},
 				});
@@ -747,12 +750,25 @@ export class GrpcCoreClient extends CoreClient {
 			} catch (error) {
 				// https://github.com/timostamm/protobuf-ts/pull/739
 				if (error instanceof Error && error.message) {
-					const decodedMessage = decodeURIComponent(error.message);
-					throw new Error(decodedMessage, { cause: error });
+					throw new SimulationError(decodeURIComponent(error.message), { cause: error });
 				}
 				throw error;
 			}
 
+			if (
+				!options.onlyTransactionKind &&
+				response.transaction?.effects?.status &&
+				!response.transaction.effects.status.success
+			) {
+				const executionError = response.transaction.effects.status.error
+					? parseGrpcExecutionError(response.transaction.effects.status.error)
+					: undefined;
+				const errorMessage = executionError?.message ?? 'Transaction failed';
+				throw new SimulationError(`Transaction resolution failed: ${errorMessage}`, {
+					executionError,
+				});
+			}
+
 			if (!response.transaction?.transaction) {
 				throw new Error('simulateTransaction did not return resolved transaction data');
 			}

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.2.0';
+export const PACKAGE_VERSION = '2.3.0';
 export const TARGETED_RPC_VERSION = '1.66.0';