@mysten/sui 2.28.0 → 2.30.0

package/src/transactions/intents/CoinWithBalance.ts

@@ -178,37 +178,44 @@ export async function resolveCoinBalance(
 	const coinsByType = new Map<string, SuiClientTypes.Coin[]>();
 	const addressBalanceByType = new Map<string, bigint>();
 	const client = buildOptions.client;
+	const assumeSufficientAddressBalances = buildOptions.assumeSufficientAddressBalances;
 
-	if (!client) {
+	if (!client && !assumeSufficientAddressBalances) {
 		throw new Error(
 			'Client must be provided to build or serialize transactions with CoinWithBalance intents',
 		);
 	}
 
-	await Promise.all([
-		...[...coinTypes].map(async (coinType) => {
-			const { coins, addressBalance } = await getCoinsAndBalanceOfType({
-				coinType,
-				balance: totalByType.get(coinType)!,
-				client,
-				owner: transactionData.sender!,
-				usedIds,
-			});
-
-			coinsByType.set(coinType, coins);
-			addressBalanceByType.set(coinType, addressBalance);
-		}),
-		totalByType.has('gas')
-			? await client.core
-					.getBalance({
-						owner: transactionData.sender!,
-						coinType: SUI_TYPE,
-					})
-					.then(({ balance }) => {
-						addressBalanceByType.set('gas', BigInt(balance.addressBalance));
-					})
-			: null,
-	]);
+	if (assumeSufficientAddressBalances) {
+		for (const [coinType, balance] of totalByType) {
+			addressBalanceByType.set(coinType, balance);
+		}
+	} else {
+		await Promise.all([
+			...[...coinTypes].map(async (coinType) => {
+				const { coins, addressBalance } = await getCoinsAndBalanceOfType({
+					coinType,
+					balance: totalByType.get(coinType)!,
+					client: client!,
+					owner: transactionData.sender!,
+					usedIds,
+				});
+
+				coinsByType.set(coinType, coins);
+				addressBalanceByType.set(coinType, addressBalance);
+			}),
+			totalByType.has('gas')
+				? await client!.core
+						.getBalance({
+							owner: transactionData.sender!,
+							coinType: SUI_TYPE,
+						})
+						.then(({ balance }) => {
+							addressBalanceByType.set('gas', BigInt(balance.addressBalance));
+						})
+				: null,
+		]);
+	}
 
 	const exactBalanceByType = new Map<string, boolean>();
 	const usedAddressBalance = new Set<string>();

package/src/transactions/resolution-utils.ts

@@ -0,0 +1,18 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type { TransactionDataBuilder } from './TransactionData.js';
+
+export function transactionUsesGasCoin(transactionData: TransactionDataBuilder) {
+	let usesGasCoin = false;
+
+	transactionData.mapArguments((arg) => {
+		if (arg.$kind === 'GasCoin') {
+			usesGasCoin = true;
+		}
+
+		return arg;
+	});
+
+	return usesGasCoin;
+}

package/src/transactions/resolve.ts

@@ -9,10 +9,19 @@ import type { BcsType } from '@mysten/bcs';
 import { Inputs } from './Inputs.js';
 import { bcs } from '../bcs/index.js';
 import { coreClientResolveTransactionPlugin } from '../client/core-resolver.js';
+import { transactionUsesGasCoin } from './resolution-utils.js';
 
 export interface BuildTransactionOptions {
 	client?: ClientWithCoreApi;
 	onlyTransactionKind?: boolean;
+	/**
+	 * Resolve `CoinWithBalance` intents from address balance without looking up balances or coins.
+	 *
+	 * If nothing else needs resolution, the transaction doesn't use `GasCoin`, and it already has a
+	 * `ValidDuring` or `Validity` expiration, an unset gas payment is also set to `[]` (pay gas from
+	 * address balance). Execution fails if the balances aren't there.
+	 */
+	assumeSufficientAddressBalances?: boolean;
 }
 
 export interface SerializeTransactionOptions extends BuildTransactionOptions {
@@ -38,11 +47,23 @@ export function needsTransactionResolution(
 	}
 
 	if (!options.onlyTransactionKind) {
-		if (!data.gasData.price || !data.gasData.budget || !data.gasData.payment) {
+		if (!data.gasData.price || !data.gasData.budget) {
 			return true;
 		}
 
-		if (data.gasData.payment.length === 0 && !data.expiration) {
+		if (!data.gasData.payment) {
+			const assumesAddressBalanceGas =
+				options.assumeSufficientAddressBalances && !transactionUsesGasCoin(data);
+
+			// Address balance gas has no object version to protect against replay, so an offline build
+			// needs a ValidDuring expiration. Epoch expiration doesn't count.
+			if (
+				!assumesAddressBalanceGas ||
+				(data.expiration?.$kind !== 'ValidDuring' && data.expiration?.$kind !== 'Validity')
+			) {
+				return true;
+			}
+		} else if (data.gasData.payment.length === 0 && !data.expiration) {
 			return true;
 		}
 	}
@@ -56,7 +77,13 @@ export async function resolveTransactionPlugin(
 	next: () => Promise<void>,
 ) {
 	normalizeRawArguments(transactionData);
+
 	if (!needsTransactionResolution(transactionData, options)) {
+		// Payment can only be unset here when assumeSufficientAddressBalances applies
+		if (!options.onlyTransactionKind && !transactionData.gasData.payment) {
+			transactionData.gasData.payment = [];
+		}
+
 		await validate(transactionData);
 		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.28.0';
+export const PACKAGE_VERSION = '2.30.0';