@aptos-labs/ts-sdk 1.33.1 → 1.33.2-sc.0

package/src/cli/move.ts

@@ -8,6 +8,8 @@ import { Network } from "../utils";
  * Class representing a Move package management utility for the Aptos blockchain.
  * This class provides methods to initialize directories, compile packages, run tests, publish modules, create objects, upgrade
  * packages, build transaction payloads, and run scripts.
+ * @group Implementation
+ * @category CLI
  */
 export class Move {
   /**
@@ -21,6 +23,8 @@ export class Move {
    * @param args.extraArguments - Optional extra arguments to include in the form of an array of strings.
    * Ex. ["--assume-yes","--gas-unit-price=10"]
    * @returns stdout
+   * @group Implementation
+   * @category CLI
    */
   async init(args: {
     network?: Network;
@@ -48,6 +52,8 @@ export class Move {
    * @param args.extraArguments - Optional extra arguments to include in the form of an array of strings.
    * Ex. ["--assume-yes","--gas-unit-price=10"]
    * @returns stdout
+   * @group Implementation
+   * @category CLI
    */
   async compile(args: {
     packageDirectoryPath: string;
@@ -78,6 +84,8 @@ export class Move {
    * @param args.extraArguments - Optional extra arguments to include in the form of an array of strings.
    * Ex. ["--assume-yes","--gas-unit-price=10"]
    * @returns The stdout output from running the tests.
+   * @group Implementation
+   * @category CLI
    */
   async test(args: {
     packageDirectoryPath: string;
@@ -109,6 +117,8 @@ export class Move {
    * @param args.extraArguments - Optional extra arguments to include in the form of an array of strings.
    * Ex. ["--assume-yes","--gas-unit-price=10"]
    * @returns stdout
+   * @group Implementation
+   * @category CLI
    */
   async publish(args: {
     packageDirectoryPath: string;
@@ -157,6 +167,8 @@ export class Move {
    * --named-addresses "launchpad_addr=0x123,initial_creator_addr=0x456" \
    * --profile my_profile \
    * --assume-yes
+   * @group Implementation
+   * @category CLI
    */
   async createObjectAndPublishPackage(args: {
     packageDirectoryPath: string;
@@ -202,6 +214,8 @@ export class Move {
    * @param args.extraArguments - Optional extra arguments to include in the form of an array of strings.
    * Ex. ["--assume-yes","--gas-unit-price=10"]
    * @returns stdout
+   * @group Implementation
+   * @category CLI
    */
   async upgradeObjectPackage(args: {
     packageDirectoryPath: string;
@@ -244,6 +258,8 @@ export class Move {
    * @param args.extraArguments - Optional extra arguments to include in the form of an array of strings.
    * Ex. ["--assume-yes","--gas-unit-price=10"]   *
    * @returns stdout
+   * @group Implementation
+   * @category CLI
    */
   async buildPublishPayload(args: {
     packageDirectoryPath: string;
@@ -286,6 +302,8 @@ export class Move {
    * Ex. ["--assume-yes","--gas-unit-price=10"]
    *
    * @returns The standard output from running the script.
+   * @group Implementation
+   * @category CLI
    */
   async runScript(args: {
     compiledScriptPath: string;
@@ -332,6 +350,8 @@ export class Move {
    * @param args - An array of strings representing the command-line arguments to be passed to the command.
    * @param showStdout - Show the standard output generated by the command.
    * @returns The standard output generated by the command.
+   * @group Implementation
+   * @category CLI
    */
   // eslint-disable-next-line class-methods-use-this
   private async runCommand(args: Array<string>, showStdout: boolean = true): Promise<{ result?: any; output: string }> {
@@ -388,6 +408,8 @@ export class Move {
    * @param namedAddresses - A Map where the key is a string representing the name and the value is an AccountAddress.
    * Ex. {'alice' => '0x123', 'bob' => '0x456'}
    * @returns An array of named addresses formatted as strings separated by a comma. Ex. "alice=0x123,bob=0x456"
+   * @group Implementation
+   * @category CLI
    */
   // eslint-disable-next-line class-methods-use-this
   private prepareNamedAddresses(namedAddresses: Map<string, AccountAddress>): Array<string> {
@@ -417,6 +439,8 @@ export class Move {
    *
    * @param namedAddresses - A record containing named addresses where the key is the name and the value is the AccountAddress.
    * @returns A Map where each key is a name and each value is the corresponding address.
+   * @group Implementation
+   * @category CLI
    */
   // eslint-disable-next-line class-methods-use-this
   private parseNamedAddresses(namedAddresses: Record<string, AccountAddress>): Map<string, AccountAddress> {
@@ -436,6 +460,8 @@ export class Move {
    * @param output - The output string containing the object address.
    * @returns The extracted object address.
    * @throws Error if the object address cannot be extracted from the output.
+   * @group Implementation
+   * @category CLI
    */
   // eslint-disable-next-line class-methods-use-this
   private extractAddressFromOutput(output: string): string {

package/src/client/core.ts

@@ -24,6 +24,8 @@ import { AptosApiError } from "../errors";
  * @param client - The client used to make the request.
  *
  * @returns The response from the request.
+ * @group Implementation
+ * @category Client
  */
 export async function request<Req, Res>(options: ClientRequest<Req>, client: Client): Promise<ClientResponse<Res>> {
   const { url, method, body, contentType, params, overrides, originMethod } = options;
@@ -62,6 +64,8 @@ export async function request<Req, Res>(options: ClientRequest<Req>, client: Cli
  * @param aptosConfig - The configuration information for the SDK client instance.
  * @param apiType - The type of API being accessed, which determines how the response is handled.
  * @returns The response from the API request or throws an AptosApiError if the request fails.
+ * @group Implementation
+ * @category Client
  */
 export async function aptosRequest<Req extends {}, Res extends {}>(
   aptosRequestOpts: AptosRequest,

package/src/client/get.ts

@@ -5,44 +5,64 @@ import { AptosApiType } from "../utils/const";
 
 /**
  * Options for making a GET request, including configuration for the API client.
+ * @group Implementation
+ * @category Client
  */
 export type GetRequestOptions = {
   /**
    * The config for the API client
+   * @group Implementation
+   * @category Client
    */
   aptosConfig: AptosConfig;
   /**
    * The type of API endpoint to call e.g. fullnode, indexer, etc
+   * @group Implementation
+   * @category Client
    */
   type: AptosApiType;
   /**
    * The name of the API method
+   * @group Implementation
+   * @category Client
    */
   originMethod: string;
   /**
    * The URL path to the API method
+   * @group Implementation
+   * @category Client
    */
   path: string;
   /**
    * The content type of the request body
+   * @group Implementation
+   * @category Client
    */
   contentType?: MimeType;
   /**
    * The accepted content type of the response of the API
+   * @group Implementation
+   * @category Client
    */
   acceptType?: MimeType;
   /**
    * The query parameters for the request
+   * @group Implementation
+   * @category Client
    */
   params?: Record<string, string | AnyNumber | boolean | undefined>;
   /**
    * Specific client overrides for this request to override aptosConfig
+   * @group Implementation
+   * @category Client
    */
   overrides?: ClientConfig;
 };
 
 /**
  * Options for making a request to the Aptos API, excluding the "type" field.
+ * @group Implementation
+ * @category Client
  */
 export type GetAptosRequestOptions = Omit<GetRequestOptions, "type">;
 
@@ -59,6 +79,8 @@ export type GetAptosRequestOptions = Omit<GetRequestOptions, "type">;
  * @param options.originMethod - The original method of the request.
  * @param options.type - The type of request being made.
  * @returns The response from the GET request.
+ * @group Implementation
+ * @category Client
  */
 export async function get<Req extends {}, Res extends {}>(
   options: GetRequestOptions,
@@ -96,6 +118,8 @@ export async function get<Req extends {}, Res extends {}>(
  * @param options.type - The type of API request being made.
  *
  * @returns A promise that resolves with the response from the Aptos full node.
+ * @group Implementation
+ * @category Client
  */
 export async function getAptosFullNode<Req extends {}, Res extends {}>(
   options: GetAptosRequestOptions,
@@ -121,6 +145,8 @@ export async function getAptosFullNode<Req extends {}, Res extends {}>(
  * @param options.param1 - Description of param1.
  * @param options.param2 - Description of param2.
  * @returns AptosResponse - The response from the Aptos Pepper service.
+ * @group Implementation
+ * @category Client
  */
 export async function getAptosPepperService<Req extends {}, Res extends {}>(
   options: GetAptosRequestOptions,
@@ -128,7 +154,11 @@ export async function getAptosPepperService<Req extends {}, Res extends {}>(
   return get<Req, Res>({ ...options, type: AptosApiType.PEPPER });
 }
 
-/// This function is a helper for paginating using a function wrapping an API
+/**
+ * This function is a helper for paginating using a function wrapping an API
+ * @group Implementation
+ * @category Client
+ */
 export async function paginateWithCursor<Req extends Record<string, any>, Res extends Array<{}>>(
   options: GetAptosRequestOptions,
 ): Promise<Res> {
@@ -149,6 +179,8 @@ export async function paginateWithCursor<Req extends Record<string, any>, Res ex
      * the cursor is a "state key" from the API perspective. Client
      * should not need to "care" what it represents but just use it
      * to query the next chunk of data.
+     * @group Implementation
+     * @category Client
      */
     cursor = response.headers["x-aptos-cursor"];
     // Now that we have the cursor (if any), we remove the headers before
@@ -159,3 +191,45 @@ export async function paginateWithCursor<Req extends Record<string, any>, Res ex
   } while (cursor !== null && cursor !== undefined);
   return out as Res;
 }
+
+/// This function is a helper for paginating using a function wrapping an API using offset instead of start
+export async function paginateWithObfuscatedCursor<Req extends Record<string, any>, Res extends Array<{}>>(
+  options: GetAptosRequestOptions,
+): Promise<Res> {
+  const out: any[] = [];
+  let cursor: string | undefined;
+  const requestParams = options.params as { offset?: string; limit?: number };
+  const totalLimit = requestParams.limit;
+  do {
+    // eslint-disable-next-line no-await-in-loop
+    const response = await get<Req, Res>({
+      type: AptosApiType.FULLNODE,
+      aptosConfig: options.aptosConfig,
+      originMethod: options.originMethod,
+      path: options.path,
+      params: requestParams,
+      overrides: options.overrides,
+    });
+    /**
+     * the cursor is a "state key" from the API perspective. Client
+     * should not need to "care" what it represents but just use it
+     * to query the next chunk of data.
+     */
+    cursor = response.headers["x-aptos-cursor"];
+    // Now that we have the cursor (if any), we remove the headers before
+    // adding these to the output of this function.
+    delete response.headers;
+    out.push(...response.data);
+    requestParams.offset = cursor;
+
+    // Re-evaluate length
+    if (totalLimit !== undefined) {
+      const newLimit = totalLimit - out.length;
+      if (newLimit <= 0) {
+        break;
+      }
+      requestParams.limit = newLimit;
+    }
+  } while (cursor !== null && cursor !== undefined);
+  return out as Res;
+}

package/src/client/post.ts

@@ -8,48 +8,70 @@ import { AptosApiType } from "../utils/const";
 
 /**
  * Options for making a POST request, including the API client configuration.
+ * @group Implementation
+ * @category Client
  */
 export type PostRequestOptions = {
   /**
    * The config for the API client
+   * @group Implementation
+   * @category Client
    */
   aptosConfig: AptosConfig;
   /**
    * The type of API endpoint to call e.g. fullnode, indexer, etc
+   * @group Implementation
+   * @category Client
    */
   type: AptosApiType;
   /**
    * The name of the API method
+   * @group Implementation
+   * @category Client
    */
   originMethod: string;
   /**
    * The URL path to the API method
+   * @group Implementation
+   * @category Client
    */
   path: string;
   /**
    * The content type of the request body
+   * @group Implementation
+   * @category Client
    */
   contentType?: MimeType;
   /**
    * The accepted content type of the response of the API
+   * @group Implementation
+   * @category Client
    */
   acceptType?: MimeType;
   /**
    * The query parameters for the request
+   * @group Implementation
+   * @category Client
    */
   params?: Record<string, string | AnyNumber | boolean | undefined>;
   /**
    * The body of the request, should match the content type of the request
+   * @group Implementation
+   * @category Client
    */
   body?: any;
   /**
    * Specific client overrides for this request to override aptosConfig
+   * @group Implementation
+   * @category Client
    */
   overrides?: ClientConfig;
 };
 
 /**
  * Options for posting a request to Aptos, excluding the type field.
+ * @group Implementation
+ * @category Client
  */
 export type PostAptosRequestOptions = Omit<PostRequestOptions, "type">;
 
@@ -67,6 +89,8 @@ export type PostAptosRequestOptions = Omit<PostRequestOptions, "type">;
  * @param options.aptosConfig - Configuration settings for the Aptos request.
  * @param options.overrides - Any overrides for the default request behavior.
  * @returns The response from the POST request.
+ * @group Implementation
+ * @category Client
  */
 export async function post<Req extends {}, Res extends {}>(
   options: PostRequestOptions,
@@ -100,6 +124,8 @@ export async function post<Req extends {}, Res extends {}>(
  * @param options.aptosConfig.clientConfig - Client-specific configuration settings.
  * @param options.aptosConfig.fullnodeConfig - Full node-specific configuration settings.
  * @param options.overrides - Additional overrides for the request.
+ * @group Implementation
+ * @category Client
  */
 export async function postAptosFullNode<Req extends {}, Res extends {}>(
   options: PostAptosRequestOptions,
@@ -128,6 +154,8 @@ export async function postAptosFullNode<Req extends {}, Res extends {}>(
  * @param options.aptosConfig.indexerConfig - The indexer configuration settings.
  * @param options.overrides - Additional overrides for the request.
  * @param options.overrides.HEADERS - Custom headers to include in the request.
+ * @group Implementation
+ * @category Client
  */
 export async function postAptosIndexer<Req extends {}, Res extends {}>(
   options: PostAptosRequestOptions,
@@ -150,12 +178,17 @@ export async function postAptosIndexer<Req extends {}, Res extends {}>(
  * Sends a request to the Aptos faucet to obtain test tokens.
  * This function modifies the provided configuration to ensure that the API_KEY is not included in the request.
  *
+ * Note that only devnet has a publicly accessible faucet. For testnet, you must use
+ * the minting page at https://aptos.dev/network/faucet.
+ *
  * @param options - The options for the request.
  * @param options.aptosConfig - The configuration settings for the Aptos client.
  * @param options.aptosConfig.clientConfig - The client-specific configuration settings.
  * @param options.aptosConfig.clientConfig.HEADERS - Optional headers to include in the request.
  * @param options.aptosConfig.faucetConfig - The configuration settings specific to the faucet.
  * @param options.overrides - Additional overrides for the request configuration.
+ * @group Implementation
+ * @category Client
  */
 export async function postAptosFaucet<Req extends {}, Res extends {}>(
   options: PostAptosRequestOptions,
@@ -190,6 +223,8 @@ export async function postAptosFaucet<Req extends {}, Res extends {}>(
  * @param options.headers - The headers to include in the request.
  * @param options.body - The body of the request.
  * @returns A promise that resolves to the response from the pepper service.
+ * @group Implementation
+ * @category Client
  */
 export async function postAptosPepperService<Req extends {}, Res extends {}>(
   options: PostAptosRequestOptions,
@@ -203,6 +238,8 @@ export async function postAptosPepperService<Req extends {}, Res extends {}>(
  * @param options - The options for the request to the Aptos proving service.
  * @param options.type - The type of the request, which should be set to AptosApiType.PROVER.
  * @param options.data - The data to be included in the request.
+ * @group Implementation
+ * @category Client
  */
 export async function postAptosProvingService<Req extends {}, Res extends {}>(
   options: PostAptosRequestOptions,

package/src/core/account/utils/address.ts

@@ -9,6 +9,8 @@ import { DeriveScheme } from "../../../types";
  * @param seed The seed in either Uint8Array | string type
  *
  * @returns The object account address
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 export const createObjectAddress = (creatorAddress: AccountAddress, seed: Uint8Array | string): AccountAddress => {
   const creatorBytes = creatorAddress.bcsToBytes();
@@ -27,6 +29,8 @@ export const createObjectAddress = (creatorAddress: AccountAddress, seed: Uint8A
  * @param seed The seed in either Uint8Array | string type
  *
  * @returns The resource account address
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 export const createResourceAddress = (creatorAddress: AccountAddress, seed: Uint8Array | string): AccountAddress => {
   const creatorBytes = creatorAddress.bcsToBytes();
@@ -46,6 +50,8 @@ export const createResourceAddress = (creatorAddress: AccountAddress, seed: Uint
  * @param tokenName The token name
  *
  * @returns The token account address
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 export const createTokenAddress = (
   creatorAddress: AccountAddress,

package/src/core/accountAddress.ts

@@ -10,6 +10,8 @@ import { HexInput, ScriptTransactionArgumentVariants } from "../types";
 
 /**
  * Provides reasons for an address was invalid.
+ * @group Implementation
+ * @category Serialization
  */
 export enum AddressInvalidReason {
   INCORRECT_NUMBER_OF_BYTES = "incorrect_number_of_bytes",
@@ -24,6 +26,8 @@ export enum AddressInvalidReason {
 
 /**
  * The input for an account address, which can be either a hexadecimal string or a standard account address.
+ * @group Implementation
+ * @category Serialization
  */
 export type AccountAddressInput = HexInput | AccountAddress;
 
@@ -42,20 +46,28 @@ export type AccountAddressInput = HexInput | AccountAddress;
  *
  * The comments in this class make frequent reference to the LONG and SHORT formats,
  * as well as "special" addresses. To learn what these refer to see AIP-40.
+ * @group Implementation
+ * @category Serialization
  */
 export class AccountAddress extends Serializable implements TransactionArgument {
   /**
    * This is the internal representation of an account address.
+   * @group Implementation
+   * @category Serialization
    */
   readonly data: Uint8Array;
 
   /**
    * The number of bytes that make up an account address.
+   * @group Implementation
+   * @category Serialization
    */
   static readonly LENGTH: number = 32;
 
   /**
    * The length of an address string in LONG form without a leading 0x.
+   * @group Implementation
+   * @category Serialization
    */
   static readonly LONG_STRING_LENGTH: number = 64;
 
@@ -78,6 +90,8 @@ export class AccountAddress extends Serializable implements TransactionArgument
    *
    * @param input A Uint8Array representing an account address.
    * @throws ParsingError if the input length is not equal to 32 bytes.
+   * @group Implementation
+   * @category Serialization
    */
   constructor(input: Uint8Array) {
     super();
@@ -99,6 +113,8 @@ export class AccountAddress extends Serializable implements TransactionArgument
    * https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
    *
    * @returns true if the address is special, false otherwise.
+   * @group Implementation
+   * @category Serialization
    */
   isSpecial(): boolean {
     return (
@@ -116,6 +132,8 @@ export class AccountAddress extends Serializable implements TransactionArgument
    * and other addresses in LONG form (0x + 64 characters).
    *
    * @returns AccountAddress as a string conforming to AIP-40.
+   * @group Implementation
+   * @category Serialization
    */
   toString(): `0x${string}` {
     return `0x${this.toStringWithoutPrefix()}`;
@@ -127,6 +145,8 @@ export class AccountAddress extends Serializable implements TransactionArgument
    * NOTE: Prefer to use `toString` where possible.
    *
    * @returns AccountAddress as a string without the leading 0x.
+   * @group Implementation
+   * @category Serialization
    */
   toStringWithoutPrefix(): string {
     let hex = bytesToHex(this.data);
@@ -142,6 +162,8 @@ export class AccountAddress extends Serializable implements TransactionArgument
    * NOTE: Prefer to use `toString` where possible, as it formats special addresses using the SHORT form (no leading 0s).
    *
    * @returns AccountAddress as a string in LONG form.
+   * @group Implementation
+   * @category Serialization
    */
   toStringLong(): `0x${string}` {
     return `0x${this.toStringLongWithoutPrefix()}`;
@@ -154,6 +176,8 @@ export class AccountAddress extends Serializable implements TransactionArgument
    * NOTE: Prefer to use `toString` where possible, as it formats special addresses using the SHORT form (no leading 0s).
    *
    * @returns {string} The account address in LONG form.
+   * @group Implementation
+   * @category Serialization
    */
   toStringLongWithoutPrefix(): string {
     return bytesToHex(this.data);
@@ -164,6 +188,8 @@ export class AccountAddress extends Serializable implements TransactionArgument
    * 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;
@@ -179,6 +205,8 @@ export class AccountAddress extends Serializable implements TransactionArgument
    * address.serialize(serializer);
    * const bytes = serializer.toUint8Array();
    * // `bytes` is now the BCS-serialized address.
+   * @group Implementation
+   * @category Serialization
    */
   serialize(serializer: Serializer): void {
     serializer.serializeFixedBytes(this.data);
@@ -189,6 +217,8 @@ export class AccountAddress extends Serializable implements TransactionArgument
    * This allows for the proper encoding of data when interacting with entry functions in the blockchain.
    *
    * @param serializer - The serializer instance used to convert the data into bytes.
+   * @group Implementation
+   * @category Serialization
    */
   serializeForEntryFunction(serializer: Serializer): void {
     const bcsBytes = this.bcsToBytes();
@@ -200,6 +230,8 @@ export class AccountAddress extends Serializable implements TransactionArgument
    * This process involves serializing the variant index and the instance data, making it suitable for transmission.
    *
    * @param serializer - The serializer instance used to perform the serialization.
+   * @group Implementation
+   * @category Serialization
    */
   serializeForScriptFunction(serializer: Serializer): void {
     serializer.serializeU32AsUleb128(ScriptTransactionArgumentVariants.Address);
@@ -216,6 +248,8 @@ export class AccountAddress extends Serializable implements TransactionArgument
    * const deserializer = new Deserializer(bytes);
    * const address = AccountAddress.deserialize(deserializer);
    * // `address` is now an instance of AccountAddress.
+   * @group Implementation
+   * @category Serialization
    */
   static deserialize(deserializer: Deserializer): AccountAddress {
     const bytes = deserializer.deserializeFixedBytes(AccountAddress.LENGTH);
@@ -258,6 +292,8 @@ export class AccountAddress extends Serializable implements TransactionArgument
    * https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
    *
    * @returns An instance of AccountAddress.
+   * @group Implementation
+   * @category Serialization
    */
   static fromStringStrict(input: string): AccountAddress {
     // Assert the string starts with 0x.
@@ -315,6 +351,8 @@ export class AccountAddress extends Serializable implements TransactionArgument
    * @returns An instance of AccountAddress.
    *
    * @throws ParsingError if the hex string is too short, too long, or contains invalid characters.
+   * @group Implementation
+   * @category Serialization
    */
   static fromString(input: string, { maxMissingChars = 4 }: { maxMissingChars?: number } = {}): AccountAddress {
     let parsedInput = input;
@@ -384,6 +422,8 @@ Received ${input}`,
    * @param input - The input to convert into an AccountAddress. This can be a string representation of an address, a Uint8Array,
    * or an existing AccountAddress.
    * @param args.maxMissingChars The number of characters that can be missing in a padded address before it is invalid.
+   * @group Implementation
+   * @category Serialization
    */
   static from(input: AccountAddressInput, { maxMissingChars = 4 }: { maxMissingChars?: number } = {}): AccountAddress {
     if (typeof input === "string") {
@@ -399,6 +439,8 @@ Received ${input}`,
    * Create an AccountAddress from various input types, including strings, Uint8Array, and AccountAddress instances.
    *
    * @param input - The input to convert into an AccountAddress, which can be a string, a Uint8Array, or an AccountAddress.
+   * @group Implementation
+   * @category Serialization
    */
   static fromStrict(input: AccountAddressInput): AccountAddress {
     if (typeof input === "string") {
@@ -422,6 +464,8 @@ Received ${input}`,
    *
    * @returns An object indicating whether the address is valid. If valid, valid = true; if not, valid = false with additional details.
    * If the address is invalid, invalidReason will explain why it is invalid, and invalidReasonMessage will provide the error message.
+   * @group Implementation
+   * @category Serialization
    */
   static isValid(args: { input: AccountAddressInput; strict?: boolean }): ParsingResult<AddressInvalidReason> {
     try {
@@ -445,6 +489,8 @@ Received ${input}`,
    *
    * @param other - The AccountAddress to compare to.
    * @returns true if the AccountAddresses are equal, false if not.
+   * @group Implementation
+   * @category Serialization
    */
   equals(other: AccountAddress): boolean {
     if (this.data.length !== other.data.length) return false;