@aptos-labs/ts-sdk 1.33.1 → 1.33.2

package/dist/esm/utils/helpers.d.mts

@@ -9,6 +9,8 @@ import './apiEndpoints.mjs';
  * This function can be used to introduce delays in asynchronous operations.
  *
  * @param timeMs - The time in milliseconds to sleep.
+ * @group Implementation
+ * @category Utils
  */
 declare function sleep(timeMs: number): Promise<null>;
 /**
@@ -16,14 +18,22 @@ declare function sleep(timeMs: number): Promise<null>;
  *
  * @param error The error to get the message from
  * @returns The error message
+ * @group Implementation
+ * @category Utils
  */
 declare function getErrorMessage(error: unknown): string;
+/**
+ * @group Implementation
+ * @category Utils
+ */
 declare const nowInSeconds: () => number;
 /**
  * Floors the given timestamp to the nearest whole hour.
  * This function is useful for normalizing timestamps to hourly intervals.
  *
  * @param timestampInSeconds - The timestamp in seconds to be floored.
+ * @group Implementation
+ * @category Utils
  */
 declare function floorToWholeHour(timestampInSeconds: number): number;
 /**
@@ -32,6 +42,8 @@ declare function floorToWholeHour(timestampInSeconds: number): number;
  *
  * @param base64Url - The base64 URL-encoded string to decode.
  * @returns The decoded string.
+ * @group Implementation
+ * @category Utils
  */
 declare function base64UrlDecode(base64Url: string): string;
 /**
@@ -44,6 +56,8 @@ declare function base64UrlDecode(base64Url: string): string;
  * @param value The value in human-readable format
  * @param decimal The token decimal
  * @returns The value in the smallest units
+ * @group Implementation
+ * @category Utils
  */
 declare const convertAmountFromHumanReadableToOnChain: (value: number, decimal: number) => number;
 /**
@@ -56,6 +70,8 @@ declare const convertAmountFromHumanReadableToOnChain: (value: number, decimal:
  * @param value The value in human-readable format
  * @param decimal The token decimal
  * @returns The value in the smallest units
+ * @group Implementation
+ * @category Utils
  */
 declare const convertAmountFromOnChainToHumanReadable: (value: number, decimal: number) => number;
 /**
@@ -72,6 +88,8 @@ declare const convertAmountFromOnChainToHumanReadable: (value: number, decimal:
  *
  * @param structObj The struct with account_address, module_name, and struct_name properties
  * @returns The MoveStructId
+ * @group Implementation
+ * @category Utils
  */
 declare const parseEncodedStruct: (structObj: {
     account_address: string;
@@ -86,6 +104,8 @@ declare const parseEncodedStruct: (structObj: {
  *
  * @param structObj The object to check
  * @returns Whether the object is an encoded struct type
+ * @group Implementation
+ * @category Utils
  */
 declare const isEncodedStruct: (structObj: any) => structObj is {
     account_address: string;

package/dist/esm/utils/helpers.mjs

@@ -1,2 +1,2 @@
-import{a,b,c,d,e,f,g,h,i}from"../chunk-V4FKFCBL.mjs";import"../chunk-KDMSOCZY.mjs";export{e as base64UrlDecode,f as convertAmountFromHumanReadableToOnChain,g as convertAmountFromOnChainToHumanReadable,d as floorToWholeHour,b as getErrorMessage,i as isEncodedStruct,c as nowInSeconds,h as parseEncodedStruct,a as sleep};
+import{a,b,c,d,e,f,g,h,i}from"../chunk-DAFSKSZ5.mjs";import"../chunk-KDMSOCZY.mjs";export{e as base64UrlDecode,f as convertAmountFromHumanReadableToOnChain,g as convertAmountFromOnChainToHumanReadable,d as floorToWholeHour,b as getErrorMessage,i as isEncodedStruct,c as nowInSeconds,h as parseEncodedStruct,a as sleep};
 //# sourceMappingURL=helpers.mjs.map

package/dist/esm/utils/index.mjs

@@ -1,2 +1,2 @@
-import"../chunk-HGLO5LDS.mjs";import{a as s}from"../chunk-CDEYH77E.mjs";import{a as t,b as u,c as v,d as w,e as x,f as y,g as z,h as A,i as B}from"../chunk-V4FKFCBL.mjs";import{a,b,c,d,e,f,g,h}from"../chunk-D3OEQLUE.mjs";import{a as i,b as j,c as k,d as l,e as m,f as n,g as o,h as p,i as q,j as r}from"../chunk-J7PJSK3J.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-ZMBXHMVQ.mjs";import"../chunk-BRV3RLKW.mjs";import"../chunk-ZMMLM6ZJ.mjs";import"../chunk-42H7WETG.mjs";import"../chunk-FD6FGKYY.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-U2PRGW4O.mjs";import"../chunk-J3E4UMBB.mjs";import"../chunk-AJ5JHBAE.mjs";import"../chunk-SPRNSFUV.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-KDMSOCZY.mjs";export{m as APTOS_COIN,n as APTOS_FA,i as AptosApiType,j as DEFAULT_MAX_GAS_AMOUNT,k as DEFAULT_TXN_EXP_SEC_FROM_NOW,l as DEFAULT_TXN_TIMEOUT_SEC,r as FIREBASE_AUTH_ISS_PATTERN,f as Network,g as NetworkToChainId,c as NetworkToFaucetAPI,a as NetworkToIndexerAPI,h as NetworkToNetworkName,b as NetworkToNodeAPI,d as NetworkToPepperAPI,e as NetworkToProverAPI,q as ProcessorType,o as RAW_TRANSACTION_SALT,p as RAW_TRANSACTION_WITH_DATA_SALT,x as base64UrlDecode,y as convertAmountFromHumanReadableToOnChain,z as convertAmountFromOnChainToHumanReadable,w as floorToWholeHour,u as getErrorMessage,B as isEncodedStruct,s as normalizeBundle,v as nowInSeconds,A as parseEncodedStruct,t as sleep};
+import"../chunk-HGLO5LDS.mjs";import{a as s}from"../chunk-4YLUM62M.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-TOBQ5UE6.mjs";import"../chunk-MT2RJ7H3.mjs";import"../chunk-IDTLNF4M.mjs";import"../chunk-ORMOQWWH.mjs";import"../chunk-FD6FGKYY.mjs";import"../chunk-U2PRGW4O.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-EBMEXURY.mjs";import{a as t,b as u,c as v,d as w,e as x,f as y,g as z,h as A,i as B}from"../chunk-DAFSKSZ5.mjs";import"../chunk-XTOIL6MB.mjs";import"../chunk-STY74NUA.mjs";import"../chunk-IF4UU2MT.mjs";import"../chunk-56CNRT2K.mjs";import{a,b,c,d,e,f,g,h}from"../chunk-4RXKALLC.mjs";import{a as i,b as j,c as k,d as l,e as m,f as n,g as o,h as p,i as q,j as r}from"../chunk-RJ7F4JDV.mjs";import"../chunk-KDMSOCZY.mjs";export{m as APTOS_COIN,n as APTOS_FA,i as AptosApiType,j as DEFAULT_MAX_GAS_AMOUNT,k as DEFAULT_TXN_EXP_SEC_FROM_NOW,l as DEFAULT_TXN_TIMEOUT_SEC,r as FIREBASE_AUTH_ISS_PATTERN,f as Network,g as NetworkToChainId,c as NetworkToFaucetAPI,a as NetworkToIndexerAPI,h as NetworkToNetworkName,b as NetworkToNodeAPI,d as NetworkToPepperAPI,e as NetworkToProverAPI,q as ProcessorType,o as RAW_TRANSACTION_SALT,p as RAW_TRANSACTION_WITH_DATA_SALT,x as base64UrlDecode,y as convertAmountFromHumanReadableToOnChain,z as convertAmountFromOnChainToHumanReadable,w as floorToWholeHour,u as getErrorMessage,B as isEncodedStruct,s as normalizeBundle,v as nowInSeconds,A as parseEncodedStruct,t as sleep};
 //# sourceMappingURL=index.mjs.map

package/dist/esm/utils/memoize.d.mts

@@ -7,6 +7,8 @@
  * @param key The cache key used to store the result.
  * @param ttlMs The time-to-live in milliseconds for cached data.
  * @returns The cached or latest result.
+ * @group Implementation
+ * @category Utils
  */
 declare function memoizeAsync<T>(func: (...args: any[]) => Promise<T>, key: string, ttlMs?: number): (...args: any[]) => Promise<T>;
 /**
@@ -16,6 +18,8 @@ declare function memoizeAsync<T>(func: (...args: any[]) => Promise<T>, key: stri
  * @param func - The function whose result will be cached.
  * @param ttlMs - The time-to-live in milliseconds for cached data.
  * @returns A memoized version of the provided function that returns the cached result if available and within TTL.
+ * @group Implementation
+ * @category Utils
  */
 declare function memoize<T>(func: (...args: any[]) => T, key: string, ttlMs?: number): (...args: any[]) => T;
 

package/dist/esm/utils/memoize.mjs

@@ -1,2 +1,2 @@
-import{a,b}from"../chunk-HBIDHQ2M.mjs";import"../chunk-KDMSOCZY.mjs";export{b as memoize,a as memoizeAsync};
+import{a,b}from"../chunk-YOZBVVKL.mjs";import"../chunk-KDMSOCZY.mjs";export{b as memoize,a as memoizeAsync};
 //# sourceMappingURL=memoize.mjs.map

package/dist/esm/utils/normalizeBundle.d.mts

@@ -8,12 +8,18 @@ import './apiEndpoints.mjs';
 import '../core/hex.mjs';
 import '../core/common.mjs';
 
+/**
+ * @group Implementation
+ * @category Utils
+ */
 type DeserializableClass<T extends Serializable> = {
     /**
      * Deserializes a serialized object using the provided deserializer.
      * This function allows you to reconstruct an object from its serialized form.
      *
      * @param deserializer - An instance of the Deserializer used to read the serialized data.
+     * @group Implementation
+     * @category Utils
      */
     deserialize(deserializer: Deserializer): T;
 };
@@ -23,6 +29,8 @@ type DeserializableClass<T extends Serializable> = {
  *
  * @param cls - The class of the object to normalize.
  * @param value - The instance to normalize.
+ * @group Implementation
+ * @category Utils
  */
 declare function normalizeBundle<T extends Serializable>(cls: DeserializableClass<T>, value: T): T;
 

package/dist/esm/utils/normalizeBundle.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-CDEYH77E.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-ZMBXHMVQ.mjs";import"../chunk-BRV3RLKW.mjs";import"../chunk-ZMMLM6ZJ.mjs";import"../chunk-42H7WETG.mjs";import"../chunk-FD6FGKYY.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-U2PRGW4O.mjs";import"../chunk-J3E4UMBB.mjs";import"../chunk-AJ5JHBAE.mjs";import"../chunk-SPRNSFUV.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-KDMSOCZY.mjs";export{a as normalizeBundle};
+import{a}from"../chunk-4YLUM62M.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-TOBQ5UE6.mjs";import"../chunk-MT2RJ7H3.mjs";import"../chunk-IDTLNF4M.mjs";import"../chunk-ORMOQWWH.mjs";import"../chunk-FD6FGKYY.mjs";import"../chunk-U2PRGW4O.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-EBMEXURY.mjs";import"../chunk-XTOIL6MB.mjs";import"../chunk-STY74NUA.mjs";import"../chunk-IF4UU2MT.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-KDMSOCZY.mjs";export{a as normalizeBundle};
 //# sourceMappingURL=normalizeBundle.mjs.map

package/dist/esm/version.d.mts

@@ -3,6 +3,6 @@
  *
  * hardcoded for now, we would want to have it injected dynamically
  */
-declare const VERSION = "1.33.1";
+declare const VERSION = "1.33.2";
 
 export { VERSION };

package/dist/esm/version.mjs

@@ -1,2 +1,2 @@
-import{a}from"./chunk-YD2BMHH7.mjs";import"./chunk-KDMSOCZY.mjs";export{a as VERSION};
+import{a}from"./chunk-77AEKF7K.mjs";import"./chunk-KDMSOCZY.mjs";export{a as VERSION};
 //# sourceMappingURL=version.mjs.map

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@aptos-labs/ts-sdk",
   "description": "Aptos TypeScript SDK",
-  "packageManager": "pnpm@8.9.0",
+  "packageManager": "pnpm@8.15.1",
   "license": "Apache-2.0",
   "engines": {
-    "node": ">=11.0.0"
+    "node": ">=20.0.0"
   },
   "bugs": {
     "url": "https://github.com/aptos-labs/aptos-ts-sdk/issues/new/choose"
@@ -32,23 +32,6 @@
     "dist",
     "src"
   ],
-  "scripts": {
-    "build:clean": "rm -rf dist",
-    "build": "pnpm build:clean && tsup",
-    "prepublishOnly": "pnpm run build",
-    "_fmt": "prettier 'src/**/*.ts' 'tests/**/*.ts' 'examples/**/*.js' 'examples/**/*.ts' '.eslintrc.js'",
-    "fmt": "pnpm _fmt --write",
-    "lint": "eslint 'src/**/*.ts' 'tests/**/*.ts' 'examples/**/*.ts'",
-    "test": "pnpm jest",
-    "unit-test": "pnpm jest tests/unit",
-    "e2e-test": "pnpm jest tests/e2e",
-    "indexer-codegen": "graphql-codegen --config ./src/types/codegen.yaml && pnpm fmt",
-    "doc": "scripts/generateDocs.sh",
-    "check-version": "scripts/checkVersion.sh",
-    "update-version": "scripts/updateVersion.sh && pnpm doc",
-    "spec": "pnpm build && pnpm _spec",
-    "_spec": "cucumber-js -p default"
-  },
   "dependencies": {
     "@aptos-labs/aptos-cli": "^1.0.2",
     "@aptos-labs/aptos-client": "^0.1.1",
@@ -96,5 +79,21 @@
     "typedoc-plugin-missing-exports": "^3.0.0",
     "typescript": "^5.6.2"
   },
-  "version": "1.33.1"
+  "version": "1.33.2",
+  "scripts": {
+    "build:clean": "rm -rf dist",
+    "build": "pnpm build:clean && tsup",
+    "_fmt": "prettier 'src/**/*.ts' 'tests/**/*.ts' 'examples/**/*.js' 'examples/**/*.ts' '.eslintrc.js'",
+    "fmt": "pnpm _fmt --write",
+    "lint": "eslint 'src/**/*.ts' 'tests/**/*.ts' 'examples/**/*.ts'",
+    "test": "pnpm jest",
+    "unit-test": "pnpm jest tests/unit",
+    "e2e-test": "pnpm jest tests/e2e",
+    "indexer-codegen": "graphql-codegen --config ./src/types/codegen.yaml && pnpm fmt",
+    "doc": "scripts/generateDocs.sh",
+    "check-version": "scripts/checkVersion.sh",
+    "update-version": "scripts/updateVersion.sh && pnpm doc",
+    "spec": "pnpm build && pnpm _spec",
+    "_spec": "cucumber-js -p default"
+  }
 }

package/src/account/AbstractKeylessAccount.ts

@@ -29,6 +29,7 @@ import { FederatedKeylessPublicKey } from "../core/crypto/federatedKeyless";
 import { Account } from "./Account";
 import { AptosConfig } from "../api/aptosConfig";
 import { KeylessError, KeylessErrorType } from "../errors";
+import type { SingleKeySigner } from "./SingleKeyAccount";
 
 /**
  * An interface which defines if an Account utilizes Keyless signing.
@@ -44,64 +45,88 @@ export function isKeylessSigner(obj: any): obj is KeylessSigner {
 /**
  * Account implementation for the Keyless authentication scheme.  This abstract class is used for standard Keyless Accounts
  * and Federated Keyless Accounts.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
-export abstract class AbstractKeylessAccount extends Serializable implements KeylessSigner {
+export abstract class AbstractKeylessAccount extends Serializable implements KeylessSigner, SingleKeySigner {
   static readonly PEPPER_LENGTH: number = 31;
 
   /**
    * The KeylessPublicKey associated with the account
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   readonly publicKey: KeylessPublicKey | FederatedKeylessPublicKey;
 
   /**
    * The EphemeralKeyPair used to generate sign.
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   readonly ephemeralKeyPair: EphemeralKeyPair;
 
   /**
    * The claim on the JWT to identify a user.  This is typically 'sub' or 'email'.
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   readonly uidKey: string;
 
   /**
    * The value of the uidKey claim on the JWT.  This intended to be a stable user identifier.
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   readonly uidVal: string;
 
   /**
    * The value of the 'aud' claim on the JWT, also known as client ID.  This is the identifier for the dApp's
    * OIDC registration with the identity provider.
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   readonly aud: string;
 
   /**
    * A value contains 31 bytes of entropy that preserves privacy of the account. Typically fetched from a pepper provider.
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   readonly pepper: Uint8Array;
 
   /**
    * Account address associated with the account
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   readonly accountAddress: AccountAddress;
 
   /**
    * The zero knowledge signature (if ready) which contains the proof used to validate the EphemeralKeyPair.
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   proof: ZeroKnowledgeSig | undefined;
 
   /**
    * The proof of the EphemeralKeyPair or a promise that provides the proof.  This is used to allow for awaiting on
    * fetching the proof.
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   readonly proofOrPromise: ZeroKnowledgeSig | Promise<ZeroKnowledgeSig>;
 
   /**
    * Signing scheme used to sign transactions
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
-  readonly signingScheme: SigningScheme;
+  readonly signingScheme: SigningScheme = SigningScheme.SingleKey;
 
   /**
    * The JWT token used to derive the account
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   readonly jwt: string;
 
@@ -113,6 +138,8 @@ export abstract class AbstractKeylessAccount extends Serializable implements Key
 
   /**
    * An event emitter used to assist in handling asynchronous proof fetching.
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   private readonly emitter: EventEmitter<ProofFetchEvents>;
 
@@ -185,7 +212,6 @@ export abstract class AbstractKeylessAccount extends Serializable implements Key
       // Note, this is purposely not awaited to be non-blocking.  The caller should await on the proofFetchCallback.
       this.init(proof);
     }
-    this.signingScheme = SigningScheme.SingleKey;
     const pepperBytes = Hex.fromHexInput(pepper).toUint8Array();
     if (pepperBytes.length !== AbstractKeylessAccount.PEPPER_LENGTH) {
       throw new Error(`Pepper length in bytes should be ${AbstractKeylessAccount.PEPPER_LENGTH}`);
@@ -199,9 +225,15 @@ export abstract class AbstractKeylessAccount extends Serializable implements Key
     }
   }
 
+  getAnyPublicKey(): AnyPublicKey {
+    return new AnyPublicKey(this.publicKey);
+  }
+
   /**
-   * This initializes the asynchronous proof fetch.
+   * This initializes the asynchronous proof fetch
    * @return Emits whether the proof succeeds or fails, but has no return.
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   async init(promise: Promise<ZeroKnowledgeSig>) {
     try {
@@ -259,6 +291,8 @@ export abstract class AbstractKeylessAccount extends Serializable implements Key
    * Checks if the proof is expired.  If so the account must be re-derived with a new EphemeralKeyPair
    * and JWT token.
    * @return boolean
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   isExpired(): boolean {
     return this.ephemeralKeyPair.isExpired();
@@ -268,6 +302,8 @@ export abstract class AbstractKeylessAccount extends Serializable implements Key
    * Sign a message using Keyless.
    * @param message the message to sign, as binary input
    * @return the AccountAuthenticator containing the signature, together with the account's public key
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   signWithAuthenticator(message: HexInput): AccountAuthenticatorSingleKey {
     const signature = new AnySignature(this.sign(message));
@@ -279,6 +315,8 @@ export abstract class AbstractKeylessAccount extends Serializable implements Key
    * Sign a transaction using Keyless.
    * @param transaction the raw transaction
    * @return the AccountAuthenticator containing the signature of the transaction, together with the account's public key
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   signTransactionWithAuthenticator(transaction: AnyRawTransaction): AccountAuthenticatorSingleKey {
     const signature = new AnySignature(this.signTransaction(transaction));
@@ -289,6 +327,8 @@ export abstract class AbstractKeylessAccount extends Serializable implements Key
   /**
    * Waits for asynchronous proof fetching to finish.
    * @return
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   async waitForProofFetch() {
     if (this.proofOrPromise instanceof Promise) {
@@ -339,6 +379,8 @@ export abstract class AbstractKeylessAccount extends Serializable implements Key
    * Sign the given message using Keyless.
    * @param message in HexInput format
    * @returns Signature
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   sign(message: HexInput): KeylessSignature {
     const { expiryDateSecs } = this.ephemeralKeyPair;
@@ -370,6 +412,8 @@ export abstract class AbstractKeylessAccount extends Serializable implements Key
    * Signs the transaction and proof to guard against proof malleability.
    * @param transaction the transaction to be signed
    * @returns KeylessSignature
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   signTransaction(transaction: AnyRawTransaction): KeylessSignature {
     if (this.proof === undefined) {
@@ -394,6 +438,8 @@ export abstract class AbstractKeylessAccount extends Serializable implements Key
    * @param args.message the message that was signed.
    * @param args.signature the KeylessSignature to verify
    * @returns boolean
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   verifySignature(args: { message: HexInput; signature: KeylessSignature }): boolean {
     const { message, signature } = args;
@@ -462,20 +508,28 @@ export abstract class AbstractKeylessAccount extends Serializable implements Key
 /**
  * A container class to hold a transaction and a proof.  It implements CryptoHashable which is used to create
  * the signing message for Keyless transactions.  We sign over the proof to ensure non-malleability.
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 export class TransactionAndProof extends Serializable {
   /**
    * The transaction to sign.
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   transaction: AnyRawTransactionInstance;
 
   /**
    * The zero knowledge proof used in signing the transaction.
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   proof?: ZkProof;
 
   /**
    * The domain separator prefix used when hashing.
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   readonly domainSeparator = "APTOS::TransactionAndProof";
 
@@ -500,25 +554,42 @@ export class TransactionAndProof extends Serializable {
    * Hashes the bcs serialized from of the class. This is the typescript corollary to the BCSCryptoHash macro in aptos-core.
    *
    * @returns Uint8Array
+   * @group Implementation
+   * @category Account (On-Chain Model)
    */
   hash(): Uint8Array {
     return generateSigningMessage(this.bcsToBytes(), this.domainSeparator);
   }
 }
-
+/**
+ * @group Implementation
+ * @category Account (On-Chain Model)
+ */
 export type ProofFetchSuccess = {
   status: "Success";
 };
-
+/**
+ * @group Implementation
+ * @category Account (On-Chain Model)
+ */
 export type ProofFetchFailure = {
   status: "Failed";
   error: string;
 };
-
+/**
+ * @group Implementation
+ * @category Account (On-Chain Model)
+ */
 export type ProofFetchStatus = ProofFetchSuccess | ProofFetchFailure;
-
+/**
+ * @group Implementation
+ * @category Account (On-Chain Model)
+ */
 export type ProofFetchCallback = (status: ProofFetchStatus) => Promise<void>;
-
+/**
+ * @group Implementation
+ * @category Account (On-Chain Model)
+ */
 export interface ProofFetchEvents {
   proofFetchFinish: (status: ProofFetchStatus) => void;
 }