@aptos-labs/ts-sdk 6.3.1 → 7.0.1

package/dist/transactions/instances/simpleTransaction.d.ts

@@ -0,0 +1,49 @@
+import { Deserializer } from "../../bcs/deserializer.js";
+import { Serializable, Serializer } from "../../bcs/serializer.js";
+import { AccountAddress } from "../../core/index.js";
+import { RawTransaction } from "./rawTransaction.js";
+/**
+ * Represents a simple transaction type that can be submitted to the Aptos chain for execution.
+ *
+ * This transaction type is designed for a single signer and includes metadata such as the Raw Transaction
+ * and an optional sponsor Account Address to cover gas fees.
+ *
+ * @param rawTransaction - The Raw Transaction.
+ * @param feePayerAddress - The optional sponsor Account Address.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare class SimpleTransaction extends Serializable {
+    rawTransaction: RawTransaction;
+    feePayerAddress?: AccountAddress | undefined;
+    readonly secondarySignerAddresses: undefined;
+    /**
+     * SimpleTransaction represents a transaction signed by a single account that
+     * can be submitted to the Aptos chain for execution.
+     *
+     * @param rawTransaction The Raw Transaction.
+     * @param feePayerAddress The optional sponsor Account Address to pay the gas fees.
+     * @group Implementation
+     * @category Transactions
+     */
+    constructor(rawTransaction: RawTransaction, feePayerAddress?: AccountAddress);
+    /**
+     * Serializes the transaction data using the provided serializer.
+     * This function ensures that the raw transaction and fee payer address are properly serialized for further processing.
+     *
+     * @param serializer - The serializer instance used to serialize the transaction data.
+     * @group Implementation
+     * @category Transactions
+     */
+    serialize(serializer: Serializer): void;
+    /**
+     * Deserializes a SimpleTransaction from the given deserializer.
+     * This function helps in reconstructing a SimpleTransaction object from its serialized form.
+     *
+     * @param deserializer - The deserializer instance used to read the serialized data.
+     * @group Implementation
+     * @category Transactions
+     */
+    static deserialize(deserializer: Deserializer): SimpleTransaction;
+}
+//# sourceMappingURL=simpleTransaction.d.ts.map

package/dist/transactions/instances/simpleTransaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"simpleTransaction.d.ts","sourceRoot":"","sources":["../../../src/transactions/instances/simpleTransaction.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD;;;;;;;;;;GAUG;AACH,qBAAa,iBAAkB,SAAQ,YAAY;IAC1C,cAAc,EAAE,cAAc,CAAC;IAE/B,eAAe,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IAIpD,SAAgB,wBAAwB,EAAE,SAAS,CAAC;IAEpD;;;;;;;;OAQG;gBACS,cAAc,EAAE,cAAc,EAAE,eAAe,CAAC,EAAE,cAAc;IAM5E;;;;;;;OAOG;IACH,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAWvC;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,iBAAiB;CAUlE"}

package/dist/transactions/instances/simpleTransaction.js

