@mysten/sui 2.30.0 → 2.31.0

package/dist/transactions/intents/ResolveBalances.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResolveBalances.mjs","names":[],"sources":["../../../src/transactions/intents/ResolveBalances.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { IntentResolverOptions } from '../resolve.js';\nimport type { TransactionDataBuilder } from '../TransactionData.js';\nimport { ALLOWANCE_BALANCE, COIN_WITH_BALANCE } from './BalanceIntentNames.js';\nimport { resolveAllowanceBalance } from './AllowanceBalance.js';\nimport { resolveCoinBalance } from './CoinWithBalance.js';\n\nexport async function resolveBalances(\n\ttransactionData: TransactionDataBuilder,\n\toptions: IntentResolverOptions,\n\tnext: () => Promise<void>,\n) {\n\tconst intents = new Set(options.intentNames ?? [ALLOWANCE_BALANCE, COIN_WITH_BALANCE]);\n\tconst shouldResolve = (name: string) =>\n\t\tintents.has(name) &&\n\t\t!options.supportedIntents?.includes(name) &&\n\t\ttransactionData.commands.some((command) => command.$Intent?.name === name);\n\n\t// Reserve allowance withdrawals before ordinary coin selection, including when\n\t// the sender is also the funder. Keep separate intents for wallet negotiation.\n\tif (shouldResolve(ALLOWANCE_BALANCE)) {\n\t\tawait resolveAllowanceBalance(transactionData, options, async () => {});\n\t}\n\tif (shouldResolve(COIN_WITH_BALANCE)) {\n\t\tawait resolveCoinBalance(transactionData, options, async () => {});\n\t}\n\tawait next();\n}\n"],"mappings":";;;;;AASA,eAAsB,gBACrB,iBACA,SACA,MACC;CACD,MAAM,UAAU,IAAI,IAAI,QAAQ,eAAe,CAAC,mBAAmB,kBAAkB,CAAC;CACtF,MAAM,iBAAiB,SACtB,QAAQ,IAAI,KAAK,IACjB,CAAC,QAAQ,kBAAkB,SAAS,KAAK,IACzC,gBAAgB,SAAS,MAAM,YAAY,QAAQ,SAAS,SAAS,KAAK;AAI3E,KAAI,cAAc,kBAAkB,CACnC,OAAM,wBAAwB,iBAAiB,SAAS,YAAY,GAAG;AAExE,KAAI,cAAc,kBAAkB,CACnC,OAAM,mBAAmB,iBAAiB,SAAS,YAAY,GAAG;AAEnE,OAAM,MAAM"}

package/dist/transactions/resolve.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"resolve.d.mts","names":[],"sources":["../../src/transactions/resolve.ts"],"mappings":";;;;;UAaiB,uBAAA;EAChB,MAAA,GAAS,iBAAA;EACT,mBAAA;EAFgB;;;;;;;EAUhB,+BAAA;AAAA;AAAA,UAGgB,2BAAA,SAAoC,uBAAA;EACpD,gBAAA;AAAA;AAAA,KAGW,iBAAA,IACX,eAAA,EAAiB,sBAAA,EACjB,OAAA,EAAS,uBAAA,EACT,IAAA,QAAY,OAAA,WACR,OAAA"}
+{"version":3,"file":"resolve.d.mts","names":[],"sources":["../../src/transactions/resolve.ts"],"mappings":";;;;;UAaiB,uBAAA;EAChB,MAAA,GAAS,iBAAA;EACT,mBAAA;EAFgB;;;;;;;EAUhB,+BAAA;AAAA;AAAA,UAGgB,2BAAA,SAAoC,uBAAA;EACpD,gBAAA;AAAA;AAAA,KASW,iBAAA,IACX,eAAA,EAAiB,sBAAA,EACjB,OAAA,EAAS,uBAAA,EACT,IAAA,QAAY,OAAA,WACR,OAAA"}

package/dist/transactions/resolve.mjs

@@ -57,5 +57,5 @@ function normalizeRawArgument(arg, schema, transactionData) {
 }
 
 //#endregion
-export { needsTransactionResolution, resolveTransactionPlugin };
+export { getClient, needsTransactionResolution, resolveTransactionPlugin };
 //# sourceMappingURL=resolve.mjs.map

