@mysten/sui 1.45.2 → 2.0.1

package/src/client/utils.ts

@@ -0,0 +1,540 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import { toBase64 } from '@mysten/utils';
+
+import { bcs } from '../bcs/index.js';
+import { ExecutionStatus } from '../bcs/effects.js';
+import { TransactionDataBuilder } from '../transactions/TransactionData.js';
+import type { SuiClientTypes } from './types.js';
+
+const ordinalRules = new Intl.PluralRules('en-US', { type: 'ordinal' });
+const ordinalSuffixes = new Map([
+	['one', 'st'],
+	['two', 'nd'],
+	['few', 'rd'],
+	['other', 'th'],
+]);
+
+export function formatOrdinal(n: number): string {
+	return `${n}${ordinalSuffixes.get(ordinalRules.select(n))}`;
+}
+
+export function formatMoveAbortMessage(options: {
+	command?: number;
+	location?: {
+		package?: string;
+		module?: string;
+		functionName?: string;
+		instruction?: number;
+	};
+	abortCode: string;
+	cleverError?: {
+		lineNumber?: number;
+		constantName?: string;
+		value?: string;
+	};
+}): string {
+	const { command, location, abortCode, cleverError } = options;
+	const parts: string[] = [];
+
+	if (command != null) {
+		parts.push(`Error in ${formatOrdinal(command + 1)} command`);
+	}
+
+	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('::')}'`];
+
+		if (cleverError?.lineNumber != null) {
+			locationStr.push(`(line ${cleverError.lineNumber})`);
+		} else if (location.instruction != null) {
+			locationStr.push(`(instruction ${location.instruction})`);
+		}
+
+		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(', ');
+}
+
+// Minimal BCS types for extracting just the status from transaction effects.
+// BCS fields are read sequentially, so we only need to define fields up to and including status.
+// This avoids parsing the entire effects structure when we only need success/failure.
+
+// First, try with the full ExecutionStatus to get detailed error info
+const MinimalEffectsWithError = bcs.struct('MinimalEffectsWithError', {
+	status: ExecutionStatus,
+});
+
+const MinimalTransactionEffectsWithError = bcs.enum('MinimalTransactionEffectsWithError', {
+	V1: MinimalEffectsWithError,
+	V2: MinimalEffectsWithError,
+});
+
+// Fallback version that doesn't parse error details - used when ExecutionFailureStatus has unknown variants
+const MinimalExecutionStatusNoError = bcs.enum('MinimalExecutionStatusNoError', {
+	Success: null,
+	Failed: null, // Don't parse the error structure
+});
+
+const MinimalEffectsNoError = bcs.struct('MinimalEffectsNoError', {
+	status: MinimalExecutionStatusNoError,
+});
+
+const MinimalTransactionEffectsNoError = bcs.enum('MinimalTransactionEffectsNoError', {
+	V1: MinimalEffectsNoError,
+	V2: MinimalEffectsNoError,
+});
+
+type BcsExecutionFailureStatus = NonNullable<
+	(typeof ExecutionStatus.$inferType)['Failure']
+>['error'];
+
+function formatErrorMessage($kind: string, data: unknown): string {
+	if (data !== null && data !== undefined && typeof data !== 'boolean') {
+		return `${$kind}(${JSON.stringify(data, (_key, value) => (typeof value === 'bigint' ? value.toString() : value))})`;
+	}
+	return $kind;
+}
+
+function parseBcsExecutionError(failure: {
+	error: BcsExecutionFailureStatus;
+	command: string | null;
+}): SuiClientTypes.ExecutionError {
+	const error = failure.error;
+	const command = failure.command != null ? Number(failure.command) : undefined;
+
+	switch (error.$kind) {
+		case 'MoveAbort': {
+			const [location, abortCode] = error.MoveAbort;
+			return {
+				$kind: 'MoveAbort',
+				message: formatErrorMessage('MoveAbort', error.MoveAbort),
+				command,
+				MoveAbort: {
+					abortCode: String(abortCode),
+					location: {
+						package: location.module.address,
+						module: location.module.name,
+						function: location.function,
+						functionName: location.functionName ?? undefined,
+						instruction: location.instruction,
+					},
+				},
+			};
+		}
+
+		case 'MoveObjectTooBig':
+			return {
+				$kind: 'SizeError',
+				message: formatErrorMessage('MoveObjectTooBig', error.MoveObjectTooBig),
+				command,
+				SizeError: {
+					name: 'ObjectTooBig',
+					size: Number(error.MoveObjectTooBig.objectSize),
+					maxSize: Number(error.MoveObjectTooBig.maxObjectSize),
+				},
+			};
+
+		case 'MovePackageTooBig':
+			return {
+				$kind: 'SizeError',
+				message: formatErrorMessage('MovePackageTooBig', error.MovePackageTooBig),
+				command,
+				SizeError: {
+					name: 'PackageTooBig',
+					size: Number(error.MovePackageTooBig.objectSize),
+					maxSize: Number(error.MovePackageTooBig.maxObjectSize),
+				},
+			};
+
+		case 'EffectsTooLarge':
+			return {
+				$kind: 'SizeError',
+				message: formatErrorMessage('EffectsTooLarge', error.EffectsTooLarge),
+				command,
+				SizeError: {
+					name: 'EffectsTooLarge',
+					size: Number(error.EffectsTooLarge.currentSize),
+					maxSize: Number(error.EffectsTooLarge.maxSize),
+				},
+			};
+
+		case 'WrittenObjectsTooLarge':
+			return {
+				$kind: 'SizeError',
+				message: formatErrorMessage('WrittenObjectsTooLarge', error.WrittenObjectsTooLarge),
+				command,
+				SizeError: {
+					name: 'WrittenObjectsTooLarge',
+					size: Number(error.WrittenObjectsTooLarge.currentSize),
+					maxSize: Number(error.WrittenObjectsTooLarge.maxSize),
+				},
+			};
+
+		case 'MoveVectorElemTooBig':
+			return {
+				$kind: 'SizeError',
+				message: formatErrorMessage('MoveVectorElemTooBig', error.MoveVectorElemTooBig),
+				command,
+				SizeError: {
+					name: 'MoveVectorElemTooBig',
+					size: Number(error.MoveVectorElemTooBig.valueSize),
+					maxSize: Number(error.MoveVectorElemTooBig.maxScaledSize),
+				},
+			};
+
+		case 'MoveRawValueTooBig':
+			return {
+				$kind: 'SizeError',
+				message: formatErrorMessage('MoveRawValueTooBig', error.MoveRawValueTooBig),
+				command,
+				SizeError: {
+					name: 'MoveRawValueTooBig',
+					size: Number(error.MoveRawValueTooBig.valueSize),
+					maxSize: Number(error.MoveRawValueTooBig.maxScaledSize),
+				},
+			};
+
+		case 'CommandArgumentError':
+			return {
+				$kind: 'CommandArgumentError',
+				message: formatErrorMessage('CommandArgumentError', error.CommandArgumentError),
+				command,
+				CommandArgumentError: {
+					argument: error.CommandArgumentError.argIdx,
+					name: error.CommandArgumentError.kind.$kind,
+				},
+			};
+
+		case 'TypeArgumentError':
+			return {
+				$kind: 'TypeArgumentError',
+				message: formatErrorMessage('TypeArgumentError', error.TypeArgumentError),
+				command,
+				TypeArgumentError: {
+					typeArgument: error.TypeArgumentError.argumentIdx,
+					name: error.TypeArgumentError.kind.$kind,
+				},
+			};
+
+		case 'PackageUpgradeError': {
+			const upgradeError = error.PackageUpgradeError.upgradeError;
+			return {
+				$kind: 'PackageUpgradeError',
+				message: formatErrorMessage('PackageUpgradeError', error.PackageUpgradeError),
+				command,
+				PackageUpgradeError: {
+					name: upgradeError.$kind,
+					packageId:
+						upgradeError.$kind === 'UnableToFetchPackage'
+							? upgradeError.UnableToFetchPackage.packageId
+							: undefined,
+					digest:
+						upgradeError.$kind === 'DigestDoesNotMatch'
+							? toBase64(upgradeError.DigestDoesNotMatch.digest)
+							: undefined,
+				},
+			};
+		}
+
+		case 'ExecutionCancelledDueToSharedObjectCongestion':
+			return {
+				$kind: 'CongestedObjects',
+				message: formatErrorMessage(
+					'ExecutionCancelledDueToSharedObjectCongestion',
+					error.ExecutionCancelledDueToSharedObjectCongestion,
+				),
+				command,
+				CongestedObjects: {
+					name: 'ExecutionCanceledDueToConsensusObjectCongestion',
+					objects: error.ExecutionCancelledDueToSharedObjectCongestion.congested_objects,
+				},
+			};
+
+		case 'AddressDeniedForCoin':
+			return {
+				$kind: 'CoinDenyListError',
+				message: formatErrorMessage('AddressDeniedForCoin', error.AddressDeniedForCoin),
+				command,
+				CoinDenyListError: {
+					name: 'AddressDeniedForCoin',
+					address: error.AddressDeniedForCoin.address,
+					coinType: error.AddressDeniedForCoin.coinType,
+				},
+			};
+
+		case 'CoinTypeGlobalPause':
+			return {
+				$kind: 'CoinDenyListError',
+				message: formatErrorMessage('CoinTypeGlobalPause', error.CoinTypeGlobalPause),
+				command,
+				CoinDenyListError: {
+					name: 'CoinTypeGlobalPause',
+					coinType: error.CoinTypeGlobalPause.coinType,
+				},
+			};
+
+		case 'CircularObjectOwnership':
+			return {
+				$kind: 'ObjectIdError',
+				message: formatErrorMessage('CircularObjectOwnership', error.CircularObjectOwnership),
+				command,
+				ObjectIdError: {
+					name: 'CircularObjectOwnership',
+					objectId: error.CircularObjectOwnership.object,
+				},
+			};
+
+		case 'InvalidGasObject':
+			return {
+				$kind: 'ObjectIdError',
+				message: 'InvalidGasObject',
+				command,
+				ObjectIdError: {
+					name: 'InvalidGasObject',
+					objectId: '',
+				},
+			};
+
+		case 'InputObjectDeleted':
+			return {
+				$kind: 'ObjectIdError',
+				message: 'InputObjectDeleted',
+				command,
+				ObjectIdError: {
+					name: 'InputObjectDeleted',
+					objectId: '',
+				},
+			};
+
+		case 'InvalidTransferObject':
+			return {
+				$kind: 'ObjectIdError',
+				message: 'InvalidTransferObject',
+				command,
+				ObjectIdError: {
+					name: 'InvalidTransferObject',
+					objectId: '',
+				},
+			};
+
+		case 'NonExclusiveWriteInputObjectModified':
+			return {
+				$kind: 'Unknown',
+				message: formatErrorMessage(
+					'NonExclusiveWriteInputObjectModified',
+					error.NonExclusiveWriteInputObjectModified,
+				),
+				command,
+				Unknown: null,
+			};
+
+		case 'InsufficientGas':
+		case 'InvariantViolation':
+		case 'FeatureNotYetSupported':
+		case 'InsufficientCoinBalance':
+		case 'CoinBalanceOverflow':
+		case 'PublishErrorNonZeroAddress':
+		case 'SuiMoveVerificationError':
+		case 'MovePrimitiveRuntimeError':
+		case 'VMVerificationOrDeserializationError':
+		case 'VMInvariantViolation':
+		case 'FunctionNotFound':
+		case 'ArityMismatch':
+		case 'TypeArityMismatch':
+		case 'NonEntryFunctionInvoked':
+		case 'UnusedValueWithoutDrop':
+		case 'InvalidPublicFunctionReturnType':
+		case 'PublishUpgradeMissingDependency':
+		case 'PublishUpgradeDependencyDowngrade':
+		case 'CertificateDenied':
+		case 'SuiMoveVerificationTimedout':
+		case 'SharedObjectOperationNotAllowed':
+		case 'ExecutionCancelledDueToRandomnessUnavailable':
+		case 'InvalidLinkage':
+		case 'InsufficientBalanceForWithdraw':
+			return {
+				$kind: 'Unknown',
+				message: error.$kind,
+				command,
+				Unknown: null,
+			};
+
+		default:
+			error satisfies never;
+			return {
+				$kind: 'Unknown',
+				message: 'Unknown error',
+				command,
+				Unknown: null,
+			};
+	}
+}
+
+export function parseTransactionBcs(
+	bytes: Uint8Array,
+	onlyTransactionKind = false,
+): SuiClientTypes.TransactionData {
+	return (
+		onlyTransactionKind
+			? TransactionDataBuilder.fromKindBytes(bytes)
+			: TransactionDataBuilder.fromBytes(bytes)
+	).snapshot();
+}
+
+/**
+ * Extracts just the status from transaction effects BCS without fully parsing.
+ * This is optimized for cases where we only need the status (success/failure)
+ * without parsing the entire effects structure.
+ *
+ * Uses a minimal BCS struct that only parses fields up to and including status,
+ * since BCS fields are read sequentially. First tries to parse with full error details,
+ * then falls back to a version without error parsing if the error enum has unknown variants.
+ *
+ * For errors with data, serializes the error as JSON to preserve all information.
+ */
+export function extractStatusFromEffectsBcs(
+	effectsBytes: Uint8Array,
+): SuiClientTypes.ExecutionStatus {
+	// First try parsing with full error details
+	let parsed: ReturnType<typeof MinimalTransactionEffectsWithError.parse> | null = null;
+	try {
+		parsed = MinimalTransactionEffectsWithError.parse(effectsBytes);
+	} catch {
+		// Fall back to parsing without error details if the error enum has unknown variants
+		const parsedNoError = MinimalTransactionEffectsNoError.parse(effectsBytes);
+		const status = (parsedNoError.V1 ?? parsedNoError.V2)!.status;
+
+		if (status.$kind === 'Success') {
+			return { success: true, error: null };
+		}
+
+		return {
+			success: false,
+			error: {
+				$kind: 'Unknown',
+				message: 'ExecutionFailed',
+				Unknown: null,
+			},
+		};
+	}
+
+	const status = (parsed.V1 ?? parsed.V2)!.status;
+
+	if (status.$kind === 'Success') {
+		return { success: true, error: null };
+	}
+
+	return {
+		success: false,
+		error: parseBcsExecutionError(status.Failure),
+	};
+}
+
+export function parseTransactionEffectsBcs(effects: Uint8Array): SuiClientTypes.TransactionEffects {
+	const parsed = bcs.TransactionEffects.parse(effects);
+
+	switch (parsed.$kind) {
+		case 'V1':
+			return parseTransactionEffectsV1({ bytes: effects, effects: parsed.V1 });
+		case 'V2':
+			return parseTransactionEffectsV2({ bytes: effects, effects: parsed.V2 });
+		default:
+			throw new Error(
+				`Unknown transaction effects version: ${(parsed as { $kind: string }).$kind}`,
+			);
+	}
+}
+
+function parseTransactionEffectsV1(_: {
+	bytes: Uint8Array;
+	effects: NonNullable<(typeof bcs.TransactionEffects.$inferType)['V1']>;
+}): SuiClientTypes.TransactionEffects {
+	throw new Error('V1 effects are not supported yet');
+}
+
+function parseTransactionEffectsV2({
+	bytes,
+	effects,
+}: {
+	bytes: Uint8Array;
+	effects: NonNullable<(typeof bcs.TransactionEffects.$inferType)['V2']>;
+}): SuiClientTypes.TransactionEffects {
+	const changedObjects = effects.changedObjects.map(
+		([id, change]): SuiClientTypes.ChangedObject => {
+			return {
+				objectId: id,
+				inputState: change.inputState.$kind === 'Exist' ? 'Exists' : 'DoesNotExist',
+				inputVersion: change.inputState.Exist?.[0][0] ?? null,
+				inputDigest: change.inputState.Exist?.[0][1] ?? null,
+				inputOwner: change.inputState.Exist?.[1] ?? null,
+				outputState:
+					change.outputState.$kind === 'NotExist' ? 'DoesNotExist' : change.outputState.$kind,
+				outputVersion:
+					change.outputState.$kind === 'PackageWrite'
+						? change.outputState.PackageWrite?.[0]
+						: change.outputState.$kind === 'ObjectWrite'
+							? effects.lamportVersion
+							: null,
+				outputDigest:
+					change.outputState.$kind === 'PackageWrite'
+						? change.outputState.PackageWrite?.[1]
+						: change.outputState.$kind === 'ObjectWrite'
+							? (change.outputState.ObjectWrite?.[0] ?? null)
+							: null,
+				outputOwner:
+					change.outputState.$kind === 'ObjectWrite' ? change.outputState.ObjectWrite[1] : null,
+				idOperation: change.idOperation.$kind,
+			};
+		},
+	);
+
+	return {
+		bcs: bytes,
+		version: 2,
+		status:
+			effects.status.$kind === 'Success'
+				? {
+						success: true,
+						error: null,
+					}
+				: {
+						success: false,
+						error: parseBcsExecutionError(effects.status.Failure),
+					},
+		gasUsed: effects.gasUsed,
+		transactionDigest: effects.transactionDigest,
+		gasObject:
+			effects.gasObjectIndex === null ? null : (changedObjects[effects.gasObjectIndex] ?? null),
+		eventsDigest: effects.eventsDigest,
+		dependencies: effects.dependencies,
+		lamportVersion: effects.lamportVersion,
+		changedObjects,
+		unchangedConsensusObjects: effects.unchangedConsensusObjects.map(
+			([objectId, object]): SuiClientTypes.UnchangedConsensusObject => {
+				return {
+					kind: object.$kind,
+					objectId: objectId,
+					version:
+						object.$kind === 'ReadOnlyRoot'
+							? object.ReadOnlyRoot[0]
+							: (object[object.$kind] as string | null),
+					digest: object.$kind === 'ReadOnlyRoot' ? object.ReadOnlyRoot[1] : null,
+				};
+			},
+		),
+		auxiliaryDataDigest: effects.auxDataDigest,
+	};
+}