@@ -0,0 +1,73 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { Serializable } from "../../bcs/serializer.js";
+import { AccountAddress } from "../../core/index.js";
+import { RawTransaction } from "./rawTransaction.js";
+/**
+ * Represents a simple transaction type that can be submitted to the Aptos chain for execution.
+ *
+ * This transaction type is designed for a single signer and includes metadata such as the Raw Transaction
+ * and an optional sponsor Account Address to cover gas fees.
+ *
+ * @param rawTransaction - The Raw Transaction.
+ * @param feePayerAddress - The optional sponsor Account Address.
+ * @group Implementation
+ * @category Transactions
+ */
+export class SimpleTransaction extends Serializable {
+    rawTransaction;
+    feePayerAddress;
+    // We don't really need it, we add it for type checking we do
+    // throughout the SDK
+    secondarySignerAddresses;
+    /**
+     * SimpleTransaction represents a transaction signed by a single account that
+     * can be submitted to the Aptos chain for execution.
+     *
+     * @param rawTransaction The Raw Transaction.
+     * @param feePayerAddress The optional sponsor Account Address to pay the gas fees.
+     * @group Implementation
+     * @category Transactions
+     */
+    constructor(rawTransaction, feePayerAddress) {
+        super();
+        this.rawTransaction = rawTransaction;
+        this.feePayerAddress = feePayerAddress;
+    }
+    /**
+     * Serializes the transaction data using the provided serializer.
+     * This function ensures that the raw transaction and fee payer address are properly serialized for further processing.
+     *
+     * @param serializer - The serializer instance used to serialize the transaction data.
+     * @group Implementation
+     * @category Transactions
+     */
+    serialize(serializer) {
+        this.rawTransaction.serialize(serializer);
+        if (this.feePayerAddress === undefined) {
+            serializer.serializeBool(false);
+        }
+        else {
+            serializer.serializeBool(true);
+            this.feePayerAddress.serialize(serializer);
+        }
+    }
+    /**
+     * Deserializes a SimpleTransaction from the given deserializer.
+     * This function helps in reconstructing a SimpleTransaction object from its serialized form.
+     *
+     * @param deserializer - The deserializer instance used to read the serialized data.
+     * @group Implementation
+     * @category Transactions
+     */
+    static deserialize(deserializer) {
+        const rawTransaction = RawTransaction.deserialize(deserializer);
+        const feePayerPresent = deserializer.deserializeBool();
+        let feePayerAddress;
+        if (feePayerPresent) {
+            feePayerAddress = AccountAddress.deserialize(deserializer);
+        }
+        return new SimpleTransaction(rawTransaction, feePayerAddress);
+    }
+}
+//# sourceMappingURL=simpleTransaction.js.map

package/dist/transactions/instances/simpleTransaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simpleTransaction.js","sourceRoot":"","sources":["../../../src/transactions/instances/simpleTransaction.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAGtC,OAAO,EAAE,YAAY,EAAc,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD;;;;;;;;;;GAUG;AACH,MAAM,OAAO,iBAAkB,SAAQ,YAAY;IAC1C,cAAc,CAAiB;IAE/B,eAAe,CAA8B;IAEpD,6DAA6D;IAC7D,qBAAqB;IACL,wBAAwB,CAAY;IAEpD;;;;;;;;OAQG;IACH,YAAY,cAA8B,EAAE,eAAgC;QAC1E,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,UAAsB;QAC9B,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAE1C,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACvC,UAAU,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAClC,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC/B,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,CAAC,YAA0B;QAC3C,MAAM,cAAc,GAAG,cAAc,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAChE,MAAM,eAAe,GAAG,YAAY,CAAC,eAAe,EAAE,CAAC;QACvD,IAAI,eAAe,CAAC;QACpB,IAAI,eAAe,EAAE,CAAC;YACpB,eAAe,GAAG,cAAc,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAC7D,CAAC;QAED,OAAO,IAAI,iBAAiB,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;IAChE,CAAC;CACF"}

package/dist/transactions/instances/transactionArgument.d.ts

