@aptos-labs/ts-sdk 1.29.0 → 1.30.0

package/src/internal/fungibleAsset.ts

@@ -45,6 +45,17 @@ import {
 import { generateTransaction } from "./transactionSubmission";
 import { SimpleTransaction } from "../transactions/instances/simpleTransaction";
 
+/**
+ * Retrieves metadata for fungible assets based on specified criteria.
+ * This function allows you to filter and paginate through fungible asset metadata.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration for Aptos.
+ * @param [args.options] - Optional parameters for pagination and filtering.
+ * @param [args.options.limit] - The maximum number of results to return.
+ * @param [args.options.offset] - The number of results to skip before starting to collect the result set.
+ * @param [args.options.where] - Conditions to filter the results.
+ */
 export async function getFungibleAssetMetadata(args: {
   aptosConfig: AptosConfig;
   options?: PaginationArgs & WhereArg<FungibleAssetMetadataBoolExp>;
@@ -69,6 +80,18 @@ export async function getFungibleAssetMetadata(args: {
   return data.fungible_asset_metadata;
 }
 
+/**
+ * Retrieves the activities associated with fungible assets.
+ * This function allows you to filter and paginate through the activities based on specified conditions.
+ *
+ * @param args - The arguments for retrieving fungible asset activities.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param [args.options] - Optional parameters for pagination and filtering.
+ * @param [args.options.limit] - The maximum number of activities to retrieve.
+ * @param [args.options.offset] - The number of activities to skip before starting to collect the result set.
+ * @param [args.options.where] - Conditions to filter the activities.
+ * @returns A promise that resolves to an array of fungible asset activities.
+ */
 export async function getFungibleAssetActivities(args: {
   aptosConfig: AptosConfig;
   options?: PaginationArgs & WhereArg<FungibleAssetActivitiesBoolExp>;
@@ -93,6 +116,17 @@ export async function getFungibleAssetActivities(args: {
   return data.fungible_asset_activities;
 }
 
+/**
+ * Retrieves the current balances of fungible assets for a specified configuration.
+ *
+ * @param args - The arguments for retrieving fungible asset balances.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.options - Optional parameters for pagination and filtering.
+ * @param args.options.limit - The maximum number of results to return.
+ * @param args.options.offset - The number of results to skip before starting to collect the results.
+ * @param args.options.where - Conditions to filter the results based on specific criteria.
+ * @returns The current balances of fungible assets.
+ */
 export async function getCurrentFungibleAssetBalances(args: {
   aptosConfig: AptosConfig;
   options?: PaginationArgs & WhereArg<CurrentFungibleAssetBalancesBoolExp>;
@@ -122,6 +156,18 @@ const faTransferAbi: EntryFunctionABI = {
   parameters: [parseTypeTag("0x1::object::Object"), new TypeTagAddress(), new TypeTagU64()],
 };
 
+/**
+ * Transfers a specified amount of a fungible asset from the sender to the recipient.
+ * This function helps facilitate the transfer of digital assets between accounts on the Aptos blockchain.
+ *
+ * @param args - The parameters for the transfer operation.
+ * @param args.aptosConfig - The configuration settings for the Aptos network.
+ * @param args.sender - The account initiating the transfer.
+ * @param args.fungibleAssetMetadataAddress - The address of the fungible asset's metadata.
+ * @param args.recipient - The address of the account receiving the asset.
+ * @param args.amount - The amount of the fungible asset to transfer.
+ * @param args.options - Optional settings for generating the transaction.
+ */
 export async function transferFungibleAsset(args: {
   aptosConfig: AptosConfig;
   sender: Account;

package/src/internal/general.ts

@@ -15,6 +15,12 @@ import { GetChainTopUserTransactionsQuery, GetProcessorStatusQuery } from "../ty
 import { GetChainTopUserTransactions, GetProcessorStatus } from "../types/generated/queries";
 import { ProcessorType } from "../utils/const";
 
+/**
+ * Retrieves information about the current ledger.
+ *
+ * @param args - The arguments for retrieving ledger information.
+ * @param args.aptosConfig - The configuration object for connecting to the Aptos network.
+ */
 export async function getLedgerInfo(args: { aptosConfig: AptosConfig }): Promise<LedgerInfo> {
   const { aptosConfig } = args;
   const { data } = await getAptosFullNode<{}, LedgerInfo>({
@@ -25,6 +31,14 @@ export async function getLedgerInfo(args: { aptosConfig: AptosConfig }): Promise
   return data;
 }
 
+/**
+ * Retrieves the top user transactions for a specific blockchain chain.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.limit - The maximum number of transactions to retrieve.
+ * @returns An array of user transactions.
+ */
 export async function getChainTopUserTransactions(args: {
   aptosConfig: AptosConfig;
   limit: number;
@@ -44,6 +58,15 @@ export async function getChainTopUserTransactions(args: {
   return data.user_transactions;
 }
 
+/**
+ * Executes a GraphQL query against the Aptos indexer and retrieves the resulting data.
+ *
+ * @param args - The arguments for the query.
+ * @param args.aptosConfig - The configuration settings for the Aptos client.
+ * @param args.query - The GraphQL query to be executed.
+ * @param args.originMethod - An optional string to specify the origin method for tracking purposes.
+ * @returns The data returned from the query execution.
+ */
 export async function queryIndexer<T extends {}>(args: {
   aptosConfig: AptosConfig;
   query: GraphqlQuery;
@@ -60,6 +83,13 @@ export async function queryIndexer<T extends {}>(args: {
   return data;
 }
 
+/**
+ * Retrieves the current statuses of processors.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @returns The statuses of the processors.
+ */
 export async function getProcessorStatuses(args: { aptosConfig: AptosConfig }): Promise<GetProcessorStatusResponse> {
   const { aptosConfig } = args;
 
@@ -76,11 +106,27 @@ export async function getProcessorStatuses(args: { aptosConfig: AptosConfig }):
   return data.processor_status;
 }
 
+/**
+ * Retrieves the last success version from the indexer.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @returns The last success version as a BigInt.
+ */
 export async function getIndexerLastSuccessVersion(args: { aptosConfig: AptosConfig }): Promise<bigint> {
   const response = await getProcessorStatuses({ aptosConfig: args.aptosConfig });
   return BigInt(response[0].last_success_version);
 }
 
+/**
+ * Retrieves the status of a specified processor in the Aptos network.
+ * This function allows you to check the current operational status of a processor, which can be useful for monitoring and troubleshooting.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration object for connecting to the Aptos network.
+ * @param args.processorType - The type of processor whose status you want to retrieve.
+ * @returns The status of the specified processor.
+ */
 export async function getProcessorStatus(args: {
   aptosConfig: AptosConfig;
   processorType: ProcessorType;

package/src/internal/keyless.ts

@@ -30,6 +30,17 @@ import { MoveVector } from "../bcs";
 import { generateTransaction } from "./transactionSubmission";
 import { SimpleTransaction } from "../transactions";
 
+/**
+ * Retrieves a pepper value based on the provided configuration and authentication details.
+ *
+ * @param args - The arguments required to fetch the pepper.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.jwt - The JSON Web Token used for authentication.
+ * @param args.ephemeralKeyPair - The ephemeral key pair used for the operation.
+ * @param args.uidKey - An optional unique identifier key (defaults to "sub").
+ * @param args.derivationPath - An optional derivation path for the key.
+ * @returns A Uint8Array containing the fetched pepper value.
+ */
 export async function getPepper(args: {
   aptosConfig: AptosConfig;
   jwt: string;
@@ -57,6 +68,18 @@ export async function getPepper(args: {
   return Hex.fromHexInput(data.pepper).toUint8Array();
 }
 
+/**
+ * Generates a zero-knowledge proof based on the provided parameters.
+ * This function is essential for creating a signed proof that can be used in various cryptographic operations.
+ *
+ * @param args - The parameters required to generate the proof.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.jwt - The JSON Web Token used for authentication.
+ * @param args.ephemeralKeyPair - The ephemeral key pair used for generating the proof.
+ * @param args.pepper - An optional hex input used to enhance security (default is generated if not provided).
+ * @param args.uidKey - An optional string that specifies the unique identifier key (defaults to "sub").
+ * @throws Error if the pepper length is not valid or if the ephemeral key pair's lifespan exceeds the maximum allowed.
+ */
 export async function getProof(args: {
   aptosConfig: AptosConfig;
   jwt: string;
@@ -109,6 +132,19 @@ export async function getProof(args: {
   return signedProof;
 }
 
+/**
+ * Derives a keyless account by fetching the necessary proof and looking up the original account address.
+ * This function helps in creating a keyless account that can be used without managing private keys directly.
+ *
+ * @param args - The arguments required to derive the keyless account.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.jwt - The JSON Web Token used for authentication.
+ * @param args.ephemeralKeyPair - The ephemeral key pair used for cryptographic operations.
+ * @param args.uidKey - An optional unique identifier key for the user.
+ * @param args.pepper - An optional hexadecimal input used for additional security.
+ * @param args.proofFetchCallback - An optional callback function to handle the proof fetch outcome.
+ * @returns A keyless account object.
+ */
 export async function deriveKeylessAccount(args: {
   aptosConfig: AptosConfig;
   jwt: string;
@@ -143,7 +179,7 @@ export async function deriveKeylessAccount(args: {
   // background and the callback will handle the outcome of the fetch.  This allows the developer to not have to block on the proof fetch
   // allowing for faster rendering of UX.
   //
-  // If no callback is provided, the just await the proof fetch and continue syncronously.
+  // If no callback is provided, the just await the proof fetch and continue synchronously.
   const proof = proofFetchCallback ? proofPromise : await proofPromise;
 
   // Look up the original address to handle key rotations and then instantiate the account.

package/src/internal/object.ts

@@ -6,6 +6,18 @@ import { GetObjectData } from "../types/generated/queries";
 import { CurrentObjectsBoolExp } from "../types/generated/types";
 import { queryIndexer } from "./general";
 
+/**
+ * Retrieves the current objects based on specified filtering and pagination options.
+ *
+ * @param args - The arguments for retrieving object data.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param [args.options] - Optional parameters for pagination and filtering.
+ * @param [args.options.offset] - The number of items to skip before starting to collect the result set.
+ * @param [args.options.limit] - The maximum number of items to return.
+ * @param [args.options.orderBy] - The criteria for ordering the results.
+ * @param [args.options.where] - The conditions to filter the results.
+ * @returns The current objects that match the specified criteria.
+ */
 export async function getObjectData(args: {
   aptosConfig: AptosConfig;
   options?: PaginationArgs & OrderByArg<GetObjectDataQueryResponse[0]> & WhereArg<CurrentObjectsBoolExp>;
@@ -30,6 +42,15 @@ export async function getObjectData(args: {
   return data.current_objects;
 }
 
+/**
+ * Retrieves the object data associated with a specific object address.
+ * This function allows you to access detailed information about an object in the Aptos blockchain.
+ *
+ * @param args - The arguments for retrieving object data.
+ * @param args.aptosConfig - The configuration for connecting to the Aptos blockchain.
+ * @param args.objectAddress - The address of the object whose data is being retrieved.
+ * @param args.options - Optional parameters for pagination and ordering of the results.
+ */
 export async function getObjectDataByObjectAddress(args: {
   aptosConfig: AptosConfig;
   objectAddress: AccountAddressInput;

package/src/internal/queries/getTableItemsData.graphql

@@ -12,4 +12,4 @@ query getTableItemsData(
     transaction_version
     write_set_change_index
   }
-}
+}

package/src/internal/queries/getTableItemsMetadata.graphql

@@ -9,4 +9,4 @@ query getTableItemsMetadata(
     key_type
     value_type
   }
-}
+}

package/src/internal/staking.ts

@@ -15,6 +15,14 @@ import { GetDelegatedStakingActivitiesQuery, GetNumberOfDelegatorsQuery } from "
 import { GetDelegatedStakingActivities, GetNumberOfDelegators } from "../types/generated/queries";
 import { queryIndexer } from "./general";
 
+/**
+ * Retrieves the number of active delegators for a specified pool address.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.poolAddress - The address of the pool for which to retrieve the number of delegators.
+ * @returns The number of active delegators for the specified pool address.
+ */
 export async function getNumberOfDelegators(args: {
   aptosConfig: AptosConfig;
   poolAddress: AccountAddressInput;
@@ -27,11 +35,20 @@ export async function getNumberOfDelegators(args: {
   };
   const data = await queryIndexer<GetNumberOfDelegatorsQuery>({ aptosConfig, query });
 
-  // commonjs (aka cjs) doesnt handle Nullish Coalescing for some reason
+  // commonjs (aka cjs) doesn't handle Nullish Coalescing for some reason
   // might be because of how ts infer the graphql generated scheme type
   return data.num_active_delegator_per_pool[0] ? data.num_active_delegator_per_pool[0].num_active_delegator : 0;
 }
 
+/**
+ * Retrieves the number of active delegators for all pools.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration for the Aptos client.
+ * @param [args.options] - Optional parameters for ordering the results.
+ * @param args.options.orderBy - Specifies the order in which to return the results.
+ * @returns The number of active delegators per pool.
+ */
 export async function getNumberOfDelegatorsForAllPools(args: {
   aptosConfig: AptosConfig;
   options?: OrderByArg<GetNumberOfDelegatorsResponse[0]>;
@@ -48,6 +65,15 @@ export async function getNumberOfDelegatorsForAllPools(args: {
   return data.num_active_delegator_per_pool;
 }
 
+/**
+ * Retrieves the delegated staking activities for a specified delegator and pool.
+ *
+ * @param args - The parameters for the query.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.delegatorAddress - The address of the delegator whose activities are being queried.
+ * @param args.poolAddress - The address of the pool associated with the delegated staking activities.
+ * @returns The delegated staking activities for the specified delegator and pool.
+ */
 export async function getDelegatedStakingActivities(args: {
   aptosConfig: AptosConfig;
   delegatorAddress: AccountAddressInput;

package/src/internal/table.ts

@@ -14,6 +14,15 @@ import { GetTableItemsData, GetTableItemsMetadata } from "../types/generated/que
 import { TableItemsBoolExp, TableMetadatasBoolExp } from "../types/generated/types";
 import { queryIndexer } from "./general";
 
+/**
+ * Retrieves a specific item from a table in the Aptos blockchain.
+ *
+ * @param args - The arguments for retrieving the table item.
+ * @param args.aptosConfig - The configuration for connecting to the Aptos blockchain.
+ * @param args.handle - The identifier for the table from which to retrieve the item.
+ * @param args.data - The request data for the table item.
+ * @param args.options - Optional parameters for the request, including ledger version.
+ */
 export async function getTableItem<T>(args: {
   aptosConfig: AptosConfig;
   handle: string;
@@ -31,6 +40,17 @@ export async function getTableItem<T>(args: {
   return response.data as T;
 }
 
+/**
+ * Retrieves table items data based on specified conditions and pagination options.
+ *
+ * @param args - The arguments for retrieving table items data.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.options - Optional parameters for pagination and filtering.
+ * @param args.options.offset - The number of items to skip before starting to collect the result set.
+ * @param args.options.limit - The maximum number of items to return.
+ * @param args.options.where - Conditions to filter the table items.
+ * @param args.options.orderBy - The criteria to sort the results.
+ */
 export async function getTableItemsData(args: {
   aptosConfig: AptosConfig;
   options?: PaginationArgs & WhereArg<TableItemsBoolExp> & OrderByArg<GetTableItemsDataResponse[0]>;
@@ -56,6 +76,18 @@ export async function getTableItemsData(args: {
   return data.table_items;
 }
 
+/**
+ * Retrieves metadata for table items based on specified options.
+ *
+ * @param args - The arguments for retrieving table items metadata.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.options - Optional parameters for pagination and filtering.
+ * @param args.options.offset - The number of items to skip before starting to collect the result set.
+ * @param args.options.limit - The maximum number of items to return.
+ * @param args.options.where - Conditions to filter the results.
+ * @param args.options.orderBy - The order in which to return the results.
+ * @returns A promise that resolves to an array of table metadata.
+ */
 export async function getTableItemsMetadata(args: {
   aptosConfig: AptosConfig;
   options?: PaginationArgs & WhereArg<TableMetadatasBoolExp> & OrderByArg<GetTableItemsMetadataResponse[0]>;

package/src/internal/transaction.ts

@@ -26,6 +26,15 @@ import { sleep } from "../utils/helpers";
 import { memoizeAsync } from "../utils/memoize";
 import { getIndexerLastSuccessVersion, getProcessorStatus } from "./general";
 
+/**
+ * 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.
+ */
 export async function getTransactions(args: {
   aptosConfig: AptosConfig;
   options?: PaginationArgs;
@@ -39,6 +48,13 @@ export async function getTransactions(args: {
   });
 }
 
+/**
+ * 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.
+ */
 export async function getGasPriceEstimation(args: { aptosConfig: AptosConfig }) {
   const { aptosConfig } = args;
 
@@ -56,6 +72,14 @@ export async function getGasPriceEstimation(args: { aptosConfig: AptosConfig })
   )();
 }
 
+/**
+ * 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.
+ */
 export async function getTransactionByVersion(args: {
   aptosConfig: AptosConfig;
   ledgerVersion: AnyNumber;
@@ -69,6 +93,14 @@ export async function getTransactionByVersion(args: {
   return data;
 }
 
+/**
+ * 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.
+ */
 export async function getTransactionByHash(args: {
   aptosConfig: AptosConfig;
   transactionHash: HexInput;
@@ -82,6 +114,16 @@ export async function getTransactionByHash(args: {
   return data;
 }
 
+/**
+ * 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.
+ */
 export async function isTransactionPending(args: {
   aptosConfig: AptosConfig;
   transactionHash: HexInput;
@@ -98,6 +140,14 @@ export async function isTransactionPending(args: {
   }
 }
 
+/**
+ * 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.
+ */
 export async function longWaitForTransaction(args: {
   aptosConfig: AptosConfig;
   transactionHash: HexInput;
@@ -111,6 +161,20 @@ export async function longWaitForTransaction(args: {
   return data;
 }
 
+/**
+ * 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.
+ */
 export async function waitForTransaction(args: {
   aptosConfig: AptosConfig;
   transactionHash: HexInput;
@@ -127,6 +191,12 @@ export async function waitForTransaction(args: {
   let backoffIntervalMs = 200;
   const backoffMultiplier = 1.5;
 
+  /**
+   * Handles API errors by throwing the last error or a timeout error for a failed transaction.
+   *
+   * @param e - The error object that occurred during the API call.
+   * @throws {Error} Throws the last error if it exists; otherwise, throws a WaitForTransactionError indicating a timeout.
+   */
   function handleAPIError(e: any) {
     // In short, this means we will retry if it was an AptosApiError and the code was 404 or 5xx.
     const isAptosApiError = e instanceof AptosApiError;
@@ -215,7 +285,12 @@ export async function waitForTransaction(args: {
 }
 
 /**
- * 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.
  */
 export async function waitForIndexer(args: {
   aptosConfig: AptosConfig;
@@ -256,12 +331,22 @@ export async function waitForIndexer(args: {
 }
 
 /**
- * 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.
  */
 export class WaitForTransactionError extends Error {
   public 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) {
     super(message);
     this.lastSubmittedTransaction = lastSubmittedTransaction;
@@ -269,8 +354,11 @@ export class WaitForTransactionError extends Error {
 }
 
 /**
- * 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.
  */
 export class FailedTransactionError extends Error {
   public readonly transaction: TransactionResponse;
@@ -281,6 +369,16 @@ export class FailedTransactionError extends Error {
   }
 }
 
+/**
+ * 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.
+ */
 export async function getBlockByVersion(args: {
   aptosConfig: AptosConfig;
   ledgerVersion: AnyNumber;
@@ -297,6 +395,16 @@ export async function getBlockByVersion(args: {
   return fillBlockTransactions({ block, ...args });
 }
 
+/**
+ * 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.
+ */
 export async function getBlockByHeight(args: {
   aptosConfig: AptosConfig;
   blockHeight: AnyNumber;
@@ -313,8 +421,13 @@ export async function getBlockByHeight(args: {
 }
 
 /**
- * Fills in the block with transactions if not enough were returned
- * @param args
+ * Fills in the block with transactions if not enough were returned. This function ensures that the block contains all relevant
+ * transactions by fetching any missing ones based on the specified options.
+ * @param args - The arguments for filling the block transactions.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.block - The block object that will be filled with transactions.
+ * @param args.options - Optional settings for fetching transactions.
+ * @param args.options.withTransactions - Indicates whether to include transactions in the block.
  */
 async function fillBlockTransactions(args: {
   aptosConfig: AptosConfig;