package/dist/transactions/resolve.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"resolve.mjs","names":["bcs"],"sources":["../../src/transactions/resolve.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { Argument } from './data/internal.js';\n\nimport type { ClientWithCoreApi } from '../client/index.js';\nimport type { TransactionDataBuilder } from './TransactionData.js';\nimport type { BcsType } from '@mysten/bcs';\nimport { Inputs } from './Inputs.js';\nimport { bcs } from '../bcs/index.js';\nimport { coreClientResolveTransactionPlugin } from '../client/core-resolver.js';\nimport { transactionUsesGasCoin } from './resolution-utils.js';\n\nexport interface BuildTransactionOptions {\n\tclient?: ClientWithCoreApi;\n\tonlyTransactionKind?: boolean;\n\t/**\n\t * Resolve `CoinWithBalance` intents from address balance without looking up balances or coins.\n\t *\n\t * If nothing else needs resolution, the transaction doesn't use `GasCoin`, and it already has a\n\t * `ValidDuring` or `Validity` expiration, an unset gas payment is also set to `[]` (pay gas from\n\t * address balance). Execution fails if the balances aren't there.\n\t */\n\tassumeSufficientAddressBalances?: boolean;\n}\n\nexport interface SerializeTransactionOptions extends BuildTransactionOptions {\n\tsupportedIntents?: string[];\n}\n\nexport type TransactionPlugin = (\n\ttransactionData: TransactionDataBuilder,\n\toptions: BuildTransactionOptions,\n\tnext: () => Promise<void>,\n) => Promise<void>;\n\nexport function needsTransactionResolution(\n\tdata: TransactionDataBuilder,\n\toptions: BuildTransactionOptions,\n): boolean {\n\tif (\n\t\tdata.inputs.some((input) => {\n\t\t\treturn input.UnresolvedObject || input.UnresolvedPure;\n\t\t})\n\t) {\n\t\treturn true;\n\t}\n\n\tif (!options.onlyTransactionKind) {\n\t\tif (!data.gasData.price || !data.gasData.budget) {\n\t\t\treturn true;\n\t\t}\n\n\t\tif (!data.gasData.payment) {\n\t\t\tconst assumesAddressBalanceGas =\n\t\t\t\toptions.assumeSufficientAddressBalances && !transactionUsesGasCoin(data);\n\n\t\t\t// Address balance gas has no object version to protect against replay, so an offline build\n\t\t\t// needs a ValidDuring expiration. Epoch expiration doesn't count.\n\t\t\tif (\n\t\t\t\t!assumesAddressBalanceGas ||\n\t\t\t\t(data.expiration?.$kind !== 'ValidDuring' && data.expiration?.$kind !== 'Validity')\n\t\t\t) {\n\t\t\t\treturn true;\n\t\t\t}\n\t\t} else if (data.gasData.payment.length === 0 && !data.expiration) {\n\t\t\treturn true;\n\t\t}\n\t}\n\n\treturn false;\n}\n\nexport async function resolveTransactionPlugin(\n\ttransactionData: TransactionDataBuilder,\n\toptions: BuildTransactionOptions,\n\tnext: () => Promise<void>,\n) {\n\tnormalizeRawArguments(transactionData);\n\n\tif (!needsTransactionResolution(transactionData, options)) {\n\t\t// Payment can only be unset here when assumeSufficientAddressBalances applies\n\t\tif (!options.onlyTransactionKind && !transactionData.gasData.payment) {\n\t\t\ttransactionData.gasData.payment = [];\n\t\t}\n\n\t\tawait validate(transactionData);\n\t\treturn next();\n\t}\n\n\tconst client = getClient(options);\n\tconst plugin = client.core?.resolveTransactionPlugin() ?? coreClientResolveTransactionPlugin;\n\n\treturn plugin(transactionData, options, async () => {\n\t\tawait validate(transactionData);\n\t\tawait next();\n\t});\n}\n\nfunction validate(transactionData: TransactionDataBuilder) {\n\ttransactionData.inputs.forEach((input, index) => {\n\t\tif (input.$kind !== 'Object' && input.$kind !== 'Pure' && input.$kind !== 'FundsWithdrawal') {\n\t\t\tthrow new Error(\n\t\t\t\t`Input at index ${index} has not been resolved.  Expected a Pure, Object, or FundsWithdrawal input, but found ${JSON.stringify(\n\t\t\t\t\tinput,\n\t\t\t\t)}`,\n\t\t\t);\n\t\t}\n\t});\n}\n\nexport function getClient(options: BuildTransactionOptions) {\n\tif (!options.client) {\n\t\tthrow new Error(\n\t\t\t`No sui client passed to Transaction#build, but transaction data was not sufficient to build offline.`,\n\t\t);\n\t}\n\n\treturn options.client;\n}\n\nfunction normalizeRawArguments(transactionData: TransactionDataBuilder) {\n\tfor (const command of transactionData.commands) {\n\t\tswitch (command.$kind) {\n\t\t\tcase 'SplitCoins':\n\t\t\t\tcommand.SplitCoins.amounts.forEach((amount) => {\n\t\t\t\t\tnormalizeRawArgument(amount, bcs.U64, transactionData);\n\t\t\t\t});\n\t\t\t\tbreak;\n\t\t\tcase 'TransferObjects':\n\t\t\t\tnormalizeRawArgument(command.TransferObjects.address, bcs.Address, transactionData);\n\t\t\t\tbreak;\n\t\t}\n\t}\n}\n\nfunction normalizeRawArgument(\n\targ: Argument,\n\tschema: BcsType<any>,\n\ttransactionData: TransactionDataBuilder,\n) {\n\tif (arg.$kind !== 'Input') {\n\t\treturn;\n\t}\n\tconst input = transactionData.inputs[arg.Input];\n\n\tif (input.$kind !== 'UnresolvedPure') {\n\t\treturn;\n\t}\n\n\ttransactionData.inputs[arg.Input] = Inputs.Pure(schema.serialize(input.UnresolvedPure.value));\n}\n"],"mappings":";;;;;;AAoCA,SAAgB,2BACf,MACA,SACU;AACV,KACC,KAAK,OAAO,MAAM,UAAU;AAC3B,SAAO,MAAM,oBAAoB,MAAM;GACtC,CAEF,QAAO;AAGR,KAAI,CAAC,QAAQ,qBAAqB;AACjC,MAAI,CAAC,KAAK,QAAQ,SAAS,CAAC,KAAK,QAAQ,OACxC,QAAO;AAGR,MAAI,CAAC,KAAK,QAAQ,SAMjB;OACC,EALA,QAAQ,mCAAmC,CAAC,uBAAuB,KAAK,KAMvE,KAAK,YAAY,UAAU,iBAAiB,KAAK,YAAY,UAAU,WAExE,QAAO;aAEE,KAAK,QAAQ,QAAQ,WAAW,KAAK,CAAC,KAAK,WACrD,QAAO;;AAIT,QAAO;;AAGR,eAAsB,yBACrB,iBACA,SACA,MACC;AACD,uBAAsB,gBAAgB;AAEtC,KAAI,CAAC,2BAA2B,iBAAiB,QAAQ,EAAE;AAE1D,MAAI,CAAC,QAAQ,uBAAuB,CAAC,gBAAgB,QAAQ,QAC5D,iBAAgB,QAAQ,UAAU,EAAE;AAGrC,QAAM,SAAS,gBAAgB;AAC/B,SAAO,MAAM;;AAMd,SAHe,UAAU,QAAQ,CACX,MAAM,0BAA0B,IAAI,oCAE5C,iBAAiB,SAAS,YAAY;AACnD,QAAM,SAAS,gBAAgB;AAC/B,QAAM,MAAM;GACX;;AAGH,SAAS,SAAS,iBAAyC;AAC1D,iBAAgB,OAAO,SAAS,OAAO,UAAU;AAChD,MAAI,MAAM,UAAU,YAAY,MAAM,UAAU,UAAU,MAAM,UAAU,kBACzE,OAAM,IAAI,MACT,kBAAkB,MAAM,wFAAwF,KAAK,UACpH,MACA,GACD;GAED;;AAGH,SAAgB,UAAU,SAAkC;AAC3D,KAAI,CAAC,QAAQ,OACZ,OAAM,IAAI,MACT,uGACA;AAGF,QAAO,QAAQ;;AAGhB,SAAS,sBAAsB,iBAAyC;AACvE,MAAK,MAAM,WAAW,gBAAgB,SACrC,SAAQ,QAAQ,OAAhB;EACC,KAAK;AACJ,WAAQ,WAAW,QAAQ,SAAS,WAAW;AAC9C,yBAAqB,QAAQA,OAAI,KAAK,gBAAgB;KACrD;AACF;EACD,KAAK;AACJ,wBAAqB,QAAQ,gBAAgB,SAASA,OAAI,SAAS,gBAAgB;AACnF;;;AAKJ,SAAS,qBACR,KACA,QACA,iBACC;AACD,KAAI,IAAI,UAAU,QACjB;CAED,MAAM,QAAQ,gBAAgB,OAAO,IAAI;AAEzC,KAAI,MAAM,UAAU,iBACnB;AAGD,iBAAgB,OAAO,IAAI,SAAS,OAAO,KAAK,OAAO,UAAU,MAAM,eAAe,MAAM,CAAC"}
+{"version":3,"file":"resolve.mjs","names":["bcs"],"sources":["../../src/transactions/resolve.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { Argument } from './data/internal.js';\n\nimport type { ClientWithCoreApi } from '../client/index.js';\nimport type { TransactionDataBuilder } from './TransactionData.js';\nimport type { BcsType } from '@mysten/bcs';\nimport { Inputs } from './Inputs.js';\nimport { bcs } from '../bcs/index.js';\nimport { coreClientResolveTransactionPlugin } from '../client/core-resolver.js';\nimport { transactionUsesGasCoin } from './resolution-utils.js';\n\nexport interface BuildTransactionOptions {\n\tclient?: ClientWithCoreApi;\n\tonlyTransactionKind?: boolean;\n\t/**\n\t * Resolve `CoinWithBalance` intents from address balance without looking up balances or coins.\n\t *\n\t * If nothing else needs resolution, the transaction doesn't use `GasCoin`, and it already has a\n\t * `ValidDuring` or `Validity` expiration, an unset gas payment is also set to `[]` (pay gas from\n\t * address balance). Execution fails if the balances aren't there.\n\t */\n\tassumeSufficientAddressBalances?: boolean;\n}\n\nexport interface SerializeTransactionOptions extends BuildTransactionOptions {\n\tsupportedIntents?: string[];\n}\n\n/** Options supplied when a registered intent resolver runs. */\nexport interface IntentResolverOptions extends SerializeTransactionOptions {\n\t/** Intent names assigned to this resolver for this serialization pass. */\n\tintentNames?: readonly string[];\n}\n\nexport type TransactionPlugin = (\n\ttransactionData: TransactionDataBuilder,\n\toptions: BuildTransactionOptions,\n\tnext: () => Promise<void>,\n) => Promise<void>;\n\nexport function needsTransactionResolution(\n\tdata: TransactionDataBuilder,\n\toptions: BuildTransactionOptions,\n): boolean {\n\tif (\n\t\tdata.inputs.some((input) => {\n\t\t\treturn input.UnresolvedObject || input.UnresolvedPure;\n\t\t})\n\t) {\n\t\treturn true;\n\t}\n\n\tif (!options.onlyTransactionKind) {\n\t\tif (!data.gasData.price || !data.gasData.budget) {\n\t\t\treturn true;\n\t\t}\n\n\t\tif (!data.gasData.payment) {\n\t\t\tconst assumesAddressBalanceGas =\n\t\t\t\toptions.assumeSufficientAddressBalances && !transactionUsesGasCoin(data);\n\n\t\t\t// Address balance gas has no object version to protect against replay, so an offline build\n\t\t\t// needs a ValidDuring expiration. Epoch expiration doesn't count.\n\t\t\tif (\n\t\t\t\t!assumesAddressBalanceGas ||\n\t\t\t\t(data.expiration?.$kind !== 'ValidDuring' && data.expiration?.$kind !== 'Validity')\n\t\t\t) {\n\t\t\t\treturn true;\n\t\t\t}\n\t\t} else if (data.gasData.payment.length === 0 && !data.expiration) {\n\t\t\treturn true;\n\t\t}\n\t}\n\n\treturn false;\n}\n\nexport async function resolveTransactionPlugin(\n\ttransactionData: TransactionDataBuilder,\n\toptions: BuildTransactionOptions,\n\tnext: () => Promise<void>,\n) {\n\tnormalizeRawArguments(transactionData);\n\n\tif (!needsTransactionResolution(transactionData, options)) {\n\t\t// Payment can only be unset here when assumeSufficientAddressBalances applies\n\t\tif (!options.onlyTransactionKind && !transactionData.gasData.payment) {\n\t\t\ttransactionData.gasData.payment = [];\n\t\t}\n\n\t\tawait validate(transactionData);\n\t\treturn next();\n\t}\n\n\tconst client = getClient(options);\n\tconst plugin = client.core?.resolveTransactionPlugin() ?? coreClientResolveTransactionPlugin;\n\n\treturn plugin(transactionData, options, async () => {\n\t\tawait validate(transactionData);\n\t\tawait next();\n\t});\n}\n\nfunction validate(transactionData: TransactionDataBuilder) {\n\ttransactionData.inputs.forEach((input, index) => {\n\t\tif (input.$kind !== 'Object' && input.$kind !== 'Pure' && input.$kind !== 'FundsWithdrawal') {\n\t\t\tthrow new Error(\n\t\t\t\t`Input at index ${index} has not been resolved.  Expected a Pure, Object, or FundsWithdrawal input, but found ${JSON.stringify(\n\t\t\t\t\tinput,\n\t\t\t\t)}`,\n\t\t\t);\n\t\t}\n\t});\n}\n\nexport function getClient(options: BuildTransactionOptions) {\n\tif (!options.client) {\n\t\tthrow new Error(\n\t\t\t`No sui client passed to Transaction#build, but transaction data was not sufficient to build offline.`,\n\t\t);\n\t}\n\n\treturn options.client;\n}\n\nfunction normalizeRawArguments(transactionData: TransactionDataBuilder) {\n\tfor (const command of transactionData.commands) {\n\t\tswitch (command.$kind) {\n\t\t\tcase 'SplitCoins':\n\t\t\t\tcommand.SplitCoins.amounts.forEach((amount) => {\n\t\t\t\t\tnormalizeRawArgument(amount, bcs.U64, transactionData);\n\t\t\t\t});\n\t\t\t\tbreak;\n\t\t\tcase 'TransferObjects':\n\t\t\t\tnormalizeRawArgument(command.TransferObjects.address, bcs.Address, transactionData);\n\t\t\t\tbreak;\n\t\t}\n\t}\n}\n\nfunction normalizeRawArgument(\n\targ: Argument,\n\tschema: BcsType<any>,\n\ttransactionData: TransactionDataBuilder,\n) {\n\tif (arg.$kind !== 'Input') {\n\t\treturn;\n\t}\n\tconst input = transactionData.inputs[arg.Input];\n\n\tif (input.$kind !== 'UnresolvedPure') {\n\t\treturn;\n\t}\n\n\ttransactionData.inputs[arg.Input] = Inputs.Pure(schema.serialize(input.UnresolvedPure.value));\n}\n"],"mappings":";;;;;;AA0CA,SAAgB,2BACf,MACA,SACU;AACV,KACC,KAAK,OAAO,MAAM,UAAU;AAC3B,SAAO,MAAM,oBAAoB,MAAM;GACtC,CAEF,QAAO;AAGR,KAAI,CAAC,QAAQ,qBAAqB;AACjC,MAAI,CAAC,KAAK,QAAQ,SAAS,CAAC,KAAK,QAAQ,OACxC,QAAO;AAGR,MAAI,CAAC,KAAK,QAAQ,SAMjB;OACC,EALA,QAAQ,mCAAmC,CAAC,uBAAuB,KAAK,KAMvE,KAAK,YAAY,UAAU,iBAAiB,KAAK,YAAY,UAAU,WAExE,QAAO;aAEE,KAAK,QAAQ,QAAQ,WAAW,KAAK,CAAC,KAAK,WACrD,QAAO;;AAIT,QAAO;;AAGR,eAAsB,yBACrB,iBACA,SACA,MACC;AACD,uBAAsB,gBAAgB;AAEtC,KAAI,CAAC,2BAA2B,iBAAiB,QAAQ,EAAE;AAE1D,MAAI,CAAC,QAAQ,uBAAuB,CAAC,gBAAgB,QAAQ,QAC5D,iBAAgB,QAAQ,UAAU,EAAE;AAGrC,QAAM,SAAS,gBAAgB;AAC/B,SAAO,MAAM;;AAMd,SAHe,UAAU,QAAQ,CACX,MAAM,0BAA0B,IAAI,oCAE5C,iBAAiB,SAAS,YAAY;AACnD,QAAM,SAAS,gBAAgB;AAC/B,QAAM,MAAM;GACX;;AAGH,SAAS,SAAS,iBAAyC;AAC1D,iBAAgB,OAAO,SAAS,OAAO,UAAU;AAChD,MAAI,MAAM,UAAU,YAAY,MAAM,UAAU,UAAU,MAAM,UAAU,kBACzE,OAAM,IAAI,MACT,kBAAkB,MAAM,wFAAwF,KAAK,UACpH,MACA,GACD;GAED;;AAGH,SAAgB,UAAU,SAAkC;AAC3D,KAAI,CAAC,QAAQ,OACZ,OAAM,IAAI,MACT,uGACA;AAGF,QAAO,QAAQ;;AAGhB,SAAS,sBAAsB,iBAAyC;AACvE,MAAK,MAAM,WAAW,gBAAgB,SACrC,SAAQ,QAAQ,OAAhB;EACC,KAAK;AACJ,WAAQ,WAAW,QAAQ,SAAS,WAAW;AAC9C,yBAAqB,QAAQA,OAAI,KAAK,gBAAgB;KACrD;AACF;EACD,KAAK;AACJ,wBAAqB,QAAQ,gBAAgB,SAASA,OAAI,SAAS,gBAAgB;AACnF;;;AAKJ,SAAS,qBACR,KACA,QACA,iBACC;AACD,KAAI,IAAI,UAAU,QACjB;CAED,MAAM,QAAQ,gBAAgB,OAAO,IAAI;AAEzC,KAAI,MAAM,UAAU,iBACnB;AAGD,iBAAgB,OAAO,IAAI,SAAS,OAAO,KAAK,OAAO,UAAU,MAAM,eAAe,MAAM,CAAC"}