@@ -0,0 +1,71 @@
+import { Serializer } from "../../bcs/serializer.js";
+import { Hex } from "../../core/hex.js";
+export interface TransactionArgument extends EntryFunctionArgument, ScriptFunctionArgument {
+}
+/**
+ * Represents an argument for entry functions, providing methods to serialize the argument
+ * to BCS-serialized bytes and convert it to different formats.
+ * @group Implementation
+ * @category Transactions
+ */
+export interface EntryFunctionArgument {
+    /**
+     * Serialize an argument to BCS-serialized bytes.
+     *
+     * @param serializer - The serializer instance used for serialization.
+     * @group Implementation
+     * @category Transactions
+     */
+    serialize(serializer: Serializer): void;
+    /**
+     * Serialize an argument to BCS-serialized bytes.
+     * Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains
+     * the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
+     *
+     * @param serializer - The serializer used to convert the argument.
+     * @group Implementation
+     * @category Transactions
+     */
+    serializeForEntryFunction(serializer: Serializer): void;
+    /**
+     * Convert the argument to BCS-serialized bytes.
+     *
+     * @returns Uint8Array representing the BCS-serialized bytes of the argument.
+     * @group Implementation
+     * @category Transactions
+     */
+    bcsToBytes(): Uint8Array;
+    /**
+     * Converts the BCS-serialized bytes of an argument into a hexadecimal representation.
+     * This function is useful for obtaining a Hex instance that encapsulates the BCS-serialized bytes,
+     * allowing for easier manipulation and representation of the data.
+     * @returns A Hex instance containing the BCS-serialized bytes.
+     * @group Implementation
+     * @category Transactions
+     */
+    bcsToHex(): Hex;
+}
+/**
+ * Represents an argument for script functions, providing methods to serialize and convert to bytes.
+ * @group Implementation
+ * @category Transactions
+ */
+export interface ScriptFunctionArgument {
+    /**
+     * Serialize an argument to BCS-serialized bytes.
+     * @group Implementation
+     * @category Transactions
+     */
+    serialize(serializer: Serializer): void;
+    /**
+     * Serialize an argument to BCS-serialized bytes as a type aware byte sequence.
+     * The byte sequence contains an enum variant index followed by the BCS-serialized
+     * bytes for a typed argument.
+     * @group Implementation
+     * @category Transactions
+     */
+    serializeForScriptFunction(serializer: Serializer): void;
+    bcsToBytes(): Uint8Array;
+    bcsToHex(): Hex;
+}
+//# sourceMappingURL=transactionArgument.d.ts.map

package/dist/transactions/instances/transactionArgument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionArgument.d.ts","sourceRoot":"","sources":["../../../src/transactions/instances/transactionArgument.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAExC,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB,EAAE,sBAAsB;CAAG;AAE7F;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;OAMG;IACH,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAExC;;;;;;;;OAQG;IACH,yBAAyB,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAExD;;;;;;OAMG;IACH,UAAU,IAAI,UAAU,CAAC;IAEzB;;;;;;;OAOG;IACH,QAAQ,IAAI,GAAG,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IACxC;;;;;;OAMG;IACH,0BAA0B,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAEzD,UAAU,IAAI,UAAU,CAAC;IACzB,QAAQ,IAAI,GAAG,CAAC;CACjB"}

package/dist/transactions/instances/transactionArgument.js

@@ -0,0 +1,4 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+export {};
+//# sourceMappingURL=transactionArgument.js.map

package/dist/transactions/instances/transactionArgument.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionArgument.js","sourceRoot":"","sources":["../../../src/transactions/instances/transactionArgument.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC"}

package/dist/transactions/instances/transactionPayload.d.ts

