@aptos-labs/ts-sdk 6.3.1 → 7.0.1

package/dist/transactions/transactionBuilder/encryptPayload.js

@@ -0,0 +1,159 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { AccountAddress } from "../../core/index.js";
+import { AuthenticationKey } from "../../core/authenticationKey.js";
+import { AccountPublicKey } from "../../core/crypto/index.js";
+import { fetchAndCacheEncryptionKey } from "../../internal/encryptionKey.js";
+import { ClaimedEntryFunction, DECRYPTION_NONCE_LENGTH, DecryptedPlaintext, PayloadAssociatedData, } from "../instances/encryptedPayload.js";
+import { Identifier } from "../instances/identifier.js";
+import { ModuleId } from "../instances/moduleId.js";
+import { TransactionExecutableEntryFunction, TransactionExtraConfigV1, TransactionInnerPayloadV1, TransactionPayloadEncryptedPayload, TransactionPayloadMultiSig, } from "../instances/transactionPayload.js";
+import { convertPayloadToInnerPayload } from "./transactionBuilder.js";
+function payloadToExecutable(payload) {
+    if (payload instanceof TransactionInnerPayloadV1) {
+        return { executable: payload.executable, extraConfig: payload.extra_config };
+    }
+    const inner = convertPayloadToInnerPayload(payload);
+    return { executable: inner.executable, extraConfig: inner.extra_config };
+}
+function toClaimedEntryFunction(input) {
+    if (input instanceof ClaimedEntryFunction) {
+        return input;
+    }
+    return new ClaimedEntryFunction(ModuleId.fromStr(input.module), input.functionName !== undefined ? new Identifier(input.functionName) : undefined);
+}
+function assertClaimMatchesExecutable(payload, claim) {
+    const { executable } = payloadToExecutable(payload);
+    if (!(executable instanceof TransactionExecutableEntryFunction)) {
+        throw new Error("claimedEntryFunction is only valid when the plaintext executable is an entry function.");
+    }
+    const entry = executable.entryFunction;
+    if (!entry.module_name.address.equals(claim.moduleId.address) ||
+        entry.module_name.name.identifier !== claim.moduleId.name.identifier) {
+        throw new Error("claimedEntryFunction.module must match the entry function module.");
+    }
+    if (claim.functionName !== undefined && entry.function_name.identifier !== claim.functionName.identifier) {
+        throw new Error("claimedEntryFunction.functionName must match the entry function name when provided.");
+    }
+}
+function payloadHasMultisigAddress(payload) {
+    if (payload instanceof TransactionPayloadMultiSig) {
+        return true;
+    }
+    if (payload instanceof TransactionInnerPayloadV1) {
+        const ec = payload.extra_config;
+        return ec instanceof TransactionExtraConfigV1 && ec.multisigAddress !== undefined;
+    }
+    return false;
+}
+function resolveClaimedEntryFun(args) {
+    const { payload, feePayerAddress, options } = args;
+    // Unlike buildSignerAuthKeys, we treat a zero feePayerAddress (deferred gas-station sponsor) the
+    // same as a real one: a fee payer *will* sign, so include claimed_entry_fun so they can inspect
+    // the payload without decrypting it. The zero check in buildSignerAuthKeys is different — adding
+    // a placeholder zero auth key to the cryptographic AAD would corrupt it.
+    const hasFeePayer = feePayerAddress !== undefined;
+    if (!hasFeePayer && !payloadHasMultisigAddress(payload)) {
+        return undefined;
+    }
+    if (options.claimedEntryFunction !== undefined) {
+        const claim = toClaimedEntryFunction(options.claimedEntryFunction);
+        assertClaimMatchesExecutable(payload, claim);
+        return claim;
+    }
+    const { executable } = payloadToExecutable(payload);
+    if (executable instanceof TransactionExecutableEntryFunction) {
+        return ClaimedEntryFunction.fromEntryFunction(executable.entryFunction);
+    }
+    return undefined;
+}
+function resolveAuthKey(input) {
+    if (input instanceof AccountPublicKey) {
+        return input.authKey();
+    }
+    return new AuthenticationKey({ data: input });
+}
+/**
+ * Validates auth-key options and assembles `(address, authenticationKey)` pairs in
+ * `TransactionAuthenticator::all_signer_auth_keys` order: sender, secondaries, fee payer last.
+ */
+function buildSignerAuthKeys(args) {
+    const { sender, options, feePayerAddress, secondarySignerAddresses } = args;
+    if (options.authenticationKey === undefined) {
+        throw new Error("options.authenticationKey is required when options.encrypted is true. " +
+            "Pass the sender's AccountPublicKey or a raw 32-byte auth key hex string.");
+    }
+    const secondaryAddrs = secondarySignerAddresses ?? [];
+    const secondaryAuthHex = options.secondarySignerAuthenticationKeys;
+    if (secondaryAddrs.length > 0) {
+        if (!secondaryAuthHex || secondaryAuthHex.length !== secondaryAddrs.length) {
+            throw new Error("Encrypted multi-agent transactions require options.secondarySignerAuthenticationKeys with one entry per secondarySignerAddresses entry, in the same order. " +
+                "Each entry may be an AccountPublicKey or a raw 32-byte auth key hex string.");
+        }
+    }
+    else if (secondaryAuthHex !== undefined && secondaryAuthHex.length > 0) {
+        throw new Error("options.secondarySignerAuthenticationKeys was set but no secondarySignerAddresses were provided to generateRawTransaction.");
+    }
+    const feePayerAddr = feePayerAddress !== undefined ? AccountAddress.from(feePayerAddress) : undefined;
+    const hasNonZeroFeePayer = feePayerAddr !== undefined && !feePayerAddr.equals(AccountAddress.ZERO);
+    if (hasNonZeroFeePayer && options.feePayerAuthenticationKey === undefined) {
+        throw new Error("options.feePayerAuthenticationKey is required when options.encrypted is true and feePayerAddress is a non-zero sponsor. " +
+            "Must match the fee payer authenticator; AAD order is sender, then secondaries, then fee payer (aptos-core `all_signer_auth_keys`).");
+    }
+    if (options.feePayerAuthenticationKey !== undefined && !hasNonZeroFeePayer) {
+        throw new Error("options.feePayerAuthenticationKey was set but feePayerAddress is missing or the zero address (no on-chain fee payer for AAD).");
+    }
+    const senderPair = {
+        address: sender,
+        authenticationKey: resolveAuthKey(options.authenticationKey),
+    };
+    const additional = secondaryAddrs.length > 0 && secondaryAuthHex
+        ? secondaryAddrs.map((addr, i) => ({
+            address: AccountAddress.from(addr),
+            authenticationKey: resolveAuthKey(secondaryAuthHex[i]),
+        }))
+        : [];
+    if (hasNonZeroFeePayer && options.feePayerAuthenticationKey !== undefined) {
+        additional.push({
+            address: feePayerAddr,
+            authenticationKey: resolveAuthKey(options.feePayerAuthenticationKey),
+        });
+    }
+    return { sender: senderPair, additional: additional.length > 0 ? additional : undefined };
+}
+/**
+ * Encrypts an entry-function/script/inner payload using the node's per-epoch batch encryption key.
+ * Validates `options.encrypted` requirements first.
+ *
+ * @group Implementation
+ * @category Transactions
+ */
+export async function buildEncryptedPayload(args) {
+    const { aptosConfig, sender, payload, options, feePayerAddress, secondarySignerAddresses, replayProtectionNonce } = args;
+    const senderAddr = AccountAddress.from(sender);
+    const { sender: senderPair, additional } = buildSignerAuthKeys({
+        sender: senderAddr,
+        options,
+        feePayerAddress,
+        secondarySignerAddresses,
+    });
+    const claimedEntryFunction = resolveClaimedEntryFun({ payload, feePayerAddress, options });
+    const encryption = await fetchAndCacheEncryptionKey({ aptosConfig });
+    if (!encryption) {
+        throw new Error("Encrypted transactions requested but the node does not provide an encryption key. " +
+            "Ensure the node supports encrypted transaction submission.");
+    }
+    const { key: encryptionKey, epoch: encryptionEpoch } = encryption;
+    const { executable, extraConfig: baseExtraConfig } = payloadToExecutable(payload);
+    let extraConfig = baseExtraConfig;
+    if (replayProtectionNonce !== undefined && extraConfig instanceof TransactionExtraConfigV1) {
+        extraConfig = new TransactionExtraConfigV1(extraConfig.multisigAddress, replayProtectionNonce);
+    }
+    const decryptionNonce = new Uint8Array(DECRYPTION_NONCE_LENGTH);
+    crypto.getRandomValues(decryptionNonce);
+    const decryptedPayload = new DecryptedPlaintext(executable, decryptionNonce);
+    const associatedData = new PayloadAssociatedData(senderAddr, [senderPair, ...(additional ?? [])]);
+    const ciphertext = encryptionKey.encrypt(decryptedPayload, associatedData);
+    return new TransactionPayloadEncryptedPayload(ciphertext, extraConfig, decryptedPayload.hash(), encryptionEpoch, claimedEntryFunction);
+}
+//# sourceMappingURL=encryptPayload.js.map

