@aptos-labs/ts-sdk 1.29.1 → 1.30.0

package/dist/esm/internal/transaction.d.mts

@@ -13,36 +13,105 @@ import '../types/generated/types.mjs';
  * transaction namespace and without having a dependency cycle error.
  */
 
+/**
+ * Retrieve a list of transactions based on the specified options.
+ *
+ * @param {Object} args - The parameters for retrieving transactions.
+ * @param {Object} args.aptosConfig - The configuration object for Aptos.
+ * @param {Object} args.options - The options for pagination.
+ * @param {number} args.options.offset - The number of transactions to skip before starting to collect the result set.
+ * @param {number} args.options.limit - The maximum number of transactions to return.
+ */
 declare function getTransactions(args: {
     aptosConfig: AptosConfig;
     options?: PaginationArgs;
 }): Promise<TransactionResponse[]>;
+/**
+ * Retrieves the estimated gas price for transactions on the Aptos network.
+ * This function helps users understand the current gas price, which is essential for transaction planning and cost estimation.
+ *
+ * @param args - The configuration parameters for the Aptos network.
+ * @param args.aptosConfig - The configuration object containing network details.
+ */
 declare function getGasPriceEstimation(args: {
     aptosConfig: AptosConfig;
 }): Promise<GasEstimation>;
+/**
+ * Retrieves the transaction details associated with a specific ledger version.
+ *
+ * @param args - The arguments for the transaction retrieval.
+ * @param args.aptosConfig - The configuration settings for the Aptos client.
+ * @param args.ledgerVersion - The ledger version for which to retrieve the transaction.
+ * @returns The transaction details for the specified ledger version.
+ */
 declare function getTransactionByVersion(args: {
     aptosConfig: AptosConfig;
     ledgerVersion: AnyNumber;
 }): Promise<TransactionResponse>;
+/**
+ * Retrieves transaction details using the specified transaction hash.
+ *
+ * @param args - The arguments for retrieving the transaction.
+ * @param args.aptosConfig - The configuration settings for the Aptos client.
+ * @param args.transactionHash - The hash of the transaction to retrieve.
+ * @returns A promise that resolves to the transaction details.
+ */
 declare function getTransactionByHash(args: {
     aptosConfig: AptosConfig;
     transactionHash: HexInput;
 }): Promise<TransactionResponse>;
+/**
+ * Checks if a transaction is currently pending based on its hash.
+ * This function helps determine the status of a transaction in the Aptos network.
+ *
+ * @param args - The arguments for checking the transaction status.
+ * @param args.aptosConfig - The configuration settings for connecting to the Aptos network.
+ * @param args.transactionHash - The hash of the transaction to check.
+ * @returns A boolean indicating whether the transaction is pending.
+ * @throws An error if the transaction cannot be retrieved due to reasons other than a 404 status.
+ */
 declare function isTransactionPending(args: {
     aptosConfig: AptosConfig;
     transactionHash: HexInput;
 }): Promise<boolean>;
+/**
+ * Waits for a transaction to be confirmed by its hash.
+ * This function allows you to monitor the status of a transaction until it is finalized.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration settings for the Aptos client.
+ * @param args.transactionHash - The hash of the transaction to wait for.
+ */
 declare function longWaitForTransaction(args: {
     aptosConfig: AptosConfig;
     transactionHash: HexInput;
 }): Promise<TransactionResponse>;
