@mysten/sui 2.1.0 → 2.3.0

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/types.ts

@@ -235,6 +235,28 @@ export namespace SuiClientTypes {
 		cursor: string | null;
 	}
 
+	/** Coin metadata methods */
+	export interface TransportMethods {
+		getCoinMetadata: (options: GetCoinMetadataOptions) => Promise<GetCoinMetadataResponse>;
+	}
+
+	export interface GetCoinMetadataOptions extends CoreClientMethodOptions {
+		coinType: string;
+	}
+
+	export interface CoinMetadata {
+		id: string | null;
+		decimals: number;
+		name: string;
+		symbol: string;
+		description: string;
+		iconUrl: string | null;
+	}
+
+	export interface GetCoinMetadataResponse {
+		coinMetadata: CoinMetadata | null;
+	}
+
 	/** Transaction methods */
 	export interface TransportMethods {
 		getTransaction: <Include extends TransactionInclude = {}>(

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/client.ts

@@ -180,6 +180,12 @@ export class SuiGraphQLClient<Queries extends Record<string, GraphQLDocument> =
 		return this.core.listBalances(input);
 	}
 
+	getCoinMetadata(
+		input: SuiClientTypes.GetCoinMetadataOptions,
+	): Promise<SuiClientTypes.GetCoinMetadataResponse> {
+		return this.core.getCoinMetadata(input);
+	}
+
 	getTransaction<Include extends SuiClientTypes.TransactionInclude = {}>(
 		input: SuiClientTypes.GetTransactionOptions<Include>,
 	): Promise<SuiClientTypes.TransactionResult<Include>> {

package/src/graphql/core.ts

@@ -20,6 +20,7 @@ import {
 	GetAllBalancesDocument,
 	GetBalanceDocument,
 	GetChainIdentifierDocument,
+	GetCoinMetadataDocument,
 	GetCoinsDocument,
 	GetCurrentSystemStateDocument,
 	GetDynamicFieldsDocument,
@@ -33,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,
@@ -269,6 +270,36 @@ export class GraphQLCoreClient extends CoreClient {
 			},
 		};
 	}
+	async getCoinMetadata(
+		options: SuiClientTypes.GetCoinMetadataOptions,
+	): Promise<SuiClientTypes.GetCoinMetadataResponse> {
+		const coinType = (await this.mvr.resolveType({ type: options.coinType })).type;
+
+		const { data, errors } = await this.#graphqlClient.query({
+			query: GetCoinMetadataDocument,
+			variables: {
+				coinType,
+			},
+		});
+
+		handleGraphQLErrors(errors);
+
+		if (!data?.coinMetadata) {
+			return { coinMetadata: null };
+		}
+
+		return {
+			coinMetadata: {
+				id: data.coinMetadata.address!,
+				decimals: data.coinMetadata.decimals!,
+				name: data.coinMetadata.name!,
+				symbol: data.coinMetadata.symbol!,
+				description: data.coinMetadata.description!,
+				iconUrl: data.coinMetadata.iconUrl ?? null,
+			},
+		};
+	}
+
 	async listBalances(
 		options: SuiClientTypes.ListBalancesOptions,
 	): Promise<SuiClientTypes.ListBalancesResponse> {
@@ -376,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);
@@ -716,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 =
@@ -935,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