package/dist/version.mjs

@@ -1,5 +1,5 @@
 //#region src/version.ts
-const PACKAGE_VERSION = "2.30.0";
+const PACKAGE_VERSION = "2.31.0";
 
 //#endregion
 export { PACKAGE_VERSION };

package/dist/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","names":[],"sources":["../src/version.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\n// This file is generated by genversion.mjs. Do not edit it directly.\n\nexport const PACKAGE_VERSION = '2.30.0';\n"],"mappings":";AAKA,MAAa,kBAAkB"}
+{"version":3,"file":"version.mjs","names":[],"sources":["../src/version.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\n// This file is generated by genversion.mjs. Do not edit it directly.\n\nexport const PACKAGE_VERSION = '2.31.0';\n"],"mappings":";AAKA,MAAa,kBAAkB"}

package/dist/zklogin/bcs.d.mts

@@ -1,31 +1,31 @@
-import * as _mysten_bcs1238 from "@mysten/bcs";
+import * as _mysten_bcs1384 from "@mysten/bcs";
 import { InferBcsInput } from "@mysten/bcs";
 
 //#region src/zklogin/bcs.d.ts
-declare const zkLoginSignature: _mysten_bcs1238.BcsStruct<{
-  inputs: _mysten_bcs1238.BcsStruct<{
-    proofPoints: _mysten_bcs1238.BcsStruct<{
-      a: _mysten_bcs1238.BcsType<string[], Iterable<string> & {
+declare const zkLoginSignature: _mysten_bcs1384.BcsStruct<{
+  inputs: _mysten_bcs1384.BcsStruct<{
+    proofPoints: _mysten_bcs1384.BcsStruct<{
+      a: _mysten_bcs1384.BcsType<string[], Iterable<string> & {
         length: number;
       }, string>;
-      b: _mysten_bcs1238.BcsType<string[][], Iterable<Iterable<string> & {
+      b: _mysten_bcs1384.BcsType<string[][], Iterable<Iterable<string> & {
         length: number;
       }> & {
         length: number;
       }, string>;
-      c: _mysten_bcs1238.BcsType<string[], Iterable<string> & {
+      c: _mysten_bcs1384.BcsType<string[], Iterable<string> & {
         length: number;
       }, string>;
     }, string>;
-    issBase64Details: _mysten_bcs1238.BcsStruct<{
-      value: _mysten_bcs1238.BcsType<string, string, "string">;
-      indexMod4: _mysten_bcs1238.BcsType<number, number, "u8">;
+    issBase64Details: _mysten_bcs1384.BcsStruct<{
+      value: _mysten_bcs1384.BcsType<string, string, "string">;
+      indexMod4: _mysten_bcs1384.BcsType<number, number, "u8">;
     }, string>;
-    headerBase64: _mysten_bcs1238.BcsType<string, string, "string">;
-    addressSeed: _mysten_bcs1238.BcsType<string, string, "string">;
+    headerBase64: _mysten_bcs1384.BcsType<string, string, "string">;
+    addressSeed: _mysten_bcs1384.BcsType<string, string, "string">;
   }, string>;
-  maxEpoch: _mysten_bcs1238.BcsType<string, string | number | bigint, "u64">;
-  userSignature: _mysten_bcs1238.BcsType<Uint8Array<ArrayBufferLike>, Iterable<number>, "vector<u8>">;
+  maxEpoch: _mysten_bcs1384.BcsType<string, string | number | bigint, "u64">;
+  userSignature: _mysten_bcs1384.BcsType<Uint8Array<ArrayBufferLike>, Iterable<number>, "vector<u8>">;
 }, string>;
 type ZkLoginSignature = InferBcsInput<typeof zkLoginSignature>;
 type ZkLoginSignatureInputs = ZkLoginSignature['inputs'];

package/docs/llms-index.md

@@ -12,6 +12,7 @@
 - [Building Transactions](./transactions/basics.md): Construct programmable transaction blocks with the Transaction API
 - [Signing and Execution](./transactions/signing-and-execution.md): Sign transactions and execute them on the Sui network
 - [Coins and Balances](./transactions/coins-and-balances.md): Work with coin objects and address balances in transactions
+- [Allowances](./transactions/allowances.md): Create allowances and spend from another account's address balance
 - [Commands and Inputs Reference](./transactions/reference.md): Complete reference for transaction commands and input types
 - [Building Offline](./transactions/offline.md): Build transactions without a network connection
 - [Cryptography](./cryptography.md): >- Sign and verify Sui transactions and messages with keypairs and external signers

package/docs/transactions/allowances.md

@@ -0,0 +1,176 @@
+# Allowances
+
+> Create allowances and spend from another account's address balance
+
+An [allowance](https://docs.sui.io/references/framework/sui_sui/allowance) lets a **spender** use a
+**funder's** address balance, subject to spending limits. The spender signs transactions that use
+it. The network must have allowance support enabled (protocol v137 or later).
+
+## Creating an allowance
+
+This non-app allowance permits up to 100 USDC of spending over 24 hours. `funder` is the signer
+creating the allowance. Replace `0xUsdcPackage::usdc::USDC` with your network's USDC type; amounts
+use its six decimal places.
+
+```tsx
+
+const USDC = '0xUsdcPackage::usdc::USDC';
+const balanceType = `0x2::balance::Balance<${USDC}>`;
+const expirationMs = BigInt(Date.now() + 24 * 60 * 60 * 1000);
+const tx = new Transaction();
+
+// RateLimit is a Move type, so construct its empty option with a Move call.
+const noRateLimit = tx.moveCall({
+	target: '0x1::option::none',
+	typeArguments: ['0x2::allowance::RateLimit'],
+});
+
+tx.moveCall({
+	target: '0x2::allowance::new',
+	typeArguments: [balanceType],
+	arguments: [
+		tx.pure.string('USDC spending allowance'),
+		tx.pure.address(spenderAddress),
+		tx.pure.option('u256', 100_000_000n), // Lifetime cap: 100 USDC
+		tx.pure.option('u64', null), // No delayed start
+		tx.pure.option('u64', expirationMs),
+		noRateLimit,
+	],
+});
+
+const result = await client.core.signAndExecuteTransaction({
+	transaction: tx,
+	signer: funder,
+	include: { effects: true },
+});
+
+if (result.$kind === 'FailedTransaction') {
+	throw new Error(result.FailedTransaction.status.error?.message ?? 'Allowance creation failed');
+}
+
+// This transaction creates one shared object: the allowance.
+const allowance = result.Transaction.effects!.changedObjects.find(
+	(change) => change.idOperation === 'Created' && change.outputOwner?.$kind === 'Shared',
+);
+if (!allowance) throw new Error('No allowance was created');
+
+const allowanceId = allowance.objectId;
+await client.core.waitForTransaction({ digest: result.Transaction.digest });
+// Give allowanceId to the spender.
+```
+
+`allowance::new` takes `Balance<USDC>` as its type argument; the spending helpers take `USDC`.
+Creation also sends the funder an `AllowanceCap`, which can revoke the allowance.
+
+Creating an allowance does not reserve or deposit funds. The funder must have enough USDC in its
+[address balance](https://docs.sui.io/onchain-finance/asset-custody/address-balances/using-address-balances#sending-funds)
+when the spender withdraws.
+
+### Limits and expiration
+
+An allowance requires both a lifetime cap and an expiration, unless it has a recurring rate limit.
+Lifetime caps must be positive `u256` amounts. Start and expiration times use Unix milliseconds; if
+both are set, the start must be earlier. Names can be at most 128 bytes.
+
+For recurring spending, use `allowance::periodic_rate_limit(period_ms, limit)` or
+`allowance::monthly_rate_limit(limit)`. Wrap the result in `0x1::option::some<RateLimit>` and pass
+it as the last argument to `allowance::new`. A rate limit can replace the lifetime cap and
+expiration, or apply alongside them.
+
+## Spending from an allowance
+
+Pass the shared allowance ID and sign with the spender's key:
+
+```tsx
+
+const USDC = '0xUsdcPackage::usdc::USDC';
+const tx = new Transaction();
+const balance = tx.balance({
+	allowance: '0xAllowanceId',
+	balance: 10_000_000n, // 10 USDC
+	type: USDC,
+});
+
+tx.moveCall({
+	target: '0xPackage::pool::deposit',
+	typeArguments: [USDC],
+	arguments: [tx.object('0xPoolId'), balance],
+});
+
+await client.core.signAndExecuteTransaction({ transaction: tx, signer: spender });
+```
+
+Use `tx.coin()` instead when the next operation expects a `Coin<T>`. Both helpers default to SUI, so
+pass `type: USDC` explicitly. Each amount must fit in a `u64`.
+
+The SDK looks up the funder from the allowance ID. Spending draws only from that funder's address
+balance and must satisfy the allowance's limits and expiration. The sender or a sponsor must pay gas
+separately; do not combine `allowance` with `useGasCoin`.
+
+### Using a known funder
+
+Pass the funder alongside the ID to skip the allowance lookup:
+
+```tsx
+
+const USDC = '0xUsdcPackage::usdc::USDC';
+const tx = new Transaction();
+const coin = tx.coin({
+	allowance: { objectId: '0xAllowanceId', funder: '0xFunderAddress' },
+	balance: 10_000_000n, // 10 USDC
+	type: USDC,
+});
+tx.transferObjects([coin], '0xRecipientAddress');
+```
+
+This skips the SDK's coin type and app binding checks; incorrect references fail on-chain. Building
+may still need a client to resolve object versions and gas.
+
+## App-bound allowances
+
+App-bound allowances require a `SpendPermit<A>` from the app as well as the spender's signature.
+Pass the permit and app type to `tx.balance()` or `tx.coin()`:
+
+```tsx
+
+const USDC = '0xUsdcPackage::usdc::USDC';
+const tx = new Transaction();
+const permit = tx.moveCall({
+	target: '0xAppPackage::subscriptions::authorize_payment',
+	arguments: [tx.object('0xSubscriptionId')],
+});
+const balance = tx.balance({
+	balance: 10_000_000n, // 10 USDC
+	type: USDC,
+	allowance: {
+		objectId: '0xAllowanceId',
+		app: { type: '0xAppPackage::subscriptions::APP', permit },
+	},
+});
+// Pass balance to the app's next operation.
+```
+
+To create an app-bound allowance, the funder calls `allowance::propose_for_app`. The app accepts the
+proposal through `allowance::issue` with a `SettingsPermit<A>`.
+
+The authorization function and its arguments are defined by the app. The SDK handles the framework's
+`app_balance_spend` call. Add `funder` to the allowance reference to skip the metadata lookup.
+
+A permit authorizes one spend but does not bind its amount or recipient. Apps that need to enforce
+those must redeem the withdrawal inside their own Move function, using `tx.withdrawal()` as the
+input.
+
+```tsx
+
+const tx = new Transaction();
+const withdrawal = tx.withdrawal({
+	amount: 10_000_000n,
+	type: '0xUsdcPackage::usdc::USDC',
+	from: 'allowance',
+	allowance: '0xAllowanceId',
+	funder: '0xFunderAddress',
+});
+// Pass withdrawal to the app's Move function that redeems it.
+```
+
+`from: 'allowance'` requires both `allowance` and `funder`; this helper does not look them up.

package/docs/transactions/coins-and-balances.md

@@ -20,7 +20,8 @@ invalidated by other transactions from the same address executing concurrently.
 ## `tx.coin` and `tx.balance`
 
 `tx.coin()` and `tx.balance()` are the recommended ways to get tokens in a transaction. They
-automatically draw from both coin objects and address balances.
+automatically draw from both coin objects and address balances. To spend funds authorized by another
+account, see [Allowances](./allowances.mdx).
 
 ### Getting a `Coin`
 
@@ -74,11 +75,11 @@ tx.moveCall({
 
 ### Options
 
-| Option       | Type               | Default    | Description                                                              |
-| ------------ | ------------------ | ---------- | ------------------------------------------------------------------------ |
-| `balance`    | `bigint \| number` | _required_ | Amount in base units (MIST for SUI)                                      |
-| `type`       | `string`           | SUI        | Coin type. Defaults to `0x2::sui::SUI`                                   |
-| `useGasCoin` | `boolean`          | `true`     | For SUI, split from the gas coin. Set `false` for sponsored transactions |
+| Option       | Type                         | Default    | Description                                                                             |
+| ------------ | ---------------------------- | ---------- | --------------------------------------------------------------------------------------- |
+| `balance`    | `bigint \| number \| string` | _required_ | Amount in base units (MIST for SUI); use safe integer numbers or bigint/decimal strings |
+| `type`       | `string`                     | SUI        | Coin type T, not Balance<T>. Defaults to `0x2::sui::SUI`                          |
+| `useGasCoin` | `boolean`                    | `true`     | For SUI, allow splitting the gas coin. Set `false` for sponsored transactions           |
 
 For SUI, `tx.coin()` splits from the gas coin by default. For sponsored transactions where the gas
 coin belongs to the sponsor, set `useGasCoin: false`:
@@ -89,7 +90,7 @@ tx.transferObjects([tx.coin({ balance: 100n, useGasCoin: false })], recipient);
 
 ### `coinWithBalance`
 
-`coinWithBalance()` is a standalone alias for `tx.coin()`:
+`coinWithBalance()` is a standalone helper for sender-funded coins:
 
 ```tsx
 
@@ -100,7 +101,8 @@ tx.transferObjects([coinWithBalance({ balance: 1_000_000_000 })], recipient);
 ## How resolution works
 
 When you call `tx.coin()` or `tx.balance()`, the SDK adds a placeholder intent to the transaction.
-At build time, the resolver replaces it with concrete commands based on the sender's funds:
+For sender-funded requests, the resolver replaces it at build time with concrete commands based on
+the sender's funds:
 
 - **`tx.balance()` with sufficient address balance:** Uses a direct `FundsWithdrawal` through
   `balance::redeem_funds`. No coin objects are used, so the transaction has no versioned object
@@ -115,7 +117,8 @@ At build time, the resolver replaces it with concrete commands based on the send
 The resolver prefers address balances when possible to avoid introducing versioned object
 dependencies.
 
-Zero-balance requests resolve to `balance::zero` or `coin::zero` with no network lookups.
+Sender-funded zero-balance requests resolve to `balance::zero` or `coin::zero` with no network
+lookups.
 
 ## Checking balances
 

package/package.json

@@ -3,7 +3,7 @@
   "author": "Mysten Labs <build@mystenlabs.com>",
   "description": "Sui TypeScript API",
   "homepage": "https://sdk.mystenlabs.com",
-  "version": "2.30.0",
+  "version": "2.31.0",
   "license": "Apache-2.0",
   "sideEffects": false,
   "files": [

package/src/bcs/bcs.ts

@@ -96,6 +96,10 @@ export const WithdrawalType = bcs.enum('WithdrawalType', {
 export const WithdrawFrom = bcs.enum('WithdrawFrom', {
 	Sender: null,
 	Sponsor: null,
+	SenderAllowance: bcs.struct('SenderAllowance', {
+		funder: Address,
+		allowance: Address,
+	}),
 });
 
 // Rust: crates/sui-types/src/transaction.rs

package/src/bcs/types.ts

@@ -44,7 +44,8 @@ export function isPureArg(arg: any): arg is PureArg {
 
 type Reservation = { MaxAmountU64: number | string };
 type WithdrawalTypeArg = { Balance: TypeTag };
-type WithdrawFrom = { Sender: null } | { Sponsor: null };
+type WithdrawFrom =
+	{ Sender: null } | { Sponsor: null } | { SenderAllowance: { funder: string; allowance: string } };
 type FundsWithdrawalArg = {
 	reservation: Reservation;
 	typeArg: WithdrawalTypeArg;

package/src/client/core-resolver.ts

@@ -66,10 +66,12 @@ export async function coreClientResolveTransactionPlugin(
 	for (const input of transactionData.inputs) {
 		if (input.$kind !== 'FundsWithdrawal' || !normalizedGasPayer) continue;
 		if (normalizeStructTag(input.FundsWithdrawal.typeArg.Balance) !== SUI_TYPE_ARG) continue;
-
-		const withdrawalOwner = input.FundsWithdrawal.withdrawFrom.Sender
-			? transactionData.sender
-			: gasPayer;
+		const source = input.FundsWithdrawal.withdrawFrom;
+		const withdrawalOwner = source.SenderAllowance
+			? source.SenderAllowance.funder
+			: source.Sender
+				? transactionData.sender
+				: gasPayer;
 		if (
 			withdrawalOwner &&
 			normalizeSuiAddress(withdrawalOwner) === normalizedGasPayer &&

package/src/client/transaction-resolver.ts

@@ -20,7 +20,7 @@ import {
 	TransactionExpiration_TransactionExpirationKind,
 } from '../grpc/proto/sui/rpc/v2/transaction.js';
 import type { ObjectReference } from '../grpc/proto/sui/rpc/v2/object_reference.js';
-import type { Input } from '../grpc/proto/sui/rpc/v2/input.js';
+import type { FundsWithdrawal, Input } from '../grpc/proto/sui/rpc/v2/input.js';
 import { FundsWithdrawal_Source, Input_InputKind } from '../grpc/proto/sui/rpc/v2/input.js';
 import type { Command } from '../grpc/proto/sui/rpc/v2/transaction.js';
 import type { Argument } from '../grpc/proto/sui/rpc/v2/argument.js';
@@ -102,10 +102,7 @@ function callArgToGrpcInput(arg: CallArg): Input {
 							? BigInt(withdrawal.reservation.MaxAmountU64)
 							: undefined,
 					coinType: withdrawal.typeArg.$kind === 'Balance' ? withdrawal.typeArg.Balance : undefined,
-					source:
-						withdrawal.withdrawFrom.$kind === 'Sponsor'
-							? FundsWithdrawal_Source.SPONSOR
-							: FundsWithdrawal_Source.SENDER,
+					...tsWithdrawFromToGrpc(withdrawal.withdrawFrom),
 				},
 			};
 		}
@@ -115,6 +112,46 @@ function callArgToGrpcInput(arg: CallArg): Input {
 	}
 }
 
+function tsWithdrawFromToGrpc(
+	withdrawFrom: Extract<CallArg, { FundsWithdrawal: unknown }>['FundsWithdrawal']['withdrawFrom'],
+): Pick<FundsWithdrawal, 'source' | 'funder' | 'allowance'> {
+	switch (withdrawFrom.$kind) {
+		case 'Sender':
+			return { source: FundsWithdrawal_Source.SENDER };
+		case 'Sponsor':
+			return { source: FundsWithdrawal_Source.SPONSOR };
+		case 'SenderAllowance':
+			return {
+				source: FundsWithdrawal_Source.SENDER_ALLOWANCE,
+				funder: withdrawFrom.SenderAllowance.funder,
+				allowance: withdrawFrom.SenderAllowance.allowance,
+			};
+		default:
+			throw new Error(`Unknown WithdrawFrom kind: ${JSON.stringify(withdrawFrom)}`);
+	}
+}
+
+function grpcWithdrawFromToTs(
+	withdrawal: FundsWithdrawal | undefined,
+): Extract<CallArg, { FundsWithdrawal: unknown }>['FundsWithdrawal']['withdrawFrom'] {
+	switch (withdrawal?.source) {
+		case FundsWithdrawal_Source.SPONSOR:
+			return { $kind: 'Sponsor', Sponsor: true };
+		case FundsWithdrawal_Source.SENDER_ALLOWANCE:
+			if (!withdrawal.funder || !withdrawal.allowance) {
+				throw new Error(
+					`SENDER_ALLOWANCE withdrawal is missing funder or allowance: ${JSON.stringify(withdrawal)}`,
+				);
+			}
+			return {
+				$kind: 'SenderAllowance',
+				SenderAllowance: { funder: withdrawal.funder, allowance: withdrawal.allowance },
+			};
+		default:
+			return { $kind: 'Sender', Sender: true };
+	}
+}
+
 /**
  * Converts a TypeScript Argument to gRPC Argument
  */
@@ -429,10 +466,7 @@ function grpcInputToCallArg(input: Input): CallArg {
 						$kind: 'Balance' as const,
 						Balance: input.fundsWithdrawal?.coinType ?? '0x2::sui::SUI',
 					},
-					withdrawFrom:
-						input.fundsWithdrawal?.source === FundsWithdrawal_Source.SPONSOR
-							? { $kind: 'Sponsor' as const, Sponsor: true as const }
-							: { $kind: 'Sender' as const, Sender: true as const },
+					withdrawFrom: grpcWithdrawFromToTs(input.fundsWithdrawal),
 				},
 			};