@mysten/sui 1.6.0 → 1.7.0

package/src/transactions/Transaction.ts

@@ -22,6 +22,7 @@ import type {
 	TransactionPlugin,
 } from './json-rpc-resolver.js';
 import { resolveTransactionData } from './json-rpc-resolver.js';
+import { createObjectMethods } from './object.js';
 import { createPure } from './pure.js';
 import { TransactionDataBuilder } from './TransactionData.js';
 import { getIdFromCallArg } from './utils.js';
@@ -98,12 +99,37 @@ export function isTransaction(obj: unknown): obj is Transaction {
 
 export type TransactionObjectInput = string | CallArg | TransactionObjectArgument;
 
+const modulePluginRegistry = {
+	buildPlugins: [] as TransactionPlugin[],
+	serializationPlugins: [] as TransactionPlugin[],
+};
+
+const TRANSACTION_REGISTRY_KEY = Symbol.for('@mysten/transaction/registry');
+function getGlobalPluginRegistry() {
+	try {
+		const target = globalThis as {
+			[TRANSACTION_REGISTRY_KEY]?: {
+				buildPlugins: TransactionPlugin[];
+				serializationPlugins: TransactionPlugin[];
+			};
+		};
+
+		if (!target[TRANSACTION_REGISTRY_KEY]) {
+			target[TRANSACTION_REGISTRY_KEY] = modulePluginRegistry;
+		}
+
+		return target[TRANSACTION_REGISTRY_KEY];
+	} catch (e) {
+		return modulePluginRegistry;
+	}
+}
+
 /**
  * Transaction Builder
  */
 export class Transaction {
-	#serializationPlugins: TransactionPlugin[] = [];
-	#buildPlugins: TransactionPlugin[] = [];
+	#serializationPlugins: TransactionPlugin[];
+	#buildPlugins: TransactionPlugin[];
 	#intentResolvers = new Map<string, TransactionPlugin>();
 
 	/**
@@ -142,6 +168,14 @@ export class Transaction {
 		return newTransaction;
 	}
 
+	static registerGlobalSerializationPlugin(step: TransactionPlugin) {
+		getGlobalPluginRegistry().serializationPlugins.push(step);
+	}
+
+	static registerGlobalBuildPlugin(step: TransactionPlugin) {
+		getGlobalPluginRegistry().buildPlugins.push(step);
+	}
+
 	addSerializationPlugin(step: TransactionPlugin) {
 		this.#serializationPlugins.push(step);
 	}
@@ -241,7 +275,10 @@ export class Transaction {
 	}
 
 	constructor() {
+		const globalPlugins = getGlobalPluginRegistry();
 		this.#data = new TransactionDataBuilder();
+		this.#buildPlugins = [...globalPlugins.buildPlugins];
+		this.#serializationPlugins = [...globalPlugins.serializationPlugins];
 	}
 
 	/** Returns an argument for the gas coin, to be used in a transaction. */
@@ -252,37 +289,43 @@ export class Transaction {
 	/**
 	 * Add a new object input to the transaction.
 	 */
-	object(value: TransactionObjectInput): { $kind: 'Input'; Input: number; type?: 'object' } {
-		if (typeof value === 'function') {
-			return this.object(value(this));
-		}
+	object = createObjectMethods(
+		(value: TransactionObjectInput): { $kind: 'Input'; Input: number; type?: 'object' } => {
+			if (typeof value === 'function') {
+				return this.object(value(this));
+			}
 
-		if (typeof value === 'object' && is(Argument, value)) {
-			return value as { $kind: 'Input'; Input: number; type?: 'object' };
-		}
+			if (typeof value === 'object' && is(Argument, value)) {
+				return value as { $kind: 'Input'; Input: number; type?: 'object' };
+			}
 
-		const id = getIdFromCallArg(value);
+			const id = getIdFromCallArg(value);
 
-		const inserted = this.#data.inputs.find((i) => id === getIdFromCallArg(i));
+			const inserted = this.#data.inputs.find((i) => id === getIdFromCallArg(i));
 
-		// Upgrade shared object inputs to mutable if needed:
-		if (inserted?.Object?.SharedObject && typeof value === 'object' && value.Object?.SharedObject) {
-			inserted.Object.SharedObject.mutable =
-				inserted.Object.SharedObject.mutable || value.Object.SharedObject.mutable;
-		}
+			// Upgrade shared object inputs to mutable if needed:
+			if (
+				inserted?.Object?.SharedObject &&
+				typeof value === 'object' &&
+				value.Object?.SharedObject
+			) {
+				inserted.Object.SharedObject.mutable =
+					inserted.Object.SharedObject.mutable || value.Object.SharedObject.mutable;
+			}
 
-		return inserted
-			? { $kind: 'Input', Input: this.#data.inputs.indexOf(inserted), type: 'object' }
-			: this.#data.addInput(
-					'object',
-					typeof value === 'string'
-						? {
-								$kind: 'UnresolvedObject',
-								UnresolvedObject: { objectId: normalizeSuiAddress(value) },
-							}
-						: value,
-				);
-	}
+			return inserted
+				? { $kind: 'Input', Input: this.#data.inputs.indexOf(inserted), type: 'object' }
+				: this.#data.addInput(
+						'object',
+						typeof value === 'string'
+							? {
+									$kind: 'UnresolvedObject',
+									UnresolvedObject: { objectId: normalizeSuiAddress(value) },
+								}
+							: value,
+					);
+		},
+	);
 
 	/**
 	 * Add a new object input to the transaction using the fully-resolved object reference.

package/src/transactions/executor/parallel.ts

@@ -5,7 +5,7 @@ import { toB64 } from '@mysten/bcs';
 
 import { bcs } from '../../bcs/index.js';
 import type { SuiObjectRef } from '../../bcs/types.js';
-import type { SuiClient } from '../../client/index.js';
+import type { SuiClient, SuiTransactionBlockResponseOptions } from '../../client/index.js';
 import type { Signer } from '../../cryptography/index.js';
 import type { ObjectCacheOptions } from '../ObjectCache.js';
 import { Transaction } from '../Transaction.js';
@@ -104,7 +104,7 @@ export class ParallelTransactionExecutor {
 		await this.#updateCache(() => this.#waitForLastDigest());
 	}
 
-	async executeTransaction(transaction: Transaction) {
+	async executeTransaction(transaction: Transaction, options?: SuiTransactionBlockResponseOptions) {
 		const { promise, resolve, reject } = promiseWithResolvers<{
 			digest: string;
 			effects: string;
@@ -113,7 +113,7 @@ export class ParallelTransactionExecutor {
 
 		const execute = () => {
 			this.#executeQueue.runTask(() => {
-				const promise = this.#execute(transaction, usedObjects);
+				const promise = this.#execute(transaction, usedObjects, options);
 
 				return promise.then(resolve, reject);
 			});
@@ -174,7 +174,11 @@ export class ParallelTransactionExecutor {
 		return usedObjects;
 	}
 
-	async #execute(transaction: Transaction, usedObjects: Set<string>) {
+	async #execute(
+		transaction: Transaction,
+		usedObjects: Set<string>,
+		options?: SuiTransactionBlockResponseOptions,
+	) {
 		let gasCoin!: CoinWithBalance;
 		try {
 			transaction.setSenderIfNotSet(this.#signer.toSuiAddress());
@@ -186,9 +190,7 @@ export class ParallelTransactionExecutor {
 					transaction.setGasPrice(await this.#getGasPrice());
 				}
 
-				if (!data.gasData.budget) {
-					transaction.setGasBudget(this.#defaultGasBudget);
-				}
+				transaction.setGasBudgetIfNotSet(this.#defaultGasBudget);
 
 				await this.#updateCache();
 				gasCoin = await this.#getGasCoin();
@@ -213,6 +215,7 @@ export class ParallelTransactionExecutor {
 				transaction: bytes,
 				signature,
 				options: {
+					...options,
 					showEffects: true,
 				},
 			});

package/src/transactions/executor/serial.ts

@@ -4,7 +4,7 @@
 import { toB64 } from '@mysten/bcs';
 
 import { bcs } from '../../bcs/index.js';
-import type { SuiClient } from '../../client/index.js';
+import type { SuiClient, SuiTransactionBlockResponseOptions } from '../../client/index.js';
 import type { Signer } from '../../cryptography/keypair.js';
 import type { ObjectCacheOptions } from '../ObjectCache.js';
 import { isTransaction, Transaction } from '../Transaction.js';
@@ -15,15 +15,20 @@ export class SerialTransactionExecutor {
 	#queue = new SerialQueue();
 	#signer: Signer;
 	#cache: CachingTransactionExecutor;
+	#defaultGasBudget: bigint;
 
 	constructor({
 		signer,
+		defaultGasBudget = 50_000_000n,
 		...options
 	}: Omit<ObjectCacheOptions, 'address'> & {
 		client: SuiClient;
 		signer: Signer;
+		/** The gasBudget to use if the transaction has not defined it's own gasBudget, defaults to `50_000_000n` */
+		defaultGasBudget?: bigint;
 	}) {
 		this.#signer = signer;
+		this.#defaultGasBudget = defaultGasBudget;
 		this.#cache = new CachingTransactionExecutor({
 			client: options.client,
 			cache: options.cache,
@@ -63,6 +68,7 @@ export class SerialTransactionExecutor {
 			copy.setGasPayment([gasCoin]);
 		}
 
+		copy.setGasBudgetIfNotSet(this.#defaultGasBudget);
 		copy.setSenderIfNotSet(this.#signer.toSuiAddress());
 
 		return this.#cache.buildTransaction({ transaction: copy });
@@ -76,7 +82,10 @@ export class SerialTransactionExecutor {
 		return this.#cache.waitForLastTransaction();
 	}
 
-	executeTransaction(transaction: Transaction | Uint8Array) {
+	executeTransaction(
+		transaction: Transaction | Uint8Array,
+		options?: SuiTransactionBlockResponseOptions,
+	) {
 		return this.#queue.runTask(async () => {
 			const bytes = isTransaction(transaction)
 				? await this.#buildTransaction(transaction)
@@ -87,6 +96,7 @@ export class SerialTransactionExecutor {
 				.executeTransaction({
 					signature,
 					transaction: bytes,
+					options,
 				})
 				.catch(async (error) => {
 					await this.resetCache();

package/src/transactions/object.ts

@@ -0,0 +1,17 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type { TransactionObjectInput } from './Transaction.js';
+
+export function createObjectMethods<T>(makeObject: (value: TransactionObjectInput) => T) {
+	function object(value: TransactionObjectInput) {
+		return makeObject(value);
+	}
+
+	object.system = () => object('0x5');
+	object.clock = () => object('0x6');
+	object.random = () => object('0x8');
+	object.denyList = () => object('0x403');
+
+	return object;
+}

package/src/verify/verify.ts

@@ -45,8 +45,9 @@ export async function verifyPersonalMessageSignature(
 export async function verifyTransactionSignature(
 	transaction: Uint8Array,
 	signature: string,
+	options: { client?: SuiGraphQLClient } = {},
 ): Promise<PublicKey> {
-	const parsedSignature = parseSignature(signature);
+	const parsedSignature = parseSignature(signature, options);
 
 	if (
 		!(await parsedSignature.publicKey.verifyTransaction(
@@ -102,10 +103,13 @@ export function publicKeyFromRawBytes(
 	}
 }
 
-export function publicKeyFromSuiBytes(publicKey: string | Uint8Array) {
+export function publicKeyFromSuiBytes(
+	publicKey: string | Uint8Array,
+	options: { client?: SuiGraphQLClient } = {},
+) {
 	const bytes = typeof publicKey === 'string' ? fromB64(publicKey) : publicKey;
 
 	const signatureScheme = SIGNATURE_FLAG_TO_SCHEME[bytes[0] as SignatureFlag];
 
-	return publicKeyFromRawBytes(signatureScheme, bytes.slice(1));
+	return publicKeyFromRawBytes(signatureScheme, bytes.slice(1), options);
 }

package/src/version.ts

@@ -3,5 +3,5 @@
 
 // This file is generated by genversion.mjs. Do not edit it directly.
 
-export const PACKAGE_VERSION = '1.6.0';
+export const PACKAGE_VERSION = '1.7.0';
 export const TARGETED_RPC_VERSION = '1.32.0';

package/src/zklogin/publickey.ts

@@ -71,6 +71,7 @@ export class ZkLoginPublicIdentifier extends PublicKey {
 	verifyPersonalMessage(message: Uint8Array, signature: Uint8Array | string): Promise<boolean> {
 		const parsedSignature = parseSerializedZkLoginSignature(signature);
 		const address = new ZkLoginPublicIdentifier(parsedSignature.publicKey).toSuiAddress();
+
 		return graphqlVerifyZkLoginSignature({
 			address: address,
 			bytes: toB64(message),