@@ -3587,7 +3587,7 @@ export type Query = {
    * If the address is fetched by name and the name does not resolve to an address (e.g. the name does not exist or has expired), `null` is returned.
    */
   address?: Maybe<Address>;
-  /** First four bytes of the network's genesis checkpoint digest (uniquely identifies the network), hex-encoded. */
+  /** The network's genesis checkpoint digest (uniquely identifies the network), Base58-encoded. */
   chainIdentifier: Scalars['String']['output'];
   /**
    * Fetch a checkpoint by its sequence number, or the latest checkpoint if no sequence number is provided.
@@ -4612,6 +4612,13 @@ export type GetChainIdentifierQueryVariables = Exact<{ [key: string]: never; }>;
 
 export type GetChainIdentifierQuery = { __typename?: 'Query', checkpoint?: { __typename?: 'Checkpoint', digest?: string | null } | null };
 
+export type GetCoinMetadataQueryVariables = Exact<{
+  coinType: Scalars['String']['input'];
+}>;
+
+
+export type GetCoinMetadataQuery = { __typename?: 'Query', coinMetadata?: { __typename?: 'CoinMetadata', address: string, decimals?: number | null, name?: string | null, symbol?: string | null, description?: string | null, iconUrl?: string | null } | null };
+
 export type GetCoinsQueryVariables = Exact<{
   owner: Scalars['SuiAddress']['input'];
   first?: InputMaybe<Scalars['Int']['input']>;
@@ -4788,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'];
@@ -5042,6 +5049,18 @@ export const GetChainIdentifierDocument = new TypedDocumentString(`
   }
 }
     `) as unknown as TypedDocumentString<GetChainIdentifierQuery, GetChainIdentifierQueryVariables>;
+export const GetCoinMetadataDocument = new TypedDocumentString(`
+    query getCoinMetadata($coinType: String!) {
+  coinMetadata(coinType: $coinType) {
+    address
+    decimals
+    name
+    symbol
+    description
+    iconUrl
+  }
+}
+    `) as unknown as TypedDocumentString<GetCoinMetadataQuery, GetCoinMetadataQueryVariables>;
 export const GetCoinsDocument = new TypedDocumentString(`
     query getCoins($owner: SuiAddress!, $first: Int, $cursor: String, $type: String = "0x2::coin::Coin<0x2::sui::SUI>") {
   address(address: $owner) {
@@ -5549,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/getCoinMetadata.graphql

@@ -0,0 +1,13 @@
+# Copyright (c) Mysten Labs, Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+query getCoinMetadata($coinType: String!) {
+	coinMetadata(coinType: $coinType) {
+		address
+		decimals
+		name
+		symbol
+		description
+		iconUrl
+	}
+}

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/client.ts

@@ -108,6 +108,12 @@ export class SuiGrpcClient extends BaseClient implements SuiClientTypes.Transpor
 		return this.core.listBalances(input);
 	}
 
+	getCoinMetadata(
+		input: SuiClientTypes.GetCoinMetadataOptions,
+	): Promise<SuiClientTypes.GetCoinMetadataResponse> {
+		return this.core.getCoinMetadata(input);
+	}
+
 	getTransaction<Include extends SuiClientTypes.TransactionInclude = {}>(
 		input: SuiClientTypes.GetTransactionOptions<Include>,
 	): Promise<SuiClientTypes.TransactionResult<Include>> {

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';
@@ -235,6 +235,36 @@ export class GrpcCoreClient extends CoreClient {
 		};
 	}
 
+	async getCoinMetadata(
+		options: SuiClientTypes.GetCoinMetadataOptions,
+	): Promise<SuiClientTypes.GetCoinMetadataResponse> {
+		const coinType = (await this.mvr.resolveType({ type: options.coinType })).type;
+
+		let response;
+		try {
+			({ response } = await this.#client.stateService.getCoinInfo({
+				coinType,
+			}));
+		} catch {
+			return { coinMetadata: null };
+		}
+
+		if (!response.metadata) {
+			return { coinMetadata: null };
+		}
+
+		return {
+			coinMetadata: {
+				id: response.metadata.id ?? null,
+				decimals: response.metadata.decimals ?? 0,
+				name: response.metadata.name ?? '',
+				symbol: response.metadata.symbol ?? '',
+				description: response.metadata.description ?? '',
+				iconUrl: response.metadata.iconUrl ?? null,
+			},
+		};
+	}
+
 	async listBalances(
 		options: SuiClientTypes.ListBalancesOptions,
 	): Promise<SuiClientTypes.ListBalancesResponse> {
@@ -703,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',
 						],
 					},
 				});
@@ -717,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/jsonRpc/core.ts

@@ -239,6 +239,32 @@ export class JSONRpcCoreClient extends CoreClient {
 			},
 		};
 	}
+	async getCoinMetadata(
+		options: SuiClientTypes.GetCoinMetadataOptions,
+	): Promise<SuiClientTypes.GetCoinMetadataResponse> {
+		const coinType = (await this.mvr.resolveType({ type: options.coinType })).type;
+
+		const result = await this.#jsonRpcClient.getCoinMetadata({
+			coinType,
+			signal: options.signal,
+		});
+
+		if (!result) {
+			return { coinMetadata: null };
+		}
+
+		return {
+			coinMetadata: {
+				id: result.id ?? null,
+				decimals: result.decimals,
+				name: result.name,
+				symbol: result.symbol,
+				description: result.description,
+				iconUrl: result.iconUrl ?? null,
+			},
+		};
+	}
+
 	async listBalances(options: SuiClientTypes.ListBalancesOptions) {
 		const balances = await this.#jsonRpcClient.getAllBalances({
 			owner: options.owner,

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