package/src/cryptography/keypair.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { bcs, toBase64 } from '@mysten/bcs';
-import { blake2b } from '@noble/hashes/blake2b';
+import { blake2b } from '@noble/hashes/blake2.js';
 import { bech32 } from '@scure/base';
 
 import type { IntentScope } from './intent.js';
@@ -12,7 +12,7 @@ import { SIGNATURE_FLAG_TO_SCHEME, SIGNATURE_SCHEME_TO_FLAG } from './signature-
 import type { SignatureScheme } from './signature-scheme.js';
 import { toSerializedSignature } from './signature.js';
 import type { Transaction } from '../transactions/Transaction.js';
-import type { ClientWithCoreApi, Experimental_SuiClientTypes } from '../experimental/index.js';
+import type { ClientWithCoreApi, SuiClientTypes } from '../client/index.js';
 
 export const PRIVATE_KEY_SIZE = 32;
 export const LEGACY_PRIVATE_KEY_SIZE = 64;
@@ -20,8 +20,6 @@ export const SUI_PRIVATE_KEY_PREFIX = 'suiprivkey';
 
 export type ParsedKeypair = {
 	scheme: SignatureScheme;
-	/** @deprecated use `scheme` instead */
-	schema: SignatureScheme;
 	secretKey: Uint8Array;
 };
 