+/**
+ * Waits for a transaction to be confirmed on the blockchain and handles potential errors during the process.
+ * This function allows you to monitor the status of a transaction until it is either confirmed or fails.
+ *
+ * @param args - The arguments for waiting for a transaction.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.transactionHash - The hash of the transaction to wait for.
+ * @param args.options - Optional settings for waiting, including timeout and success check.
+ * @param args.options.timeoutSecs - The maximum time to wait for the transaction in seconds. Defaults to a predefined value.
+ * @param args.options.checkSuccess - A flag indicating whether to check the success status of the transaction. Defaults to true.
+ * @returns A promise that resolves to the transaction response once the transaction is confirmed.
+ * @throws WaitForTransactionError if the transaction times out or remains pending.
+ * @throws FailedTransactionError if the transaction fails.
+ */
 declare function waitForTransaction(args: {
     aptosConfig: AptosConfig;
     transactionHash: HexInput;
     options?: WaitForTransactionOptions;
 }): Promise<CommittedTransactionResponse>;
 /**
- * Waits for the indexer to sync up to the ledgerVersion. Timeout is 3 seconds.
+ * Waits for the indexer to sync up to the specified ledger version. The timeout is 3 seconds.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.minimumLedgerVersion - The minimum ledger version that the indexer should sync to.
+ * @param args.processorType - (Optional) The type of processor to check the last success version from.
  */
 declare function waitForIndexer(args: {
     aptosConfig: AptosConfig;
@@ -50,21 +119,44 @@ declare function waitForIndexer(args: {
     processorType?: ProcessorType;
 }): Promise<void>;
 /**
- * This error is used by `waitForTransaction` when waiting for a
- * transaction to time out or when the transaction response is undefined
+ * Represents an error that occurs when waiting for a transaction to complete.
+ * This error is thrown by the `waitForTransaction` function when a transaction
+ * times out or when the transaction response is undefined.
+ *
+ * @param message - A descriptive message for the error.
+ * @param lastSubmittedTransaction - The last submitted transaction response, if available.
  */
 declare class WaitForTransactionError extends Error {
     readonly lastSubmittedTransaction: TransactionResponse | undefined;
+    /**
+     * Constructs an instance of the class with a specified message and transaction response.
+     *
+     * @param message - The message associated with the transaction.
+     * @param lastSubmittedTransaction - The transaction response object containing details about the transaction.
+     */
     constructor(message: string, lastSubmittedTransaction: TransactionResponse | undefined);
 }
 /**
- * This error is used by `waitForTransaction` if `checkSuccess` is true.
- * See that function for more information.
+ * Represents an error that occurs when a transaction fails.
+ * This error is thrown by the `waitForTransaction` function when the `checkSuccess` parameter is set to true.
+ *
+ * @param message - A description of the error.
+ * @param transaction - The transaction response associated with the failure.
  */
 declare class FailedTransactionError extends Error {
     readonly transaction: TransactionResponse;
     constructor(message: string, transaction: TransactionResponse);
 }
+/**
+ * Retrieves a block from the Aptos blockchain by its ledger version.
+ * This function allows you to obtain detailed information about a specific block, including its transactions if requested.
+ *
+ * @param args - The arguments for retrieving the block.
+ * @param args.aptosConfig - The configuration object for connecting to the Aptos node.
+ * @param args.ledgerVersion - The ledger version of the block to retrieve.
+ * @param args.options - Optional parameters for the request.
+ * @param args.options.withTransactions - Indicates whether to include transactions in the block data.
+ */
 declare function getBlockByVersion(args: {
     aptosConfig: AptosConfig;
     ledgerVersion: AnyNumber;
@@ -72,6 +164,16 @@ declare function getBlockByVersion(args: {
         withTransactions?: boolean;
     };
 }): Promise<Block>;
+/**
+ * Retrieves a block from the Aptos blockchain by its height.
+ *
+ * @param args - The parameters for retrieving the block.
+ * @param args.aptosConfig - The configuration object for connecting to the Aptos network.
+ * @param args.blockHeight - The height of the block to retrieve.
+ * @param args.options - Optional parameters for the request.
+ * @param args.options.withTransactions - Indicates whether to include transactions in the block data.
+ * @returns A promise that resolves to the block data, potentially including its transactions.
+ */
 declare function getBlockByHeight(args: {
     aptosConfig: AptosConfig;
     blockHeight: AnyNumber;

package/dist/esm/internal/transaction.mjs

@@ -1,2 +1,2 @@
-import{a,b,c,d,e,f,g,h,i,j,k,l}from"../chunk-MO4IZXLK.mjs";import"../chunk-GFGX3QDP.mjs";import"../chunk-VHNX2NUR.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{j as FailedTransactionError,i as WaitForTransactionError,l as getBlockByHeight,k as getBlockByVersion,b as getGasPriceEstimation,d as getTransactionByHash,c as getTransactionByVersion,a as getTransactions,e as isTransactionPending,f as longWaitForTransaction,h as waitForIndexer,g as waitForTransaction};
+import{a,b,c,d,e,f,g,h,i,j,k,l}from"../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{j as FailedTransactionError,i as WaitForTransactionError,l as getBlockByHeight,k as getBlockByVersion,b as getGasPriceEstimation,d as getTransactionByHash,c as getTransactionByVersion,a as getTransactions,e as isTransactionPending,f as longWaitForTransaction,h as waitForIndexer,g as waitForTransaction};
 //# sourceMappingURL=transaction.mjs.map

package/dist/esm/internal/transactionSubmission.d.mts

@@ -3,7 +3,7 @@ import { AccountAuthenticator } from '../transactions/authenticator/account.mjs'
 import { UserTransactionResponse, PendingTransactionResponse, HexInput, TransactionResponse } from '../types/index.mjs';
 import { AccountAddressInput } from '../core/accountAddress.mjs';
 import { PrivateKey } from '../core/crypto/privateKey.mjs';
-import { A as Account } from '../Ed25519Account-B1VMJOY2.mjs';
+import { A as Account } from '../Ed25519Account-DpH9qAcg.mjs';
 import { InputGenerateSingleSignerRawTransactionData, InputGenerateMultiAgentRawTransactionData, InputGenerateTransactionData, AnyTransactionPayloadInstance, AnyRawTransaction, InputSimulateTransactionData, InputSubmitTransactionData, InputGenerateTransactionOptions } from '../transactions/types.mjs';
 import { SimpleTransaction } from '../transactions/instances/simpleTransaction.mjs';
 import { MultiAgentTransaction } from '../transactions/instances/multiAgentTransaction.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/crypto/signature.mjs';
 import '../transactions/instances/transactionArgument.mjs';
 import '../core/crypto/multiEd25519.mjs';
@@ -52,38 +52,53 @@ declare function generateTransaction(args: {
 declare function generateTransaction(args: {
     aptosConfig: AptosConfig;
 } & InputGenerateMultiAgentRawTransactionData): Promise<MultiAgentTransaction>;
+/**
+ * Builds a transaction payload based on the provided configuration and input data.
+ * This function is essential for preparing transaction data for execution on the Aptos blockchain.
+ *
+ * @param args - The arguments for building the transaction payload.
+ * @param args.aptosConfig - Configuration settings for the Aptos network.
+ * @param args.data - Input data required to generate the transaction payload, which may include bytecode, multisig address,
+ * function name, function arguments, type arguments, and ABI.
+ * @returns A promise that resolves to the generated transaction payload instance.
+ */
 declare function buildTransactionPayload(args: {
     aptosConfig: AptosConfig;
 } & InputGenerateTransactionData): Promise<AnyTransactionPayloadInstance>;
+/**
+ * Builds a raw transaction based on the provided configuration and payload.
+ * This function helps in creating a transaction that can be sent to the Aptos blockchain.
+ *
+ * @param args - The arguments for generating the transaction.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.sender - The address of the sender of the transaction.
+ * @param args.options - Additional options for the transaction.
+ * @param payload - The payload of the transaction, which defines the action to be performed.
+ */
 declare function buildRawTransaction(args: {
     aptosConfig: AptosConfig;
 } & InputGenerateTransactionData, payload: AnyTransactionPayloadInstance): Promise<AnyRawTransaction>;
 /**
- * Builds a signing message that can be signed by external signers
+ * Builds a signing message that can be signed by external signers.
  *
- * Note: Please prefer using `signTransaction` unless signing outside the SDK
+ * Note: Please prefer using `signTransaction` unless signing outside the SDK.
  *
- * @param args.transaction AnyRawTransaction, as generated by `generateTransaction()`
+ * @param args - The arguments for generating the signing message.
+ * @param args.transaction - AnyRawTransaction, as generated by `generateTransaction()`.
  *
- * @return The message to be signed
+ * @returns The message to be signed.
  */
 declare function getSigningMessage(args: {
     transaction: AnyRawTransaction;
 }): Uint8Array;
 /**
- * Sign a transaction that can later be submitted to chain
+ * Sign a transaction that can later be submitted to the chain.
  *
- * @param args.signer The signer account to sign the transaction
- * @param args.transaction An instance of a RawTransaction, plus optional secondary/fee payer addresses
- * ```
- * {
- *  rawTransaction: RawTransaction,
- *  secondarySignerAddresses? : Array<AccountAddress>,
- *  feePayerAddress?: AccountAddress
- * }
- * ```
+ * @param args The arguments for signing the transaction.
+ * @param args.signer The signer account to sign the transaction.
+ * @param args.transaction An instance of a RawTransaction, plus optional secondary/fee payer addresses.
  *
- * @return The signer AccountAuthenticator
+ * @return The signer AccountAuthenticator.
  */
 declare function signTransaction(args: {
     signer: Account;
@@ -94,25 +109,32 @@ declare function signAsFeePayer(args: {
     transaction: AnyRawTransaction;
 }): AccountAuthenticator;
 /**
- * Simulates a transaction before singing it.
+ * Simulates a transaction before signing it to evaluate its potential outcome.
  *
- * @param args.signerPublicKey The signer public key
- * @param args.transaction The raw transaction to simulate
- * @param args.secondarySignersPublicKeys optional. For when the transaction is a multi signers transaction
- * @param args.feePayerPublicKey optional. For when the transaction is a fee payer (aka sponsored) transaction
- * @param args.options optional. A config to simulate the transaction with
+ * @param args The arguments for simulating the transaction.
+ * @param args.aptosConfig The configuration for the Aptos network.
+ * @param args.transaction The raw transaction to simulate.
+ * @param args.signerPublicKey The signer public key.
+ * @param args.secondarySignersPublicKeys Optional. For when the transaction involves multiple signers.
+ * @param args.feePayerPublicKey Optional. For when the transaction is sponsored by a fee payer.
+ * @param args.options Optional. A configuration object to customize the simulation process.
+ * @param args.options.estimateGasUnitPrice Optional. Indicates whether to estimate the gas unit price.
+ * @param args.options.estimateMaxGasAmount Optional. Indicates whether to estimate the maximum gas amount.
+ * @param args.options.estimatePrioritizedGasUnitPrice Optional. Indicates whether to estimate the prioritized gas unit price.
  */
 declare function simulateTransaction(args: {
     aptosConfig: AptosConfig;
 } & InputSimulateTransactionData): Promise<Array<UserTransactionResponse>>;
 /**
- * Submit transaction to chain
+ * Submit a transaction to the Aptos blockchain.
  *
- * @param args.transaction A aptos transaction type
- * @param args.senderAuthenticator The account authenticator of the transaction sender
- * @param args.secondarySignerAuthenticators optional. For when the transaction is a multi signers transaction
+ * @param args - The arguments for submitting the transaction.
+ * @param args.aptosConfig - The configuration for connecting to the Aptos network.
+ * @param args.transaction - The Aptos transaction data to be submitted.
+ * @param args.senderAuthenticator - The account authenticator of the transaction sender.
+ * @param args.secondarySignerAuthenticators - Optional. Authenticators for additional signers in a multi-signer transaction.
  *
- * @return PendingTransactionResponse
+ * @returns PendingTransactionResponse - The response containing the status of the submitted transaction.
  */
 declare function submitTransaction(args: {
     aptosConfig: AptosConfig;
@@ -138,6 +160,17 @@ declare function signAndSubmitAsFeePayer(args: {
     senderAuthenticator: AccountAuthenticator;
     transaction: AnyRawTransaction;
 }): Promise<PendingTransactionResponse>;
+/**
+ * Publishes a package transaction to the Aptos blockchain.
+ * This function allows you to create and send a transaction that publishes a package with the specified metadata and bytecode.
+ *
+ * @param args - The arguments for the package transaction.
+ * @param args.aptosConfig - The configuration settings for the Aptos client.
+ * @param args.account - The address of the account sending the transaction.
+ * @param args.metadataBytes - The metadata associated with the package, represented as hexadecimal input.
+ * @param args.moduleBytecode - An array of module bytecode, each represented as hexadecimal input.
+ * @param args.options - Optional parameters for generating the transaction.
+ */
 declare function publicPackageTransaction(args: {
     aptosConfig: AptosConfig;
     account: AccountAddressInput;
@@ -146,7 +179,17 @@ declare function publicPackageTransaction(args: {
     options?: InputGenerateTransactionOptions;
 }): Promise<SimpleTransaction>;
 /**
- * TODO: Need to refactor and move this function out of transactionSubmission
+ * Rotates the authentication key for a given account, allowing for enhanced security and management of account access.
+ *
+ * @param args - The arguments for rotating the authentication key.
+ * @param args.aptosConfig - The configuration settings for the Aptos network.
+ * @param args.fromAccount - The account from which the authentication key will be rotated.
+ * @param args.toNewPrivateKey - The new private key that will be associated with the account.
+ *
+ * @remarks
+ * This function requires the current authentication key and the new private key to sign a challenge that validates the rotation.
+ *
+ * TODO: Need to refactor and move this function out of transactionSubmission.
  */
 declare function rotateAuthKey(args: {
     aptosConfig: AptosConfig;

package/dist/esm/internal/transactionSubmission.mjs

@@ -1,2 +1,2 @@
-import{a,b,c,d,e,f,g,h,i,j,k,l}from"../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 buildRawTransaction,b as buildTransactionPayload,a as generateTransaction,d as getSigningMessage,k as publicPackageTransaction,l as rotateAuthKey,j as signAndSubmitAsFeePayer,i as signAndSubmitTransaction,f as signAsFeePayer,e as signTransaction,g as simulateTransaction,h as submitTransaction};
+import{a,b,c,d,e,f,g,h,i,j,k,l}from"../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 buildRawTransaction,b as buildTransactionPayload,a as generateTransaction,d as getSigningMessage,k as publicPackageTransaction,l as rotateAuthKey,j as signAndSubmitAsFeePayer,i as signAndSubmitTransaction,f as signAsFeePayer,e as signTransaction,g as simulateTransaction,h as submitTransaction};
 //# sourceMappingURL=transactionSubmission.mjs.map

package/dist/esm/internal/view.d.mts

@@ -15,7 +15,7 @@ import '../core/common.mjs';
 import '../transactions/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 '../transactions/instances/rawTransaction.mjs';
 import '../transactions/instances/chainId.mjs';

package/dist/esm/internal/view.mjs

@@ -1,2 +1,2 @@
-import{a,b}from"../chunk-G7MWTE2J.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 view,b as viewJson};
+import{a,b}from"../chunk-KSUZS6EL.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 view,b as viewJson};
 //# sourceMappingURL=view.mjs.map

package/dist/esm/publicKey-_tPa99ea.d.mts

@@ -0,0 +1,151 @@
+import { HexInput, AuthenticationKeyScheme } from './types/index.mjs';
+import { Serializable, Serializer } from './bcs/serializer.mjs';
+import { AccountAddress } from './core/accountAddress.mjs';
+import { Deserializer } from './bcs/deserializer.mjs';
+import { Signature } from './core/crypto/signature.mjs';
+import { Hex } from './core/hex.mjs';
+
+/**
+ * Represents an authentication key used for account management. Each account stores an authentication key that enables account
+ * owners to rotate their private key(s) without changing the address that hosts their account. The authentication key is a
+ * SHA3-256 hash of data and is always 32 bytes in length.
+ *
+ * @see {@link https://aptos.dev/concepts/accounts | Account Basics}
+ *
+ * Account addresses can be derived from the AuthenticationKey.
+ */
+declare class AuthenticationKey extends Serializable {
+    /**
+     * An authentication key is always a SHA3-256 hash of data, and is always 32 bytes.
+     *
+     * The data to hash depends on the underlying public key type and the derivation scheme.
+     */
+    static readonly LENGTH: number;
+    /**
+     * The raw bytes of the authentication key.
+     */
+    readonly data: Hex;
+    /**
+     * Creates an instance of the AuthenticationKey using the provided hex input.
+     * This ensures that the hex input is valid and conforms to the required length for an Authentication Key.
+     *
+     * @param args - The arguments for constructing the AuthenticationKey.
+     * @param args.data - The hex input data to be used for the Authentication Key.
+     * @throws {Error} Throws an error if the length of the provided hex input is not equal to the required Authentication Key
+     * length.
+     */
+    constructor(args: {
+        data: HexInput;
+    });
+    /**
+     * Serializes the fixed bytes data into a format suitable for transmission or storage.
+     *
+     * @param serializer - The serializer instance used to perform the serialization.
+     */
+    serialize(serializer: Serializer): void;
+    /**
+     * Deserialize an AuthenticationKey from the byte buffer in a Deserializer instance.
+     * @param deserializer - The deserializer to deserialize the AuthenticationKey from.
+     * @returns An instance of AuthenticationKey.
+     */
+    static deserialize(deserializer: Deserializer): AuthenticationKey;
+    /**
+     * Convert the internal data representation to a Uint8Array.
+     *
+     * This function is useful for obtaining a byte representation of the data, which can be utilized for serialization or transmission.
+     *
+     * @returns Uint8Array representation of the internal data.
+     */
+    toUint8Array(): Uint8Array;
+    /**
+     * Generates an AuthenticationKey from the specified scheme and input bytes.
+     * This function is essential for creating a valid authentication key based on a given scheme.
+     *
+     * @param args - The arguments for generating the AuthenticationKey.
+     * @param args.scheme - The authentication key scheme to use.
+     * @param args.input - The input data in hexadecimal format to derive the key.
+     * @returns An instance of AuthenticationKey containing the generated key data.
+     */
+    static fromSchemeAndBytes(args: {
+        scheme: AuthenticationKeyScheme;
+        input: HexInput;
+    }): AuthenticationKey;
+    /**
+     * Derives an AuthenticationKey from the provided public key using a specified derivation scheme.
+     *
+     * @deprecated Use `fromPublicKey` instead.
+     * @param args - The arguments for deriving the authentication key.
+     * @param args.publicKey - The public key used for the derivation.
+     * @param args.scheme - The scheme to use for deriving the authentication key.
+     */
+    static fromPublicKeyAndScheme(args: {
+        publicKey: AccountPublicKey;
+        scheme: AuthenticationKeyScheme;
+    }): AuthenticationKey;
+    /**
+     * Converts a PublicKey to an AuthenticationKey using the derivation scheme inferred from the provided PublicKey instance.
+     *
+     * @param args - The arguments for the function.
+     * @param args.publicKey - The PublicKey to be converted.
+     * @returns AuthenticationKey - The derived AuthenticationKey.
+     */
+    static fromPublicKey(args: {
+        publicKey: AccountPublicKey;
+    }): AuthenticationKey;
+    /**
+     * Derives an account address from an AuthenticationKey by translating the AuthenticationKey bytes directly to an AccountAddress.
+     *
+     * @returns AccountAddress - The derived account address.
+     */
+    derivedAddress(): AccountAddress;
+}
+
+/**
+ * Represents the arguments required to verify a digital signature.
+ *
+ * @param message - The original message that was signed.
+ * @param signature - The signature to be verified against the message.
+ */
+interface VerifySignatureArgs {
+    message: HexInput;
+    signature: Signature;
+}
+/**
+ * Represents an abstract public key.
+ *
+ * This class provides a common interface for verifying signatures associated with the public key.
+ * It allows for the retrieval of the raw public key bytes and the public key in a hexadecimal string format.
+ */
+declare abstract class PublicKey extends Serializable {
+    /**
+     * Verifies that the private key associated with this public key signed the message with the given signature.
+     * @param args.message The message that was signed
+     * @param args.signature The signature to verify
+     */
+    abstract verifySignature(args: VerifySignatureArgs): boolean;
+    /**
+     * Get the raw public key bytes
+     */
+    toUint8Array(): Uint8Array;
+    /**
+     * Get the public key as a hex string with a 0x prefix.
+     *
+     * @returns The public key in hex format.
+     */
+    toString(): string;
+}
+/**
+ * An abstract representation of an account public key.
+ *
+ * Provides a common interface for deriving an authentication key.
+ *
+ * @abstract
+ */
+declare abstract class AccountPublicKey extends PublicKey {
+    /**
+     * Get the authentication key associated with this public key
+     */
+    abstract authKey(): AuthenticationKey;
+}
+
+export { AuthenticationKey as A, PublicKey as P, type VerifySignatureArgs as V, AccountPublicKey as a };