@aptos-labs/ts-sdk 1.29.1 → 1.30.0

package/dist/esm/transactions/management/accountSequenceNumber.d.mts

@@ -1,5 +1,5 @@
 import { AptosConfig } from '../../api/aptosConfig.mjs';
-import { A as Account } from '../../Ed25519Account-B1VMJOY2.mjs';
+import { A as Account } from '../../Ed25519Account-DpH9qAcg.mjs';
 import '../../types/index.mjs';
 import '../../utils/apiEndpoints.mjs';
 import '../../types/indexer.mjs';
@@ -12,7 +12,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 '../instances/transactionArgument.mjs';
 import '../../core/crypto/signature.mjs';
@@ -58,6 +58,17 @@ import '../instances/multiAgentTransaction.mjs';
  * If a transaction fails, you should call synchronize and wait for timeouts.
  */
 
+/**
+ * Represents an account's sequence number management for transaction handling on the Aptos blockchain.
+ * This class provides methods to retrieve the next available sequence number, synchronize with the on-chain sequence number,
+ * and manage local sequence numbers while ensuring thread safety.
+ *
+ * @param aptosConfig - The configuration settings for Aptos.
+ * @param account - The account associated with the sequence number.
+ * @param maxWaitTime - The maximum time to wait for a transaction to commit.
+ * @param maximumInFlight - The maximum number of transactions that can be in flight at once.
+ * @param sleepTime - The time to wait before retrying to get the sequence number.
+ */
 declare class AccountSequenceNumber {
     readonly aptosConfig: AptosConfig;
     readonly account: Account;
@@ -70,7 +81,7 @@ declare class AccountSequenceNumber {
      * which can result in race conditions and data inconsistency.
      * This code actually doesn't do it though, since we aren't giving out a slot, it is still somewhat a race condition.
      *
-     * The ideal solution is likely that each thread grabs the next number from a incremental integer.
+     * The ideal solution is likely that each thread grabs the next number from an incremental integer.
      * When they complete, they increment that number and that entity is able to enter the `lock`.
      * That would guarantee ordering.
      */
@@ -78,28 +89,43 @@ declare class AccountSequenceNumber {
     maxWaitTime: number;
     maximumInFlight: number;
     sleepTime: number;
+    /**
+     * Creates an instance of the class with the specified configuration and account details.
+     * This constructor initializes the necessary parameters for managing Aptos transactions.
+     *
+     * @param aptosConfig - The configuration settings for Aptos.
+     * @param account - The account associated with the Aptos transactions.
+     * @param maxWaitTime - The maximum time to wait for a transaction to be processed, in milliseconds.
+     * @param maximumInFlight - The maximum number of transactions that can be in flight at the same time.
+     * @param sleepTime - The time to sleep between transaction checks, in milliseconds.
+     */
     constructor(aptosConfig: AptosConfig, account: Account, maxWaitTime: number, maximumInFlight: number, sleepTime: number);
     /**
-     * Returns the next available sequence number for this account
+     * Returns the next available sequence number for this account.
+     * This function ensures that the sequence number is updated and synchronized, handling potential delays in transaction commits.
      *
-     * @returns next available sequence number
+     * @returns {BigInt} The next available sequence number.
      */
     nextSequenceNumber(): Promise<bigint | null>;
     /**
-     * Initializes this account with the sequence number on chain
+     * Initializes this account with the sequence number on chain.
+     *
+     * @returns {Promise<void>} A promise that resolves when the account has been initialized.
+     *
+     * @throws {Error} Throws an error if the account information cannot be retrieved.
      */
     initialize(): Promise<void>;
     /**
-     * Updates this account sequence number with the one on-chain
+     * Updates this account's sequence number with the one on-chain.
      *
-     * @returns on-chain sequence number for this account
+     * @returns The on-chain sequence number for this account.
      */
     update(): Promise<bigint>;
     /**
-     * Synchronizes local sequence number with the seqeunce number on chain for this account.
+     * Synchronizes the local sequence number with the sequence number on-chain for the specified account.
+     * This function polls the network until all submitted transactions have either been committed or until the maximum wait time has elapsed.
      *
-     * Poll the network until all submitted transactions have either been committed or until
-     * the maximum wait time has elapsed
+     * @throws {Error} Throws an error if there is an issue synchronizing the account sequence number with the one on-chain.
      */
     synchronize(): Promise<void>;
 }

package/dist/esm/transactions/management/accountSequenceNumber.mjs

@@ -1,2 +1,2 @@
-import{a}from"../../chunk-WS4RPKL6.mjs";import"../../chunk-BKEJMQQ6.mjs";import"../../chunk-STGYDB5E.mjs";import"../../chunk-GFGX3QDP.mjs";import"../../chunk-VHNX2NUR.mjs";import"../../chunk-GAEAYY44.mjs";import"../../chunk-46D5QX3G.mjs";import"../../chunk-FRGXKOU5.mjs";import"../../chunk-B6M7QBUO.mjs";import"../../chunk-KYSDF3CA.mjs";import"../../chunk-6RZZIOGH.mjs";import"../../chunk-YHAPZP5A.mjs";import"../../chunk-K2O24YLZ.mjs";import"../../chunk-KXBIA4KR.mjs";import"../../chunk-4NMDYPUD.mjs";import"../../chunk-XONG5JZ4.mjs";import"../../chunk-RNTXQYJQ.mjs";import"../../chunk-CVDR5SJR.mjs";import"../../chunk-TL7DR54X.mjs";import"../../chunk-5655UVIK.mjs";import"../../chunk-UYVPNUH3.mjs";import"../../chunk-2TQIU7CG.mjs";import"../../chunk-QDIKOQRK.mjs";import"../../chunk-QIW56MUH.mjs";import"../../chunk-LXLISEQ4.mjs";import"../../chunk-E37YRKWK.mjs";import"../../chunk-N5JNKD5F.mjs";import"../../chunk-TMW2HIXC.mjs";import"../../chunk-E7FWVXGX.mjs";import"../../chunk-NECL5FCQ.mjs";import"../../chunk-4QMXOWHP.mjs";import"../../chunk-WP7WF54Q.mjs";import"../../chunk-B2CXRZL5.mjs";import"../../chunk-HEZ2ZYZA.mjs";import"../../chunk-KUX6GQ2E.mjs";import"../../chunk-BD6BJETG.mjs";import"../../chunk-GGR3P2TG.mjs";import"../../chunk-U67PFBTL.mjs";import"../../chunk-LGD5KU56.mjs";import"../../chunk-PNXUYOYI.mjs";import"../../chunk-LG3DAAPD.mjs";import"../../chunk-SRPI2FFA.mjs";import"../../chunk-M2QV232A.mjs";import"../../chunk-3MCYLML2.mjs";import"../../chunk-DAJOX4PL.mjs";import"../../chunk-IMGLHDIA.mjs";import"../../chunk-BF4ZE37Q.mjs";import"../../chunk-Q4XR6QOZ.mjs";import"../../chunk-LR65XHSF.mjs";import"../../chunk-KA6FZNWP.mjs";import"../../chunk-QPP6BX53.mjs";import"../../chunk-AH44UPM4.mjs";import"../../chunk-N2FKVZ4D.mjs";import"../../chunk-EV2USF7B.mjs";import"../../chunk-7V6DEA7G.mjs";import"../../chunk-PUZ25PTD.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-BSUYPXRD.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-CCMHWJ3Q.mjs";import"../../chunk-6QGVRNV6.mjs";import"../../chunk-YJCZU6PR.mjs";import"../../chunk-MS4MRLGA.mjs";import"../../chunk-KEYAPEAX.mjs";import"../../chunk-TDGQGILY.mjs";import"../../chunk-44GYWUSH.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-HPZ2S4FE.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-BCUSI3N6.mjs";import"../../chunk-LG7RJQ57.mjs";import"../../chunk-UAL27G6B.mjs";import"../../chunk-SCHZ67F3.mjs";import"../../chunk-EXP5STXZ.mjs";import"../../chunk-555I4YHP.mjs";import"../../chunk-FVA2OPG4.mjs";export{a as AccountSequenceNumber};
+import{a}from"../../chunk-7V6RL27I.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-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 AccountSequenceNumber};
 //# sourceMappingURL=accountSequenceNumber.mjs.map

package/dist/esm/transactions/management/asyncQueue.d.mts

@@ -2,7 +2,7 @@
  * The AsyncQueue class is an async-aware data structure that provides a queue-like
  * behavior for managing asynchronous tasks or operations.
  * It allows to enqueue items and dequeue them asynchronously.
- * This is not thread-safe but it is async concurrency safe and
+ * This is not thread-safe, but it is async concurrency safe, and
  * it does not guarantee ordering for those that call into and await on enqueue.
  */
 declare class AsyncQueue<T> {
@@ -10,48 +10,51 @@ declare class AsyncQueue<T> {
     private pendingDequeue;
     private cancelled;
     /**
-     * The enqueue method adds an item to the queue. If there are pending dequeued promises,
-     * in the pendingDequeue, it resolves the oldest promise with the enqueued item immediately.
-     * Otherwise, it adds the item to the queue.
+     * Adds an item to the queue. If there are pending dequeued promises, it resolves the oldest promise with the enqueued item
+     * immediately; otherwise, it adds the item to the queue.
      *
-     * @param item T
+     * @param item - The item to be added to the queue.
      */
     enqueue(item: T): void;
     /**
-     * The dequeue method returns a promise that resolves to the next item in the queue.
-     * If the queue is not empty, it resolves the promise immediately with the next item.
-     * Otherwise, it creates a new promise. The promise's resolve function is stored
-     * in the pendingDequeue with a unique counter value as the key.
-     * The newly created promise is then returned, and it will be resolved later when an item is enqueued.
+     * Dequeues the next item from the queue and returns a promise that resolves to it.
+     * If the queue is empty, it creates a new promise that will be resolved when an item is enqueued.
      *
      * @returns Promise<T>
      */
     dequeue(): Promise<T>;
     /**
-     * The isEmpty method returns whether the queue is empty or not.
+     * Determine whether the queue is empty.
      *
-     * @returns boolean
+     * @returns boolean - Returns true if the queue has no elements, otherwise false.
      */
     isEmpty(): boolean;
     /**
-     * The cancel method cancels all pending promises in the queue.
-     * It rejects the promises with a AsyncQueueCancelledError error,
-     * ensuring that any awaiting code can handle the cancellation appropriately.
+     * Cancels all pending promises in the queue and rejects them with an AsyncQueueCancelledError.
+     * This ensures that any awaiting code can handle the cancellation appropriately.
+     *
+     * @returns {void}
      */
     cancel(): void;
     /**
-     * The isCancelled method returns whether the queue is cancelled or not.
+     * Determine whether the queue has been cancelled.
      *
-     * @returns boolean
+     * @returns boolean - Returns true if the queue is cancelled, otherwise false.
      */
     isCancelled(): boolean;
     /**
-     * The pendingDequeueLength method returns the length of the pendingDequeue.
+     * Retrieve the length of the pending dequeue.
      *
-     * @returns number
+     * @returns number - The number of items currently in the pending dequeue.
      */
     pendingDequeueLength(): number;
 }
+/**
+ * Represents an error that occurs when an asynchronous queue operation is cancelled.
+ * This error extends the built-in Error class to provide additional context for cancellation events.
+ *
+ * @extends Error
+ */
 declare class AsyncQueueCancelledError extends Error {
 }
 

package/dist/esm/transactions/management/asyncQueue.mjs

@@ -1,2 +1,2 @@
-import{a,b}from"../../chunk-U6Z4FNB7.mjs";import"../../chunk-FVA2OPG4.mjs";export{a as AsyncQueue,b as AsyncQueueCancelledError};
+import{a,b}from"../../chunk-2CJC43CV.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as AsyncQueue,b as AsyncQueueCancelledError};
 //# sourceMappingURL=asyncQueue.mjs.map

package/dist/esm/transactions/management/index.d.mts

@@ -7,14 +7,14 @@ import '../../types/indexer.mjs';
 import '../../types/generated/operations.mjs';
 import '../../types/generated/types.mjs';
 import '../../utils/const.mjs';
-import '../../Ed25519Account-B1VMJOY2.mjs';
+import '../../Ed25519Account-DpH9qAcg.mjs';
 import '../authenticator/account.mjs';
 import '../../bcs/deserializer.mjs';
 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 '../instances/transactionArgument.mjs';
 import '../../core/crypto/signature.mjs';

package/dist/esm/transactions/management/index.mjs

@@ -1,2 +1,2 @@
-import"../../chunk-IHYTP2EW.mjs";import{a as b,b as c,c as d}from"../../chunk-L5NY7TMI.mjs";import{a}from"../../chunk-WS4RPKL6.mjs";import"../../chunk-U6Z4FNB7.mjs";import"../../chunk-WWZ3METZ.mjs";import"../../chunk-I5OYNCZS.mjs";import"../../chunk-JXCZTOYC.mjs";import"../../chunk-MEWFJJJN.mjs";import"../../chunk-NNRAQP36.mjs";import"../../chunk-3YKAGVHZ.mjs";import"../../chunk-PKXEB7XP.mjs";import"../../chunk-BSCOVLWS.mjs";import"../../chunk-V3MBJJTL.mjs";import"../../chunk-BKEJMQQ6.mjs";import"../../chunk-STGYDB5E.mjs";import"../../chunk-MO4IZXLK.mjs";import"../../chunk-GFGX3QDP.mjs";import"../../chunk-VHNX2NUR.mjs";import"../../chunk-GAEAYY44.mjs";import"../../chunk-46D5QX3G.mjs";import"../../chunk-FRGXKOU5.mjs";import"../../chunk-B6M7QBUO.mjs";import"../../chunk-KYSDF3CA.mjs";import"../../chunk-6RZZIOGH.mjs";import"../../chunk-YHAPZP5A.mjs";import"../../chunk-K2O24YLZ.mjs";import"../../chunk-KXBIA4KR.mjs";import"../../chunk-4NMDYPUD.mjs";import"../../chunk-XONG5JZ4.mjs";import"../../chunk-RNTXQYJQ.mjs";import"../../chunk-CVDR5SJR.mjs";import"../../chunk-TL7DR54X.mjs";import"../../chunk-5655UVIK.mjs";import"../../chunk-UYVPNUH3.mjs";import"../../chunk-2TQIU7CG.mjs";import"../../chunk-QDIKOQRK.mjs";import"../../chunk-QIW56MUH.mjs";import"../../chunk-LXLISEQ4.mjs";import"../../chunk-E37YRKWK.mjs";import"../../chunk-N5JNKD5F.mjs";import"../../chunk-TMW2HIXC.mjs";import"../../chunk-E7FWVXGX.mjs";import"../../chunk-NECL5FCQ.mjs";import"../../chunk-4QMXOWHP.mjs";import"../../chunk-WP7WF54Q.mjs";import"../../chunk-B2CXRZL5.mjs";import"../../chunk-HEZ2ZYZA.mjs";import"../../chunk-KUX6GQ2E.mjs";import"../../chunk-BD6BJETG.mjs";import"../../chunk-GGR3P2TG.mjs";import"../../chunk-U67PFBTL.mjs";import"../../chunk-LGD5KU56.mjs";import"../../chunk-PNXUYOYI.mjs";import"../../chunk-LG3DAAPD.mjs";import"../../chunk-SRPI2FFA.mjs";import"../../chunk-M2QV232A.mjs";import"../../chunk-3MCYLML2.mjs";import"../../chunk-DAJOX4PL.mjs";import"../../chunk-IMGLHDIA.mjs";import"../../chunk-BF4ZE37Q.mjs";import"../../chunk-Q4XR6QOZ.mjs";import"../../chunk-LR65XHSF.mjs";import"../../chunk-KA6FZNWP.mjs";import"../../chunk-QPP6BX53.mjs";import"../../chunk-AH44UPM4.mjs";import"../../chunk-N2FKVZ4D.mjs";import"../../chunk-EV2USF7B.mjs";import"../../chunk-7V6DEA7G.mjs";import"../../chunk-PUZ25PTD.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-BSUYPXRD.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-CCMHWJ3Q.mjs";import"../../chunk-6QGVRNV6.mjs";import"../../chunk-YJCZU6PR.mjs";import"../../chunk-MS4MRLGA.mjs";import"../../chunk-KEYAPEAX.mjs";import"../../chunk-TDGQGILY.mjs";import"../../chunk-44GYWUSH.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-HPZ2S4FE.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-BCUSI3N6.mjs";import"../../chunk-LG7RJQ57.mjs";import"../../chunk-UAL27G6B.mjs";import"../../chunk-SCHZ67F3.mjs";import"../../chunk-EXP5STXZ.mjs";import"../../chunk-555I4YHP.mjs";import"../../chunk-FVA2OPG4.mjs";export{a as AccountSequenceNumber,d as TransactionWorker,c as TransactionWorkerEventsEnum,b as promiseFulfilledStatus};
+import"../../chunk-IHYTP2EW.mjs";import{a as b,b as c,c as d}from"../../chunk-WUCPTRXU.mjs";import"../../chunk-2CJC43CV.mjs";import{a}from"../../chunk-7V6RL27I.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 AccountSequenceNumber,d as TransactionWorker,c as TransactionWorkerEventsEnum,b as promiseFulfilledStatus};
 //# sourceMappingURL=index.mjs.map

package/dist/esm/transactions/management/transactionWorker.d.mts

@@ -2,7 +2,7 @@ import { AccountSequenceNumber } from './accountSequenceNumber.mjs';
 import EventEmitter from 'eventemitter3';
 import { AptosConfig } from '../../api/aptosConfig.mjs';
 import { PendingTransactionResponse } from '../../types/index.mjs';
-import { A as Account } from '../../Ed25519Account-B1VMJOY2.mjs';
+import { A as Account } from '../../Ed25519Account-DpH9qAcg.mjs';
 import { InputGenerateTransactionPayloadData, InputGenerateTransactionOptions } from '../types.mjs';
 import { AsyncQueue } from './asyncQueue.mjs';
 import { SimpleTransaction } from '../instances/simpleTransaction.mjs';
@@ -17,7 +17,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 '../instances/transactionArgument.mjs';
 import '../../core/crypto/signature.mjs';
@@ -37,6 +37,9 @@ import '../typeTag/index.mjs';
 import '../instances/multiAgentTransaction.mjs';
 
 declare const promiseFulfilledStatus = "fulfilled";
+/**
+ * Events emitted by the transaction worker during its operation, allowing the dapp to respond to various transaction states.
+ */
 declare enum TransactionWorkerEventsEnum {
     TransactionSent = "transactionSent",
     TransactionSendFailed = "transactionSendFailed",
@@ -44,6 +47,14 @@ declare enum TransactionWorkerEventsEnum {
     TransactionExecutionFailed = "transactionExecutionFailed",
     ExecutionFinish = "executionFinish"
 }
+/**
+ * Defines the events emitted by the transaction worker during various stages of transaction processing. *
+ * @event transactionSent - Emitted when a transaction is successfully sent.
+ * @event transactionSendFailed - Emitted when sending a transaction fails.
+ * @event transactionExecuted - Emitted when a transaction is successfully executed.
+ * @event transactionExecutionFailed - Emitted when executing a transaction fails.
+ * @event executionFinish - Emitted when the execution process is finished.
+ */
 interface TransactionWorkerEvents {
     transactionSent: (data: SuccessEventData) => void;
     transactionSendFailed: (data: FailureEventData) => void;
@@ -51,13 +62,22 @@ interface TransactionWorkerEvents {
     transactionExecutionFailed: (data: FailureEventData) => void;
     executionFinish: (data: ExecutionFinishEventData) => void;
 }
+/**
+ * The payload for when the worker has finished its job.
+ */
 type ExecutionFinishEventData = {
     message: string;
 };
+/**
+ * The payload for a success event.
+ */
 type SuccessEventData = {
     message: string;
     transactionHash: string;
 };
+/**
+ * The payload for a failure event.
+ */
 type FailureEventData = {
     message: string;
     error: string;
@@ -99,68 +119,79 @@ declare class TransactionWorker extends EventEmitter<TransactionWorkerEvents> {
      */
     executedTransactions: Array<[string, bigint, any]>;
     /**
-     * Provides a simple framework for receiving payloads to be processed.
+     * Initializes a new instance of the class, providing a framework for receiving payloads to be processed.
      *
-     * @param aptosConfig - a config object
-     * @param sender - a sender as Account
-     * @param maxWaitTime - the max wait time to wait before resyncing the sequence number
-     * to the current on-chain state, default to 30
-     * @param maximumInFlight - submit up to `maximumInFlight` transactions per account.
-     * Mempool limits the number of transactions per account to 100, hence why we default to 100.
-     * @param sleepTime - If `maximumInFlight` are in flight, wait `sleepTime` seconds before re-evaluating, default to 10
+     * @param aptosConfig - A configuration object for Aptos.
+     * @param account - The account that will be used for sending transactions.
+     * @param maxWaitTime - The maximum wait time to wait before re-syncing the sequence number to the current on-chain state,
+     * default is 30 seconds.
+     * @param maximumInFlight - The maximum number of transactions that can be submitted per account, default is 100.
+     * @param sleepTime - The time to wait in seconds before re-evaluating if the maximum number of transactions are in flight,
+     * default is 10 seconds.
      */
     constructor(aptosConfig: AptosConfig, account: Account, maxWaitTime?: number, maximumInFlight?: number, sleepTime?: number);
     /**
-     * Gets the current account sequence number,
-     * generates the transaction with the account sequence number,
-     * adds the transaction to the outstanding transaction queue
-     * to be processed later.
+     * Submits the next transaction for the account by generating it with the current sequence number
+     * and adding it to the outstanding transaction queue for processing.
+     * This function continues to submit transactions until there are no more to process.
+     *
+     * @throws {Error} Throws an error if the transaction submission fails.
      */
     submitNextTransaction(): Promise<void>;
     /**
-     * Reads the outstanding transaction queue and submits the transaction to chain.
-     *
-     * If the transaction has fulfilled, it pushes the transaction to the processed
-     * transactions queue and fires a transactionsFulfilled event.
+     * Reads the outstanding transaction queue and submits the transactions to the chain.
+     * This function processes each transaction, checking their status and emitting events based on whether they were successfully
+     * sent or failed.
      *
-     * If the transaction has failed, it pushes the transaction to the processed
-     * transactions queue with the failure reason and fires a transactionsFailed event.
+     * @throws {Error} Throws an error if the process execution fails.
+     * @event TransactionWorkerEventsEnum.TransactionSent - Emitted when a transaction has been successfully committed to the chain.
+     * @event TransactionWorkerEventsEnum.TransactionSendFailed - Emitted when a transaction fails to commit, along with the error
+     * reason.
+     * @event TransactionWorkerEventsEnum.ExecutionFinish - Emitted when the execution of transactions is complete.
      */
     processTransactions(): Promise<void>;
     /**
-     * Once transaction has been sent to chain, we check for its execution status.
-     * @param sentTransaction transactions that were sent to chain and are now waiting to be executed
-     * @param sequenceNumber the account's sequence number that was sent with the transaction
+     * Once a transaction has been sent to the chain, this function checks for its execution status.
+     * @param sentTransaction - The transaction that was sent to the chain and is now waiting to be executed.
+     * @param sequenceNumber - The account's sequence number that was sent with the transaction.
      */
     checkTransaction(sentTransaction: PromiseFulfilledResult<PendingTransactionResponse>, sequenceNumber: bigint): Promise<void>;
     /**
-     * Push transaction to the transactions queue
+     * Pushes a transaction to the transactions queue for processing.
      *
-     * @param transactionData Transaction payload
-     * @param transactionData.abi For all entry function payloads, the ABI to skip remote ABI lookups
-     * @param options.maxGasAmount Maximum gas amount for the transaction
-     * @param options.gasUnitPrice Gas unit price for the transaction
-     * @param options.expireTimestamp expiration timestamp on the transaction
-     * @param options.accountSequenceNumber the sequence number for the transaction
+     * @param transactionData - The transaction payload containing necessary details.
+     * @param transactionData.abi - For all entry function payloads, the ABI to skip remote ABI lookups.
+     * @param options - Optional parameters for transaction configuration.
+     * @param options.maxGasAmount - Maximum gas amount for the transaction.
+     * @param options.gasUnitPrice - Gas unit price for the transaction.
+     * @param options.expireTimestamp - Expiration timestamp on the transaction.
+     * @param options.accountSequenceNumber - The sequence number for the transaction.
      */
     push(transactionData: InputGenerateTransactionPayloadData, options?: InputGenerateTransactionOptions): Promise<void>;
     /**
-     * Generates a signed transaction that can be submitted to chain
-     * @param account an Aptos account
-     * @param sequenceNumber a sequence number the transaction will be generated with
-     * @returns
+     * Generates a signed transaction that can be submitted to the chain.
+     *
+     * @param account - An Aptos account used as the sender of the transaction.
+     * @param sequenceNumber - A sequence number the transaction will be generated with.
+     * @returns A signed transaction object or undefined if the transaction queue is empty.
      */
     generateNextTransaction(account: Account, sequenceNumber: bigint): Promise<SimpleTransaction | undefined>;
     /**
-     * Starts transaction submission and transaction processing.
+     * Starts transaction submission and processing by executing tasks from the queue until it is cancelled.
+     *
+     * @throws {Error} Throws an error if unable to start transaction batching.
      */
     run(): Promise<void>;
     /**
      * Starts the transaction management process.
+     *
+     * @throws {Error} Throws an error if the worker has already started.
      */
     start(): void;
     /**
-     * Stops the the transaction management process.
+     * Stops the transaction management process.
+     *
+     * @throws {Error} Throws an error if the worker has already stopped.
      */
     stop(): void;
 }

package/dist/esm/transactions/management/transactionWorker.mjs

@@ -1,2 +1,2 @@
-import{a,b,c}from"../../chunk-L5NY7TMI.mjs";import"../../chunk-WS4RPKL6.mjs";import"../../chunk-U6Z4FNB7.mjs";import"../../chunk-WWZ3METZ.mjs";import"../../chunk-I5OYNCZS.mjs";import"../../chunk-JXCZTOYC.mjs";import"../../chunk-MEWFJJJN.mjs";import"../../chunk-NNRAQP36.mjs";import"../../chunk-3YKAGVHZ.mjs";import"../../chunk-PKXEB7XP.mjs";import"../../chunk-BSCOVLWS.mjs";import"../../chunk-V3MBJJTL.mjs";import"../../chunk-BKEJMQQ6.mjs";import"../../chunk-STGYDB5E.mjs";import"../../chunk-MO4IZXLK.mjs";import"../../chunk-GFGX3QDP.mjs";import"../../chunk-VHNX2NUR.mjs";import"../../chunk-GAEAYY44.mjs";import"../../chunk-46D5QX3G.mjs";import"../../chunk-FRGXKOU5.mjs";import"../../chunk-B6M7QBUO.mjs";import"../../chunk-KYSDF3CA.mjs";import"../../chunk-6RZZIOGH.mjs";import"../../chunk-YHAPZP5A.mjs";import"../../chunk-K2O24YLZ.mjs";import"../../chunk-KXBIA4KR.mjs";import"../../chunk-4NMDYPUD.mjs";import"../../chunk-XONG5JZ4.mjs";import"../../chunk-RNTXQYJQ.mjs";import"../../chunk-CVDR5SJR.mjs";import"../../chunk-TL7DR54X.mjs";import"../../chunk-5655UVIK.mjs";import"../../chunk-UYVPNUH3.mjs";import"../../chunk-2TQIU7CG.mjs";import"../../chunk-QDIKOQRK.mjs";import"../../chunk-QIW56MUH.mjs";import"../../chunk-LXLISEQ4.mjs";import"../../chunk-E37YRKWK.mjs";import"../../chunk-N5JNKD5F.mjs";import"../../chunk-TMW2HIXC.mjs";import"../../chunk-E7FWVXGX.mjs";import"../../chunk-NECL5FCQ.mjs";import"../../chunk-4QMXOWHP.mjs";import"../../chunk-WP7WF54Q.mjs";import"../../chunk-B2CXRZL5.mjs";import"../../chunk-HEZ2ZYZA.mjs";import"../../chunk-KUX6GQ2E.mjs";import"../../chunk-BD6BJETG.mjs";import"../../chunk-GGR3P2TG.mjs";import"../../chunk-U67PFBTL.mjs";import"../../chunk-LGD5KU56.mjs";import"../../chunk-PNXUYOYI.mjs";import"../../chunk-LG3DAAPD.mjs";import"../../chunk-SRPI2FFA.mjs";import"../../chunk-M2QV232A.mjs";import"../../chunk-3MCYLML2.mjs";import"../../chunk-DAJOX4PL.mjs";import"../../chunk-IMGLHDIA.mjs";import"../../chunk-BF4ZE37Q.mjs";import"../../chunk-Q4XR6QOZ.mjs";import"../../chunk-LR65XHSF.mjs";import"../../chunk-KA6FZNWP.mjs";import"../../chunk-QPP6BX53.mjs";import"../../chunk-AH44UPM4.mjs";import"../../chunk-N2FKVZ4D.mjs";import"../../chunk-EV2USF7B.mjs";import"../../chunk-7V6DEA7G.mjs";import"../../chunk-PUZ25PTD.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-BSUYPXRD.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-CCMHWJ3Q.mjs";import"../../chunk-6QGVRNV6.mjs";import"../../chunk-YJCZU6PR.mjs";import"../../chunk-MS4MRLGA.mjs";import"../../chunk-KEYAPEAX.mjs";import"../../chunk-TDGQGILY.mjs";import"../../chunk-44GYWUSH.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-HPZ2S4FE.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-BCUSI3N6.mjs";import"../../chunk-LG7RJQ57.mjs";import"../../chunk-UAL27G6B.mjs";import"../../chunk-SCHZ67F3.mjs";import"../../chunk-EXP5STXZ.mjs";import"../../chunk-555I4YHP.mjs";import"../../chunk-FVA2OPG4.mjs";export{c as TransactionWorker,b as TransactionWorkerEventsEnum,a as promiseFulfilledStatus};
+import{a,b,c}from"../../chunk-WUCPTRXU.mjs";import"../../chunk-2CJC43CV.mjs";import"../../chunk-7V6RL27I.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{c as TransactionWorker,b as TransactionWorkerEventsEnum,a as promiseFulfilledStatus};
 //# sourceMappingURL=transactionWorker.mjs.map

package/dist/esm/transactions/transactionBuilder/helpers.d.mts

@@ -10,7 +10,7 @@ import '../../utils/const.mjs';
 import '../../types/indexer.mjs';
 import '../../types/generated/operations.mjs';
 import '../../types/generated/types.mjs';
-import '../../publicKey-B3XRNhHO.mjs';
+import '../../publicKey-_tPa99ea.mjs';
 import '../../bcs/serializer.mjs';
 import '../../core/hex.mjs';
 import '../../core/common.mjs';
@@ -32,12 +32,56 @@ import '../../core/crypto/singleKey.mjs';
 import '../instances/simpleTransaction.mjs';
 import '../instances/multiAgentTransaction.mjs';
 
+/**
+ * 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.
+ */
 declare function isBool(arg: SimpleEntryFunctionArgumentTypes): arg is boolean;
+/**
+ * Checks if the provided argument is of type string.
+ *
+ * @param arg - The value to be checked for string type.
+ * @returns A boolean indicating whether the argument is a string.
+ */
 declare function isString(arg: any): arg is string;
+/**
+ * Determines if the provided argument is of type number.
+ *
+ * @param arg - The argument to check, which can be of various types.
+ * @returns A boolean indicating whether the argument is a number.
+ */
 declare function isNumber(arg: SimpleEntryFunctionArgumentTypes): arg is number;
+/**
+ * Converts a number or a string representation of a number into a number type.
+ * This function is useful for ensuring that the input is in a consistent numeric format,
+ * which can help prevent type mismatches in further processing.
+ *
+ * @param arg - The input value to be converted. This can be a number, a string representing a number, or any other type.
+ * @returns Returns the converted number if the input is valid; otherwise, it returns undefined.
+ */
 declare function convertNumber(arg: SimpleEntryFunctionArgumentTypes): number | undefined;
+/**
+ * Determines if the provided argument is a large number, which can be a number, bigint, or string representation of a number.
+ *
+ * @param arg - The argument to check, which can be of type number, bigint, or string.
+ */
 declare function isLargeNumber(arg: SimpleEntryFunctionArgumentTypes): arg is number | bigint | string;
+/**
+ * Checks if the provided argument is empty, meaning it is either null or undefined.
+ *
+ * @param arg - The argument to check for emptiness.
+ * @returns A boolean indicating whether the argument is empty.
+ */
 declare function isEmptyOption(arg: SimpleEntryFunctionArgumentTypes): arg is null | undefined;
+/**
+ * Determines if the provided argument is a valid encoded entry function argument type.
+ * This function helps validate that the argument conforms to the expected types for entry function parameters.
+ *
+ * @param arg - The argument to check, which can be of type EntryFunctionArgumentTypes or SimpleEntryFunctionArgumentTypes.
+ */
 declare function isEncodedEntryFunctionArgument(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is EntryFunctionArgumentTypes;
 declare function isBcsBool(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is Bool;
 declare function isBcsAddress(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is AccountAddress;
@@ -49,16 +93,42 @@ declare function isBcsU32(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionA
 declare function isBcsU64(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U64;
 declare function isBcsU128(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U128;
 declare function isBcsU256(arg: EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes): arg is U256;
+/**
+ * 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.
+ */
 declare function isScriptDataInput(arg: InputGenerateTransactionPayloadDataWithRemoteABI | InputGenerateTransactionPayloadData): arg is InputScriptData;
+/**
+ * Throws an error indicating a type mismatch for a specified argument position.
+ * This function helps in debugging by providing clear feedback on expected types.
+ *
+ * @param expectedType - The type that was expected for the argument.
+ * @param position - The position of the argument that caused the type mismatch.
+ */
 declare function throwTypeMismatch(expectedType: string, position: number): void;
 /**
- * Finds first non-signer arg.
+ * 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.
- * @param functionAbi
+ * 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.
  */
 declare function findFirstNonSignerArg(functionAbi: MoveFunction): number;
+/**
+ * Splits a function identifier into its constituent parts: module address, module name, and function name.
+ * This function helps in validating and extracting details from a function identifier string.
+ *
+ * @param functionArg - The function identifier string in the format "moduleAddress::moduleName::functionName".
+ * @returns An object containing the module address, module name, and function name.
+ * @throws Error if the function identifier does not contain exactly three parts.
+ */
 declare function getFunctionParts(functionArg: MoveFunctionId): {
     moduleAddress: string;
     moduleName: string;

package/dist/esm/transactions/transactionBuilder/helpers.mjs

@@ -1,2 +1,2 @@
-import{a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u}from"../../chunk-3YKAGVHZ.mjs";import"../../chunk-E7FWVXGX.mjs";import"../../chunk-NECL5FCQ.mjs";import"../../chunk-4QMXOWHP.mjs";import"../../chunk-WP7WF54Q.mjs";import"../../chunk-HEZ2ZYZA.mjs";import"../../chunk-KUX6GQ2E.mjs";import"../../chunk-BD6BJETG.mjs";import"../../chunk-GGR3P2TG.mjs";import"../../chunk-U67PFBTL.mjs";import"../../chunk-LGD5KU56.mjs";import"../../chunk-PNXUYOYI.mjs";import"../../chunk-LG3DAAPD.mjs";import"../../chunk-SRPI2FFA.mjs";import"../../chunk-M2QV232A.mjs";import"../../chunk-3MCYLML2.mjs";import"../../chunk-DAJOX4PL.mjs";import"../../chunk-IMGLHDIA.mjs";import"../../chunk-BF4ZE37Q.mjs";import"../../chunk-Q4XR6QOZ.mjs";import"../../chunk-LR65XHSF.mjs";import"../../chunk-KA6FZNWP.mjs";import"../../chunk-QPP6BX53.mjs";import"../../chunk-AH44UPM4.mjs";import"../../chunk-N2FKVZ4D.mjs";import"../../chunk-EV2USF7B.mjs";import"../../chunk-7V6DEA7G.mjs";import"../../chunk-PUZ25PTD.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-BSUYPXRD.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-CCMHWJ3Q.mjs";import"../../chunk-6QGVRNV6.mjs";import"../../chunk-YJCZU6PR.mjs";import"../../chunk-MS4MRLGA.mjs";import"../../chunk-KEYAPEAX.mjs";import"../../chunk-TDGQGILY.mjs";import"../../chunk-44GYWUSH.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-HPZ2S4FE.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-BCUSI3N6.mjs";import"../../chunk-LG7RJQ57.mjs";import"../../chunk-UAL27G6B.mjs";import"../../chunk-SCHZ67F3.mjs";import"../../chunk-EXP5STXZ.mjs";import"../../chunk-555I4YHP.mjs";import"../../chunk-FVA2OPG4.mjs";export{d as convertNumber,t as findFirstNonSignerArg,u as getFunctionParts,i as isBcsAddress,h as isBcsBool,k as isBcsFixedBytes,j as isBcsString,p as isBcsU128,m as isBcsU16,q as isBcsU256,n as isBcsU32,o as isBcsU64,l as isBcsU8,a as isBool,f as isEmptyOption,g as isEncodedEntryFunctionArgument,e as isLargeNumber,c as isNumber,r as isScriptDataInput,b as isString,s as throwTypeMismatch};
+import{a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u}from"../../chunk-N3OYD6VZ.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-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{d as convertNumber,t as findFirstNonSignerArg,u as getFunctionParts,i as isBcsAddress,h as isBcsBool,k as isBcsFixedBytes,j as isBcsString,p as isBcsU128,m as isBcsU16,q as isBcsU256,n as isBcsU32,o as isBcsU64,l as isBcsU8,a as isBool,f as isEmptyOption,g as isEncodedEntryFunctionArgument,e as isLargeNumber,c as isNumber,r as isScriptDataInput,b as isString,s as throwTypeMismatch};
 //# sourceMappingURL=helpers.mjs.map

package/dist/esm/transactions/transactionBuilder/index.d.mts

@@ -19,7 +19,7 @@ import '../../core/common.mjs';
 import '../instances/transactionArgument.mjs';
 import '../../bcs/serializable/fixedBytes.mjs';
 import '../../core/accountAddress.mjs';
-import '../../publicKey-B3XRNhHO.mjs';
+import '../../publicKey-_tPa99ea.mjs';
 import '../../core/crypto/signature.mjs';
 import '../instances/rawTransaction.mjs';
 import '../instances/chainId.mjs';