@aptos-labs/ts-sdk 1.33.1 → 1.33.2

package/src/core/crypto/singleKey.ts

@@ -1,13 +1,15 @@
 import { Deserializer, Serializer } from "../../bcs";
 import { AnyPublicKeyVariant, AnySignatureVariant, SigningScheme as AuthenticationKeyScheme } from "../../types";
 import { AuthenticationKey } from "../authenticationKey";
-import { Ed25519PublicKey, Ed25519Signature } from "./ed25519";
+import { Ed25519PrivateKey, Ed25519PublicKey, Ed25519Signature } from "./ed25519";
 import { AccountPublicKey, PublicKey, VerifySignatureArgs } from "./publicKey";
-import { Secp256k1PublicKey, Secp256k1Signature } from "./secp256k1";
+import { Secp256k1PrivateKey, Secp256k1PublicKey, Secp256k1Signature } from "./secp256k1";
 import { KeylessPublicKey, KeylessSignature } from "./keyless";
 import { Signature } from "./signature";
 import { FederatedKeylessPublicKey } from "./federatedKeyless";
 
+export type PrivateKeyInput = Ed25519PrivateKey | Secp256k1PrivateKey;
+
 /**
  * Represents any public key supported by Aptos.
  *
@@ -15,15 +17,21 @@ import { FederatedKeylessPublicKey } from "./federatedKeyless";
  * `Legacy` and `Unified` authentication keys.
  *
  * Any unified authentication key is represented in the SDK as `AnyPublicKey`.
+ * @group Implementation
+ * @category Serialization
  */
 export class AnyPublicKey extends AccountPublicKey {
   /**
    * Reference to the inner public key
+   * @group Implementation
+   * @category Serialization
    */
   public readonly publicKey: PublicKey;
 
   /**
    * Index of the underlying enum variant
+   * @group Implementation
+   * @category Serialization
    */
   public readonly variant: AnyPublicKeyVariant;
 
@@ -35,6 +43,8 @@ export class AnyPublicKey extends AccountPublicKey {
    *
    * @param publicKey - The publicKey object which determines the variant to be used.
    * @throws Error if the provided signature type is unsupported.
+   * @group Implementation
+   * @category Serialization
    */
   constructor(publicKey: PublicKey) {
     super();
@@ -64,6 +74,8 @@ export class AnyPublicKey extends AccountPublicKey {
    * @param args.message - The message that was signed.
    * @param args.signature - The signature to verify, which must be an instance of AnySignature.
    * @returns A boolean indicating whether the signature is valid for the given message.
+   * @group Implementation
+   * @category Serialization
    */
   verifySignature(args: VerifySignatureArgs): boolean {
     const { message, signature } = args;
@@ -82,6 +94,8 @@ export class AnyPublicKey extends AccountPublicKey {
    * This function is essential for creating a unique identifier for authentication purposes.
    *
    * @returns {AuthenticationKey} The generated authentication key.
+   * @group Implementation
+   * @category Serialization
    */
   authKey(): AuthenticationKey {
     return AuthenticationKey.fromSchemeAndBytes({
@@ -97,6 +111,8 @@ export class AnyPublicKey extends AccountPublicKey {
    * Use AnySignature.bcsToBytes() instead.
    *
    * @returns Uint8Array representation of the signature.
+   * @group Implementation
+   * @category Serialization
    */
   toUint8Array() {
     return this.bcsToBytes();
@@ -111,6 +127,8 @@ export class AnyPublicKey extends AccountPublicKey {
    * This function helps in converting the object into a format suitable for transmission or storage.
    *
    * @param serializer - The serializer instance used to perform the serialization.
+   * @group Implementation
+   * @category Serialization
    */
   serialize(serializer: Serializer): void {
     serializer.serializeU32AsUleb128(this.variant);
@@ -122,6 +140,8 @@ export class AnyPublicKey extends AccountPublicKey {
    * This function helps in reconstructing the AnySignature object from its serialized form, allowing for further processing or validation.
    *
    * @param deserializer - The deserializer instance used to read the serialized data.
+   * @group Implementation
+   * @category Serialization
    */
   static deserialize(deserializer: Deserializer): AnyPublicKey {
     const variantIndex = deserializer.deserializeUleb128AsU32();
@@ -151,6 +171,8 @@ export class AnyPublicKey extends AccountPublicKey {
    *
    * @param publicKey - The public key to check.
    * @deprecated Use `instanceof AnyPublicKey` instead.
+   * @group Implementation
+   * @category Serialization
    */
   static isPublicKey(publicKey: AccountPublicKey): publicKey is AnyPublicKey {
     return publicKey instanceof AnyPublicKey;
@@ -160,6 +182,8 @@ export class AnyPublicKey extends AccountPublicKey {
    * Determines if the current public key is an instance of Ed25519PublicKey.
    *
    * @deprecated use `publicKey instanceof Ed25519PublicKey` instead.
+   * @group Implementation
+   * @category Serialization
    */
   isEd25519(): boolean {
     return this.publicKey instanceof Ed25519PublicKey;
@@ -169,6 +193,8 @@ export class AnyPublicKey extends AccountPublicKey {
    * Checks if the public key is an instance of Secp256k1PublicKey.
    *
    * @deprecated use `publicKey instanceof Secp256k1PublicKey` instead.
+   * @group Implementation
+   * @category Serialization
    */
   isSecp256k1PublicKey(): boolean {
     return this.publicKey instanceof Secp256k1PublicKey;
@@ -180,6 +206,8 @@ export class AnyPublicKey extends AccountPublicKey {
    * @param publicKey - The publicKey to be checked for validity.
    * @param publicKey.publicKey - The actual publicKey object that needs to be validated.
    * @returns True if the signature is a valid instance; otherwise, false.
+   * @group Implementation
+   * @category Serialization
    */
   static isInstance(publicKey: PublicKey): publicKey is AnyPublicKey {
     return "publicKey" in publicKey && "variant" in publicKey;
@@ -192,12 +220,16 @@ export class AnyPublicKey extends AccountPublicKey {
  * only be generated by a `SingleKeySigner` due to the shared authentication mechanism.
  *
  * @extends Signature
+ * @group Implementation
+ * @category Serialization
  */
 export class AnySignature extends Signature {
   public readonly signature: Signature;
 
   /**
    * Index of the underlying enum variant
+   * @group Implementation
+   * @category Serialization
    */
   private readonly variant: AnySignatureVariant;
 

package/src/core/crypto/utils.ts

@@ -7,6 +7,8 @@ import { Hex } from "../hex";
  * @param message a message as a string or Uint8Array
  *
  * @returns a valid HexInput - string or Uint8Array
+ * @group Implementation
+ * @category Serialization
  */
 export const convertSigningMessage = (message: HexInput): HexInput => {
   // if message is of type string, verify it is a valid Hex string

package/src/core/hex.ts

@@ -7,6 +7,8 @@ import { HexInput } from "../types";
 
 /**
  * Provides reasons for parsing failures related to hexadecimal values.
+ * @group Implementation
+ * @category Serialization
  */
 export enum HexInvalidReason {
   TOO_SHORT = "too_short",
@@ -37,6 +39,8 @@ export enum HexInvalidReason {
  * Other ways to chain the functions together:
  * - `Hex.fromHexString({ hexInput: "0x1f" }).toUint8Array()`
  * - `new Hex([1, 3]).toStringWithoutPrefix()`
+ * @group Implementation
+ * @category Serialization
  */
 export class Hex {
   private readonly data: Uint8Array;
@@ -45,6 +49,8 @@ export class Hex {
    * Create a new Hex instance from a Uint8Array.
    *
    * @param data - The Uint8Array containing the data to initialize the Hex instance.
+   * @group Implementation
+   * @category Serialization
    */
   constructor(data: Uint8Array) {
     this.data = data;
@@ -58,6 +64,8 @@ export class Hex {
    * Get the inner hex data as a Uint8Array. The inner data is already a Uint8Array, so no conversion takes place.
    *
    * @returns Hex data as Uint8Array
+   * @group Implementation
+   * @category Serialization
    */
   toUint8Array(): Uint8Array {
     return this.data;
@@ -67,6 +75,8 @@ export class Hex {
    * Get the hex data as a string without the 0x prefix.
    *
    * @returns Hex string without 0x prefix
+   * @group Implementation
+   * @category Serialization
    */
   toStringWithoutPrefix(): string {
     return bytesToHex(this.data);
@@ -76,6 +86,8 @@ export class Hex {
    * Get the hex data as a string with the 0x prefix.
    *
    * @returns Hex string with 0x prefix
+   * @group Implementation
+   * @category Serialization
    */
   toString(): string {
     return `0x${this.toStringWithoutPrefix()}`;
@@ -93,6 +105,8 @@ export class Hex {
    * @throws ParsingError - If the hex string is too short, has an odd number of characters, or contains invalid hex characters.
    *
    * @returns Hex - The resulting Hex instance created from the provided string.
+   * @group Implementation
+   * @category Serialization
    */
   static fromHexString(str: string): Hex {
     let input = str;
@@ -128,6 +142,8 @@ export class Hex {
    *
    * @param hexInput - A HexInput which can be a string or Uint8Array.
    * @returns A Hex instance created from the provided hexInput.
+   * @group Implementation
+   * @category Serialization
    */
   static fromHexInput(hexInput: HexInput): Hex {
     if (hexInput instanceof Uint8Array) return new Hex(hexInput);
@@ -192,6 +208,8 @@ export class Hex {
    *  - valid: A boolean indicating whether the string is valid.
    *  - invalidReason: The reason for invalidity if the string is not valid.
    *  - invalidReasonMessage: A message explaining why the string is invalid.
+   * @group Implementation
+   * @category Serialization
    */
   static isValid(str: string): ParsingResult<HexInvalidReason> {
     try {
@@ -211,6 +229,8 @@ export class Hex {
    *
    * @param other The Hex instance to compare to.
    * @returns true if the Hex instances are equal, false if not.
+   * @group Implementation
+   * @category Serialization
    */
   equals(other: Hex): boolean {
     if (this.data.length !== other.data.length) return false;

package/src/internal/account.ts

@@ -6,9 +6,10 @@
  * the {@link api/account}. By moving the methods out into a separate file,
  * other namespaces and processes can access these methods without depending on the entire
  * account namespace and without having a dependency cycle error.
+ * @group Implementation
  */
 import { AptosConfig } from "../api/aptosConfig";
-import { getAptosFullNode, paginateWithCursor } from "../client";
+import { getAptosFullNode, paginateWithCursor, paginateWithObfuscatedCursor } from "../client";
 import {
   AccountData,
   GetAccountCoinsDataResponse,
@@ -63,6 +64,7 @@ import { AptosApiError } from "../errors";
  * @param args - The arguments for retrieving account information.
  * @param args.aptosConfig - The configuration object for Aptos.
  * @param args.accountAddress - The address of the account to retrieve information for.
+ * @group Implementation
  */
 export async function getInfo(args: {
   aptosConfig: AptosConfig;
@@ -85,8 +87,9 @@ export async function getInfo(args: {
  * @param args.accountAddress - The address of the account whose modules are to be retrieved.
  * @param args.options - Optional parameters for pagination and ledger version.
  * @param args.options.limit - The maximum number of modules to retrieve (default is 1000).
- * @param args.options.offset - The starting point for pagination.
+ * @param args.options.offset - The starting point for pagination.  Note, this is obfuscated and is not an index.
  * @param args.options.ledgerVersion - The specific ledger version to query.
+ * @group Implementation
  */
 export async function getModules(args: {
   aptosConfig: AptosConfig;
@@ -94,13 +97,13 @@ export async function getModules(args: {
   options?: PaginationArgs & LedgerVersionArg;
 }): Promise<MoveModuleBytecode[]> {
   const { aptosConfig, accountAddress, options } = args;
-  return paginateWithCursor<{}, MoveModuleBytecode[]>({
+  return paginateWithObfuscatedCursor<{}, MoveModuleBytecode[]>({
     aptosConfig,
     originMethod: "getModules",
     path: `accounts/${AccountAddress.from(accountAddress).toString()}/modules`,
     params: {
       ledger_version: options?.ledgerVersion,
-      start: options?.offset,
+      offset: options?.offset,
       limit: options?.limit ?? 1000,
     },
   });
@@ -117,6 +120,7 @@ export async function getModules(args: {
  * @param args.options - Optional parameters for the request.
  * @param args.options.ledgerVersion - Specifies the ledger version of transactions. By default, the latest version will be used.
  * @returns The move module.
+ * @group Implementation
  */
 export async function getModule(args: {
   aptosConfig: AptosConfig;
@@ -146,6 +150,7 @@ export async function getModule(args: {
  * @param args.moduleName - The name of the module to retrieve.
  * @param args.options - Optional parameters for specifying the ledger version.
  * @param args.options.ledgerVersion - The specific ledger version to query.
+ * @group Implementation
  */
 async function getModuleInner(args: {
   aptosConfig: AptosConfig;
@@ -174,6 +179,7 @@ async function getModuleInner(args: {
  * @param args.options - Optional pagination parameters.
  * @param args.options.offset - The starting point for pagination.
  * @param args.options.limit - The maximum number of transactions to retrieve.
+ * @group Implementation
  */
 export async function getTransactions(args: {
   aptosConfig: AptosConfig;
@@ -196,9 +202,10 @@ export async function getTransactions(args: {
  * @param args.aptosConfig - The configuration settings for Aptos.
  * @param args.accountAddress - The address of the account to fetch resources for.
  * @param args.options - Optional pagination and ledger version parameters.
- * @param args.options.offset - The starting point for pagination.
+ * @param args.options.offset - The starting point for pagination.  Note, this is obfuscated and is not an index.
  * @param args.options.limit - The maximum number of resources to retrieve (default is 999).
  * @param args.options.ledgerVersion - The specific ledger version to query.
+ * @group Implementation
  */
 export async function getResources(args: {
   aptosConfig: AptosConfig;
@@ -206,13 +213,13 @@ export async function getResources(args: {
   options?: PaginationArgs & LedgerVersionArg;
 }): Promise<MoveResource[]> {
   const { aptosConfig, accountAddress, options } = args;
-  return paginateWithCursor<{}, MoveResource[]>({
+  return paginateWithObfuscatedCursor<{}, MoveResource[]>({
     aptosConfig,
     originMethod: "getResources",
     path: `accounts/${AccountAddress.from(accountAddress).toString()}/resources`,
     params: {
       ledger_version: options?.ledgerVersion,
-      start: options?.offset,
+      offset: options?.offset,
       limit: options?.limit ?? 999,
     },
   });
@@ -226,6 +233,7 @@ export async function getResources(args: {
  * @param args.accountAddress - The address of the account from which to retrieve the resource.
  * @param args.resourceType - The type of the resource to retrieve, specified as a MoveStructId.
  * @param args.options - Optional parameters for specifying the ledger version.
+ * @group Implementation
  */
 export async function getResource<T extends {}>(args: {
   aptosConfig: AptosConfig;
@@ -252,6 +260,7 @@ export async function getResource<T extends {}>(args: {
  * @param args.options - Optional parameters for specifying the ledger version.
  * @returns The original account address or the provided authentication key address if not found.
  * @throws Throws an error if the lookup fails for reasons other than the address not being found.
+ * @group Implementation
  */
 export async function lookupOriginalAccountAddress(args: {
   aptosConfig: AptosConfig;
@@ -306,6 +315,7 @@ export async function lookupOriginalAccountAddress(args: {
  * @param args.aptosConfig - The configuration settings for the Aptos network.
  * @param args.accountAddress - The address of the account for which to count the tokens.
  * @returns The count of tokens owned by the specified account.
+ * @group Implementation
  */
 export async function getAccountTokensCount(args: {
   aptosConfig: AptosConfig;
@@ -350,6 +360,7 @@ export async function getAccountTokensCount(args: {
  * @param args.options.limit - The maximum number of records to return.
  * @param args.options.orderBy - The criteria for ordering the results.
  * @returns A promise that resolves to the current token ownerships of the specified account.
+ * @group Implementation
  */
 export async function getAccountOwnedTokens(args: {
   aptosConfig: AptosConfig;
@@ -397,6 +408,7 @@ export async function getAccountOwnedTokens(args: {
  * @param args.collectionAddress - The address of the collection from which tokens are being retrieved.
  * @param args.options - Optional parameters for filtering and pagination, including token standard, pagination arguments, and
  * order by options.
+ * @group Implementation
  */
 export async function getAccountOwnedTokensFromCollectionAddress(args: {
   aptosConfig: AptosConfig;
@@ -453,6 +465,7 @@ export async function getAccountOwnedTokensFromCollectionAddress(args: {
  * @param args.options.offset - An optional offset for pagination.
  * @param args.options.limit - An optional limit for the number of results returned.
  * @param args.options.orderBy - An optional parameter to specify the order of the results.
+ * @group Implementation
  */
 export async function getAccountCollectionsWithOwnedTokens(args: {
   aptosConfig: AptosConfig;
@@ -501,6 +514,7 @@ export async function getAccountCollectionsWithOwnedTokens(args: {
  * @param args.aptosConfig - The configuration settings for Aptos.
  * @param args.accountAddress - The address of the account for which to retrieve the transaction count.
  * @returns The number of transactions associated with the specified account.
+ * @group Implementation
  */
 export async function getAccountTransactionsCount(args: {
   aptosConfig: AptosConfig;
@@ -536,6 +550,7 @@ export async function getAccountTransactionsCount(args: {
  * @param args.faMetadataAddress - Optional; the address of the fungible asset metadata.
  * @returns The amount of the specified coin held by the account, or 0 if none is found.
  * @throws Error if neither coinType nor faMetadataAddress is provided.
+ * @group Implementation
  */
 export async function getAccountCoinAmount(args: {
   aptosConfig: AptosConfig;
@@ -600,6 +615,7 @@ export async function getAccountCoinAmount(args: {
  * @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 - Conditions to filter the results based on the current fungible asset balances.
+ * @group Implementation
  */
 export async function getAccountCoinsData(args: {
   aptosConfig: AptosConfig;
@@ -640,6 +656,7 @@ export async function getAccountCoinsData(args: {
  * @param args.aptosConfig - The configuration settings for the Aptos network.
  * @param args.accountAddress - The address of the account for which to retrieve the coin count.
  * @throws Error if the count of account coins cannot be retrieved.
+ * @group Implementation
  */
 export async function getAccountCoinsCount(args: {
   aptosConfig: AptosConfig;
@@ -677,6 +694,7 @@ export async function getAccountCoinsCount(args: {
  * @param args.options.limit - The maximum number of items to return.
  * @param args.options.orderBy - The criteria to order the results by.
  * @returns A promise that resolves to the current objects owned by the specified account.
+ * @group Implementation
  */
 export async function getAccountOwnedObjects(args: {
   aptosConfig: AptosConfig;
@@ -721,6 +739,7 @@ export async function getAccountOwnedObjects(args: {
  * @param args.aptosConfig - The Aptos configuration used for account lookup.
  * @param args.privateKey - The private key used to derive the account.
  * @throws Error if the account cannot be derived from the private key.
+ * @group Implementation
  */
 export async function deriveAccountFromPrivateKey(args: {
   aptosConfig: AptosConfig;
@@ -773,6 +792,7 @@ export async function deriveAccountFromPrivateKey(args: {
  * @returns A promise that resolves to a boolean indicating whether the account exists.
  *
  * @throws Throws an Error if there is an issue while looking for account information.
+ * @group Implementation
  */
 export async function isAccountExist(args: { aptosConfig: AptosConfig; authKey: AuthenticationKey }): Promise<boolean> {
   const { aptosConfig, authKey } = args;

package/src/internal/ans.ts

@@ -6,6 +6,7 @@
  * the {@link api/name}. By moving the methods out into a separate file,
  * other namespaces and processes can access these methods without depending on the entire
  * name namespace and without having a dependency cycle error.
+ * @group Implementation
  */
 
 import { AptosConfig } from "../api/aptosConfig";
@@ -34,6 +35,7 @@ export const VALIDATION_RULES_DESCRIPTION = [
  *
  * @param fragment - A fragment of a name, either the domain or subdomain.
  * @returns A boolean indicating if the fragment is a valid fragment.
+ * @group Implementation
  */
 export function isValidANSSegment(fragment: string): boolean {
   if (!fragment) return false;
@@ -48,6 +50,7 @@ export function isValidANSSegment(fragment: string): boolean {
  * Checks if an ANS name is valid or not.
  *
  * @param name - A string of the domain name, which can include or exclude the .apt suffix.
+ * @group Implementation
  */
 export function isValidANSName(name: string): { domainName: string; subdomainName?: string } {
   const [first, second, ...rest] = name.replace(/\.apt$/, "").split(".");
@@ -72,6 +75,7 @@ export function isValidANSName(name: string): { domainName: string; subdomainNam
 
 /**
  * Policy for determining how subdomains expire in relation to their parent domain.
+ * @group Implementation
  */
 export enum SubdomainExpirationPolicy {
   Independent = 0,
@@ -86,6 +90,7 @@ export enum SubdomainExpirationPolicy {
  *
  * @param name - An ANS name returned from one of the functions of the SDK.
  * @returns A boolean indicating whether the contract considers the name active or not.
+ * @group Implementation
  */
 export function isActiveANSName(name: GetANSNameResponse[0]): boolean {
   if (!name) return false;
@@ -126,6 +131,7 @@ const NetworkToAnsContract: Record<Network, string | null> = {
  * @param aptosConfig.network - The network for which to retrieve the ANS contract address.
  *
  * @throws Throws an error if the ANS contract is not deployed to the specified network.
+ * @group Implementation
  */
 function getRouterAddress(aptosConfig: AptosConfig): string {
   const address = NetworkToAnsContract[aptosConfig.network];
@@ -148,6 +154,7 @@ const unwrapOption = <T>(option: any): T | undefined => {
  * @param args.aptosConfig - The Aptos configuration object.
  * @param args.name - The name of the domain or subdomain to query.
  * @returns The account address of the owner, or undefined if not found.
+ * @group Implementation
  */
 export async function getOwnerAddress(args: {
   aptosConfig: AptosConfig;
@@ -177,6 +184,7 @@ export async function getOwnerAddress(args: {
  * @param sender - The account initiating the name registration.
  * @param name - The name to be registered.
  * @param expiration - The expiration policy for the name registration.
+ * @group Implementation
  */
 export interface RegisterNameParameters {
   aptosConfig: AptosConfig;
@@ -211,6 +219,7 @@ export interface RegisterNameParameters {
  * @throws Error if the subdomain expiration time exceeds the domain expiration time.
  *
  * @returns A transaction object representing the registration process.
+ * @group Implementation
  */
 export async function registerName(args: RegisterNameParameters): Promise<SimpleTransaction> {
   const { aptosConfig, expiration, name, sender, targetAddress, toAddress, options, transferable } = args;
@@ -297,6 +306,7 @@ export async function registerName(args: RegisterNameParameters): Promise<Simple
  * @param args.aptosConfig - The configuration object for Aptos.
  * @param args.name - The name of the domain or subdomain to check.
  * @returns The expiration time in epoch milliseconds, or undefined if an error occurs.
+ * @group Implementation
  */
 export async function getExpiration(args: { aptosConfig: AptosConfig; name: string }): Promise<number | undefined> {
   const { aptosConfig, name } = args;
@@ -327,6 +337,7 @@ export async function getExpiration(args: { aptosConfig: AptosConfig; name: stri
  * @param args.aptosConfig - The Aptos configuration object.
  * @param args.address - The account address for which to retrieve the primary name.
  * @returns The primary name as a string, or undefined if no domain name exists.
+ * @group Implementation
  */
 export async function getPrimaryName(args: {
   aptosConfig: AptosConfig;
@@ -361,6 +372,7 @@ export async function getPrimaryName(args: {
  * @param args.name - The name to set as the primary name. If omitted, the function will clear the primary name.
  * @param args.options - Optional transaction generation options.
  * @returns A transaction object representing the operation.
+ * @group Implementation
  */
 export async function setPrimaryName(args: {
   aptosConfig: AptosConfig;
@@ -407,6 +419,7 @@ export async function setPrimaryName(args: {
  * @param args.aptosConfig - The Aptos configuration object.
  * @param args.name - The name of the domain, which may include a subdomain.
  * @returns The target address as an AccountAddress, or undefined if not found.
+ * @group Implementation
  */
 export async function getTargetAddress(args: {
   aptosConfig: AptosConfig;
@@ -440,6 +453,7 @@ export async function getTargetAddress(args: {
  * @param args.options - Optional parameters for generating the transaction.
  *
  * @returns A transaction object representing the set target address operation.
+ * @group Implementation
  */
 export async function setTargetAddress(args: {
   aptosConfig: AptosConfig;
@@ -472,6 +486,7 @@ export async function setTargetAddress(args: {
  * @param args.aptosConfig - The configuration object for Aptos.
  * @param args.name - The name to look up, which includes the domain and optional subdomain.
  * @returns The active Aptos name if it exists; otherwise, returns undefined.
+ * @group Implementation
  */
 export async function getName(args: {
   aptosConfig: AptosConfig;
@@ -510,6 +525,7 @@ export async function getName(args: {
  * Options for querying names, including pagination, ordering, and filtering criteria.
  *
  * @param options - Pagination and filtering options for the query.
+ * @group Implementation
  */
 interface QueryNamesOptions {
   options?: PaginationArgs & OrderByArg<GetANSNameResponse[0]> & WhereArg<CurrentAptosNamesBoolExp>;
@@ -519,6 +535,7 @@ interface QueryNamesOptions {
  * Arguments for retrieving account names based on the specified account address.
  *
  * @param accountAddress - The address of the account for which names are to be retrieved.
+ * @group Implementation
  */
 export interface GetAccountNamesArgs extends QueryNamesOptions {
   accountAddress: AccountAddressInput;
@@ -537,6 +554,7 @@ export interface GetAccountNamesArgs extends QueryNamesOptions {
  * @param args.accountAddress - The address of the account for which to retrieve names.
  *
  * @returns An array of sanitized Aptos names associated with the specified account address.
+ * @group Implementation
  */
 export async function getAccountNames(
   args: { aptosConfig: AptosConfig } & GetAccountNamesArgs,
@@ -570,6 +588,7 @@ export async function getAccountNames(
  * Arguments for retrieving the domains associated with a specific account.
  *
  * @param accountAddress - The address of the account for which to fetch domains.
+ * @group Implementation
  */
 export interface GetAccountDomainsArgs extends QueryNamesOptions {
   accountAddress: AccountAddressInput;
@@ -590,6 +609,7 @@ export interface GetAccountDomainsArgs extends QueryNamesOptions {
  * @param args.options.where.subdomain - The specific subdomain to filter by.
  *
  * @returns An array of sanitized domain names owned by the specified account.
+ * @group Implementation
  */
 export async function getAccountDomains(
   args: { aptosConfig: AptosConfig } & GetAccountDomainsArgs,
@@ -624,6 +644,7 @@ export async function getAccountDomains(
  * Arguments for retrieving subdomains associated with a specific account.
  *
  * @param accountAddress - The address of the account for which to fetch subdomains.
+ * @group Implementation
  */
 export interface GetAccountSubdomainsArgs extends QueryNamesOptions {
   accountAddress: AccountAddressInput;
@@ -644,6 +665,7 @@ export interface GetAccountSubdomainsArgs extends QueryNamesOptions {
  * @param args.options.where.expiration_timestamp - The expiration timestamp to filter by.
  * @param args.options.where.subdomain - The subdomain condition to filter by.
  * @param args.accountAddress - The address of the account whose subdomains are being queried.
+ * @group Implementation
  */
 export async function getAccountSubdomains(
   args: { aptosConfig: AptosConfig } & GetAccountSubdomainsArgs,
@@ -678,6 +700,7 @@ export async function getAccountSubdomains(
  * Arguments for retrieving subdomains associated with a specific domain.
  *
  * @param domain - The domain for which to fetch subdomains.
+ * @group Implementation
  */
 export interface GetDomainSubdomainsArgs extends QueryNamesOptions {
   domain: string;
@@ -696,6 +719,7 @@ export interface GetDomainSubdomainsArgs extends QueryNamesOptions {
  * @param args.domain - The domain for which to retrieve subdomains.
  *
  * @returns An array of active subdomain names.
+ * @group Implementation
  */
 export async function getDomainSubdomains(
   args: { aptosConfig: AptosConfig } & GetDomainSubdomainsArgs,
@@ -734,6 +758,7 @@ export async function getDomainSubdomains(
  * @param args - The arguments for the function.
  * @param args.aptosConfig - An AptosConfig object containing the configuration settings.
  * @returns The expiration date in ISO 8601 format.
+ * @group Implementation
  */
 async function getANSExpirationDate(args: { aptosConfig: AptosConfig }): Promise<string> {
   const { aptosConfig } = args;
@@ -762,6 +787,7 @@ async function getANSExpirationDate(args: { aptosConfig: AptosConfig }): Promise
  * @param args.years - The number of years to renew the domain for. Currently, only 1 year renewals are supported. (optional, default is 1)
  * @param args.options - Additional options for generating the transaction. (optional)
  * @throws Error if the name contains a subdomain or if the years parameter is not equal to 1.
+ * @group Implementation
  */
 export async function renewDomain(args: {
   aptosConfig: AptosConfig;
@@ -804,6 +830,7 @@ export async function renewDomain(args: {
  *
  * @param name - The ANS name response to sanitize.
  * @param name.expiration_timestamp - The expiration timestamp in ISO string format.
+ * @group Implementation
  */
 function sanitizeANSName(name: GetANSNameResponse[0]): GetANSNameResponse[0] {
   return {

package/src/internal/coin.ts

@@ -23,6 +23,7 @@ const coinTransferAbi: EntryFunctionABI = {
  * @param args.amount - The amount of coins to transfer.
  * @param args.coinType - (Optional) The type of coin to transfer, defaults to Aptos Coin if not specified.
  * @param args.options - (Optional) Options for generating the transaction.
+ * @group Implementation
  */
 export async function transferCoinTransaction(args: {
   aptosConfig: AptosConfig;