package/dist/transactions/transactionBuilder/encryptPayload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encryptPayload.js","sourceRoot":"","sources":["../../../src/transactions/transactionBuilder/encryptPayload.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAGtC,OAAO,EAAE,cAAc,EAAuB,MAAM,qBAAqB,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,kBAAkB,EAClB,qBAAqB,GAEtB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAEL,kCAAkC,EAElC,wBAAwB,EACxB,yBAAyB,EACzB,kCAAkC,EAClC,0BAA0B,GAC3B,MAAM,oCAAoC,CAAC;AAG5C,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AAEvE,SAAS,mBAAmB,CAAC,OAAsC;IAIjE,IAAI,OAAO,YAAY,yBAAyB,EAAE,CAAC;QACjD,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,YAAY,EAAE,CAAC;IAC/E,CAAC;IACD,MAAM,KAAK,GAAG,4BAA4B,CAAC,OAAO,CAA8B,CAAC;IACjF,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,WAAW,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC;AAC3E,CAAC;AAED,SAAS,sBAAsB,CAAC,KAAuD;IACrF,IAAI,KAAK,YAAY,oBAAoB,EAAE,CAAC;QAC1C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,IAAI,oBAAoB,CAC7B,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAC9B,KAAK,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAClF,CAAC;AACJ,CAAC;AAED,SAAS,4BAA4B,CAAC,OAAsC,EAAE,KAA2B;IACvG,MAAM,EAAE,UAAU,EAAE,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACpD,IAAI,CAAC,CAAC,UAAU,YAAY,kCAAkC,CAAC,EAAE,CAAC;QAChE,MAAM,IAAI,KAAK,CAAC,wFAAwF,CAAC,CAAC;IAC5G,CAAC;IACD,MAAM,KAAK,GAAG,UAAU,CAAC,aAAa,CAAC;IACvC,IACE,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC;QACzD,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,EACpE,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;IACvF,CAAC;IACD,IAAI,KAAK,CAAC,YAAY,KAAK,SAAS,IAAI,KAAK,CAAC,aAAa,CAAC,UAAU,KAAK,KAAK,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;QACzG,MAAM,IAAI,KAAK,CAAC,qFAAqF,CAAC,CAAC;IACzG,CAAC;AACH,CAAC;AAED,SAAS,yBAAyB,CAAC,OAAsC;IACvE,IAAI,OAAO,YAAY,0BAA0B,EAAE,CAAC;QAClD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,OAAO,YAAY,yBAAyB,EAAE,CAAC;QACjD,MAAM,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC;QAChC,OAAO,EAAE,YAAY,wBAAwB,IAAI,EAAE,CAAC,eAAe,KAAK,SAAS,CAAC;IACpF,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,sBAAsB,CAAC,IAI/B;IACC,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IACnD,iGAAiG;IACjG,gGAAgG;IAChG,iGAAiG;IACjG,yEAAyE;IACzE,MAAM,WAAW,GAAG,eAAe,KAAK,SAAS,CAAC;IAClD,IAAI,CAAC,WAAW,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,EAAE,CAAC;QACxD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,OAAO,CAAC,oBAAoB,KAAK,SAAS,EAAE,CAAC;QAC/C,MAAM,KAAK,GAAG,sBAAsB,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QACnE,4BAA4B,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC7C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,EAAE,UAAU,EAAE,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACpD,IAAI,UAAU,YAAY,kCAAkC,EAAE,CAAC;QAC7D,OAAO,oBAAoB,CAAC,iBAAiB,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IAC1E,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,cAAc,CAAC,KAAkC;IACxD,IAAI,KAAK,YAAY,gBAAgB,EAAE,CAAC;QACtC,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC;IACzB,CAAC;IACD,OAAO,IAAI,iBAAiB,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;AAChD,CAAC;AAED;;;GAGG;AACH,SAAS,mBAAmB,CAAC,IAK5B;IACC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,wBAAwB,EAAE,GAAG,IAAI,CAAC;IAE5E,IAAI,OAAO,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;QAC5C,MAAM,IAAI,KAAK,CACb,wEAAwE;YACtE,0EAA0E,CAC7E,CAAC;IACJ,CAAC;IACD,MAAM,cAAc,GAAG,wBAAwB,IAAI,EAAE,CAAC;IACtD,MAAM,gBAAgB,GAAG,OAAO,CAAC,iCAAiC,CAAC;IACnE,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9B,IAAI,CAAC,gBAAgB,IAAI,gBAAgB,CAAC,MAAM,KAAK,cAAc,CAAC,MAAM,EAAE,CAAC;YAC3E,MAAM,IAAI,KAAK,CACb,6JAA6J;gBAC3J,6EAA6E,CAChF,CAAC;QACJ,CAAC;IACH,CAAC;SAAM,IAAI,gBAAgB,KAAK,SAAS,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzE,MAAM,IAAI,KAAK,CACb,4HAA4H,CAC7H,CAAC;IACJ,CAAC;IAED,MAAM,YAAY,GAAG,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACtG,MAAM,kBAAkB,GAAG,YAAY,KAAK,SAAS,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACnG,IAAI,kBAAkB,IAAI,OAAO,CAAC,yBAAyB,KAAK,SAAS,EAAE,CAAC;QAC1E,MAAM,IAAI,KAAK,CACb,0HAA0H;YACxH,oIAAoI,CACvI,CAAC;IACJ,CAAC;IACD,IAAI,OAAO,CAAC,yBAAyB,KAAK,SAAS,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC3E,MAAM,IAAI,KAAK,CACb,+HAA+H,CAChI,CAAC;IACJ,CAAC;IAED,MAAM,UAAU,GAAsB;QACpC,OAAO,EAAE,MAAM;QACf,iBAAiB,EAAE,cAAc,CAAC,OAAO,CAAC,iBAAiB,CAAC;KAC7D,CAAC;IACF,MAAM,UAAU,GACd,cAAc,CAAC,MAAM,GAAG,CAAC,IAAI,gBAAgB;QAC3C,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;YAC/B,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC;YAClC,iBAAiB,EAAE,cAAc,CAAC,gBAAgB,CAAC,CAAC,CAAE,CAAC;SACxD,CAAC,CAAC;QACL,CAAC,CAAC,EAAE,CAAC;IACT,IAAI,kBAAkB,IAAI,OAAO,CAAC,yBAAyB,KAAK,SAAS,EAAE,CAAC;QAC1E,UAAU,CAAC,IAAI,CAAC;YACd,OAAO,EAAE,YAAY;YACrB,iBAAiB,EAAE,cAAc,CAAC,OAAO,CAAC,yBAAyB,CAAC;SACrE,CAAC,CAAC;IACL,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;AAC5F,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,IAQ3C;IACC,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,GAC/G,IAAI,CAAC;IAEP,MAAM,UAAU,GAAG,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,mBAAmB,CAAC;QAC7D,MAAM,EAAE,UAAU;QAClB,OAAO;QACP,eAAe;QACf,wBAAwB;KACzB,CAAC,CAAC;IACH,MAAM,oBAAoB,GAAG,sBAAsB,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,CAAC,CAAC;IAE3F,MAAM,UAAU,GAAG,MAAM,0BAA0B,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;IACrE,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CACb,oFAAoF;YAClF,4DAA4D,CAC/D,CAAC;IACJ,CAAC;IACD,MAAM,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,eAAe,EAAE,GAAG,UAAU,CAAC;IAElE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,eAAe,EAAE,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAClF,IAAI,WAAW,GAA2B,eAAe,CAAC;IAC1D,IAAI,qBAAqB,KAAK,SAAS,IAAI,WAAW,YAAY,wBAAwB,EAAE,CAAC;QAC3F,WAAW,GAAG,IAAI,wBAAwB,CAAC,WAAW,CAAC,eAAe,EAAE,qBAAqB,CAAC,CAAC;IACjG,CAAC;IAED,MAAM,eAAe,GAAG,IAAI,UAAU,CAAC,uBAAuB,CAAC,CAAC;IAChE,MAAM,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;IACxC,MAAM,gBAAgB,GAAG,IAAI,kBAAkB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;IAC7E,MAAM,cAAc,GAAG,IAAI,qBAAqB,CAAC,UAAU,EAAE,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAClG,MAAM,UAAU,GAAG,aAAa,CAAC,OAAO,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;IAE3E,OAAO,IAAI,kCAAkC,CAC3C,UAAU,EACV,WAAW,EACX,gBAAgB,CAAC,IAAI,EAAE,EACvB,eAAe,EACf,oBAAoB,CACrB,CAAC;AACJ,CAAC"}