@@ -0,0 +1,369 @@
+import { Deserializer } from "../../bcs/deserializer.js";
+import { Serializable, Serializer } from "../../bcs/serializer.js";
+import { AccountAddress } from "../../core/index.js";
+import { Ciphertext } from "../../core/crypto/encryption/ciphertext.js";
+import { ClaimedEntryFunction } from "./encryptedPayload.js";
+import { Identifier } from "./identifier.js";
+import { ModuleId } from "./moduleId.js";
+import type { EntryFunctionArgument, ScriptFunctionArgument, TransactionArgument } from "./transactionArgument.js";
+import { AnyNumber, MoveModuleId } from "../../types/index.js";
+import { TypeTag } from "../typeTag/index.js";
+/**
+ * Deserialize a Script Transaction Argument.
+ * This function retrieves and deserializes various types of script transaction arguments based on the provided deserializer.
+ *
+ * @param deserializer - The deserializer used to read the script transaction argument.
+ * @returns The deserialized script transaction argument.
+ * @throws Error if the variant index is unknown.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare function deserializeFromScriptArgument(deserializer: Deserializer): TransactionArgument;
+/**
+ * Represents a supported Transaction Payload that can be serialized and deserialized.
+ *
+ * This class serves as a base for different types of transaction payloads, allowing for
+ * their serialization into a format suitable for transmission and deserialization back
+ * into their original form.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare abstract class TransactionPayload extends Serializable {
+    /**
+     * Serialize a Transaction Payload
+     * @group Implementation
+     * @category Transactions
+     */
+    abstract serialize(serializer: Serializer): void;
+    /**
+     * Deserialize a Transaction Payload
+     * @group Implementation
+     * @category Transactions
+     */
+    /**
+     * Deserializes a multisig transaction payload from the provided deserializer.
+     * This function enables the reconstruction of a MultiSigTransactionPayload object from its serialized form.
+     *
+     * @param deserializer - The deserializer instance used to read the serialized data.
+     * @group Implementation
+     * @category Transactions
+     */
+    static deserialize(deserializer: Deserializer): TransactionPayload;
+}
+/**
+ * Represents a transaction payload script that can be serialized and deserialized.
+ *
+ * This class encapsulates a script that defines the logic for a transaction payload.
+ *
+ * @extends TransactionPayload
+ * @group Implementation
+ * @category Transactions
+ */
+export declare class TransactionPayloadScript extends TransactionPayload {
+    readonly script: Script;
+    /**
+     * Initializes a multi-sig account transaction with the provided payload.
+     *
+     * @param script - The payload of the multi-sig transaction. This can only be an EntryFunction for now, but Script might be
+     * supported in the future.
+     * @group Implementation
+     * @category Transactions
+     */
+    constructor(script: Script);
+    /**
+     * Serializes the transaction payload, enabling future support for multiple types of inner transaction payloads.
+     *
+     * @param serializer - The serializer instance used to serialize the transaction data.
+     * @group Implementation
+     * @category Transactions
+     */
+    serialize(serializer: Serializer): void;
+    /**
+     * Loads a MultiSig transaction payload from the provided deserializer.
+     * This function helps in reconstructing a MultiSig transaction payload from its serialized form.
+     *
+     * @param deserializer - The deserializer used to read the serialized data.
+     * @group Implementation
+     * @category Transactions
+     */
+    static load(deserializer: Deserializer): TransactionPayloadScript;
+}
+/**
+ * Represents a transaction payload entry function that can be serialized and deserialized.
+ *
+ * @extends TransactionPayload
+ * @group Implementation
+ * @category Transactions
+ */
+export declare class TransactionPayloadEntryFunction extends TransactionPayload {
+    readonly entryFunction: EntryFunction;
+    constructor(entryFunction: EntryFunction);
+    serialize(serializer: Serializer): void;
+    static load(deserializer: Deserializer): TransactionPayloadEntryFunction;
+}
+/**
+ * Represents a multi-signature transaction payload that can be serialized and deserialized.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare class TransactionPayloadMultiSig extends TransactionPayload {
+    readonly multiSig: MultiSig;
+    constructor(multiSig: MultiSig);
+    serialize(serializer: Serializer): void;
+    static load(deserializer: Deserializer): TransactionPayloadMultiSig;
+}
+/**
+ * Represents an entry function that can be serialized and deserialized.
+ * This class encapsulates the details required to invoke a function within a module,
+ * including the module name, function name, type arguments, and function arguments.
+ *
+ * @param module_name - Fully qualified module name in the format "account_address::module_name" (e.g., "0x1::coin").
+ * @param function_name - The name of the function (e.g., "transfer").
+ * @param type_args - Type arguments required by the Move function.
+ * @param args - Arguments to the Move function.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare class EntryFunction {
+    readonly module_name: ModuleId;
+    readonly function_name: Identifier;
+    readonly type_args: Array<TypeTag>;
+    readonly args: Array<EntryFunctionArgument>;
+    /**
+     * Contains the payload to run a function within a module.
+     * @param module_name Fully qualified module name in format "account_address::module_name" e.g. "0x1::coin"
+     * @param function_name The function name. e.g "transfer"
+     * @param type_args Type arguments that move function requires.
+     *
+     * @example
+     * A coin transfer function has one type argument "CoinType".
+     * ```
+     * public entry fun transfer<CoinType>(from: &signer, to: address, amount: u64)
+     * ```
+     * @param args arguments to the move function.
+     *
+     * @example
+     * A coin transfer function has three arguments "from", "to" and "amount".
+     * ```
+     * public entry fun transfer<CoinType>(from: &signer, to: address, amount: u64)
+     * ```
+     * @group Implementation
+     * @category Transactions
+     */
+    constructor(module_name: ModuleId, function_name: Identifier, type_args: Array<TypeTag>, args: Array<EntryFunctionArgument>);
+    /**
+     * Build an EntryFunction payload from raw primitive values.
+     *
+     * @param module_id - Fully qualified module name in the format "AccountAddress::module_id", e.g., "0x1::coin".
+     * @param function_name - The name of the function to be called.
+     * @param type_args - Type arguments that the Move function requires.
+     * @param args - Arguments to the Move function.
+     *
+     * @example
+     * A coin transfer function has one type argument "CoinType".
+     * ```
+     * public(script) fun transfer<CoinType>(from: &signer, to: address, amount: u64)
+     * ```
+     *
+     * A coin transfer function has three arguments "from", "to", and "amount".
+     * ```
+     * public(script) fun transfer<CoinType>(from: &signer, to: address, amount: u64)
+     * ```
+     *
+     * @returns EntryFunction
+     * @group Implementation
+     * @category Transactions
+     */
+    static build(module_id: MoveModuleId, function_name: string, type_args: Array<TypeTag>, args: Array<EntryFunctionArgument>): EntryFunction;
+    serialize(serializer: Serializer): void;
+    /**
+     * Deserializes an entry function payload with the arguments represented as EntryFunctionBytes instances.
+     * @see EntryFunctionBytes
+     *
+     * NOTE: When you deserialize an EntryFunction payload with this method, the entry function
+     * arguments are populated into the deserialized instance as type-agnostic, raw fixed bytes
+     * in the form of the EntryFunctionBytes class.
+     *
+     * In order to correctly deserialize these arguments as their actual type representations, you
+     * must know the types of the arguments beforehand and deserialize them yourself individually.
+     *
+     * One way you could achieve this is by using the ABIs for an entry function and deserializing each
+     * argument as its given, corresponding type.
+     *
+     * @param deserializer
+     * @returns A deserialized EntryFunction payload for a transaction.
+     *
+     * @group Implementation
+     * @category Transactions
+     */
+    static deserialize(deserializer: Deserializer): EntryFunction;
+}
+/**
+ * `EncryptedPayload::Encrypted` as a `TransactionPayload`. BCS:
+ * variant tag (5) | inner tag (0) | Ciphertext | TransactionExtraConfig | 32-byte payload_hash | u64 epoch | Option&lt;ClaimedEntryFunction&gt;.
+ */
+export declare class TransactionPayloadEncryptedPayload extends TransactionPayload {
+    readonly ciphertext: Ciphertext;
+    readonly extraConfig: TransactionExtraConfig;
+    readonly payloadHash: Uint8Array;
+    /** Epoch hint matching the node's per-epoch encryption key (see aptos-core `EncryptedInner`). */
+    readonly encryptionEpoch: bigint;
+    readonly claimedEntryFunction?: ClaimedEntryFunction;
+    constructor(ciphertext: Ciphertext, extraConfig: TransactionExtraConfig, payloadHash: Uint8Array, encryptionEpoch: bigint, claimedEntryFunction?: ClaimedEntryFunction);
+    serialize(serializer: Serializer): void;
+    static load(deserializer: Deserializer): TransactionPayloadEncryptedPayload;
+}
+/**
+ * Represents a Script that can be serialized and deserialized.
+ * Scripts contain the Move bytecode payload that can be submitted to the Aptos chain for execution.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare class Script {
+    /**
+     * The move module bytecode
+     * @group Implementation
+     * @category Transactions
+     */
+    readonly bytecode: Uint8Array;
+    /**
+     * The type arguments that the bytecode function requires.
+     * @group Implementation
+     * @category Transactions
+     */
+    readonly type_args: Array<TypeTag>;
+    /**
+     * The arguments that the bytecode function requires.
+     * @group Implementation
+     * @category Transactions
+     */
+    readonly args: Array<ScriptFunctionArgument>;
+    /**
+     * Scripts contain the Move bytecodes payload that can be submitted to Aptos chain for execution.
+     *
+     * @param bytecode The move module bytecode
+     * @param type_args The type arguments that the bytecode function requires.
+     *
+     * @example
+     * A coin transfer function has one type argument "CoinType".
+     * ```
+     * public(script) fun transfer<CoinType>(from: &signer, to: address, amount: u64)
+     * ```
+     * @param args The arguments that the bytecode function requires.
+     *
+     * @example
+     * A coin transfer function has three arguments "from", "to" and "amount".
+     * ```
+     * public(script) fun transfer<CoinType>(from: &signer, to: address, amount: u64)
+     * ```
+     * @group Implementation
+     * @category Transactions
+     */
+    constructor(bytecode: Uint8Array, type_args: Array<TypeTag>, args: Array<ScriptFunctionArgument>);
+    serialize(serializer: Serializer): void;
+    static deserialize(deserializer: Deserializer): Script;
+}
+/**
+ * Represents a MultiSig account that can be serialized and deserialized.
+ *
+ * This class encapsulates the functionality to manage multi-signature transactions, including the address of the
+ * multi-sig account and the associated transaction payload.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare class MultiSig {
+    readonly multisig_address: AccountAddress;
+    readonly transaction_payload?: MultiSigTransactionPayload;
+    /**
+     * Contains the payload to run a multi-sig account transaction.
+     *
+     * @param multisig_address The multi-sig account address the transaction will be executed as.
+     *
+     * @param transaction_payload The payload of the multi-sig transaction. This is optional when executing a multi-sig
+     *  transaction whose payload is already stored on chain.
+     * @group Implementation
+     * @category Transactions
+     */
+    constructor(multisig_address: AccountAddress, transaction_payload?: MultiSigTransactionPayload);
+    serialize(serializer: Serializer): void;
+    static deserialize(deserializer: Deserializer): MultiSig;
+}
+/**
+ * Represents a multi-signature transaction payload that can be serialized and deserialized.
+ * This class is designed to encapsulate the transaction payload for multi-sig account transactions
+ * as defined in the `multisig_account.move` module. Future enhancements may allow support for script
+ * payloads as the `multisig_account.move` module evolves.
+ * @group Implementation
+ * @category Transactions
+ */
+export declare class MultiSigTransactionPayload extends Serializable {
+    readonly transaction_payload: EntryFunction | Script;
+    /**
+     * Contains the payload to run a multi-sig account transaction.
+     *
+     * @param transaction_payload The payload of the multi-sig transaction.
+     * This can be an EntryFunction or a Script.
+     * @group Implementation
+     * @category Transactions
+     */
+    constructor(transaction_payload: EntryFunction | Script);
+    serialize(serializer: Serializer): void;
+    static deserialize(deserializer: Deserializer): MultiSigTransactionPayload;
+}
+/**
+ * Represents any transaction payload that can be submitted to the Aptos chain for execution.
+ *
+ * This is specifically required for orderless transactions, but can be used for any transaction payload.
+ */
+export declare abstract class TransactionInnerPayload extends TransactionPayload {
+    abstract serialize(serializer: Serializer): void;
+    static deserialize(deserializer: Deserializer): TransactionInnerPayload;
+}
+export declare class TransactionInnerPayloadV1 extends TransactionInnerPayload {
+    executable: TransactionExecutable;
+    extra_config: TransactionExtraConfig;
+    constructor(executable: TransactionExecutable, extra_config: TransactionExtraConfig);
+    serialize(serializer: Serializer): void;
+    static load(deserializer: Deserializer): TransactionInnerPayloadV1;
+}
+export declare abstract class TransactionExecutable {
+    abstract serialize(serializer: Serializer): void;
+    static deserialize(deserializer: Deserializer): TransactionExecutable;
+}
+export declare class TransactionExecutableScript extends TransactionExecutable {
+    script: Script;
+    constructor(script: Script);
+    serialize(serializer: Serializer): void;
+    static load(deserializer: Deserializer): TransactionExecutableScript;
+}
+export declare class TransactionExecutableEntryFunction extends TransactionExecutable {
+    entryFunction: EntryFunction;
+    constructor(entryFunction: EntryFunction);
+    serialize(serializer: Serializer): void;
+    static load(deserializer: Deserializer): TransactionExecutableEntryFunction;
+}
+export declare class TransactionExecutableEmpty extends TransactionExecutable {
+    serialize(serializer: Serializer): void;
+    static load(_: Deserializer): TransactionExecutableEmpty;
+}
+/**
+ * Server-side sentinel variant the fullnode places in a decrypted transaction.
+ * The SDK never constructs this; it exists only for deserialization completeness.
+ * @internal
+ */
+export declare class TransactionExecutableEncrypted extends TransactionExecutable {
+    serialize(serializer: Serializer): void;
+    static load(_: Deserializer): TransactionExecutableEncrypted;
+}
+export declare abstract class TransactionExtraConfig extends Serializable {
+    abstract serialize(serializer: Serializer): void;
+    static deserialize(deserializer: Deserializer): TransactionExtraConfig;
+}
+export declare class TransactionExtraConfigV1 extends TransactionExtraConfig {
+    multisigAddress?: AccountAddress;
+    replayProtectionNonce?: bigint;
+    constructor(multisigAddress?: AccountAddress, replayProtectionNonce?: AnyNumber);
+    serialize(serializer: Serializer): void;
+    static load(deserializer: Deserializer): TransactionExtraConfigV1;
+}
+//# sourceMappingURL=transactionPayload.d.ts.map

