@aptos-labs/ts-sdk 6.3.1 → 7.0.0

package/dist/transactions/transactionBuilder/helpers.js

@@ -0,0 +1,344 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { Bool, FixedBytes, I128, I16, I256, I32, I64, I8, MoveOption, MoveString, MoveVector, U128, U16, U256, U32, U64, U8, } from "../../bcs/index.js";
+import { AccountAddress } from "../../core/index.js";
+import { MoveEnumArgument, MoveStructArgument } from "./structEnumParser.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 function isBool(arg) {
+    return typeof arg === "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 function isString(arg) {
+    return typeof arg === "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 function isNumber(arg) {
+    return typeof arg === "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 function convertNumber(arg) {
+    if (isNumber(arg)) {
+        return arg;
+    }
+    if (isString(arg) && arg !== "") {
+        return Number.parseInt(arg, 10);
+    }
+    return 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 function isLargeNumber(arg) {
+    return typeof arg === "number" || typeof arg === "bigint" || typeof arg === "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 function isEmptyOption(arg) {
+    return arg === null || arg === 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 function isEncodedEntryFunctionArgument(arg) {
+    return (
+    /**
+     * Determines if the provided argument is an instance of the Bool class.
+     *
+     * @param arg - The argument to check, which can be of type EntryFunctionArgumentTypes or SimpleEntryFunctionArgumentTypes.
+     * @group Implementation
+     * @category Transactions
+     */
+    isBcsBool(arg) ||
+        /**
+         * Determines if the provided argument is an instance of U8.
+         * This function helps validate the type of the argument passed to ensure it is a U8 type.
+         *
+         * @param arg - The argument to be checked, which can be of type EntryFunctionArgumentTypes or SimpleEntryFunctionArgumentTypes.
+         * @group Implementation
+         * @category Transactions
+         */
+        isBcsU8(arg) ||
+        /**
+         * Determines if the provided argument is an instance of U16.
+         *
+         * @param arg - The argument to check, which can be of type EntryFunctionArgumentTypes or SimpleEntryFunctionArgumentTypes.
+         * @group Implementation
+         * @category Transactions
+         */
+        isBcsU16(arg) ||
+        /**
+         * Determines if the provided argument is an instance of U32.
+         *
+         * @param arg - The argument to check, which can be of type EntryFunctionArgumentTypes or SimpleEntryFunctionArgumentTypes.
+         * @returns A boolean indicating whether the argument is a U32 instance.
+         * @group Implementation
+         * @category Transactions
+         */
+        isBcsU32(arg) ||
+        /**
+         * Determine if the provided argument is an instance of U64.
+         * This function helps validate that the argument conforms to the expected U64 type.
+         *
+         * @param arg - The argument to check, which can be of type EntryFunctionArgumentTypes or SimpleEntryFunctionArgumentTypes.
+         * @group Implementation
+         * @category Transactions
+         */
+        isBcsU64(arg) ||
+        /**
+         * Determines if the provided argument is an instance of U128.
+         * This function helps validate the type of the argument passed to ensure it is a U128 type.
+         *
+         * @param arg - The argument to be checked, which can be of type EntryFunctionArgumentTypes or SimpleEntryFunctionArgumentTypes.
+         * @group Implementation
+         * @category Transactions
+         */
+        isBcsU128(arg) ||
+        /**
+         * Determines if the provided argument is an instance of U256.
+         *
+         * @param arg - The argument to check, which can be of type EntryFunctionArgumentTypes or SimpleEntryFunctionArgumentTypes.
+         * @returns A boolean indicating whether the argument is a U256 instance.
+         * @group Implementation
+         * @category Transactions
+         */
+        isBcsU256(arg) ||
+        /**
+         * Determines if the provided argument is an instance of AccountAddress.
+         * This function helps validate whether a given input corresponds to a valid BCS address type.
+         *
+         * @param arg - The argument to check, which can be of type EntryFunctionArgumentTypes or SimpleEntryFunctionArgumentTypes.
+         * @group Implementation
+         * @category Transactions
+         */
+        isBcsAddress(arg) ||
+        /**
+         * Determine if the provided argument is an instance of MoveString.
+         *
+         * @param arg - The argument to check, which can be of types EntryFunctionArgumentTypes or SimpleEntryFunctionArgumentTypes.
+         * @group Implementation
+         * @category Transactions
+         */
+        isBcsString(arg) ||
+        /**
+         * Determine if the provided argument is an instance of FixedBytes.
+         * This function helps to validate the type of the argument being passed.
+         *
+         * @param arg - The argument to check, which can be of type EntryFunctionArgumentTypes or SimpleEntryFunctionArgumentTypes.
+         * @group Implementation
+         * @category Transactions
+         */
+        isBcsFixedBytes(arg) ||
+        isBcsI8(arg) ||
+        isBcsI16(arg) ||
+        isBcsI32(arg) ||
+        isBcsI64(arg) ||
+        isBcsI128(arg) ||
+        isBcsI256(arg) ||
+        arg instanceof MoveVector ||
+        arg instanceof MoveOption ||
+        arg instanceof MoveStructArgument ||
+        arg instanceof MoveEnumArgument);
+}
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export function isBcsBool(arg) {
+    return arg instanceof Bool;
+}
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export function isBcsAddress(arg) {
+    return arg instanceof AccountAddress;
+}
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export function isBcsString(arg) {
+    return arg instanceof MoveString;
+}
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export function isBcsFixedBytes(arg) {
+    return arg instanceof FixedBytes;
+}
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export function isBcsU8(arg) {
+    return arg instanceof U8;
+}
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export function isBcsU16(arg) {
+    return arg instanceof U16;
+}
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export function isBcsU32(arg) {
+    return arg instanceof U32;
+}
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export function isBcsU64(arg) {
+    return arg instanceof U64;
+}
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export function isBcsU128(arg) {
+    return arg instanceof U128;
+}
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export function isBcsU256(arg) {
+    return arg instanceof U256;
+}
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export function isBcsI8(arg) {
+    return arg instanceof I8;
+}
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export function isBcsI16(arg) {
+    return arg instanceof I16;
+}
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export function isBcsI32(arg) {
+    return arg instanceof I32;
+}
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export function isBcsI64(arg) {
+    return arg instanceof I64;
+}
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export function isBcsI128(arg) {
+    return arg instanceof I128;
+}
+/**
+ * @group Implementation
+ * @category Transactions
+ */
+export function isBcsI256(arg) {
+    return arg instanceof 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 function isScriptDataInput(arg) {
+    return "bytecode" in arg;
+}
+/**
+ * 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 function throwTypeMismatch(expectedType, position) {
+    throw new Error(`Type mismatch for argument ${position}, expected '${expectedType}'`);
+}
+/**
+ * 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 function findFirstNonSignerArg(functionAbi) {
+    const index = functionAbi.params.findIndex((param) => param !== "signer" && param !== "&signer");
+    if (index < 0) {
+        return functionAbi.params.length;
+    }
+    return index;
+}
+//# sourceMappingURL=helpers.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/transactions/transactionBuilder/helpers.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAStC,OAAO,EACL,IAAI,EACJ,UAAU,EACV,IAAI,EACJ,GAAG,EACH,IAAI,EACJ,GAAG,EACH,GAAG,EACH,EAAE,EACF,UAAU,EACV,UAAU,EACV,UAAU,EACV,IAAI,EACJ,GAAG,EACH,IAAI,EACJ,GAAG,EACH,GAAG,EACH,EAAE,GACH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE7E;;;;;;;;GAQG;AACH,MAAM,UAAU,MAAM,CAAC,GAAqC;IAC1D,OAAO,OAAO,GAAG,KAAK,SAAS,CAAC;AAClC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAQ;IAC/B,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC;AACjC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAqC;IAC5D,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC;AACjC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAAC,GAAqC;IACjE,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAClB,OAAO,GAAG,CAAC;IACb,CAAC;IACD,IAAI,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,EAAE,EAAE,CAAC;QAChC,OAAO,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAClC,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,GAAqC;IACjE,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC;AACvF,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,GAAqC;IACjE,OAAO,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS,CAAC;AAC3C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,8BAA8B,CAC5C,GAAkE;IAElE,OAAO;IACL;;;;;;OAMG;IACH,SAAS,CAAC,GAAG,CAAC;QACd;;;;;;;WAOG;QACH,OAAO,CAAC,GAAG,CAAC;QACZ;;;;;;WAMG;QACH,QAAQ,CAAC,GAAG,CAAC;QACb;;;;;;;WAOG;QACH,QAAQ,CAAC,GAAG,CAAC;QACb;;;;;;;WAOG;QACH,QAAQ,CAAC,GAAG,CAAC;QACb;;;;;;;WAOG;QACH,SAAS,CAAC,GAAG,CAAC;QACd;;;;;;;WAOG;QACH,SAAS,CAAC,GAAG,CAAC;QACd;;;;;;;WAOG;QACH,YAAY,CAAC,GAAG,CAAC;QACjB;;;;;;WAMG;QACH,WAAW,CAAC,GAAG,CAAC;QAChB;;;;;;;WAOG;QACH,eAAe,CAAC,GAAG,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC;QACZ,QAAQ,CAAC,GAAG,CAAC;QACb,QAAQ,CAAC,GAAG,CAAC;QACb,QAAQ,CAAC,GAAG,CAAC;QACb,SAAS,CAAC,GAAG,CAAC;QACd,SAAS,CAAC,GAAG,CAAC;QACd,GAAG,YAAY,UAAU;QACzB,GAAG,YAAY,UAAU;QACzB,GAAG,YAAY,kBAAkB;QACjC,GAAG,YAAY,gBAAgB,CAChC,CAAC;AACJ,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,GAAkE;IAC1F,OAAO,GAAG,YAAY,IAAI,CAAC;AAC7B,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,YAAY,CAC1B,GAAkE;IAElE,OAAO,GAAG,YAAY,cAAc,CAAC;AACvC,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,GAAkE;IAC5F,OAAO,GAAG,YAAY,UAAU,CAAC;AACnC,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,GAAkE;IAChG,OAAO,GAAG,YAAY,UAAU,CAAC;AACnC,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,OAAO,CAAC,GAAkE;IACxF,OAAO,GAAG,YAAY,EAAE,CAAC;AAC3B,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAkE;IACzF,OAAO,GAAG,YAAY,GAAG,CAAC;AAC5B,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAkE;IACzF,OAAO,GAAG,YAAY,GAAG,CAAC;AAC5B,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAkE;IACzF,OAAO,GAAG,YAAY,GAAG,CAAC;AAC5B,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,GAAkE;IAC1F,OAAO,GAAG,YAAY,IAAI,CAAC;AAC7B,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,GAAkE;IAC1F,OAAO,GAAG,YAAY,IAAI,CAAC;AAC7B,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,OAAO,CAAC,GAAkE;IACxF,OAAO,GAAG,YAAY,EAAE,CAAC;AAC3B,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAkE;IACzF,OAAO,GAAG,YAAY,GAAG,CAAC;AAC5B,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAkE;IACzF,OAAO,GAAG,YAAY,GAAG,CAAC;AAC5B,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAkE;IACzF,OAAO,GAAG,YAAY,GAAG,CAAC;AAC5B,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,GAAkE;IAC1F,OAAO,GAAG,YAAY,IAAI,CAAC;AAC7B,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,GAAkE;IAC1F,OAAO,GAAG,YAAY,IAAI,CAAC;AAC7B,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,iBAAiB,CAC/B,GAA2F;IAE3F,OAAO,UAAU,IAAI,GAAG,CAAC;AAC3B,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAAC,YAAoB,EAAE,QAAgB;IACtE,MAAM,IAAI,KAAK,CAAC,8BAA8B,QAAQ,eAAe,YAAY,GAAG,CAAC,CAAC;AACxF,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,qBAAqB,CAAC,WAAyB;IAC7D,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,SAAS,CAAC,CAAC;IACjG,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACd,OAAO,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC;IACnC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

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

@@ -0,0 +1,6 @@
+export * from "./helpers.js";
+export * from "./transactionBuilder.js";
+export * from "./remoteAbi.js";
+export * from "./signingMessage.js";
+export * from "./structEnumParser.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/transactions/transactionBuilder/index.ts"],"names":[],"mappings":"AAGA,cAAc,cAAc,CAAC;AAC7B,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC"}

package/dist/transactions/transactionBuilder/index.js

@@ -0,0 +1,8 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+export * from "./helpers.js";
+export * from "./transactionBuilder.js";
+export * from "./remoteAbi.js";
+export * from "./signingMessage.js";
+export * from "./structEnumParser.js";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/transactions/transactionBuilder/index.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAEtC,cAAc,cAAc,CAAC;AAC7B,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC"}

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

@@ -0,0 +1,167 @@
+import { TypeTag } from "../typeTag/index.js";
+import { AptosConfig } from "../../api/aptosConfig.js";
+import { EntryFunctionArgumentTypes, SimpleEntryFunctionArgumentTypes, EntryFunctionABI, ViewFunctionABI, FunctionABI, TypeArgument } from "../types.js";
+import { MoveFunction, MoveModule } from "../../types/index.js";
+/**
+ * Convert type arguments to only type tags, allowing for string representations of type tags.
+ *
+ * @param typeArguments - An optional array of type arguments that may include string representations.
+ * @returns An array of TypeTag objects derived from the provided type arguments.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function standardizeTypeTags(typeArguments?: Array<TypeArgument>): Array<TypeTag>;
+/**
+ * Represents a bundle of a module ABI along with all struct ABIs it references.
+ * This allows for offline struct/enum encoding without additional network calls.
+ */
+export type ModuleAbiBundle = {
+    /** The main module ABI */
+    module: MoveModule;
+    /** Map of modules containing referenced struct ABIs: "address::module" -> MoveModule */
+    referencedStructModules: Map<string, MoveModule>;
+};
+/**
+ * Fetches the ABI of a specified module from the on-chain module ABI.
+ * Results are cached for 5 minutes to reduce redundant network calls.
+ *
+ * @param moduleAddress - The address of the module from which to fetch the ABI.
+ * @param moduleName - The name of the module containing the ABI.
+ * @param aptosConfig - The configuration settings for Aptos.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function fetchModuleAbi(moduleAddress: string, moduleName: string, aptosConfig: AptosConfig): Promise<MoveModule | undefined>;
+/**
+ * Fetches a module ABI along with all struct ABIs it references.
+ * This optimization minimizes nested network calls when encoding struct/enum arguments.
+ *
+ * Strategy:
+ * - Fetches the main module ABI
+ * - Parses all type references in struct fields and function parameters
+ * - Fetches ABIs for all referenced struct modules in parallel
+ * - Caches the complete bundle together
+ *
+ * @param moduleAddress - The address of the module from which to fetch the ABI.
+ * @param moduleName - The name of the module containing the ABI.
+ * @param aptosConfig - The configuration settings for Aptos.
+ * @returns ModuleAbiBundle containing the module and all referenced struct modules
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function fetchModuleAbiWithStructs(moduleAddress: string, moduleName: string, aptosConfig: AptosConfig): Promise<ModuleAbiBundle>;
+/**
+ * Fetches the ABI of a specified function from the on-chain module ABI. This function allows you to access the details of a
+ * specific function within a module.
+ *
+ * @param moduleAddress - The address of the module from which to fetch the function ABI.
+ * @param moduleName - The name of the module containing the function.
+ * @param functionName - The name of the function whose ABI is to be fetched.
+ * @param aptosConfig - The configuration settings for Aptos.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function fetchFunctionAbi(moduleAddress: string, moduleName: string, functionName: string, aptosConfig: AptosConfig): Promise<MoveFunction | undefined>;
+/**
+ * @deprecated Use `fetchFunctionAbi` instead and manually parse the type tags.
+ */
+export declare function fetchMoveFunctionAbi(moduleAddress: string, moduleName: string, functionName: string, aptosConfig: AptosConfig): Promise<FunctionABI>;
+/**
+ * Fetches the ABI for an entry function from the specified module address.
+ * This function validates if the ABI corresponds to an entry function and retrieves its parameters.
+ *
+ * @param moduleAddress - The address of the module containing the entry function.
+ * @param moduleName - The name of the module containing the entry function.
+ * @param functionName - The name of the entry function to fetch the ABI for.
+ * @param aptosConfig - The configuration settings for Aptos.
+ * @returns An object containing the number of signers, type parameters, and function parameters.
+ * @throws Error if the ABI cannot be found or if the function is not an entry function.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function fetchEntryFunctionAbi(moduleAddress: string, moduleName: string, functionName: string, aptosConfig: AptosConfig): Promise<EntryFunctionABI>;
+/**
+ * Fetches the ABI for a view function from the specified module address.
+ * This function ensures that the ABI is valid and retrieves the type parameters, parameters, and return types for the view function.
+ *
+ * @param moduleAddress - The address of the module containing the view function.
+ * @param moduleName - The name of the module containing the view function.
+ * @param functionName - The name of the view function for which to fetch the ABI.
+ * @param aptosConfig - The configuration settings for Aptos.
+ * @returns An object containing the type parameters, parameters, and return types of the view function.
+ * @throws Error if the ABI cannot be found or if the function is not a view function.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function fetchViewFunctionAbi(moduleAddress: string, moduleName: string, functionName: string, aptosConfig: AptosConfig): Promise<ViewFunctionABI>;
+/**
+ * Converts a non-BCS encoded argument into BCS encoded, if necessary.
+ * This is the synchronous version that works offline with pre-fetched ABIs.
+ * Does NOT support struct/enum arguments - use convertArgumentWithABI for those.
+ *
+ * @param functionName - The name of the function for which the argument is being converted.
+ * @param functionAbiOrModuleAbi - The ABI (Application Binary Interface) of the function, which defines its parameters.
+ * @param arg - The argument to be converted, which can be of various types.
+ * @param position - The index of the argument in the function's parameter list.
+ * @param genericTypeParams - An array of type tags for any generic type parameters.
+ * @param options - Options for the conversion process.
+ * @param options.allowUnknownStructs - If true, unknown structs will be allowed and converted to a `FixedBytes`.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function convertArgument(functionName: string, functionAbiOrModuleAbi: MoveModule | FunctionABI, arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes, position: number, genericTypeParams: Array<TypeTag>, options?: {
+    allowUnknownStructs?: boolean;
+}): EntryFunctionArgumentTypes;
+/**
+ * Converts a non-BCS encoded argument into BCS encoded, with support for struct/enum arguments.
+ * This is the asynchronous version that fetches module ABIs from the network as needed.
+ *
+ * @param functionName - The name of the function for which the argument is being converted.
+ * @param functionAbiOrModuleAbi - The ABI (Application Binary Interface) of the function, which defines its parameters.
+ * @param arg - The argument to be converted, which can be of various types.
+ * @param position - The index of the argument in the function's parameter list.
+ * @param genericTypeParams - An array of type tags for any generic type parameters.
+ * @param aptosConfig - Aptos configuration for fetching module ABIs (required for struct/enum arguments).
+ * @param options - Options for the conversion process.
+ * @param options.allowUnknownStructs - If true, unknown structs will be allowed and converted to a `FixedBytes`.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function convertArgumentWithABI(functionName: string, functionAbiOrModuleAbi: MoveModule | FunctionABI, arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes, position: number, genericTypeParams: Array<TypeTag>, aptosConfig: AptosConfig, options?: {
+    allowUnknownStructs?: boolean;
+}): Promise<EntryFunctionArgumentTypes>;
+/**
+ * Checks if the provided argument is BCS encoded and converts it if necessary, ensuring type compatibility with the ABI.
+ * This is the synchronous version that works offline with pre-fetched ABIs.
+ * Does NOT support struct/enum arguments - use checkOrConvertArgumentWithABI for those.
+ *
+ * @param arg - The argument to check or convert, which can be either a simple or entry function argument type.
+ * @param param - The expected type tag for the argument.
+ * @param position - The position of the argument in the function call.
+ * @param genericTypeParams - An array of generic type parameters that may be used for conversion.
+ * @param moduleAbi - The ABI of the module containing the function, used for type checking.
+ * @param options - Options for the conversion process.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function checkOrConvertArgument(arg: SimpleEntryFunctionArgumentTypes | EntryFunctionArgumentTypes, param: TypeTag, position: number, genericTypeParams: Array<TypeTag>, moduleAbi?: MoveModule, options?: {
+    allowUnknownStructs?: boolean;
+}): EntryFunctionArgumentTypes;
+/**
+ * Checks if the provided argument is BCS encoded and converts it if necessary, with support for struct/enum arguments.
+ * This is the asynchronous version that fetches module ABIs from the network as needed.
+ *
+ * @param arg - The argument to check or convert, which can be either a simple or entry function argument type.
+ * @param param - The expected type tag for the argument.
+ * @param position - The position of the argument in the function call.
+ * @param genericTypeParams - An array of generic type parameters that may be used for conversion.
+ * @param aptosConfig - Aptos configuration for fetching module ABIs (required for struct/enum arguments).
+ * @param moduleAbi - The ABI of the module containing the function, used for type checking.
+ * @param options - Options for the conversion process.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function checkOrConvertArgumentWithABI(arg: SimpleEntryFunctionArgumentTypes | EntryFunctionArgumentTypes, param: TypeTag, position: number, genericTypeParams: Array<TypeTag>, aptosConfig: AptosConfig, moduleAbi?: MoveModule, options?: {
+    allowUnknownStructs?: boolean;
+}): Promise<EntryFunctionArgumentTypes>;
+//# sourceMappingURL=remoteAbi.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"remoteAbi.d.ts","sourceRoot":"","sources":["../../../src/transactions/transactionBuilder/remoteAbi.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,OAAO,EAgBR,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EACL,0BAA0B,EAC1B,gCAAgC,EAChC,gBAAgB,EAChB,eAAe,EACf,WAAW,EACX,YAAY,EACb,MAAM,aAAa,CAAC;AA+CrB,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAMhE;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAUvF;AAQD;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,0BAA0B;IAC1B,MAAM,EAAE,UAAU,CAAC;IACnB,wFAAwF;IACxF,uBAAuB,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;CAClD,CAAC;AAqDF;;;;;;;;;GASG;AACH,wBAAsB,cAAc,CAClC,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAWjC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,yBAAyB,CAC7C,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,eAAe,CAAC,CAyC1B;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,gBAAgB,CACpC,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAInC;AAED;;GAEG;AACH,wBAAsB,oBAAoB,CACxC,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,WAAW,CAAC,CActB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CACzC,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,gBAAgB,CAAC,CAyB3B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,oBAAoB,CACxC,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,eAAe,CAAC,CA8B1B;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAC7B,YAAY,EAAE,MAAM,EACpB,sBAAsB,EAAE,UAAU,GAAG,WAAW,EAChD,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,EAClE,QAAQ,EAAE,MAAM,EAChB,iBAAiB,EAAE,KAAK,CAAC,OAAO,CAAC,EACjC,OAAO,CAAC,EAAE;IAAE,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAAE,8BAiC5C;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,sBAAsB,CAC1C,YAAY,EAAE,MAAM,EACpB,sBAAsB,EAAE,UAAU,GAAG,WAAW,EAChD,GAAG,EAAE,0BAA0B,GAAG,gCAAgC,EAClE,QAAQ,EAAE,MAAM,EAChB,iBAAiB,EAAE,KAAK,CAAC,OAAO,CAAC,EACjC,WAAW,EAAE,WAAW,EACxB,OAAO,CAAC,EAAE;IAAE,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAAE,uCAkC5C;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,gCAAgC,GAAG,0BAA0B,EAClE,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,MAAM,EAChB,iBAAiB,EAAE,KAAK,CAAC,OAAO,CAAC,EACjC,SAAS,CAAC,EAAE,UAAU,EACtB,OAAO,CAAC,EAAE;IAAE,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAAE,GAC1C,0BAA0B,CAoB5B;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,6BAA6B,CACjD,GAAG,EAAE,gCAAgC,GAAG,0BAA0B,EAClE,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,MAAM,EAChB,iBAAiB,EAAE,KAAK,CAAC,OAAO,CAAC,EACjC,WAAW,EAAE,WAAW,EACxB,SAAS,CAAC,EAAE,UAAU,EACtB,OAAO,CAAC,EAAE;IAAE,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAAE,GAC1C,OAAO,CAAC,0BAA0B,CAAC,CA4BrC"}