package/dist/transactions/transactionBuilder/helpers.d.ts

@@ -0,0 +1,184 @@
+import { EntryFunctionArgumentTypes, InputGenerateTransactionPayloadData, InputGenerateTransactionPayloadDataWithRemoteABI, InputScriptData, SimpleEntryFunctionArgumentTypes } from "../types.js";
+import { Bool, FixedBytes, I128, I16, I256, I32, I64, I8, MoveString, U128, U16, U256, U32, U64, U8 } from "../../bcs/index.js";
+import { AccountAddress } from "../../core/index.js";
+import { MoveFunction } from "../../types/index.js";
+/**
+ * Determines if the provided argument is of type boolean.
+ * This can help in validating input types before processing them further.
+ *
+ * @param arg - The argument to check, which can be of various types.
+ * @returns A boolean indicating whether the argument is a boolean.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isBool(arg: SimpleEntryFunctionArgumentTypes): arg is boolean;
+/**
+ * Checks if the provided argument is of type string.
+ *
+ * @param arg - The value to be checked for string type.
+ * @returns A boolean indicating whether the argument is a string.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isString(arg: any): arg is string;
+/**
+ * Determines if the provided argument is of type number.
+ *
+ * @param arg - The argument to check, which can be of various types.
+ * @returns A boolean indicating whether the argument is a number.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isNumber(arg: SimpleEntryFunctionArgumentTypes): arg is number;
+/**
+ * Converts a number or a string representation of a number into a number type.
+ * This function is useful for ensuring that the input is in a consistent numeric format,
+ * which can help prevent type mismatches in further processing.
+ *
+ * @param arg - The input value to be converted. This can be a number, a string representing a number, or any other type.
+ * @returns Returns the converted number if the input is valid; otherwise, it returns undefined.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function convertNumber(arg: SimpleEntryFunctionArgumentTypes): number | undefined;
+/**
+ * Determines if the provided argument is a large number, which can be a number, bigint, or string representation of a number.
+ *
+ * @param arg - The argument to check, which can be of type number, bigint, or string.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isLargeNumber(arg: SimpleEntryFunctionArgumentTypes): arg is number | bigint | string;
+/**
+ * Checks if the provided argument is empty, meaning it is either null or undefined.
+ *
+ * @param arg - The argument to check for emptiness.
+ * @returns A boolean indicating whether the argument is empty.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isEmptyOption(arg: SimpleEntryFunctionArgumentTypes): arg is null | undefined;
+/**
+ * Determines if the provided argument is a valid encoded entry function argument type.
+ * This function helps validate that the argument conforms to the expected types for entry function parameters.
+ *
+ * @param arg - The argument to check, which can be of type EntryFunctionArgumentTypes or SimpleEntryFunctionArgumentTypes.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isEncodedEntryFunctionArgument(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is EntryFunctionArgumentTypes;
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isBcsBool(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is Bool;
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isBcsAddress(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is AccountAddress;
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isBcsString(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is MoveString;
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isBcsFixedBytes(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is FixedBytes;
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isBcsU8(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U8;
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isBcsU16(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U16;
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isBcsU32(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U32;
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isBcsU64(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U64;
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isBcsU128(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U128;
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isBcsU256(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U256;
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isBcsI8(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is I8;
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isBcsI16(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is I16;
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isBcsI32(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is I32;
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isBcsI64(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is I64;
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isBcsI128(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is I128;
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isBcsI256(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is I256;
+/**
+ * Determines if the provided argument contains script data input by checking for the presence of bytecode.
+ *
+ * @param arg - The input data to be checked, which can either be a payload with remote ABI or a standard payload.
+ * @param arg.bytecode - The bytecode of the script, present if the input is script data.
+ * @param arg.function - The function associated with the transaction, which is relevant for standard payloads.
+ * @param arg.args - The arguments for the function, applicable in the context of standard payloads.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function isScriptDataInput(arg: InputGenerateTransactionPayloadDataWithRemoteABI | InputGenerateTransactionPayloadData): arg is InputScriptData;
+/**
+ * Throws an error indicating a type mismatch for a specified argument position.
+ * This function helps in debugging by providing clear feedback on expected types.
+ *
+ * @param expectedType - The type that was expected for the argument.
+ * @param position - The position of the argument that caused the type mismatch.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function throwTypeMismatch(expectedType: string, position: number): void;
+/**
+ * Finds the index of the first non-signer argument in the function ABI parameters.
+ *
+ * A function is often defined with a `signer` or `&signer` arguments at the start, which are filled in
+ * by signatures and not by the caller. This function helps identify the position of the first argument that
+ * can be provided by the caller, allowing for easier handling of function parameters.
+ *
+ * @param functionAbi - The ABI of the function to analyze.
+ * @returns The index of the first non-signer argument, or the length of the parameters array if none are found.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function findFirstNonSignerArg(functionAbi: MoveFunction): number;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/transactions/transactionBuilder/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/transactions/transactionBuilder/helpers.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,0BAA0B,EAC1B,mCAAmC,EACnC,gDAAgD,EAChD,eAAe,EACf,gCAAgC,EACjC,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,IAAI,EACJ,UAAU,EACV,IAAI,EACJ,GAAG,EACH,IAAI,EACJ,GAAG,EACH,GAAG,EACH,EAAE,EAEF,UAAU,EAEV,IAAI,EACJ,GAAG,EACH,IAAI,EACJ,GAAG,EACH,GAAG,EACH,EAAE,EACH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAGpD;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,gCAAgC,GAAG,GAAG,IAAI,OAAO,CAE5E;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,MAAM,CAEhD;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,gCAAgC,GAAG,GAAG,IAAI,MAAM,CAE7E;AAED;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,gCAAgC,GAAG,MAAM,GAAG,SAAS,CASvF;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,gCAAgC,GAAG,GAAG,IAAI,MAAM,GAAG,MAAM,GAAG,MAAM,CAEpG;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,gCAAgC,GAAG,GAAG,IAAI,IAAI,GAAG,SAAS,CAE5F;AAED;;;;;;;GAOG;AACH,wBAAgB,8BAA8B,CAC5C,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,GACjE,GAAG,IAAI,0BAA0B,CAoGnC;AACD;;;GAGG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,GAAG,GAAG,IAAI,IAAI,CAEzG;AACD;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,GACjE,GAAG,IAAI,cAAc,CAEvB;AACD;;;GAGG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,GAAG,GAAG,IAAI,UAAU,CAEjH;AACD;;;GAGG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,GAAG,GAAG,IAAI,UAAU,CAErH;AACD;;;GAGG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,GAAG,GAAG,IAAI,EAAE,CAErG;AACD;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,GAAG,GAAG,IAAI,GAAG,CAEvG;AACD;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,GAAG,GAAG,IAAI,GAAG,CAEvG;AACD;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,GAAG,GAAG,IAAI,GAAG,CAEvG;AACD;;;GAGG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,GAAG,GAAG,IAAI,IAAI,CAEzG;AACD;;;GAGG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,GAAG,GAAG,IAAI,IAAI,CAEzG;AACD;;;GAGG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,GAAG,GAAG,IAAI,EAAE,CAErG;AACD;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,GAAG,GAAG,IAAI,GAAG,CAEvG;AACD;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,GAAG,GAAG,IAAI,GAAG,CAEvG;AACD;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,GAAG,GAAG,IAAI,GAAG,CAEvG;AACD;;;GAGG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,GAAG,GAAG,IAAI,IAAI,CAEzG;AACD;;;GAGG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,GAAG,GAAG,IAAI,IAAI,CAEzG;AAED;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,gDAAgD,GAAG,mCAAmC,GAC1F,GAAG,IAAI,eAAe,CAExB;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,QAEvE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,YAAY,GAAG,MAAM,CAMvE"}