@aptos-labs/ts-sdk 1.29.0 → 1.30.0

package/dist/esm/api/transactionSubmission/sign.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/api/transactionSubmission/sign.ts"],"sourcesContent":["// Copyright © Aptos Foundation\n// SPDX-License-Identifier: Apache-2.0\n\nimport { Account } from \"../../account\";\nimport { signTransaction } from \"../../internal/transactionSubmission\";\nimport { AccountAuthenticator, AnyRawTransaction } from \"../../transactions\";\nimport { AptosConfig } from \"../aptosConfig\";\n\n/**\n * A class to handle all `Sign` transaction operations\n */\nexport class Sign {\n  readonly config: AptosConfig;\n\n  constructor(config: AptosConfig) {\n    this.config = config;\n  }\n\n  // eslint-disable-next-line class-methods-use-this\n  transaction(args: { signer: Account; transaction: AnyRawTransaction }): AccountAuthenticator {\n    return signTransaction({\n      ...args,\n    });\n  }\n\n  // eslint-disable-next-line class-methods-use-this\n  transactionAsFeePayer(args: { signer: Account; transaction: AnyRawTransaction }): AccountAuthenticator {\n    const { signer, transaction } = args;\n\n    // if transaction doesnt hold a \"feePayerAddress\" prop it means\n    // this is not a fee payer transaction\n    if (!transaction.feePayerAddress) {\n      throw new Error(`Transaction ${transaction} is not a Fee Payer transaction`);\n    }\n\n    // Set the feePayerAddress to the signer account address\n    transaction.feePayerAddress = signer.accountAddress;\n\n    return signTransaction({\n      signer,\n      transaction,\n    });\n  }\n}\n"],"mappings":"iwFAWO,IAAMA,EAAN,KAAW,CAGhB,YAAYC,EAAqB,CAC/B,KAAK,OAASA,CAChB,CAGA,YAAYC,EAAiF,CAC3F,OAAOC,EAAgB,CACrB,GAAGD,CACL,CAAC,CACH,CAGA,sBAAsBA,EAAiF,CACrG,GAAM,CAAE,OAAAE,EAAQ,YAAAC,CAAY,EAAIH,EAIhC,GAAI,CAACG,EAAY,gBACf,MAAM,IAAI,MAAM,eAAeA,CAAW,iCAAiC,EAI7E,OAAAA,EAAY,gBAAkBD,EAAO,eAE9BD,EAAgB,CACrB,OAAAC,EACA,YAAAC,CACF,CAAC,CACH,CACF","names":["Sign","config","args","signTransaction","signer","transaction"]}
+{"version":3,"sources":["../../../../src/api/transactionSubmission/sign.ts"],"sourcesContent":["// Copyright © Aptos Foundation\n// SPDX-License-Identifier: Apache-2.0\n\nimport { Account } from \"../../account\";\nimport { signTransaction } from \"../../internal/transactionSubmission\";\nimport { AccountAuthenticator, AnyRawTransaction } from \"../../transactions\";\nimport { AptosConfig } from \"../aptosConfig\";\n\n/**\n * A class to handle all `Sign` transaction operations.\n *\n * @param config - The configuration object for Aptos.\n */\nexport class Sign {\n  readonly config: AptosConfig;\n\n  /**\n   * Creates an instance of the Aptos client with the specified configuration.\n   *\n   * @param config - The configuration settings for the Aptos client.\n   *\n   * @example\n   * ```typescript\n   * import { Aptos, AptosConfig, Network } from \"@aptos-labs/ts-sdk\";\n   *\n   * async function runExample() {\n   *     // Create a new Aptos client with testnet configuration\n   *     const config = new AptosConfig({ network: Network.TESTNET });\n   *     const aptos = new Aptos(config);\n   *\n   *     console.log(\"Aptos client created with config:\", config);\n   * }\n   * runExample().catch(console.error);\n   * ```\n   */\n  constructor(config: AptosConfig) {\n    this.config = config;\n  }\n\n  /**\n   * Signs a transaction using the provided account signer. This function is essential for ensuring that transactions are properly\n   * authenticated before being sent to the network.\n   *\n   * @param args - The arguments for signing the transaction.\n   * @param args.signer - The account that will sign the transaction.\n   * @param args.transaction - The raw transaction data to be signed.\n   *\n   * @example\n   * ```typescript\n   * import { Aptos, AptosConfig, Network, Account } from \"@aptos-labs/ts-sdk\";\n   *\n   * const config = new AptosConfig({ network: Network.TESTNET });\n   * const aptos = new Aptos(config);\n   *\n   * async function runExample() {\n   *   const sender = Account.generate(); // Generate a new account for signing\n   *   const transaction = await aptos.transaction.build.simple({\n   *     sender: sender.accountAddress,\n   *     data: {\n   *       function: \"0x1::aptos_account::transfer\",\n   *       functionArguments: [ \"0x1\", 100 ], // replace with a real account address and amount\n   *     },\n   *   });\n   *\n   *   // Sign the transaction\n   *   const signedTransaction = await aptos.transaction.sign({\n   *     signer: sender,\n   *     transaction: transaction,\n   *   });\n   *\n   *   console.log(\"Signed Transaction:\", signedTransaction);\n   * }\n   * runExample().catch(console.error);\n   * ```\n   */\n  // eslint-disable-next-line class-methods-use-this\n  transaction(args: { signer: Account; transaction: AnyRawTransaction }): AccountAuthenticator {\n    return signTransaction({\n      ...args,\n    });\n  }\n\n  /**\n   * Sets the fee payer address for a transaction and signs it with the provided account.\n   * This function is essential for transactions that require a designated fee payer.\n   *\n   * @param args - The arguments for the function.\n   * @param args.signer - The account that will sign the transaction.\n   * @param args.transaction - The transaction object that requires a fee payer address.\n   *\n   * @throws Error if the transaction does not have a feePayerAddress property.\n   *\n   * @example\n   * ```typescript\n   * import { Aptos, AptosConfig, Network, Account } from \"@aptos-labs/ts-sdk\";\n   *\n   * const config = new AptosConfig({ network: Network.TESTNET });\n   * const aptos = new Aptos(config);\n   *\n   * async function runExample() {\n   *   const sender = Account.generate(); // Generate a new account for signing\n   *   const transaction = await aptos.transaction.build.simple({\n   *     sender: sender.accountAddress,\n   *     data: {\n   *       function: \"0x1::aptos_account::transfer\",\n   *       functionArguments: [\"0x1\", 100], // replace with a real recipient address\n   *     },\n   *   });\n   *\n   *   // Set the fee payer for the transaction\n   *   transaction.feePayerAddress = \"0x1\"; // replace with a real fee payer address\n   *\n   *   const signedTransaction = await aptos.transactionAsFeePayer({ signer: sender, transaction });\n   *\n   *   console.log(\"Signed Transaction:\", signedTransaction);\n   * }\n   * runExample().catch(console.error);\n   * ```\n   */\n  // eslint-disable-next-line class-methods-use-this\n  transactionAsFeePayer(args: { signer: Account; transaction: AnyRawTransaction }): AccountAuthenticator {\n    const { signer, transaction } = args;\n\n    // if transaction doesn't hold a \"feePayerAddress\" prop it means\n    // this is not a fee payer transaction\n    if (!transaction.feePayerAddress) {\n      throw new Error(`Transaction ${transaction} is not a Fee Payer transaction`);\n    }\n\n    // Set the feePayerAddress to the signer account address\n    transaction.feePayerAddress = signer.accountAddress;\n\n    return signTransaction({\n      signer,\n      transaction,\n    });\n  }\n}\n"],"mappings":"iwFAaO,IAAMA,EAAN,KAAW,CAsBhB,YAAYC,EAAqB,CAC/B,KAAK,OAASA,CAChB,CAuCA,YAAYC,EAAiF,CAC3F,OAAOC,EAAgB,CACrB,GAAGD,CACL,CAAC,CACH,CAwCA,sBAAsBA,EAAiF,CACrG,GAAM,CAAE,OAAAE,EAAQ,YAAAC,CAAY,EAAIH,EAIhC,GAAI,CAACG,EAAY,gBACf,MAAM,IAAI,MAAM,eAAeA,CAAW,iCAAiC,EAI7E,OAAAA,EAAY,gBAAkBD,EAAO,eAE9BD,EAAgB,CACrB,OAAAC,EACA,YAAAC,CACF,CAAC,CACH,CACF","names":["Sign","config","args","signTransaction","signer","transaction"]}

