@mysten/sui 2.22.1 → 2.23.2

package/src/grpc/proto/types.ts

@@ -23,6 +23,7 @@ export * from './sui/rpc/v2/error_reason.js';
 export * from './sui/rpc/v2/event.js';
 export * from './sui/rpc/v2/executed_transaction.js';
 export * from './sui/rpc/v2/execution_status.js';
+export * from './sui/rpc/v2/filter.js';
 export * from './sui/rpc/v2/gas_cost_summary.js';
 export * from './sui/rpc/v2/input.js';
 export * from './sui/rpc/v2/jwk.js';
@@ -34,6 +35,7 @@ export * from './sui/rpc/v2/object.js';
 export * from './sui/rpc/v2/object_reference.js';
 export * from './sui/rpc/v2/owner.js';
 export * from './sui/rpc/v2/protocol_config.js';
+export * from './sui/rpc/v2/query_options.js';
 export * from './sui/rpc/v2/signature.js';
 export * from './sui/rpc/v2/signature_scheme.js';
 export * from './sui/rpc/v2/signature_verification_service.js';

package/src/jsonRpc/core.ts

@@ -1,12 +1,13 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { fromBase64, type InferBcsInput } from '@mysten/bcs';
+import { fromBase58, fromBase64, type InferBcsInput } from '@mysten/bcs';
 
 import { bcs, TypeTagSerializer } from '../bcs/index.js';
 import type {
 	DevInspectResults,
 	DryRunTransactionBlockResponse,
+	EventId,
 	ExecutionStatus as JsonRpcExecutionStatus,
 	ObjectOwner,
 	SuiMoveAbilitySet,
@@ -19,6 +20,12 @@ import type {
 	SuiTransactionBlockResponse,
 	TransactionEffects,
 } from './types/index.js';
+import {
+	resolveEventFilter,
+	resolvePagination,
+	resolveTransactionFilter,
+	validateTransactionQuery,
+} from '../client/query-filters.js';
 import { Transaction } from '../transactions/Transaction.js';
 import { computeGasBudget, coreClientResolveTransactionPlugin } from '../client/core-resolver.js';
 import { TransactionDataBuilder } from '../transactions/TransactionData.js';
@@ -650,6 +657,118 @@ export class JSONRpcCoreClient extends CoreClient {
 		};
 	}
 