package/dist/transactions/instances/transactionPayload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionPayload.d.ts","sourceRoot":"","sources":["../../../src/transactions/instances/transactionPayload.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAkBnE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,4CAA4C,CAAC;AACxE,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACnH,OAAO,EACL,SAAS,EACT,YAAY,EAOb,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C;;;;;;;;;GASG;AACH,wBAAgB,6BAA6B,CAAC,YAAY,EAAE,YAAY,GAAG,mBAAmB,CAuC7F;AAED;;;;;;;;GAQG;AACH,8BAAsB,kBAAmB,SAAQ,YAAY;IAC3D;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAEhD;;;;OAIG;IAEH;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,kBAAkB;CAkBnE;AAED;;;;;;;;GAQG;AACH,qBAAa,wBAAyB,SAAQ,kBAAkB;IAC9D,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B;;;;;;;OAOG;gBACS,MAAM,EAAE,MAAM;IAK1B;;;;;;OAMG;IACH,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAKvC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,wBAAwB;CAIlE;AAED;;;;;;GAMG;AACH,qBAAa,+BAAgC,SAAQ,kBAAkB;IACrE,SAAgB,aAAa,EAAE,aAAa,CAAC;gBAEjC,aAAa,EAAE,aAAa;IAKxC,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAKvC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,+BAA+B;CAIzE;AAED;;;;GAIG;AACH,qBAAa,0BAA2B,SAAQ,kBAAkB;IAChE,SAAgB,QAAQ,EAAE,QAAQ,CAAC;gBAEvB,QAAQ,EAAE,QAAQ;IAK9B,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAKvC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,0BAA0B;CAIpE;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,aAAa;IACxB,SAAgB,WAAW,EAAE,QAAQ,CAAC;IAEtC,SAAgB,aAAa,EAAE,UAAU,CAAC;IAE1C,SAAgB,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE1C,SAAgB,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;;OAoBG;gBAED,WAAW,EAAE,QAAQ,EACrB,aAAa,EAAE,UAAU,EACzB,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,EACzB,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC;IAQpC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,KAAK,CACV,SAAS,EAAE,YAAY,EACvB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,EACzB,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,GACjC,aAAa;IAIhB,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAUvC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,aAAa;CAgB9D;AAYD;;;GAGG;AACH,qBAAa,kCAAmC,SAAQ,kBAAkB;IACxE,SAAgB,UAAU,EAAE,UAAU,CAAC;IAEvC,SAAgB,WAAW,EAAE,sBAAsB,CAAC;IAEpD,SAAgB,WAAW,EAAE,UAAU,CAAC;IAExC,iGAAiG;IACjG,SAAgB,eAAe,EAAE,MAAM,CAAC;IAExC,SAAgB,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;gBAG1D,UAAU,EAAE,UAAU,EACtB,WAAW,EAAE,sBAAsB,EACnC,WAAW,EAAE,UAAU,EACvB,eAAe,EAAE,MAAM,EACvB,oBAAoB,CAAC,EAAE,oBAAoB;IAa7C,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAUvC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,kCAAkC;CAkB5E;AAED;;;;;GAKG;AACH,qBAAa,MAAM;IACjB;;;;OAIG;IACH,SAAgB,QAAQ,EAAE,UAAU,CAAC;IAErC;;;;OAIG;IACH,SAAgB,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE1C;;;;OAIG;IACH,SAAgB,IAAI,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAEpD;;;;;;;;;;;;;;;;;;;;OAoBG;gBACS,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,sBAAsB,CAAC;IAMhG,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IASvC,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM;CAcvD;AAED;;;;;;;GAOG;AACH,qBAAa,QAAQ;IACnB,SAAgB,gBAAgB,EAAE,cAAc,CAAC;IAEjD,SAAgB,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;IAEjE;;;;;;;;;OASG;gBACS,gBAAgB,EAAE,cAAc,EAAE,mBAAmB,CAAC,EAAE,0BAA0B;IAK9F,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAYvC,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,QAAQ;CASzD;AAED;;;;;;;GAOG;AACH,qBAAa,0BAA2B,SAAQ,YAAY;IAC1D,SAAgB,mBAAmB,EAAE,aAAa,GAAG,MAAM,CAAC;IAE5D;;;;;;;OAOG;gBACS,mBAAmB,EAAE,aAAa,GAAG,MAAM;IAKvD,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAWvC,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,0BAA0B;CAW3E;AAED;;;;GAIG;AACH,8BAAsB,uBAAwB,SAAQ,kBAAkB;IACtE,QAAQ,CAAC,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAEhD,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,uBAAuB;CAUxE;AAED,qBAAa,yBAA0B,SAAQ,uBAAuB;IACpE,UAAU,EAAE,qBAAqB,CAAC;IAClC,YAAY,EAAE,sBAAsB,CAAC;gBAEzB,UAAU,EAAE,qBAAqB,EAAE,YAAY,EAAE,sBAAsB;IAMnF,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IASvC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,yBAAyB;CAKnE;AAED,8BAAsB,qBAAqB;IACzC,QAAQ,CAAC,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAEhD,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,qBAAqB;CAgBtE;AAED,qBAAa,2BAA4B,SAAQ,qBAAqB;IACpE,MAAM,EAAE,MAAM,CAAC;gBAEH,MAAM,EAAE,MAAM;IAK1B,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAKvC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,2BAA2B;CAIrE;AAED,qBAAa,kCAAmC,SAAQ,qBAAqB;IAC3E,aAAa,EAAE,aAAa,CAAC;gBAEjB,aAAa,EAAE,aAAa;IAKxC,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAKvC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,kCAAkC;CAI5E;AAED,qBAAa,0BAA2B,SAAQ,qBAAqB;IACnE,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAIvC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,YAAY,GAAG,0BAA0B;CAGzD;AAED;;;;GAIG;AACH,qBAAa,8BAA+B,SAAQ,qBAAqB;IACvE,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAIvC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,YAAY,GAAG,8BAA8B;CAG7D;AAED,8BAAsB,sBAAuB,SAAQ,YAAY;IAC/D,QAAQ,CAAC,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAEhD,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,sBAAsB;CAUvE;AAED,qBAAa,wBAAyB,SAAQ,sBAAsB;IAClE,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,qBAAqB,CAAC,EAAE,MAAM,CAAC;gBAEnB,eAAe,CAAC,EAAE,cAAc,EAAE,qBAAqB,CAAC,EAAE,SAAS;IAM/E,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAQvC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,wBAAwB;CAKlE"}