package/dist/esm/api/transactionSubmission/simulate.d.mts

@@ -1,5 +1,5 @@
 import { UserTransactionResponse } from '../../types/index.mjs';
-import { P as PublicKey } from '../../publicKey-B3XRNhHO.mjs';
+import { P as PublicKey } from '../../publicKey-_tPa99ea.mjs';
 import { AptosConfig } from '../aptosConfig.mjs';
 import { AnyRawTransaction, InputSimulateTransactionOptions } from '../../transactions/types.mjs';
 import '../../utils/apiEndpoints.mjs';
@@ -33,20 +33,90 @@ import '../../transactions/instances/simpleTransaction.mjs';
 import '../../transactions/instances/multiAgentTransaction.mjs';
 
 /**
- * A class to handle all `Simulate` transaction operations
+ * A class to handle all `Simulate` transaction operations.
  */
 declare class Simulate {
     readonly config: AptosConfig;
+    /**
+     * Initializes a new instance of the Aptos client with the specified configuration.
+     * This allows you to interact with the Aptos blockchain using the provided settings.
+     *
+     * @param config - The configuration settings for the Aptos client.
+     * @param config.network - The network to connect to (e.g., TESTNET, MAINNET).
+     * @param config.nodeUrl - The URL of the Aptos node to connect to.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a configuration for the Aptos client
+     *     const config = new AptosConfig({ network: Network.TESTNET }); // Specify your desired network
+     *
+     *     // Initialize the Aptos client with the configuration
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     */
     constructor(config: AptosConfig);
     /**
-     * Simulate a simple transaction
+     * Simulates a transaction based on the provided parameters and returns the result.
+     * This function helps you understand the outcome of a transaction before executing it on the blockchain.
+     *
+     * @param args - The parameters for simulating the transaction.
+     * @param args.signerPublicKey - The public key of the signer for the transaction.
+     * @param args.transaction - The raw transaction data to simulate.
+     * @param args.feePayerPublicKey - The public key of the fee payer (optional).
+     * @param args.options - Additional options for simulating the transaction (optional).
+     *
+     * @example
+     * ```typescript
+     * import {
+     *     Account,
+     *     Aptos,
+     *     AptosConfig,
+     *     Network,
+     * } from "@aptos-labs/ts-sdk";
+     *
+     * async function example() {
+     *     let sender = Account.generate();
+     *     let receiver = Account.generate();
+     *
+     *     // 0. Set up the client and test accounts
+     *     const config = new AptosConfig({ network: Network.DEVNET });
+     *     const aptos = new Aptos(config);
      *
-     * @param args.signerPublicKey The signer public key
-     * @param args.transaction An instance of a raw transaction
-     * @param args.options optional. Optional transaction configurations
-     * @param args.feePayerPublicKey optional. The fee payer public key if it is a fee payer transaction
+     *     await aptos.fundAccount({
+     *         accountAddress: sender.accountAddress,
+     *         amount: 100_000_000,
+     *     });
      *
-     * @returns Array<UserTransactionResponse>
+     *     // 1. Build the transaction to preview the impact of it
+     *     const transaction = await aptos.transaction.build.simple({
+     *         sender: sender.accountAddress,
+     *         data: {
+     *             // All transactions on Aptos are implemented via smart contracts.
+     *             function: "0x1::aptos_account::transfer",
+     *             functionArguments: [receiver.accountAddress, 100],
+     *         },
+     *     });
+     *
+     *     // 2. Simulate to see what would happen if we execute this transaction
+     *     const [userTransactionResponse] = await aptos.transaction.simulate.simple({
+     *         signerPublicKey: sender.publicKey,
+     *         transaction,
+     *     });
+     *     console.log(userTransactionResponse);
+     *
+     *     // If the fee looks ok, continue to signing!
+     *     // ...
+     * }
+     *
+     * example();
+     * ```
      */
     simple(args: {
         signerPublicKey: PublicKey;
@@ -55,15 +125,70 @@ declare class Simulate {
         options?: InputSimulateTransactionOptions;
     }): Promise<Array<UserTransactionResponse>>;
     /**
-     * Simulate a multi agent transaction
+     * Simulates a multi-agent transaction by generating a signed transaction and posting it to the Aptos full node.
+     * This function helps in understanding the outcome of a transaction involving multiple signers before it is executed.
+     *
+     * @param args - The parameters for simulating the transaction.
+     * @param args.signerPublicKey - The public key of the primary signer.
+     * @param args.transaction - The raw transaction to be simulated.
+     * @param args.secondarySignersPublicKeys - An array of public keys for secondary signers.
+     * @param args.feePayerPublicKey - (Optional) The public key of the fee payer.
+     * @param args.options - (Optional) Options for simulating the transaction.
+     *
+     * @example
+     * ```typescript
+     * import {
+     *     Account,
+     *     Aptos,
+     *     AptosConfig,
+     *     Network,
+     * } from "@aptos-labs/ts-sdk";
+     *
+     * async function example() {
+     *     let sender1 = Account.generate();
+     *     let sender2 = Account.generate();
+     *     let receiver = Account.generate();
+     *
+     *     // 0. Set up the client and test accounts
+     *     const config = new AptosConfig({ network: Network.DEVNET });
+     *     const aptos = new Aptos(config);
+     *
+     *     await aptos.fundAccount({
+     *         accountAddress: sender.accountAddress,
+     *         amount: 100_000_000,
+     *     });
+     *
+     *     // 1. Build
+     *     console.log("\n=== 1. Building the transaction ===\n");
+     *     const transaction = await aptos.transaction.build.multiAgent({
+     *     sender: sender1.accountAddress,
+     *     secondarySignerAddresses: [sender2.accountAddress],
+     *     data: {
+     *        // REPLACE WITH YOUR MULTI-AGENT FUNCTION HERE
+     *        function:
+     *          "<REPLACE WITH YOUR MULTI AGENT MOVE ENTRY FUNCTION> (Syntax {address}::{module}::{function})",
+     *          functionArguments: [],
+     *        },
+     *      });
+     *      console.log("Transaction:", transaction);
+     *
+     *      // 2. Simulate (Optional)
+     *      console.log("\n === 2. Simulating Response (Optional) === \n");
+     *      const [userTransactionResponse] = await aptos.transaction.simulate.multiAgent(
+     *        {
+     *          signerPublicKey: sender1.publicKey,
+     *          secondarySignersPublicKeys: [sender2.publicKey],
+     *          transaction,
+     *        },
+     *      );
+     *      console.log(userTransactionResponse);
      *
-     * @param args.signerPublicKey The signer public key
-     * @param args.transaction An instance of a raw transaction
-     * @param args.secondarySignersPublicKeys An array of the secondary signers public keys
-     * @param args.options optional. Optional transaction configurations
-     * @param args.feePayerPublicKey optional. The fee payer public key if it is a fee payer transaction
+     *      // If the fee looks ok, continue to signing!
+     *      // ...
+     * }
      *
-     * @returns Array<UserTransactionResponse>
+     * example();
+     * ```
      */
     multiAgent(args: {
         signerPublicKey: PublicKey;

package/dist/esm/api/transactionSubmission/simulate.mjs

@@ -1,2 +1,2 @@
-import{a}from"../../chunk-JH6VLTMS.mjs";import"../../chunk-6EMN3BOV.mjs";import"../../chunk-P2EIZ7WL.mjs";import"../../chunk-I5OYNCZS.mjs";import"../../chunk-JXCZTOYC.mjs";import"../../chunk-MDJ66AA3.mjs";import"../../chunk-TQWGQLM6.mjs";import"../../chunk-NWOMSL6K.mjs";import"../../chunk-53RB2PRH.mjs";import"../../chunk-BSCOVLWS.mjs";import"../../chunk-V3MBJJTL.mjs";import"../../chunk-STUXKQVZ.mjs";import"../../chunk-D3Q4BC3I.mjs";import"../../chunk-FZ5EYP3D.mjs";import"../../chunk-2BTTX2KO.mjs";import"../../chunk-VHNX2NUR.mjs";import"../../chunk-GAEAYY44.mjs";import"../../chunk-RXE6NNOL.mjs";import"../../chunk-QPB6EJVM.mjs";import"../../chunk-4HR32TSY.mjs";import"../../chunk-3W2DHZXK.mjs";import"../../chunk-CB6H4VMZ.mjs";import"../../chunk-E4O26ZJB.mjs";import"../../chunk-Y3BATGHX.mjs";import"../../chunk-O2BPA6TS.mjs";import"../../chunk-4NMDYPUD.mjs";import"../../chunk-UYVPNUH3.mjs";import"../../chunk-MAMPMCO7.mjs";import"../../chunk-SWNFKKRE.mjs";import"../../chunk-5PCNWXRN.mjs";import"../../chunk-L2QXU6F4.mjs";import"../../chunk-QBSU3L5Q.mjs";import"../../chunk-7VKFXX5Q.mjs";import"../../chunk-SUJLWCRN.mjs";import"../../chunk-YDZBU2DJ.mjs";import"../../chunk-YUNDX5I7.mjs";import"../../chunk-A42BPAD4.mjs";import"../../chunk-KUZ2YTJH.mjs";import"../../chunk-BOYYQAB4.mjs";import"../../chunk-E7FWVXGX.mjs";import"../../chunk-NECL5FCQ.mjs";import"../../chunk-4QMXOWHP.mjs";import"../../chunk-WRRQ7L5K.mjs";import"../../chunk-ADE6MVXC.mjs";import"../../chunk-HEZ2ZYZA.mjs";import"../../chunk-45IUUCAV.mjs";import"../../chunk-HHGJXVAE.mjs";import"../../chunk-GMBSQDPO.mjs";import"../../chunk-KUX6GQ2E.mjs";import"../../chunk-GDO6Q2FI.mjs";import"../../chunk-BA4RBST6.mjs";import"../../chunk-G5XLMQ5E.mjs";import"../../chunk-SRPI2FFA.mjs";import"../../chunk-MQGW234H.mjs";import"../../chunk-F63E4CR7.mjs";import"../../chunk-GWSDIX6C.mjs";import"../../chunk-MLDQ2TY2.mjs";import"../../chunk-Q4XR6QOZ.mjs";import"../../chunk-76OH2Z4Q.mjs";import"../../chunk-LR65XHSF.mjs";import"../../chunk-G5MGSV7Y.mjs";import"../../chunk-OHRL766V.mjs";import"../../chunk-AH44UPM4.mjs";import"../../chunk-N2FKVZ4D.mjs";import"../../chunk-YU3IYJRL.mjs";import"../../chunk-CRA2MFJC.mjs";import"../../chunk-XMW65WCQ.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-BSUYPXRD.mjs";import"../../chunk-SCHZ67F3.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-LNEZEYYE.mjs";import"../../chunk-YPHH6CAO.mjs";import"../../chunk-P5V7OZNN.mjs";import"../../chunk-H6YNXJNF.mjs";import"../../chunk-44GYWUSH.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-A63SMUOU.mjs";import"../../chunk-BCUSI3N6.mjs";import"../../chunk-LG7RJQ57.mjs";import"../../chunk-TDGQGILY.mjs";import"../../chunk-EXP5STXZ.mjs";import"../../chunk-UAL27G6B.mjs";import"../../chunk-KEYAPEAX.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-UAEODDZS.mjs";import"../../chunk-FVA2OPG4.mjs";export{a as Simulate};
+import{a}from"../../chunk-HAMXSLWF.mjs";import"../../chunk-I2NMCLNW.mjs";import"../../chunk-2I56E4T2.mjs";import"../../chunk-I5OYNCZS.mjs";import"../../chunk-JXCZTOYC.mjs";import"../../chunk-HGVZ7ULA.mjs";import"../../chunk-RUDS7RSB.mjs";import"../../chunk-KRVLR3L4.mjs";import"../../chunk-N3OYD6VZ.mjs";import"../../chunk-BSCOVLWS.mjs";import"../../chunk-V3MBJJTL.mjs";import"../../chunk-7D3RY73L.mjs";import"../../chunk-GAEAYY44.mjs";import"../../chunk-L5I7F3NZ.mjs";import"../../chunk-ZS3EWM5A.mjs";import"../../chunk-HCV3NGLS.mjs";import"../../chunk-KSKQVOBA.mjs";import"../../chunk-K6MZXKVV.mjs";import"../../chunk-LZS7BQ2B.mjs";import"../../chunk-5ZBHIUWG.mjs";import"../../chunk-VQTEGTUQ.mjs";import"../../chunk-4NMDYPUD.mjs";import"../../chunk-LD5MUWGW.mjs";import"../../chunk-5AAFF2PV.mjs";import"../../chunk-JY3JJ55D.mjs";import"../../chunk-FO4F3OJJ.mjs";import"../../chunk-7PVIWKGT.mjs";import"../../chunk-UYVPNUH3.mjs";import"../../chunk-JDYASF3E.mjs";import"../../chunk-OTY3NO7Q.mjs";import"../../chunk-OS2EG6AE.mjs";import"../../chunk-IFHQSZLK.mjs";import"../../chunk-ZINOJTLU.mjs";import"../../chunk-NODYW7DM.mjs";import"../../chunk-AGBA3Y7A.mjs";import"../../chunk-UKAXCARD.mjs";import"../../chunk-Z36WHOZV.mjs";import"../../chunk-E7FWVXGX.mjs";import"../../chunk-NECL5FCQ.mjs";import"../../chunk-4QMXOWHP.mjs";import"../../chunk-PCLU4KLY.mjs";import"../../chunk-HEZ2ZYZA.mjs";import"../../chunk-KUX6GQ2E.mjs";import"../../chunk-WIXNX7HY.mjs";import"../../chunk-6AGTDRNM.mjs";import"../../chunk-S3FVA55H.mjs";import"../../chunk-DZJXOL64.mjs";import"../../chunk-37UZKMJI.mjs";import"../../chunk-5CCHECTE.mjs";import"../../chunk-ONBFUPEC.mjs";import"../../chunk-XHCALZ7X.mjs";import"../../chunk-GMKKHGXK.mjs";import"../../chunk-WSVOJSAC.mjs";import"../../chunk-4OV7QU2U.mjs";import"../../chunk-IBLZ6MZU.mjs";import"../../chunk-KIW54KWR.mjs";import"../../chunk-PHP47DI4.mjs";import"../../chunk-PRZ7AIGA.mjs";import"../../chunk-DCUVV3VY.mjs";import"../../chunk-HDTKBFRX.mjs";import"../../chunk-VHNX2NUR.mjs";import"../../chunk-HBIDHQ2M.mjs";import"../../chunk-N2FKVZ4D.mjs";import"../../chunk-OLPI7QAH.mjs";import"../../chunk-WOOH5MMX.mjs";import"../../chunk-CRL4WGOH.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-4CDDWSKZ.mjs";import"../../chunk-LEKBJ2EG.mjs";import"../../chunk-GQABU3RQ.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-IECDO22V.mjs";import"../../chunk-OZN3OOJV.mjs";import"../../chunk-JGNMNCQB.mjs";import"../../chunk-6FLHGOKP.mjs";import"../../chunk-N47FTRYO.mjs";import"../../chunk-KM6UXNC7.mjs";import"../../chunk-7XS45O6M.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-QQIVWB6G.mjs";import"../../chunk-KFNDDPOW.mjs";import"../../chunk-6Q2O5G3J.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-UI3AKMZX.mjs";import"../../chunk-D3OEQLUE.mjs";import"../../chunk-J245N3XF.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as Simulate};
 //# sourceMappingURL=simulate.mjs.map

package/dist/esm/api/transactionSubmission/submit.d.mts

@@ -11,7 +11,7 @@ import '../../bcs/serializer.mjs';
 import '../../core/hex.mjs';
 import '../../core/common.mjs';
 import '../../core/crypto/ed25519.mjs';
-import '../../publicKey-B3XRNhHO.mjs';
+import '../../publicKey-_tPa99ea.mjs';
 import '../../core/accountAddress.mjs';
 import '../../transactions/instances/transactionArgument.mjs';
 import '../../core/crypto/signature.mjs';
@@ -33,19 +33,76 @@ import '../../transactions/instances/simpleTransaction.mjs';
 import '../../transactions/instances/multiAgentTransaction.mjs';
 
 /**
- * A class to handle all `Submit` transaction operations
+ * A class to handle all `Submit` transaction operations.
  */
 declare class Submit {
     readonly config: AptosConfig;
+    /**
+     * Initializes a new instance of the Aptos client with the specified configuration.
+     * This allows you to interact with the Aptos blockchain using the provided settings.
+     *
+     * @param config - The configuration settings for the Aptos client.
+     * @param config.network - The network to connect to (e.g., TESTNET, MAINNET).
+     * @param config.nodeUrl - The URL of the Aptos node to connect to.
+     * @param config.faucetUrl - The URL of the faucet for obtaining test tokens.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a configuration for the Aptos client
+     *     const config = new AptosConfig({
+     *         network: Network.TESTNET, // Use the TESTNET for testing
+     *         nodeUrl: "https://testnet.aptos.dev", // Specify the node URL
+     *         faucetUrl: "https://faucet.testnet.aptos.dev" // Specify the faucet URL
+     *     });
+     *
+     *     // Initialize the Aptos client with the configuration
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     */
     constructor(config: AptosConfig);
     /**
-     * Submit a simple transaction
+     * Submits a transaction to the Aptos blockchain using the provided transaction details and authenticators.
+     * This function allows you to execute transactions securely by specifying the sender and optional fee payer authenticators.
+     *
+     * @param args - The arguments for submitting the transaction.
+     * @param args.transaction - The raw transaction data to be submitted.
+     * @param args.senderAuthenticator - The authenticator for the sender's account.
+     * @param [args.feePayerAuthenticator] - The optional authenticator for the fee payer's account.
      *
-     * @param args.transaction An instance of a raw transaction
-     * @param args.senderAuthenticator optional. The sender account authenticator
-     * @param args.feePayerAuthenticator optional. The fee payer account authenticator if it is a fee payer transaction
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network, Account } from "@aptos-labs/ts-sdk";
      *
-     * @returns PendingTransactionResponse
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   const sender = Account.generate(); // Generate a new sender account
+     *   const transaction = await aptos.transaction.build.simple({
+     *     sender: sender.accountAddress,
+     *     data: {
+     *       function: "0x1::aptos_account::transfer",
+     *       functionArguments: [Account.generate().accountAddress, 100], // Replace with a real destination account
+     *     },
+     *   });
+     *
+     *   // Submit the transaction
+     *   const response = await aptos.simple({
+     *     transaction,
+     *     senderAuthenticator: sender.getAuthenticator(), // Use the sender's authenticator
+     *   });
+     *
+     *   console.log("Transaction submitted:", response);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     simple(args: {
         transaction: AnyRawTransaction;
@@ -53,14 +110,48 @@ declare class Submit {
         feePayerAuthenticator?: AccountAuthenticator;
     }): Promise<PendingTransactionResponse>;
     /**
-     * Submit a multi agent transaction
+     * Submits a multi-agent transaction to the Aptos network, allowing multiple signers to authorize the transaction.
+     * This function is useful for scenarios where a transaction requires approval from multiple accounts.
+     *
+     * @param args - The parameters for the multi-agent transaction.
+     * @param args.transaction - The raw transaction to be submitted.
+     * @param args.senderAuthenticator - The authenticator for the sender account.
+     * @param args.additionalSignersAuthenticators - An array of authenticators for additional signers.
+     * @param [args.feePayerAuthenticator] - An optional authenticator for the fee payer account.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network, Account } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   const sender = Account.generate(); // Generate a new sender account
+     *   const additionalSigner1 = Account.generate(); // Generate an additional signer account
+     *   const additionalSigner2 = Account.generate(); // Generate another additional signer account
+     *
+     *   const transaction = await aptos.transaction.build.simple({
+     *     sender: sender.accountAddress,
+     *     data: {
+     *       function: "0x1::aptos_account::transfer",
+     *       functionArguments: [additionalSigner1.accountAddress, 100],
+     *     },
+     *   });
      *
-     * @param args.transaction An instance of a raw transaction
-     * @param args.senderAuthenticator optional. The sender account authenticator
-     * @param args.additionalSignersAuthenticators An array of the secondary signers account authenticators
-     * @param args.feePayerAuthenticator optional. The fee payer account authenticator if it is a fee payer transaction
+     *   const response = await aptos.multiAgent({
+     *     transaction,
+     *     senderAuthenticator: sender.getAuthenticator(), // Use the sender's authenticator
+     *     additionalSignersAuthenticators: [
+     *       additionalSigner1.getAuthenticator(), // Use the first additional signer's authenticator
+     *       additionalSigner2.getAuthenticator(), // Use the second additional signer's authenticator
+     *     ],
+     *   });
      *
-     * @returns PendingTransactionResponse
+     *   console.log(response); // Log the response from the transaction submission
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     multiAgent(args: {
         transaction: AnyRawTransaction;

package/dist/esm/api/transactionSubmission/submit.mjs

@@ -1,2 +1,2 @@
-import{a}from"../../chunk-HVMFZF6P.mjs";import"../../chunk-6EMN3BOV.mjs";import"../../chunk-P2EIZ7WL.mjs";import"../../chunk-I5OYNCZS.mjs";import"../../chunk-JXCZTOYC.mjs";import"../../chunk-MDJ66AA3.mjs";import"../../chunk-TQWGQLM6.mjs";import"../../chunk-NWOMSL6K.mjs";import"../../chunk-53RB2PRH.mjs";import"../../chunk-BSCOVLWS.mjs";import"../../chunk-V3MBJJTL.mjs";import"../../chunk-STUXKQVZ.mjs";import"../../chunk-D3Q4BC3I.mjs";import"../../chunk-FZ5EYP3D.mjs";import"../../chunk-2BTTX2KO.mjs";import"../../chunk-VHNX2NUR.mjs";import"../../chunk-GAEAYY44.mjs";import"../../chunk-RXE6NNOL.mjs";import"../../chunk-QPB6EJVM.mjs";import"../../chunk-4HR32TSY.mjs";import"../../chunk-3W2DHZXK.mjs";import"../../chunk-CB6H4VMZ.mjs";import"../../chunk-E4O26ZJB.mjs";import"../../chunk-Y3BATGHX.mjs";import"../../chunk-O2BPA6TS.mjs";import"../../chunk-4NMDYPUD.mjs";import"../../chunk-UYVPNUH3.mjs";import"../../chunk-MAMPMCO7.mjs";import"../../chunk-SWNFKKRE.mjs";import"../../chunk-5PCNWXRN.mjs";import"../../chunk-L2QXU6F4.mjs";import"../../chunk-QBSU3L5Q.mjs";import"../../chunk-7VKFXX5Q.mjs";import"../../chunk-SUJLWCRN.mjs";import"../../chunk-YDZBU2DJ.mjs";import"../../chunk-YUNDX5I7.mjs";import"../../chunk-A42BPAD4.mjs";import"../../chunk-KUZ2YTJH.mjs";import"../../chunk-BOYYQAB4.mjs";import"../../chunk-E7FWVXGX.mjs";import"../../chunk-NECL5FCQ.mjs";import"../../chunk-4QMXOWHP.mjs";import"../../chunk-WRRQ7L5K.mjs";import"../../chunk-ADE6MVXC.mjs";import"../../chunk-HEZ2ZYZA.mjs";import"../../chunk-45IUUCAV.mjs";import"../../chunk-HHGJXVAE.mjs";import"../../chunk-GMBSQDPO.mjs";import"../../chunk-KUX6GQ2E.mjs";import"../../chunk-GDO6Q2FI.mjs";import"../../chunk-BA4RBST6.mjs";import"../../chunk-G5XLMQ5E.mjs";import"../../chunk-SRPI2FFA.mjs";import"../../chunk-MQGW234H.mjs";import"../../chunk-F63E4CR7.mjs";import"../../chunk-GWSDIX6C.mjs";import"../../chunk-MLDQ2TY2.mjs";import"../../chunk-Q4XR6QOZ.mjs";import"../../chunk-76OH2Z4Q.mjs";import"../../chunk-LR65XHSF.mjs";import"../../chunk-G5MGSV7Y.mjs";import"../../chunk-OHRL766V.mjs";import"../../chunk-AH44UPM4.mjs";import"../../chunk-N2FKVZ4D.mjs";import"../../chunk-YU3IYJRL.mjs";import"../../chunk-CRA2MFJC.mjs";import"../../chunk-XMW65WCQ.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-BSUYPXRD.mjs";import"../../chunk-SCHZ67F3.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-LNEZEYYE.mjs";import"../../chunk-YPHH6CAO.mjs";import"../../chunk-P5V7OZNN.mjs";import"../../chunk-H6YNXJNF.mjs";import"../../chunk-44GYWUSH.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-A63SMUOU.mjs";import"../../chunk-BCUSI3N6.mjs";import"../../chunk-LG7RJQ57.mjs";import"../../chunk-TDGQGILY.mjs";import"../../chunk-EXP5STXZ.mjs";import"../../chunk-UAL27G6B.mjs";import"../../chunk-KEYAPEAX.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-UAEODDZS.mjs";import"../../chunk-FVA2OPG4.mjs";export{a as Submit};
+import{a}from"../../chunk-NV6DHDM3.mjs";import"../../chunk-I2NMCLNW.mjs";import"../../chunk-2I56E4T2.mjs";import"../../chunk-I5OYNCZS.mjs";import"../../chunk-JXCZTOYC.mjs";import"../../chunk-HGVZ7ULA.mjs";import"../../chunk-RUDS7RSB.mjs";import"../../chunk-KRVLR3L4.mjs";import"../../chunk-N3OYD6VZ.mjs";import"../../chunk-BSCOVLWS.mjs";import"../../chunk-V3MBJJTL.mjs";import"../../chunk-7D3RY73L.mjs";import"../../chunk-GAEAYY44.mjs";import"../../chunk-L5I7F3NZ.mjs";import"../../chunk-ZS3EWM5A.mjs";import"../../chunk-HCV3NGLS.mjs";import"../../chunk-KSKQVOBA.mjs";import"../../chunk-K6MZXKVV.mjs";import"../../chunk-LZS7BQ2B.mjs";import"../../chunk-5ZBHIUWG.mjs";import"../../chunk-VQTEGTUQ.mjs";import"../../chunk-4NMDYPUD.mjs";import"../../chunk-LD5MUWGW.mjs";import"../../chunk-5AAFF2PV.mjs";import"../../chunk-JY3JJ55D.mjs";import"../../chunk-FO4F3OJJ.mjs";import"../../chunk-7PVIWKGT.mjs";import"../../chunk-UYVPNUH3.mjs";import"../../chunk-JDYASF3E.mjs";import"../../chunk-OTY3NO7Q.mjs";import"../../chunk-OS2EG6AE.mjs";import"../../chunk-IFHQSZLK.mjs";import"../../chunk-ZINOJTLU.mjs";import"../../chunk-NODYW7DM.mjs";import"../../chunk-AGBA3Y7A.mjs";import"../../chunk-UKAXCARD.mjs";import"../../chunk-Z36WHOZV.mjs";import"../../chunk-E7FWVXGX.mjs";import"../../chunk-NECL5FCQ.mjs";import"../../chunk-4QMXOWHP.mjs";import"../../chunk-PCLU4KLY.mjs";import"../../chunk-HEZ2ZYZA.mjs";import"../../chunk-KUX6GQ2E.mjs";import"../../chunk-WIXNX7HY.mjs";import"../../chunk-6AGTDRNM.mjs";import"../../chunk-S3FVA55H.mjs";import"../../chunk-DZJXOL64.mjs";import"../../chunk-37UZKMJI.mjs";import"../../chunk-5CCHECTE.mjs";import"../../chunk-ONBFUPEC.mjs";import"../../chunk-XHCALZ7X.mjs";import"../../chunk-GMKKHGXK.mjs";import"../../chunk-WSVOJSAC.mjs";import"../../chunk-4OV7QU2U.mjs";import"../../chunk-IBLZ6MZU.mjs";import"../../chunk-KIW54KWR.mjs";import"../../chunk-PHP47DI4.mjs";import"../../chunk-PRZ7AIGA.mjs";import"../../chunk-DCUVV3VY.mjs";import"../../chunk-HDTKBFRX.mjs";import"../../chunk-VHNX2NUR.mjs";import"../../chunk-HBIDHQ2M.mjs";import"../../chunk-N2FKVZ4D.mjs";import"../../chunk-OLPI7QAH.mjs";import"../../chunk-WOOH5MMX.mjs";import"../../chunk-CRL4WGOH.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-4CDDWSKZ.mjs";import"../../chunk-LEKBJ2EG.mjs";import"../../chunk-GQABU3RQ.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-IECDO22V.mjs";import"../../chunk-OZN3OOJV.mjs";import"../../chunk-JGNMNCQB.mjs";import"../../chunk-6FLHGOKP.mjs";import"../../chunk-N47FTRYO.mjs";import"../../chunk-KM6UXNC7.mjs";import"../../chunk-7XS45O6M.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-QQIVWB6G.mjs";import"../../chunk-KFNDDPOW.mjs";import"../../chunk-6Q2O5G3J.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-UI3AKMZX.mjs";import"../../chunk-D3OEQLUE.mjs";import"../../chunk-J245N3XF.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as Submit};
 //# sourceMappingURL=submit.mjs.map

package/dist/esm/api/utils.d.mts

@@ -7,10 +7,33 @@ import '../types/generated/operations.mjs';
 import '../types/generated/types.mjs';
 
 /**
- * Utility function to handle optional waiting on indexer for APIs
+ * Waits for the indexer to reach a specified ledger version, allowing for synchronization with the blockchain.
+ * This function is useful for ensuring that your application is working with the most up-to-date data before proceeding.
  *
- * This is purposely placed here to not expose this internal function.
- * @param args
+ * @param args - The parameters for waiting on the indexer.
+ * @param args.config - The configuration object for Aptos.
+ * @param [args.minimumLedgerVersion] - The minimum ledger version to wait for. If not specified, the function will not wait.
+ * @param args.processorType - The type of processor to wait for.
+ *
+ * @example
+ * ```typescript
+ * import { Aptos, AptosConfig, Network, ProcessorType } from "@aptos-labs/ts-sdk";
+ *
+ * const config = new AptosConfig({ network: Network.TESTNET });
+ * const aptos = new Aptos(config);
+ *
+ * async function runExample() {
+ *   // Wait for the indexer to reach a specific ledger version
+ *   await aptos.waitForIndexerOnVersion({
+ *     config: config,
+ *     minimumLedgerVersion: 1000n, // replace with a real ledger version
+ *     processorType: ProcessorType.DEFAULT,
+ *   });
+ *
+ *   console.log("Indexer is synced to the specified ledger version.");
+ * }
+ * runExample().catch(console.error);
+ * ```
  */
 declare function waitForIndexerOnVersion(args: {
     config: AptosConfig;

package/dist/esm/api/utils.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-SDWE6WMM.mjs";import"../chunk-FZ5EYP3D.mjs";import"../chunk-2BTTX2KO.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-AH44UPM4.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-YU3IYJRL.mjs";import"../chunk-CRA2MFJC.mjs";import"../chunk-XMW65WCQ.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-BSUYPXRD.mjs";import"../chunk-SCHZ67F3.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-LNEZEYYE.mjs";import"../chunk-YPHH6CAO.mjs";import"../chunk-P5V7OZNN.mjs";import"../chunk-H6YNXJNF.mjs";import"../chunk-44GYWUSH.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-A63SMUOU.mjs";import"../chunk-BCUSI3N6.mjs";import"../chunk-LG7RJQ57.mjs";import"../chunk-TDGQGILY.mjs";import"../chunk-EXP5STXZ.mjs";import"../chunk-UAL27G6B.mjs";import"../chunk-KEYAPEAX.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-UAEODDZS.mjs";import"../chunk-FVA2OPG4.mjs";export{a as waitForIndexerOnVersion};
+import{a}from"../chunk-TRU3EK64.mjs";import"../chunk-DCUVV3VY.mjs";import"../chunk-HDTKBFRX.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-HBIDHQ2M.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-OLPI7QAH.mjs";import"../chunk-WOOH5MMX.mjs";import"../chunk-CRL4WGOH.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-4CDDWSKZ.mjs";import"../chunk-LEKBJ2EG.mjs";import"../chunk-GQABU3RQ.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-IECDO22V.mjs";import"../chunk-OZN3OOJV.mjs";import"../chunk-JGNMNCQB.mjs";import"../chunk-6FLHGOKP.mjs";import"../chunk-N47FTRYO.mjs";import"../chunk-7XS45O6M.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-QQIVWB6G.mjs";import"../chunk-KFNDDPOW.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-UI3AKMZX.mjs";import"../chunk-D3OEQLUE.mjs";import"../chunk-J245N3XF.mjs";import"../chunk-KDMSOCZY.mjs";export{a as waitForIndexerOnVersion};
 //# sourceMappingURL=utils.mjs.map

package/dist/esm/bcs/consts.mjs

@@ -1,2 +1,2 @@
-import{a,b,c,d,e,f}from"../chunk-56CNRT2K.mjs";import"../chunk-FVA2OPG4.mjs";export{e as MAX_U128_BIG_INT,b as MAX_U16_NUMBER,f as MAX_U256_BIG_INT,c as MAX_U32_NUMBER,d as MAX_U64_BIG_INT,a as MAX_U8_NUMBER};
+import{a,b,c,d,e,f}from"../chunk-56CNRT2K.mjs";import"../chunk-KDMSOCZY.mjs";export{e as MAX_U128_BIG_INT,b as MAX_U16_NUMBER,f as MAX_U256_BIG_INT,c as MAX_U32_NUMBER,d as MAX_U64_BIG_INT,a as MAX_U8_NUMBER};
 //# sourceMappingURL=consts.mjs.map