@aptos-labs/ts-sdk 1.33.0-sc.1 → 1.33.0-sc.3

package/dist/esm/client/get.d.mts

@@ -9,43 +9,63 @@ import '@aptos-labs/script-composer-pack';
 
 /**
  * Options for making a GET request, including configuration for the API client.
+ * @group Implementation
+ * @category Client
  */
 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
  */
 type GetAptosRequestOptions = Omit<GetRequestOptions, "type">;
 /**
@@ -61,6 +81,8 @@ 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
  */
 declare function get<Req extends {}, Res extends {}>(options: GetRequestOptions): Promise<AptosResponse<Req, Res>>;
 /**
@@ -74,6 +96,8 @@ declare function get<Req extends {}, Res extends {}>(options: GetRequestOptions)
  * @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
  */
 declare function getAptosFullNode<Req extends {}, Res extends {}>(options: GetAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
 /**
@@ -83,8 +107,16 @@ declare function getAptosFullNode<Req extends {}, Res extends {}>(options: GetAp
  * @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
  */
 declare function getAptosPepperService<Req extends {}, Res extends {}>(options: GetAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
+/**
+ * This function is a helper for paginating using a function wrapping an API
+ * @group Implementation
+ * @category Client
+ */
 declare function paginateWithCursor<Req extends Record<string, any>, Res extends Array<{}>>(options: GetAptosRequestOptions): Promise<Res>;
+declare function paginateWithObfuscatedCursor<Req extends Record<string, any>, Res extends Array<{}>>(options: GetAptosRequestOptions): Promise<Res>;
 
-export { type GetAptosRequestOptions, type GetRequestOptions, get, getAptosFullNode, getAptosPepperService, paginateWithCursor };
+export { type GetAptosRequestOptions, type GetRequestOptions, get, getAptosFullNode, getAptosPepperService, paginateWithCursor, paginateWithObfuscatedCursor };

package/dist/esm/client/get.mjs

@@ -1,2 +1,2 @@
-import{a,b,c,d}from"../chunk-LRN4ALMT.mjs";import"../chunk-P6RNNESB.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-UZTJWOLS.mjs";import"../chunk-F45G3GP3.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-Q3CWUEXI.mjs";import"../chunk-42H7WETG.mjs";import"../chunk-ZMBXHMVQ.mjs";import"../chunk-BRV3RLKW.mjs";import"../chunk-D52UKPQF.mjs";import"../chunk-3OLFJ65O.mjs";import"../chunk-U2PRGW4O.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-AJ5JHBAE.mjs";import"../chunk-SPRNSFUV.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-V4FKFCBL.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-D3OEQLUE.mjs";import"../chunk-J7PJSK3J.mjs";import"../chunk-YQHOQJRQ.mjs";import"../chunk-KDMSOCZY.mjs";export{a as get,b as getAptosFullNode,c as getAptosPepperService,d as paginateWithCursor};
+import{a,b,c,d,e}from"../chunk-5VILVOYP.mjs";import"../chunk-EYE4UEWZ.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-4YLUM62M.mjs";import"../chunk-QHEKBHNU.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-TOBQ5UE6.mjs";import"../chunk-MT2RJ7H3.mjs";import"../chunk-IDTLNF4M.mjs";import"../chunk-ORMOQWWH.mjs";import"../chunk-3OLFJ65O.mjs";import"../chunk-U2PRGW4O.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-EBMEXURY.mjs";import"../chunk-DAFSKSZ5.mjs";import"../chunk-XTOIL6MB.mjs";import"../chunk-STY74NUA.mjs";import"../chunk-IF4UU2MT.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-4RXKALLC.mjs";import"../chunk-RJ7F4JDV.mjs";import"../chunk-IOZSAIGP.mjs";import"../chunk-KDMSOCZY.mjs";export{a as get,b as getAptosFullNode,c as getAptosPepperService,d as paginateWithCursor,e as paginateWithObfuscatedCursor};
 //# sourceMappingURL=get.mjs.map

package/dist/esm/client/index.d.mts

@@ -1,5 +1,5 @@
 export { aptosRequest, request } from './core.mjs';
-export { GetAptosRequestOptions, GetRequestOptions, get, getAptosFullNode, getAptosPepperService, paginateWithCursor } from './get.mjs';
+export { GetAptosRequestOptions, GetRequestOptions, get, getAptosFullNode, getAptosPepperService, paginateWithCursor, paginateWithObfuscatedCursor } from './get.mjs';
 export { PostAptosRequestOptions, PostRequestOptions, post, postAptosFaucet, postAptosFullNode, postAptosIndexer, postAptosPepperService, postAptosProvingService } from './post.mjs';
 import '../api/aptosConfig.mjs';
 import '../types/types.mjs';

package/dist/esm/client/index.mjs

@@ -1,2 +1,2 @@
-import"../chunk-7ECCT6PK.mjs";import{a as c,b as d,c as e,d as f}from"../chunk-LRN4ALMT.mjs";import{a as g,b as h,c as i,d as j,e as k,f as l}from"../chunk-YT3IP57B.mjs";import{a,b}from"../chunk-P6RNNESB.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-UZTJWOLS.mjs";import"../chunk-F45G3GP3.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-Q3CWUEXI.mjs";import"../chunk-42H7WETG.mjs";import"../chunk-ZMBXHMVQ.mjs";import"../chunk-BRV3RLKW.mjs";import"../chunk-D52UKPQF.mjs";import"../chunk-3OLFJ65O.mjs";import"../chunk-U2PRGW4O.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-AJ5JHBAE.mjs";import"../chunk-SPRNSFUV.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-V4FKFCBL.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-D3OEQLUE.mjs";import"../chunk-J7PJSK3J.mjs";import"../chunk-YQHOQJRQ.mjs";import"../chunk-KDMSOCZY.mjs";export{b as aptosRequest,c as get,d as getAptosFullNode,e as getAptosPepperService,f as paginateWithCursor,g as post,j as postAptosFaucet,h as postAptosFullNode,i as postAptosIndexer,k as postAptosPepperService,l as postAptosProvingService,a as request};
+import"../chunk-7ECCT6PK.mjs";import{a as h,b as i,c as j,d as k,e as l,f as m}from"../chunk-QD55JBJB.mjs";import{a as c,b as d,c as e,d as f,e as g}from"../chunk-5VILVOYP.mjs";import{a,b}from"../chunk-EYE4UEWZ.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-4YLUM62M.mjs";import"../chunk-QHEKBHNU.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-TOBQ5UE6.mjs";import"../chunk-MT2RJ7H3.mjs";import"../chunk-IDTLNF4M.mjs";import"../chunk-ORMOQWWH.mjs";import"../chunk-3OLFJ65O.mjs";import"../chunk-U2PRGW4O.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-EBMEXURY.mjs";import"../chunk-DAFSKSZ5.mjs";import"../chunk-XTOIL6MB.mjs";import"../chunk-STY74NUA.mjs";import"../chunk-IF4UU2MT.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-4RXKALLC.mjs";import"../chunk-RJ7F4JDV.mjs";import"../chunk-IOZSAIGP.mjs";import"../chunk-KDMSOCZY.mjs";export{b as aptosRequest,c as get,d as getAptosFullNode,e as getAptosPepperService,f as paginateWithCursor,g as paginateWithObfuscatedCursor,h as post,k as postAptosFaucet,i as postAptosFullNode,j as postAptosIndexer,l as postAptosPepperService,m as postAptosProvingService,a as request};
 //# sourceMappingURL=index.mjs.map

package/dist/esm/client/post.d.mts

@@ -9,47 +9,69 @@ import '@aptos-labs/script-composer-pack';
 
 /**
  * Options for making a POST request, including the API client configuration.
+ * @group Implementation
+ * @category Client
  */
 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
  */
 type PostAptosRequestOptions = Omit<PostRequestOptions, "type">;
 /**
@@ -66,6 +88,8 @@ 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
  */
 declare function post<Req extends {}, Res extends {}>(options: PostRequestOptions): Promise<AptosResponse<Req, Res>>;
 /**
@@ -77,6 +101,8 @@ declare function post<Req extends {}, Res extends {}>(options: PostRequestOption
  * @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
  */
 declare function postAptosFullNode<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
 /**
@@ -89,18 +115,25 @@ declare function postAptosFullNode<Req extends {}, Res extends {}>(options: Post
  * @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
  */
 declare function postAptosIndexer<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
 /**
  * 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
  */
 declare function postAptosFaucet<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
 /**
@@ -111,6 +144,8 @@ declare function postAptosFaucet<Req extends {}, Res extends {}>(options: PostAp
  * @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
  */
 declare function postAptosPepperService<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
 /**
@@ -119,6 +154,8 @@ declare function postAptosPepperService<Req extends {}, Res extends {}>(options:
  * @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
  */
 declare function postAptosProvingService<Req extends {}, Res extends {}>(options: PostAptosRequestOptions): Promise<AptosResponse<Req, Res>>;
 

package/dist/esm/client/post.mjs

@@ -1,2 +1,2 @@
-import{a,b,c,d,e,f}from"../chunk-YT3IP57B.mjs";import"../chunk-P6RNNESB.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-UZTJWOLS.mjs";import"../chunk-F45G3GP3.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-Q3CWUEXI.mjs";import"../chunk-42H7WETG.mjs";import"../chunk-ZMBXHMVQ.mjs";import"../chunk-BRV3RLKW.mjs";import"../chunk-D52UKPQF.mjs";import"../chunk-3OLFJ65O.mjs";import"../chunk-U2PRGW4O.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-AJ5JHBAE.mjs";import"../chunk-SPRNSFUV.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-V4FKFCBL.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-D3OEQLUE.mjs";import"../chunk-J7PJSK3J.mjs";import"../chunk-YQHOQJRQ.mjs";import"../chunk-KDMSOCZY.mjs";export{a as post,d as postAptosFaucet,b as postAptosFullNode,c as postAptosIndexer,e as postAptosPepperService,f as postAptosProvingService};
+import{a,b,c,d,e,f}from"../chunk-QD55JBJB.mjs";import"../chunk-EYE4UEWZ.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-4YLUM62M.mjs";import"../chunk-QHEKBHNU.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-TOBQ5UE6.mjs";import"../chunk-MT2RJ7H3.mjs";import"../chunk-IDTLNF4M.mjs";import"../chunk-ORMOQWWH.mjs";import"../chunk-3OLFJ65O.mjs";import"../chunk-U2PRGW4O.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-EBMEXURY.mjs";import"../chunk-DAFSKSZ5.mjs";import"../chunk-XTOIL6MB.mjs";import"../chunk-STY74NUA.mjs";import"../chunk-IF4UU2MT.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-4RXKALLC.mjs";import"../chunk-RJ7F4JDV.mjs";import"../chunk-IOZSAIGP.mjs";import"../chunk-KDMSOCZY.mjs";export{a as post,d as postAptosFaucet,b as postAptosFullNode,c as postAptosIndexer,e as postAptosPepperService,f as postAptosProvingService};
 //# sourceMappingURL=post.mjs.map

package/dist/esm/core/account/index.mjs

@@ -1,2 +1,2 @@
-import"../../chunk-NECL5FCQ.mjs";import"../../chunk-4QMXOWHP.mjs";import{a,b,c}from"../../chunk-6ZOVTYLJ.mjs";import"../../chunk-JNO7KPMG.mjs";import"../../chunk-3OLFJ65O.mjs";import"../../chunk-U2PRGW4O.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-AJ5JHBAE.mjs";import"../../chunk-SPRNSFUV.mjs";import"../../chunk-6Q2O5G3J.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as createObjectAddress,b as createResourceAddress,c as createTokenAddress};
+import"../../chunk-NECL5FCQ.mjs";import"../../chunk-4QMXOWHP.mjs";import{a,b,c}from"../../chunk-BI3BTSUB.mjs";import"../../chunk-Q4C4U6I4.mjs";import"../../chunk-3OLFJ65O.mjs";import"../../chunk-U2PRGW4O.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-EBMEXURY.mjs";import"../../chunk-STY74NUA.mjs";import"../../chunk-IF4UU2MT.mjs";import"../../chunk-56CNRT2K.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as createObjectAddress,b as createResourceAddress,c as createTokenAddress};
 //# sourceMappingURL=index.mjs.map

package/dist/esm/core/account/utils/address.d.mts

@@ -18,6 +18,8 @@ import '../../../transactions/instances/transactionArgument.mjs';
  * @param seed The seed in either Uint8Array | string type
  *
  * @returns The object account address
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 declare const createObjectAddress: (creatorAddress: AccountAddress, seed: Uint8Array | string) => AccountAddress;
 /**
@@ -27,6 +29,8 @@ declare 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)
  */
 declare const createResourceAddress: (creatorAddress: AccountAddress, seed: Uint8Array | string) => AccountAddress;
 /**
@@ -37,6 +41,8 @@ declare const createResourceAddress: (creatorAddress: AccountAddress, seed: Uint
  * @param tokenName The token name
  *
  * @returns The token account address
+ * @group Implementation
+ * @category Account (On-Chain Model)
  */
 declare const createTokenAddress: (creatorAddress: AccountAddress, collectionName: string, tokenName: string) => AccountAddress;
 

package/dist/esm/core/account/utils/address.mjs

@@ -1,2 +1,2 @@
-import{a,b,c}from"../../../chunk-6ZOVTYLJ.mjs";import"../../../chunk-JNO7KPMG.mjs";import"../../../chunk-3OLFJ65O.mjs";import"../../../chunk-U2PRGW4O.mjs";import"../../../chunk-4WPQQPUF.mjs";import"../../../chunk-AJ5JHBAE.mjs";import"../../../chunk-SPRNSFUV.mjs";import"../../../chunk-6Q2O5G3J.mjs";import"../../../chunk-56CNRT2K.mjs";import"../../../chunk-KDMSOCZY.mjs";export{a as createObjectAddress,b as createResourceAddress,c as createTokenAddress};
+import{a,b,c}from"../../../chunk-BI3BTSUB.mjs";import"../../../chunk-Q4C4U6I4.mjs";import"../../../chunk-3OLFJ65O.mjs";import"../../../chunk-U2PRGW4O.mjs";import"../../../chunk-4WPQQPUF.mjs";import"../../../chunk-EBMEXURY.mjs";import"../../../chunk-STY74NUA.mjs";import"../../../chunk-IF4UU2MT.mjs";import"../../../chunk-56CNRT2K.mjs";import"../../../chunk-KDMSOCZY.mjs";export{a as createObjectAddress,b as createResourceAddress,c as createTokenAddress};
 //# sourceMappingURL=address.mjs.map

package/dist/esm/core/account/utils/index.mjs

@@ -1,2 +1,2 @@
-import"../../../chunk-4QMXOWHP.mjs";import{a,b,c}from"../../../chunk-6ZOVTYLJ.mjs";import"../../../chunk-JNO7KPMG.mjs";import"../../../chunk-3OLFJ65O.mjs";import"../../../chunk-U2PRGW4O.mjs";import"../../../chunk-4WPQQPUF.mjs";import"../../../chunk-AJ5JHBAE.mjs";import"../../../chunk-SPRNSFUV.mjs";import"../../../chunk-6Q2O5G3J.mjs";import"../../../chunk-56CNRT2K.mjs";import"../../../chunk-KDMSOCZY.mjs";export{a as createObjectAddress,b as createResourceAddress,c as createTokenAddress};
+import"../../../chunk-4QMXOWHP.mjs";import{a,b,c}from"../../../chunk-BI3BTSUB.mjs";import"../../../chunk-Q4C4U6I4.mjs";import"../../../chunk-3OLFJ65O.mjs";import"../../../chunk-U2PRGW4O.mjs";import"../../../chunk-4WPQQPUF.mjs";import"../../../chunk-EBMEXURY.mjs";import"../../../chunk-STY74NUA.mjs";import"../../../chunk-IF4UU2MT.mjs";import"../../../chunk-56CNRT2K.mjs";import"../../../chunk-KDMSOCZY.mjs";export{a as createObjectAddress,b as createResourceAddress,c as createTokenAddress};
 //# sourceMappingURL=index.mjs.map

package/dist/esm/core/accountAddress.d.mts

@@ -12,6 +12,8 @@ import '@aptos-labs/script-composer-pack';
 
 /**
  * Provides reasons for an address was invalid.
+ * @group Implementation
+ * @category Serialization
  */
 declare enum AddressInvalidReason {
     INCORRECT_NUMBER_OF_BYTES = "incorrect_number_of_bytes",
@@ -25,6 +27,8 @@ declare enum AddressInvalidReason {
 }
 /**
  * The input for an account address, which can be either a hexadecimal string or a standard account address.
+ * @group Implementation
+ * @category Serialization
  */
 type AccountAddressInput = HexInput | AccountAddress;
 /**
@@ -42,18 +46,26 @@ 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
  */
 declare 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;
     /**
      * The length of an address string in LONG form without a leading 0x.
+     * @group Implementation
+     * @category Serialization
      */
     static readonly LONG_STRING_LENGTH: number;
     static ZERO: AccountAddress;
@@ -69,6 +81,8 @@ declare 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);
     /**
@@ -80,6 +94,8 @@ declare 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;
     /**
@@ -89,6 +105,8 @@ declare 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}`;
     /**
@@ -97,6 +115,8 @@ declare 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;
     /**
@@ -105,6 +125,8 @@ declare 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}`;
     /**
@@ -114,6 +136,8 @@ declare 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;
     /**
@@ -121,6 +145,8 @@ declare 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;
     /**
@@ -133,6 +159,8 @@ declare 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;
     /**
@@ -140,6 +168,8 @@ declare 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;
     /**
@@ -147,6 +177,8 @@ declare 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;
     /**
@@ -159,6 +191,8 @@ declare 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;
     /**
@@ -193,6 +227,8 @@ declare 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;
     /**
@@ -222,6 +258,8 @@ declare 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 }?: {
         maxMissingChars?: number;
@@ -234,6 +272,8 @@ declare class AccountAddress extends Serializable implements TransactionArgument
      * @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 }?: {
         maxMissingChars?: number;
@@ -242,6 +282,8 @@ declare class AccountAddress extends Serializable implements TransactionArgument
      * 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;
     /**
@@ -253,6 +295,8 @@ declare class AccountAddress extends Serializable implements TransactionArgument
      *
      * @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;
@@ -263,6 +307,8 @@ declare class AccountAddress extends Serializable implements TransactionArgument
      *
      * @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;
 }

package/dist/esm/core/accountAddress.mjs

@@ -1,2 +1,2 @@
-import{a,b}from"../chunk-JNO7KPMG.mjs";import"../chunk-3OLFJ65O.mjs";import"../chunk-U2PRGW4O.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-AJ5JHBAE.mjs";import"../chunk-SPRNSFUV.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-KDMSOCZY.mjs";export{b as AccountAddress,a as AddressInvalidReason};
+import{a,b}from"../chunk-Q4C4U6I4.mjs";import"../chunk-3OLFJ65O.mjs";import"../chunk-U2PRGW4O.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-EBMEXURY.mjs";import"../chunk-STY74NUA.mjs";import"../chunk-IF4UU2MT.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-KDMSOCZY.mjs";export{b as AccountAddress,a as AddressInvalidReason};
 //# sourceMappingURL=accountAddress.mjs.map

package/dist/esm/core/authenticationKey.d.mts

@@ -1,7 +1,7 @@
 import './accountAddress.mjs';
 import '../bcs/deserializer.mjs';
 import '../bcs/serializer.mjs';
-export { A as AuthenticationKey } from '../publicKey-BVXX1nVl.mjs';
+export { A as AuthenticationKey } from '../publicKey-BMtGNNLg.mjs';
 import '../types/types.mjs';
 import './hex.mjs';
 import './common.mjs';

package/dist/esm/core/authenticationKey.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-AKIO3OIT.mjs";import"../chunk-JNO7KPMG.mjs";import"../chunk-3OLFJ65O.mjs";import"../chunk-U2PRGW4O.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-AJ5JHBAE.mjs";import"../chunk-SPRNSFUV.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-KDMSOCZY.mjs";export{a as AuthenticationKey};
+import{a}from"../chunk-FN4C3CKC.mjs";import"../chunk-Q4C4U6I4.mjs";import"../chunk-3OLFJ65O.mjs";import"../chunk-U2PRGW4O.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-EBMEXURY.mjs";import"../chunk-STY74NUA.mjs";import"../chunk-IF4UU2MT.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-KDMSOCZY.mjs";export{a as AuthenticationKey};
 //# sourceMappingURL=authenticationKey.mjs.map

package/dist/esm/core/common.d.mts

@@ -1,11 +1,15 @@
 /**
  * This error is used to explain why parsing failed.
+ * @group Implementation
+ * @category Serialization
  */
 declare class ParsingError<T> extends Error {
     /**
      * This provides a programmatic way to access why parsing failed. Downstream devs
      * might want to use this to build their own error messages if the default error
      * messages are not suitable for their use case. This should be an enum.
+     * @group Implementation
+     * @category Serialization
      */
     invalidReason: T;
     /**
@@ -13,24 +17,34 @@ declare class ParsingError<T> extends Error {
      *
      * @param message The error message that describes the issue.
      * @param invalidReason The reason why the input is considered invalid.
+     * @group Implementation
+     * @category Serialization
      */
     constructor(message: string, invalidReason: T);
 }
 /**
  * Whereas ParsingError is thrown when parsing fails, e.g. in a fromString function,
  * this type is returned from "defensive" functions like isValid.
+ * @group Implementation
+ * @category Serialization
  */
 type ParsingResult<T> = {
     /**
      * True if valid, false otherwise.
+     * @group Implementation
+     * @category Serialization
      */
     valid: boolean;
     /**
      * If valid is false, this will be a code explaining why parsing failed.
+     * @group Implementation
+     * @category Serialization
      */
     invalidReason?: T;
     /**
      * If valid is false, this will be a string explaining why parsing failed.
+     * @group Implementation
+     * @category Serialization
      */
     invalidReasonMessage?: string;
 };

package/dist/esm/core/common.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-6Q2O5G3J.mjs";import"../chunk-KDMSOCZY.mjs";export{a as ParsingError};
+import{a}from"../chunk-IF4UU2MT.mjs";import"../chunk-KDMSOCZY.mjs";export{a as ParsingError};
 //# sourceMappingURL=common.mjs.map