@aptos-labs/ts-sdk 1.33.1 → 1.33.2

package/src/internal/digitalAsset.ts

@@ -6,6 +6,7 @@
  * the {@link api/digitalAsset}. By moving the methods out into a separate file,
  * other namespaces and processes can access these methods without depending on the entire
  * digitalAsset namespace and without having a dependency cycle error.
+ * @group Implementation
  */
 
 import { AptosConfig } from "../api/aptosConfig";
@@ -77,6 +78,7 @@ const PropertyTypeMap = {
 
 /**
  * The keys of the PropertyTypeMap, representing different property types.
+ * @group Implementation
  */
 export type PropertyType = keyof typeof PropertyTypeMap;
 
@@ -84,6 +86,7 @@ export type PropertyType = keyof typeof PropertyTypeMap;
  * Accepted property value types for user input, including boolean, number, bigint, string, AccountAddress, and Uint8Array.
  * To pass in an Array, use Uint8Array type
  * for example `new MoveVector([new MoveString("hello"), new MoveString("world")]).bcsToBytes()`
+ * @group Implementation
  */
 export type PropertyValue = boolean | number | bigint | string | AccountAddress | Uint8Array;
 
@@ -99,6 +102,7 @@ const defaultDigitalAssetType = "0x4::token::Token";
  * @param args.aptosConfig - The configuration settings for Aptos.
  * @param args.digitalAssetAddress - The address of the digital asset to retrieve data for.
  * @returns The data of the specified digital asset.
+ * @group Implementation
  */
 export async function getDigitalAssetData(args: {
   aptosConfig: AptosConfig;
@@ -133,6 +137,7 @@ export async function getDigitalAssetData(args: {
  * @param args.aptosConfig - The configuration settings for Aptos.
  * @param args.digitalAssetAddress - The address of the digital asset to query ownership for.
  * @returns The current ownership details of the specified digital asset.
+ * @group Implementation
  */
 export async function getCurrentDigitalAssetOwnership(args: {
   aptosConfig: AptosConfig;
@@ -173,6 +178,7 @@ export async function getCurrentDigitalAssetOwnership(args: {
  * @param args.options.orderBy - The criteria for ordering the results.
  *
  * @returns An array of digital assets currently owned by the specified account.
+ * @group Implementation
  */
 export async function getOwnedDigitalAssets(args: {
   aptosConfig: AptosConfig;
@@ -217,6 +223,7 @@ export async function getOwnedDigitalAssets(args: {
  * @param args.options.limit - The maximum number of records to return.
  * @param args.options.orderBy - The criteria to order the results by.
  * @returns A promise that resolves to an array of token activities for the specified digital asset.
+ * @group Implementation
  */
 export async function getDigitalAssetActivity(args: {
   aptosConfig: AptosConfig;
@@ -264,6 +271,7 @@ export async function getDigitalAssetActivity(args: {
  * @param tokensFreezableByCreator - Indicates if the creator can freeze tokens in the collection.
  * @param royaltyNumerator - The numerator for calculating royalties.
  * @param royaltyDenominator - The denominator for calculating royalties.
+ * @group Implementation
  */
 export interface CreateCollectionOptions {
   maxSupply?: AnyNumber;
@@ -324,6 +332,7 @@ const createCollectionAbi: EntryFunctionABI = {
  * @param args.tokensFreezableByCreator - Indicates if tokens can be frozen by the creator (optional, defaults to true).
  * @param args.royaltyNumerator - The numerator for calculating royalties (optional, defaults to 0).
  * @param args.royaltyDenominator - The denominator for calculating royalties (optional, defaults to 1).
+ * @group Implementation
  */
 export async function createCollectionTransaction(
   args: {
@@ -376,6 +385,7 @@ export async function createCollectionTransaction(
  * @param args.options.limit - The limit for pagination.
  * @param args.options.where - The conditions to filter the collections.
  * @returns The data of the current collections.
+ * @group Implementation
  */
 export async function getCollectionData(args: {
   aptosConfig: AptosConfig;
@@ -416,6 +426,7 @@ export async function getCollectionData(args: {
  * @param args.options - Optional parameters for filtering the results, including token standard and pagination options.
  * @param args.options.tokenStandard - The token standard to filter the results by (optional).
  * @param args.options.pagination - Pagination options for the results (optional).
+ * @group Implementation
  */
 export async function getCollectionDataByCreatorAddressAndCollectionName(args: {
   aptosConfig: AptosConfig;
@@ -447,6 +458,7 @@ export async function getCollectionDataByCreatorAddressAndCollectionName(args: {
  * @param args.options - Optional parameters for filtering the results.
  * @param args.options.tokenStandard - The token standard to filter the collections by.
  * @param args.options.pagination - Pagination options for the results.
+ * @group Implementation
  */
 export async function getCollectionDataByCreatorAddress(args: {
   aptosConfig: AptosConfig;
@@ -477,6 +489,7 @@ export async function getCollectionDataByCreatorAddress(args: {
  * @param args.options.tokenStandard - The standard of the token to filter the collection data.
  * @param args.options.page - The page number for pagination.
  * @param args.options.limit - The number of items per page for pagination.
+ * @group Implementation
  */
 export async function getCollectionDataByCollectionId(args: {
   aptosConfig: AptosConfig;
@@ -508,6 +521,7 @@ export async function getCollectionDataByCollectionId(args: {
  * @param args.options - Optional parameters for additional filtering.
  * @param args.options.tokenStandard - The token standard to filter the collection (default is "v2").
  * @returns The ID of the specified collection.
+ * @group Implementation
  */
 export async function getCollectionId(args: {
   aptosConfig: AptosConfig;
@@ -559,6 +573,7 @@ const mintDigitalAssetAbi: EntryFunctionABI = {
  * @param [args.propertyTypes] - Optional array of property types corresponding to the asset's properties.
  * @param [args.propertyValues] - Optional array of property values for the asset's properties.
  * @param [args.options] - Optional transaction generation options.
+ * @group Implementation
  */
 export async function mintDigitalAssetTransaction(args: {
   aptosConfig: AptosConfig;
@@ -604,6 +619,7 @@ export async function mintDigitalAssetTransaction(args: {
          * @param propertyValues - An array of property values from which to extract the raw data.
          * @param propertyTypes - An array of strings representing the types of properties to retrieve.
          * @returns An array of Uint8Array containing the raw values for the specified property types.
+         * @group Implementation
          */
         getPropertyValueRaw(propertyValues ?? [], convertedPropertyType ?? []),
       ],
@@ -629,6 +645,7 @@ const transferDigitalAssetAbi: EntryFunctionABI = {
  * @param args.recipient - The address of the account receiving the digital asset.
  * @param args.digitalAssetType - (Optional) The type of the digital asset being transferred.
  * @param args.options - (Optional) Additional options for generating the transaction.
+ * @group Implementation
  */
 export async function transferDigitalAssetTransaction(args: {
   aptosConfig: AptosConfig;
@@ -683,6 +700,7 @@ const mintSoulBoundAbi: EntryFunctionABI = {
  * @param [args.propertyValues] - Optional array of property values that match the property keys and types.
  * @param [args.options] - Optional transaction generation options.
  * @throws Error if the counts of property keys, property types, and property values do not match.
+ * @group Implementation
  */
 export async function mintSoulBoundTransaction(args: {
   aptosConfig: AptosConfig;
@@ -753,6 +771,7 @@ const burnDigitalAssetAbi: EntryFunctionABI = {
  * @param args.digitalAssetAddress - The address of the digital asset to be burned.
  * @param args.digitalAssetType - Optional; the type of the digital asset being burned.
  * @param args.options - Optional; additional options for generating the transaction.
+ * @group Implementation
  */
 export async function burnDigitalAssetTransaction(args: {
   aptosConfig: AptosConfig;
@@ -790,6 +809,7 @@ const freezeDigitalAssetAbi: EntryFunctionABI = {
  * @param args.digitalAssetAddress - The address of the digital asset to be frozen.
  * @param args.digitalAssetType - (Optional) The type of the digital asset as a Move struct ID.
  * @param args.options - (Optional) Additional options for generating the transaction.
+ * @group Implementation
  */
 export async function freezeDigitalAssetTransferTransaction(args: {
   aptosConfig: AptosConfig;
@@ -826,6 +846,7 @@ const unfreezeDigitalAssetAbi: EntryFunctionABI = {
  * @param args.digitalAssetAddress - The address of the digital asset to be unfrozen.
  * @param args.digitalAssetType - (Optional) The type of the digital asset being unfrozen.
  * @param args.options - (Optional) Additional options for generating the transaction.
+ * @group Implementation
  */
 export async function unfreezeDigitalAssetTransferTransaction(args: {
   aptosConfig: AptosConfig;
@@ -863,6 +884,7 @@ const setDigitalAssetDescriptionAbi: EntryFunctionABI = {
  * @param args.digitalAssetAddress - The address of the digital asset whose description is being set.
  * @param args.digitalAssetType - (Optional) The type of the digital asset.
  * @param args.options - (Optional) Additional options for generating the transaction.
+ * @group Implementation
  */
 export async function setDigitalAssetDescriptionTransaction(args: {
   aptosConfig: AptosConfig;
@@ -902,6 +924,7 @@ const setDigitalAssetNameAbi: EntryFunctionABI = {
  * @param args.digitalAssetAddress - The address of the digital asset to update.
  * @param args.digitalAssetType - (Optional) The type of the digital asset, represented as a Move struct ID.
  * @param args.options - (Optional) Additional options for generating the transaction.
+ * @group Implementation
  */
 export async function setDigitalAssetNameTransaction(args: {
   aptosConfig: AptosConfig;
@@ -940,6 +963,7 @@ const setDigitalAssetURIAbi: EntryFunctionABI = {
  * @param args.digitalAssetAddress - The address of the digital asset whose URI is being set.
  * @param args.digitalAssetType - The optional type of the digital asset; defaults to a predefined type if not provided.
  * @param args.options - Optional settings for generating the transaction.
+ * @group Implementation
  */
 export async function setDigitalAssetURITransaction(args: {
   aptosConfig: AptosConfig;
@@ -986,6 +1010,7 @@ const addDigitalAssetPropertyAbi: EntryFunctionABI = {
  * @param args.digitalAssetAddress - The address of the digital asset to which the property is being added.
  * @param args.digitalAssetType - The optional type of the digital asset.
  * @param args.options - Optional transaction generation options.
+ * @group Implementation
  */
 export async function addDigitalAssetPropertyTransaction(args: {
   aptosConfig: AptosConfig;
@@ -1041,6 +1066,7 @@ const removeDigitalAssetPropertyAbi: EntryFunctionABI = {
  * @param args.digitalAssetAddress - The address of the digital asset from which the property will be removed.
  * @param args.digitalAssetType - The type of the digital asset (optional).
  * @param args.options - Additional options for generating the transaction (optional).
+ * @group Implementation
  */
 export async function removeDigitalAssetPropertyTransaction(args: {
   aptosConfig: AptosConfig;
@@ -1087,6 +1113,7 @@ const updateDigitalAssetPropertyAbi: EntryFunctionABI = {
  * @param args.digitalAssetAddress - The address of the digital asset to update.
  * @param args.digitalAssetType - (Optional) The type of the digital asset.
  * @param args.options - (Optional) Additional options for generating the transaction.
+ * @group Implementation
  */
 export async function updateDigitalAssetPropertyTransaction(args: {
   aptosConfig: AptosConfig;
@@ -1125,6 +1152,7 @@ export async function updateDigitalAssetPropertyTransaction(args: {
          * @param propertyValue - The value of the property to convert.
          * @param propertyType - The type of the property, which determines how the value is processed.
          * @returns The raw byte representation of the property value.
+         * @group Implementation
          */
         getSinglePropertyValueRaw(propertyValue, PropertyTypeMap[propertyType]),
       ],
@@ -1156,6 +1184,7 @@ const addDigitalAssetTypedPropertyAbi: EntryFunctionABI = {
  * @param args.digitalAssetAddress - The address of the digital asset to which the property is being added.
  * @param args.digitalAssetType - (Optional) The type of the digital asset.
  * @param args.options - (Optional) Additional options for generating the transaction.
+ * @group Implementation
  */
 export async function addDigitalAssetTypedPropertyTransaction(args: {
   aptosConfig: AptosConfig;
@@ -1211,6 +1240,7 @@ const updateDigitalAssetTypedPropertyAbi: EntryFunctionABI = {
  * @param args.digitalAssetAddress - The address of the digital asset to be updated.
  * @param args.digitalAssetType - Optional. The type of the digital asset, if not provided, defaults to the standard type.
  * @param args.options - Optional. Additional options for generating the transaction.
+ * @group Implementation
  */
 export async function updateDigitalAssetTypedPropertyTransaction(args: {
   aptosConfig: AptosConfig;

package/src/internal/event.ts

@@ -6,6 +6,7 @@
  * the {@link api/event}. By moving the methods out into a separate file,
  * other namespaces and processes can access these methods without depending on the entire
  * event namespace and without having a dependency cycle error.
+ * @group Implementation
  */
 
 import { AptosConfig } from "../api/aptosConfig";
@@ -31,6 +32,7 @@ const checkEventTypeLength = (eventType?: InputMaybe<string>) => {
  * @param args.aptosConfig - The configuration object for Aptos.
  * @param args.eventType - The MoveStructId representing the type of event to retrieve.
  * @param [args.options] - Optional pagination and ordering parameters for the event retrieval.
+ * @group Implementation
  */
 export async function getModuleEventsByEventType(args: {
   aptosConfig: AptosConfig;
@@ -64,6 +66,7 @@ export async function getModuleEventsByEventType(args: {
  * @param args.accountAddress - The address of the account for which events are being retrieved.
  * @param args.creationNumber - The creation number to filter events.
  * @param args.options - Optional pagination and ordering parameters for the event retrieval.
+ * @group Implementation
  */
 export async function getAccountEventsByCreationNumber(args: {
   aptosConfig: AptosConfig;
@@ -90,6 +93,7 @@ export async function getAccountEventsByCreationNumber(args: {
  * @param args.accountAddress - The address of the account for which to retrieve events.
  * @param args.eventType - The type of event to filter by.
  * @param args.options - Optional pagination and ordering parameters for the event retrieval.
+ * @group Implementation
  */
 export async function getAccountEventsByEventType(args: {
   aptosConfig: AptosConfig;
@@ -119,6 +123,7 @@ export async function getAccountEventsByEventType(args: {
  * @param [args.options.orderBy] - Defines the order in which to return the events.
  * @param [args.options.where] - Conditions to filter the events.
  * @param [args.options.where.indexed_type] - Filters events by the indexed type.
+ * @group Implementation
  */
 export async function getEvents(args: {
   aptosConfig: AptosConfig;
@@ -136,6 +141,7 @@ export async function getEvents(args: {
    * @param options.offset - The number of items to skip before starting to collect the result set.
    * @param options.limit - The maximum number of items to return.
    * @param options.orderBy - The criteria to sort the results.
+   * @group Implementation
    */
   // eslint-disable-next-line no-underscore-dangle
   checkEventTypeLength(options?.where?.indexed_type?._eq);

package/src/internal/faucet.ts

@@ -6,6 +6,7 @@
  * the {@link api/faucet}. By moving the methods out into a separate file,
  * other namespaces and processes can access these methods without depending on the entire
  * faucet namespace and without having a dependency cycle error.
+ * @group Implementation
  */
 
 import { AptosConfig } from "../api/aptosConfig";
@@ -19,6 +20,9 @@ import { waitForTransaction } from "./transaction";
  * Funds an account with a specified amount of tokens from the Aptos faucet.
  * This function is useful for quickly providing a new or existing account with tokens to facilitate transactions.
  *
+ * Note that only devnet has a publicly accessible faucet. For testnet, you must use
+ * the minting page at https://aptos.dev/network/faucet.
+ *
  * @param args - The arguments for funding the account.
  * @param args.aptosConfig - The configuration settings for connecting to the Aptos network.
  * @param args.accountAddress - The address of the account to be funded.
@@ -28,6 +32,7 @@ import { waitForTransaction } from "./transaction";
  * @param args.options.checkSuccess - A flag indicating whether to check if the transaction was successful.
  *
  * @throws Error if the transaction does not return a user transaction type.
+ * @group Implementation
  */
 export async function fundAccount(args: {
   aptosConfig: AptosConfig;

package/src/internal/fungibleAsset.ts

@@ -6,6 +6,7 @@
  * the {@link api/fungible_asset}. By moving the methods out into a separate file,
  * other namespaces and processes can access these methods without depending on the entire
  * fungible_asset namespace and without having a dependency cycle error.
+ * @group Implementation
  */
 
 import { AptosConfig } from "../api/aptosConfig";
@@ -55,6 +56,7 @@ import { SimpleTransaction } from "../transactions/instances/simpleTransaction";
  * @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.
+ * @group Implementation
  */
 export async function getFungibleAssetMetadata(args: {
   aptosConfig: AptosConfig;
@@ -91,6 +93,7 @@ export async function getFungibleAssetMetadata(args: {
  * @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.
+ * @group Implementation
  */
 export async function getFungibleAssetActivities(args: {
   aptosConfig: AptosConfig;
@@ -126,6 +129,7 @@ export async function getFungibleAssetActivities(args: {
  * @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.
+ * @group Implementation
  */
 export async function getCurrentFungibleAssetBalances(args: {
   aptosConfig: AptosConfig;
@@ -167,6 +171,7 @@ const faTransferAbi: EntryFunctionABI = {
  * @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.
+ * @group Implementation
  */
 export async function transferFungibleAsset(args: {
   aptosConfig: AptosConfig;

package/src/internal/general.ts

@@ -6,6 +6,7 @@
  * the {@link api/general}. By moving the methods out into a separate file,
  * other namespaces and processes can access these methods without depending on the entire
  * general namespace and without having a dependency cycle error.
+ * @group Implementation
  */
 
 import { AptosConfig } from "../api/aptosConfig";
@@ -20,6 +21,7 @@ import { ProcessorType } from "../utils/const";
  *
  * @param args - The arguments for retrieving ledger information.
  * @param args.aptosConfig - The configuration object for connecting to the Aptos network.
+ * @group Implementation
  */
 export async function getLedgerInfo(args: { aptosConfig: AptosConfig }): Promise<LedgerInfo> {
   const { aptosConfig } = args;
@@ -38,6 +40,7 @@ export async function getLedgerInfo(args: { aptosConfig: AptosConfig }): Promise
  * @param args.aptosConfig - The configuration object for Aptos.
  * @param args.limit - The maximum number of transactions to retrieve.
  * @returns An array of user transactions.
+ * @group Implementation
  */
 export async function getChainTopUserTransactions(args: {
   aptosConfig: AptosConfig;
@@ -66,6 +69,7 @@ export async function getChainTopUserTransactions(args: {
  * @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.
+ * @group Implementation
  */
 export async function queryIndexer<T extends {}>(args: {
   aptosConfig: AptosConfig;
@@ -89,6 +93,7 @@ export async function queryIndexer<T extends {}>(args: {
  * @param args - The arguments for the function.
  * @param args.aptosConfig - The configuration object for Aptos.
  * @returns The statuses of the processors.
+ * @group Implementation
  */
 export async function getProcessorStatuses(args: { aptosConfig: AptosConfig }): Promise<GetProcessorStatusResponse> {
   const { aptosConfig } = args;
@@ -112,6 +117,7 @@ export async function getProcessorStatuses(args: { aptosConfig: AptosConfig }):
  * @param args - The arguments for the function.
  * @param args.aptosConfig - The configuration object for Aptos.
  * @returns The last success version as a BigInt.
+ * @group Implementation
  */
 export async function getIndexerLastSuccessVersion(args: { aptosConfig: AptosConfig }): Promise<bigint> {
   const response = await getProcessorStatuses({ aptosConfig: args.aptosConfig });
@@ -126,6 +132,7 @@ export async function getIndexerLastSuccessVersion(args: { aptosConfig: AptosCon
  * @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.
+ * @group Implementation
  */
 export async function getProcessorStatus(args: {
   aptosConfig: AptosConfig;

package/src/internal/keyless.ts

@@ -6,6 +6,7 @@
  * the {@link api/keyless}. By moving the methods out into a separate file,
  * other namespaces and processes can access these methods without depending on the entire
  * keyless namespace and without having a dependency cycle error.
+ * @group Implementation
  */
 import { jwtDecode, JwtPayload } from "jwt-decode";
 import { AptosConfig } from "../api/aptosConfig";
@@ -43,6 +44,7 @@ import { FIREBASE_AUTH_ISS_PATTERN } from "../utils/const";
  * @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.
+ * @group Implementation
  */
 export async function getPepper(args: {
   aptosConfig: AptosConfig;
@@ -82,6 +84,7 @@ export async function getPepper(args: {
  * @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.
+ * @group Implementation
  */
 export async function getProof(args: {
   aptosConfig: AptosConfig;
@@ -154,6 +157,7 @@ export async function getProof(args: {
  * @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.
+ * @group Implementation
  */
 export async function deriveKeylessAccount(args: {
   aptosConfig: AptosConfig;

package/src/internal/object.ts

@@ -17,6 +17,7 @@ import { queryIndexer } from "./general";
  * @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.
+ * @group Implementation
  */
 export async function getObjectData(args: {
   aptosConfig: AptosConfig;
@@ -50,6 +51,7 @@ export async function getObjectData(args: {
  * @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.
+ * @group Implementation
  */
 export async function getObjectDataByObjectAddress(args: {
   aptosConfig: AptosConfig;

package/src/internal/staking.ts

@@ -5,7 +5,8 @@
  * This file contains the underlying implementations for exposed API surface in
  * the {@link api/staking}. By moving the methods out into a separate file,
  * other namespaces and processes can access these methods without depending on the entire
- * faucet namespace and without having a dependency cycle error.
+ * staking namespace and without having a dependency cycle error.
+ * @group Implementation
  */
 
 import { AptosConfig } from "../api/aptosConfig";
@@ -22,6 +23,7 @@ import { queryIndexer } from "./general";
  * @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.
+ * @group Implementation
  */
 export async function getNumberOfDelegators(args: {
   aptosConfig: AptosConfig;
@@ -48,6 +50,7 @@ export async function getNumberOfDelegators(args: {
  * @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.
+ * @group Implementation
  */
 export async function getNumberOfDelegatorsForAllPools(args: {
   aptosConfig: AptosConfig;
@@ -73,6 +76,7 @@ export async function getNumberOfDelegatorsForAllPools(args: {
  * @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.
+ * @group Implementation
  */
 export async function getDelegatedStakingActivities(args: {
   aptosConfig: AptosConfig;

package/src/internal/table.ts

@@ -22,6 +22,7 @@ import { queryIndexer } from "./general";
  * @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.
+ * @group Implementation
  */
 export async function getTableItem<T>(args: {
   aptosConfig: AptosConfig;
@@ -50,6 +51,7 @@ export async function getTableItem<T>(args: {
  * @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.
+ * @group Implementation
  */
 export async function getTableItemsData(args: {
   aptosConfig: AptosConfig;
@@ -87,6 +89,7 @@ export async function getTableItemsData(args: {
  * @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.
+ * @group Implementation
  */
 export async function getTableItemsMetadata(args: {
   aptosConfig: AptosConfig;

package/src/internal/transaction.ts

@@ -6,6 +6,7 @@
  * the {@link api/transaction}. By moving the methods out into a separate file,
  * other namespaces and processes can access these methods without depending on the entire
  * transaction namespace and without having a dependency cycle error.
+ * @group Implementation
  */
 
 import { AptosConfig } from "../api/aptosConfig";
@@ -35,6 +36,7 @@ import { getIndexerLastSuccessVersion, getProcessorStatus } from "./general";
  * @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.
+ * @group Implementation
  */
 export async function getTransactions(args: {
   aptosConfig: AptosConfig;
@@ -55,6 +57,7 @@ export async function getTransactions(args: {
  *
  * @param args - The configuration parameters for the Aptos network.
  * @param args.aptosConfig - The configuration object containing network details.
+ * @group Implementation
  */
 export async function getGasPriceEstimation(args: { aptosConfig: AptosConfig }) {
   const { aptosConfig } = args;
@@ -80,6 +83,7 @@ export async function getGasPriceEstimation(args: { aptosConfig: AptosConfig })
  * @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.
+ * @group Implementation
  */
 export async function getTransactionByVersion(args: {
   aptosConfig: AptosConfig;
@@ -101,6 +105,7 @@ export async function getTransactionByVersion(args: {
  * @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.
+ * @group Implementation
  */
 export async function getTransactionByHash(args: {
   aptosConfig: AptosConfig;
@@ -124,6 +129,7 @@ export async function getTransactionByHash(args: {
  * @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.
+ * @group Implementation
  */
 export async function isTransactionPending(args: {
   aptosConfig: AptosConfig;
@@ -148,6 +154,7 @@ export async function isTransactionPending(args: {
  * @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.
+ * @group Implementation
  */
 export async function longWaitForTransaction(args: {
   aptosConfig: AptosConfig;
@@ -175,6 +182,7 @@ export async function longWaitForTransaction(args: {
  * @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.
+ * @group Implementation
  */
 export async function waitForTransaction(args: {
   aptosConfig: AptosConfig;
@@ -197,6 +205,7 @@ export async function waitForTransaction(args: {
    *
    * @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.
+   * @group Implementation
    */
   function handleAPIError(e: any) {
     // In short, this means we will retry if it was an AptosApiError and the code was 404 or 5xx.
@@ -292,6 +301,7 @@ export async function waitForTransaction(args: {
  * @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.
+ * @group Implementation
  */
 export async function waitForIndexer(args: {
   aptosConfig: AptosConfig;
@@ -338,6 +348,7 @@ export async function waitForIndexer(args: {
  *
  * @param message - A descriptive message for the error.
  * @param lastSubmittedTransaction - The last submitted transaction response, if available.
+ * @group Implementation
  */
 export class WaitForTransactionError extends Error {
   public readonly lastSubmittedTransaction: TransactionResponse | undefined;
@@ -347,6 +358,7 @@ export class WaitForTransactionError extends Error {
    *
    * @param message - The message associated with the transaction.
    * @param lastSubmittedTransaction - The transaction response object containing details about the transaction.
+   * @group Implementation
    */
   constructor(message: string, lastSubmittedTransaction: TransactionResponse | undefined) {
     super(message);
@@ -360,6 +372,7 @@ export class WaitForTransactionError extends Error {
  *
  * @param message - A description of the error.
  * @param transaction - The transaction response associated with the failure.
+ * @group Implementation
  */
 export class FailedTransactionError extends Error {
   public readonly transaction: TransactionResponse;
@@ -379,6 +392,7 @@ export class FailedTransactionError extends Error {
  * @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.
+ * @group Implementation
  */
 export async function getBlockByVersion(args: {
   aptosConfig: AptosConfig;
@@ -405,6 +419,7 @@ export async function getBlockByVersion(args: {
  * @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.
+ * @group Implementation
  */
 export async function getBlockByHeight(args: {
   aptosConfig: AptosConfig;
@@ -429,6 +444,7 @@ export async function getBlockByHeight(args: {
  * @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.
+ * @group Implementation
  */
 async function fillBlockTransactions(args: {
   aptosConfig: AptosConfig;