+	/**
+	 * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient`
+	 * from `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+	 */
+	async listTransactions<Include extends SuiClientTypes.TransactionInclude = {}>(
+		options: SuiClientTypes.ListTransactionsOptions<Include>,
+	): Promise<SuiClientTypes.ListTransactionsResponse<Include>> {
+		const filter = options.filter
+			? await resolveTransactionFilter(this.mvr, options.filter, options.signal)
+			: undefined;
+
+		// Transaction cursors are digests, and bounds are interpreted relative to the
+		// traversal direction
+		const pagination = resolvePagination(options);
+		const { descending, after, before } = pagination;
+		validateTransactionQuery(filter, pagination);
+
+		const page = await this.#jsonRpcClient.queryTransactionBlocks({
+			filter:
+				filter &&
+				(filter.$kind === 'sender'
+					? { FromAddress: filter.sender }
+					: {
+							MoveFunction: {
+								package: filter.package,
+								module: filter.module ?? null,
+								function: filter.function ?? null,
+							},
+						}),
+			cursor: after ?? before,
+			limit: pagination.limit,
+			order: descending ? 'descending' : 'ascending',
+			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 {
+			transactions: page.data.map((transaction) => parseTransaction(transaction, options.include)),
+			hasNextPage: page.hasNextPage,
+			startCursor: page.data[0]?.digest ?? null,
+			endCursor: page.data.length
+				? (page.nextCursor ?? page.data[page.data.length - 1].digest)
+				: null,
+		};
+	}
+
+	/**
+	 * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient`
+	 * from `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
+	 */
+	async listEvents(
+		options: SuiClientTypes.ListEventsOptions,
+	): Promise<SuiClientTypes.ListEventsResponse> {
+		const filter = options.filter
+			? await resolveEventFilter(this.mvr, options.filter, options.signal)
+			: undefined;
+		// Event cursors are event ids, and bounds are interpreted relative to the
+		// traversal direction
+		const { descending, after, before, limit } = resolvePagination(options);
+		const cursor = after ?? before;
+
+		const page = await this.#jsonRpcClient.queryEvents({
+			query: !filter
+				? { All: [] }
+				: filter.$kind === 'sender'
+					? { Sender: filter.sender }
+					: filter.$kind === 'emitModule'
+						? { MoveModule: { package: filter.package, module: filter.module } }
+						: filter.$kind === 'eventTypeModule'
+							? { MoveEventModule: { package: filter.package, module: filter.module } }
+							: { MoveEventType: filter.eventType },
+			cursor: cursor ? parseEventCursor(cursor) : undefined,
+			limit,
+			order: descending ? 'descending' : 'ascending',
+			signal: options.signal,
+		});
+
+		return {
+			events: page.data.map(
+				(event): SuiClientTypes.EventEntry => ({
+					packageId: normalizeSuiAddress(event.packageId),
+					module: event.transactionModule,
+					sender: normalizeSuiAddress(event.sender),
+					eventType: normalizeStructTag(event.type),
+					bcs: event.bcsEncoding === 'base58' ? fromBase58(event.bcs) : fromBase64(event.bcs),
+					json: (event.parsedJson as Record<string, unknown>) ?? null,
+					// queryEvents responses do not include checkpoint information
+					checkpoint: null,
+					transactionDigest: event.id.txDigest,
+					eventIndex: Number(event.id.eventSeq),
+				}),
+			),
+			hasNextPage: page.hasNextPage,
+			startCursor: page.data.length ? JSON.stringify(page.data[0].id) : null,
+			endCursor:
+				page.data.length && page.nextCursor
+					? JSON.stringify(page.nextCursor)
+					: page.data.length
+						? JSON.stringify(page.data[page.data.length - 1].id)
+						: null,
+		};
+	}
+
 	/**
 	 * @deprecated JSON-RPC APIs are deprecated in the Sui TypeScript SDK. Use `SuiGrpcClient`
 	 * from `@mysten/sui/grpc` or `SuiGraphQLClient` from `@mysten/sui/graphql` instead.
@@ -948,6 +1067,18 @@ function parseOwnerAddress(owner: ObjectOwner): string | null {
 	throw new Error(`Unknown owner type: ${JSON.stringify(owner)}`);
 }
 
+function parseEventCursor(cursor: string): EventId {
+	try {
+		const parsed = JSON.parse(cursor) as EventId;
+		if (typeof parsed?.txDigest !== 'string' || typeof parsed?.eventSeq !== 'string') {
+			throw new Error('malformed event cursor');
+		}
+		return parsed;
+	} catch {
+		throw new Error(`Invalid event cursor: ${cursor}`);
+	}
+}
+
 function parseTransaction<Include extends SuiClientTypes.TransactionInclude = {}>(
 	transaction: SuiTransactionBlockResponse,
 	include?: Include,
@@ -968,7 +1099,10 @@ function parseTransaction<Include extends SuiClientTypes.TransactionInclude = {}
 
 	if (transaction.rawTransaction) {
 		const parsedTx = bcs.SenderSignedData.parse(fromBase64(transaction.rawTransaction))[0];
-		signatures = parsedTx.txSignatures;
+		// The genesis transaction's raw data carries a placeholder signature that
+		// other transports do not report
+		signatures =
+			parsedTx.intentMessage.value.V1.kind.$kind === 'Genesis' ? [] : parsedTx.txSignatures;
 
 		if (include?.transaction || include?.bcs) {
 			const bytes = bcs.TransactionData.serialize(parsedTx.intentMessage.value).toBytes();
@@ -1048,7 +1182,7 @@ function parseTransaction<Include extends SuiClientTypes.TransactionInclude = {}
 			};
 }
 
-function parseTransactionEffectsJson({
+export function parseTransactionEffectsJson({
 	bytes,
 	effects,
 	objectChanges,
@@ -1168,6 +1302,28 @@ function parseTransactionEffectsJson({
 		}
 	});
 
+	// When the transaction has no gas object (system transactions, or gas paid
+	// from an address balance), the RPC substitutes a placeholder ref with the
+	// 0x0 object id rather than omitting the field.
+	const hasGasObject =
+		normalizeSuiAddress(effects.gasObject.reference.objectId) !== normalizeSuiAddress('0x0');
+
+	let lamportVersion: string | null = null;
+	if (hasGasObject) {
+		lamportVersion = effects.gasObject.reference.version;
+	} else {
+		// Written objects are all assigned the lamport version, so recover it
+		// from the changed objects when the gas object can't provide it.
+		for (const change of changedObjects) {
+			if (
+				change.outputVersion &&
+				(lamportVersion === null || BigInt(change.outputVersion) > BigInt(lamportVersion))
+			) {
+				lamportVersion = change.outputVersion;
+			}
+		}
+	}
+
 	return {
 		objectTypes,
 		effects: {
@@ -1176,21 +1332,23 @@ function parseTransactionEffectsJson({
 			status: parseJsonRpcExecutionStatus(effects.status, effects.abortError),
 			gasUsed: effects.gasUsed,
 			transactionDigest: effects.transactionDigest,
-			gasObject: {
-				objectId: effects.gasObject?.reference.objectId,
-				inputState: 'Exists',
-				inputVersion: null,
-				inputDigest: null,
-				inputOwner: null,
-				outputState: 'ObjectWrite',
-				outputVersion: effects.gasObject.reference.version,
-				outputDigest: effects.gasObject.reference.digest,
-				outputOwner: parseOwner(effects.gasObject.owner),
-				idOperation: 'None',
-			},
+			gasObject: hasGasObject
+				? {
+						objectId: effects.gasObject.reference.objectId,
+						inputState: 'Exists',
+						inputVersion: null,
+						inputDigest: null,
+						inputOwner: null,
+						outputState: 'ObjectWrite',
+						outputVersion: effects.gasObject.reference.version,
+						outputDigest: effects.gasObject.reference.digest,
+						outputOwner: parseOwner(effects.gasObject.owner),
+						idOperation: 'None',
+					}
+				: null,
 			eventsDigest: effects.eventsDigest ?? null,
 			dependencies: effects.dependencies ?? [],
-			lamportVersion: effects.gasObject.reference.version,
+			lamportVersion,
 			changedObjects,
 			unchangedConsensusObjects,
 			auxiliaryDataDigest: null,

package/src/transactions/intents/CoinWithBalance.ts

@@ -210,7 +210,6 @@ export async function resolveCoinBalance(
 			: null,
 	]);
 
-	const mergedCoins = new Map<string, Argument>();
 	const exactBalanceByType = new Map<string, boolean>();
 	const usedAddressBalance = new Set<string>();
 
@@ -351,8 +350,6 @@ export async function resolveCoinBalance(
 					commands.push(TransactionCommands.MergeCoins(baseCoin, rest.slice(i, i + 500)));
 				}
 
-				mergedCoins.set(type, baseCoin);
-
 				// Step 2: Combined SplitCoins for all intents of this type
 				const splitCmdIndex = index + commands.length;
 				commands.push(
@@ -389,6 +386,47 @@ export async function resolveCoinBalance(
 					}
 				}
 
+				// Step 3: Remainder handling
+				//
+				// Add cleanup to this replacement command list rather than appending
+				// it to the complete transaction. Appending cleanup can place it after
+				// a MoveCall that consumes Random, which Sui rejects.
+				//
+				// When gas type used GasCoin (not AB), leftover stays in the gas coin
+				// -- no remainder handling is needed.
+				if (type !== 'gas' || usedAddressBalance.has(type)) {
+					const hasBalanceIntent = intents.some((intent) => intent.outputKind === 'balance');
+					const sourcedFromAB = usedAddressBalance.has(type);
+
+					if (hasBalanceIntent || sourcedFromAB) {
+						// Sourced from AB or balance intents exist: send remainder back to sender's address
+						// balance. `coin::send_funds` is gasless-eligible and handles zero amounts.
+						commands.push(
+							TransactionCommands.MoveCall({
+								target: '0x2::coin::send_funds',
+								typeArguments: [coinType],
+								arguments: [
+									baseCoin,
+									transactionData.addInput(
+										'pure',
+										Inputs.Pure(bcs.Address.serialize(transactionData.sender!)),
+									),
+								],
+							}),
+						);
+					} else if (exactBalanceByType.get(type)) {
+						// Coin-only with exact match: destroy the zero-value dust coin.
+						commands.push(
+							TransactionCommands.MoveCall({
+								target: '0x2::coin::destroy_zero',
+								typeArguments: [coinType],
+								arguments: [baseCoin],
+							}),
+						);
+					}
+					// Coin-only with surplus: merged coin stays with sender as an owned object.
+				}
+
 				typeState.set(type, { results, nextIntent: 0 });
 			}
 
@@ -408,44 +446,6 @@ export async function resolveCoinBalance(
 		index += commands.length;
 	}
 
-	// Step 3: Remainder handling
-	for (const [type, mergedCoin] of mergedCoins) {
-		// When gas type used GasCoin (not AB), leftover stays in the gas coin — no remainder needed.
-		if (type === 'gas' && !usedAddressBalance.has(type)) continue;
-
-		const coinType = type === 'gas' ? SUI_TYPE : type;
-		const hasBalanceIntent = intentsByType.get(type)?.some((i) => i.outputKind === 'balance');
-		const sourcedFromAB = usedAddressBalance.has(type);
-
-		if (hasBalanceIntent || sourcedFromAB) {
-			// Sourced from AB or balance intents exist: send remainder back to sender's address balance.
-			// coin::send_funds is gasless-eligible and handles zero amounts.
-			transactionData.commands.push(
-				TransactionCommands.MoveCall({
-					target: '0x2::coin::send_funds',
-					typeArguments: [coinType],
-					arguments: [
-						mergedCoin,
-						transactionData.addInput(
-							'pure',
-							Inputs.Pure(bcs.Address.serialize(transactionData.sender!)),
-						),
-					],
-				}),
-			);
-		} else if (exactBalanceByType.get(type)) {
-			// Coin-only with exact match: destroy the zero-value dust coin.
-			transactionData.commands.push(
-				TransactionCommands.MoveCall({
-					target: '0x2::coin::destroy_zero',
-					typeArguments: [coinType],
-					arguments: [mergedCoin],
-				}),
-			);
-		}
-		// Coin-only with surplus: merged coin stays with sender as an owned object
-	}
-
 	return next();
 }
 

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.22.1';
+export const PACKAGE_VERSION = '2.23.2';