@@ -84,16 +82,17 @@ export abstract class Signer {
 		transaction,
 		client,
 	}: SignAndExecuteOptions): Promise<
-		Omit<Experimental_SuiClientTypes.TransactionResponse, 'balanceChanges'>
+		SuiClientTypes.TransactionResult<{ transaction: true; effects: true }>
 	> {
+		transaction.setSenderIfNotSet(this.toSuiAddress());
 		const bytes = await transaction.build({ client });
 		const { signature } = await this.signTransaction(bytes);
-		const response = await client.core.executeTransaction({
+
+		return client.core.executeTransaction({
 			transaction: bytes,
 			signatures: [signature],
+			include: { transaction: true, effects: true },
 		});
-
-		return response.transaction;
 	}
 
 	toSuiAddress(): string {
@@ -135,7 +134,6 @@ export function decodeSuiPrivateKey(value: string): ParsedKeypair {
 
 	return {
 		scheme: signatureScheme,
-		schema: signatureScheme,
 		secretKey: secretKey,
 	};
 }

package/src/cryptography/publickey.ts

@@ -2,8 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { fromBase64, toBase64 } from '@mysten/bcs';
-import { blake2b } from '@noble/hashes/blake2b';
-import { bytesToHex } from '@noble/hashes/utils';
+import { blake2b } from '@noble/hashes/blake2.js';
+import { bytesToHex } from '@noble/hashes/utils.js';
 
 import { bcs } from '../bcs/index.js';
 import { normalizeSuiAddress, SUI_ADDRESS_LENGTH } from '../utils/sui-types.js';