@aptos-labs/ts-sdk 1.33.1 → 1.33.2

package/src/api/faucet.ts

@@ -10,11 +10,15 @@ import { ProcessorType } from "../utils";
 
 /**
  * A class to query all `Faucet` related queries on Aptos.
+ * @group Faucet
  */
 export class Faucet {
   /**
    * Initializes a new instance of the Aptos client with the specified configuration.
    *
+   * Note that only devnet has a publicly accessible faucet. For testnet, you must use
+   * the minting page at https://aptos.dev/network/faucet.
+   *
    * @param config - The configuration settings for the Aptos client.
    *
    * @example
@@ -23,7 +27,7 @@ export class Faucet {
    *
    * async function runExample() {
    *     // Create a configuration for the Aptos client
-   *     const config = new AptosConfig({ network: Network.TESTNET }); // specify your own network if needed
+   *     const config = new AptosConfig({ network: Network.DEVNET }); // specify your own network if needed
    *
    *     // Initialize the Aptos client with the configuration
    *     const aptos = new Aptos(config);
@@ -32,12 +36,16 @@ export class Faucet {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Faucet
    */
   constructor(readonly config: AptosConfig) {}
 
   /**
    * This function creates an account if it does not exist and mints the specified amount of coins into that account.
    *
+   * Note that only devnet has a publicly accessible faucet. For testnet, you must use
+   * the minting page at https://aptos.dev/network/faucet.
+   *
    * @param args - The arguments for funding the account.
    * @param args.accountAddress - The address of the account to fund.
    * @param args.amount - The amount of tokens to fund the account with.
@@ -48,7 +56,7 @@ export class Faucet {
    * ```typescript
    * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
    *
-   * const config = new AptosConfig({ network: Network.TESTNET });
+   * const config = new AptosConfig({ network: Network.DEVNET });
    * const aptos = new Aptos(config);
    *
    * async function runExample() {
@@ -62,6 +70,7 @@ export class Faucet {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Faucet
    */
   async fundAccount(args: {
     accountAddress: AccountAddressInput;

package/src/api/fungibleAsset.ts

@@ -30,6 +30,7 @@ import { SimpleTransaction } from "../transactions/instances/simpleTransaction";
 
 /**
  * A class for querying and managing fungible asset-related operations on the Aptos blockchain.
+ * @group FungibleAsset
  */
 export class FungibleAsset {
   /**
@@ -53,6 +54,7 @@ export class FungibleAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group FungibleAsset
    */
   constructor(readonly config: AptosConfig) {}
 
@@ -79,6 +81,7 @@ export class FungibleAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group FungibleAsset
    */
   async getFungibleAssetMetadata(args?: {
     minimumLedgerVersion?: AnyNumber;
@@ -119,6 +122,7 @@ export class FungibleAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group FungibleAsset
    */
   async getFungibleAssetMetadataByAssetType(args: {
     assetType: string;
@@ -169,6 +173,7 @@ export class FungibleAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group FungibleAsset
    */
   async getFungibleAssetMetadataByCreatorAddress(args: {
     creatorAddress: AccountAddressInput;
@@ -213,6 +218,7 @@ export class FungibleAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group FungibleAsset
    */
   async getFungibleAssetActivities(args?: {
     minimumLedgerVersion?: AnyNumber;
@@ -250,6 +256,7 @@ export class FungibleAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group FungibleAsset
    */
   async getCurrentFungibleAssetBalances(args?: {
     minimumLedgerVersion?: AnyNumber;
@@ -297,6 +304,7 @@ export class FungibleAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group FungibleAsset
    */
   async transferFungibleAsset(args: {
     sender: Account;

package/src/api/general.ts

@@ -26,6 +26,7 @@ import { InputViewFunctionData, InputViewFunctionJsonData } from "../transaction
 
 /**
  * A class to query various Aptos-related information and perform operations on the Aptos blockchain.
+ * @group General
  */
 export class General {
   readonly config: AptosConfig;
@@ -56,6 +57,7 @@ export class General {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group General
    */
   constructor(config: AptosConfig) {
     this.config = config;
@@ -81,6 +83,7 @@ export class General {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group General
    */
   async getLedgerInfo(): Promise<LedgerInfo> {
     return getLedgerInfo({ aptosConfig: this.config });
@@ -105,6 +108,7 @@ export class General {
    *
    * @returns The chain ID of the Aptos blockchain.
    * ```
+   * @group General
    */
   async getChainId(): Promise<number> {
     const result = await this.getLedgerInfo();
@@ -135,6 +139,7 @@ export class General {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group General
    */
   async getBlockByVersion(args: {
     ledgerVersion: AnyNumber;
@@ -170,6 +175,7 @@ export class General {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group General
    */
   async getBlockByHeight(args: { blockHeight: AnyNumber; options?: { withTransactions?: boolean } }): Promise<Block> {
     return getBlockByHeight({ aptosConfig: this.config, ...args });
@@ -190,6 +196,7 @@ export class General {
    * })
    *
    * @returns an array of Move values
+   * @group General
    */
   async view<T extends Array<MoveValue>>(args: {
     payload: InputViewFunctionData;
@@ -213,6 +220,7 @@ export class General {
    * })
    *
    * @returns an array of Move values
+   * @group General
    */
   async viewJson<T extends Array<MoveValue>>(args: {
     payload: InputViewFunctionJsonData;
@@ -243,6 +251,7 @@ export class General {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group General
    */
   async getChainTopUserTransactions(args: { limit: number }): Promise<GetChainTopUserTransactionsResponse> {
     return getChainTopUserTransactions({
@@ -281,6 +290,7 @@ export class General {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group General
    */
   async queryIndexer<T extends {}>(args: { query: GraphqlQuery }): Promise<T> {
     return queryIndexer<T>({
@@ -307,6 +317,7 @@ export class General {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group General
    */
   async getIndexerLastSuccessVersion(): Promise<bigint> {
     return getIndexerLastSuccessVersion({ aptosConfig: this.config });
@@ -332,6 +343,7 @@ export class General {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group General
    */
   async getProcessorStatus(processorType: ProcessorType): Promise<GetProcessorStatusResponse[0]> {
     return getProcessorStatus({ aptosConfig: this.config, processorType });

package/src/api/keyless.ts

@@ -19,6 +19,7 @@ import { AptosConfig } from "./aptosConfig";
  *
  * More documentation on how to integrate Keyless Accounts see the below
  * [Aptos Keyless Integration Guide](https://aptos.dev/guides/keyless-accounts/#aptos-keyless-integration-guide).
+ * @group Keyless
  */
 export class Keyless {
   /**
@@ -42,6 +43,7 @@ export class Keyless {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Keyless
    */
   constructor(readonly config: AptosConfig) {}
 
@@ -77,6 +79,7 @@ export class Keyless {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Keyless
    */
   async getPepper(args: {
     jwt: string;
@@ -120,6 +123,7 @@ export class Keyless {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Keyless
    */
   async getProof(args: {
     jwt: string;
@@ -186,6 +190,7 @@ export class Keyless {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Keyless
    */
   async deriveKeylessAccount(args: {
     jwt: string;
@@ -209,6 +214,7 @@ export class Keyless {
    * @param args.jwksUrl the URL to find the corresponding JWKs. For supported IDP providers this parameter in not necessary.
    *
    * @returns The pending transaction that results from submission.
+   * @group Keyless
    */
   async updateFederatedKeylessJwkSetTransaction(args: {
     sender: Account;

package/src/api/object.ts

@@ -10,6 +10,7 @@ import { getObjectDataByObjectAddress } from "../internal/object";
 
 /**
  * A class to query all `Object` related queries on Aptos.
+ * @group Object
  */
 export class AptosObject {
   /**
@@ -39,6 +40,7 @@ export class AptosObject {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Object
    */
   constructor(readonly config: AptosConfig) {}
 
@@ -68,6 +70,7 @@ export class AptosObject {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Object
    */
   async getObjectDataByObjectAddress(args: {
     objectAddress: AccountAddressInput;

package/src/api/staking.ts

@@ -14,6 +14,7 @@ import { waitForIndexerOnVersion } from "./utils";
 
 /**
  * A class to query all `Staking` related queries on Aptos.
+ * @group Staking
  */
 export class Staking {
   /**
@@ -39,6 +40,7 @@ export class Staking {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Staking
    */
   constructor(readonly config: AptosConfig) {}
 
@@ -64,6 +66,7 @@ export class Staking {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Staking
    */
   async getNumberOfDelegators(args: {
     poolAddress: AccountAddressInput;
@@ -99,6 +102,7 @@ export class Staking {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Staking
    */
   async getNumberOfDelegatorsForAllPools(args?: {
     minimumLedgerVersion?: AnyNumber;
@@ -140,6 +144,7 @@ export class Staking {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Staking
    */
   async getDelegatedStakingActivities(args: {
     delegatorAddress: AccountAddressInput;

package/src/api/table.ts

@@ -16,6 +16,7 @@ import { waitForIndexerOnVersion } from "./utils";
 
 /**
  * A class to query all `Table` Aptos related queries.
+ * @group Table
  */
 export class Table {
   readonly config: AptosConfig;
@@ -39,6 +40,7 @@ export class Table {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Table
    */
   constructor(config: AptosConfig) {
     this.config = config;
@@ -79,6 +81,7 @@ export class Table {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Table
    */
   async getTableItem<T>(args: { handle: string; data: TableItemRequest; options?: LedgerVersionArg }): Promise<T> {
     return getTableItem<T>({ aptosConfig: this.config, ...args });
@@ -124,6 +127,7 @@ export class Table {
    * ```
    *
    * @returns GetTableItemsDataResponse
+   * @group Table
    */
   async getTableItemsData(args: {
     minimumLedgerVersion?: AnyNumber;
@@ -173,6 +177,7 @@ export class Table {
    * ```
    *
    * @returns GetTableItemsMetadataResponse
+   * @group Table
    */
   async getTableItemsMetadata(args: {
     minimumLedgerVersion?: AnyNumber;

package/src/api/transaction.ts

@@ -36,7 +36,7 @@ import {
   InputGenerateTransactionOptions,
   InputGenerateTransactionPayloadData,
 } from "../transactions";
-import { AccountAddressInput, PrivateKey } from "../core";
+import { AccountAddressInput, PrivateKeyInput } from "../core";
 import { Account } from "../account";
 import { Build } from "./transactionSubmission/build";
 import { Simulate } from "./transactionSubmission/simulate";
@@ -66,7 +66,7 @@ import { SimpleTransaction } from "../transactions/instances/simpleTransaction";
  *   );
  *
  *   // Set up the client
- *   const config = new AptosConfig({ network: Network.TESTNET });
+ *   const config = new AptosConfig({ network: Network.DEVNET });
  *   const aptos = new Aptos(config);
  *
  *   // Generate two account credentials
@@ -126,6 +126,7 @@ import { SimpleTransaction } from "../transactions/instances/simpleTransaction";
  *
  * example();
  * ```
+ * @group Transaction
  */
 export class Transaction {
   readonly config: AptosConfig;
@@ -159,6 +160,7 @@ export class Transaction {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Transaction
    */
   constructor(config: AptosConfig) {
     this.config = config;
@@ -199,6 +201,7 @@ export class Transaction {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Transaction
    */
   async getTransactions(args?: { options?: PaginationArgs }): Promise<TransactionResponse[]> {
     return getTransactions({
@@ -229,6 +232,7 @@ export class Transaction {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Transaction
    */
   async getTransactionByVersion(args: { ledgerVersion: AnyNumber }): Promise<TransactionResponse> {
     return getTransactionByVersion({
@@ -259,6 +263,7 @@ export class Transaction {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Transaction
    */
   async getTransactionByHash(args: { transactionHash: HexInput }): Promise<TransactionResponse> {
     return getTransactionByHash({
@@ -289,6 +294,7 @@ export class Transaction {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Transaction
    */
   async isPendingTransaction(args: { transactionHash: HexInput }): Promise<boolean> {
     return isTransactionPending({
@@ -340,6 +346,7 @@ export class Transaction {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Transaction
    */
   async waitForTransaction(args: {
     transactionHash: HexInput;
@@ -373,6 +380,7 @@ export class Transaction {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Transaction
    */
   async getGasPriceEstimation(): Promise<GasEstimation> {
     return getGasPriceEstimation({
@@ -407,6 +415,7 @@ export class Transaction {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Transaction
    */
   // eslint-disable-next-line class-methods-use-this
   getSigningMessage(args: { transaction: AnyRawTransaction }): Uint8Array {
@@ -453,6 +462,7 @@ export class Transaction {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Transaction
    */
   async publishPackageTransaction(args: {
     account: AccountAddressInput;
@@ -494,8 +504,9 @@ export class Transaction {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Transaction
    */
-  async rotateAuthKey(args: { fromAccount: Account; toNewPrivateKey: PrivateKey }): Promise<TransactionResponse> {
+  async rotateAuthKey(args: { fromAccount: Account; toNewPrivateKey: PrivateKeyInput }): Promise<TransactionResponse> {
     return rotateAuthKey({ aptosConfig: this.config, ...args });
   }
 
@@ -535,6 +546,7 @@ export class Transaction {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Transaction
    */
   // eslint-disable-next-line class-methods-use-this
   sign(args: { signer: Account; transaction: AnyRawTransaction }): AccountAuthenticator {
@@ -578,6 +590,7 @@ export class Transaction {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Transaction
    */
   // eslint-disable-next-line class-methods-use-this
   signAsFeePayer(args: { signer: Account; transaction: AnyRawTransaction }): AccountAuthenticator {
@@ -626,6 +639,7 @@ export class Transaction {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Transaction
    */
   async batchTransactionsForSingleAccount(args: {
     sender: Account;
@@ -676,6 +690,7 @@ export class Transaction {
    * runExample().catch(console.error);
    * ```
    * @return PendingTransactionResponse
+   * @group Transaction
    */
   async signAndSubmitTransaction(
     args: FeePayerOrFeePayerAuthenticatorOrNeither & {
@@ -706,6 +721,7 @@ export class Transaction {
    * })
    *
    * @return PendingTransactionResponse
+   * @group Transaction
    */
   async signAndSubmitAsFeePayer(args: {
     feePayer: Account;

package/src/api/transactionSubmission/build.ts

@@ -10,6 +10,7 @@ import { AptosConfig } from "../aptosConfig";
 
 /**
  * A class to handle all `Build` transaction operations.
+ * @group Implementation
  */
 export class Build {
   readonly config: AptosConfig;
@@ -41,6 +42,7 @@ export class Build {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Implementation
    */
   constructor(config: AptosConfig) {
     this.config = config;
@@ -83,6 +85,7 @@ export class Build {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Implementation
    */
   async simple(args: {
     sender: AccountAddressInput;
@@ -133,6 +136,7 @@ export class Build {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Implementation
    */
   async multiAgent(args: {
     sender: AccountAddressInput;

package/src/api/transactionSubmission/helpers.ts

@@ -43,6 +43,7 @@
  * }
  * runExample().catch(console.error);
  * ```
+ * @group Implementation
  */
 export function ValidateFeePayerDataOnSubmission(target: unknown, propertyKey: string, descriptor: PropertyDescriptor) {
   const originalMethod = descriptor.value;
@@ -92,6 +93,7 @@ export function ValidateFeePayerDataOnSubmission(target: unknown, propertyKey: s
  * }
  * runExample().catch(console.error);
  * ```
+ * @group Implementation
  */
 export function ValidateFeePayerDataOnSimulation(target: unknown, propertyKey: string, descriptor: PropertyDescriptor) {
   const originalMethod = descriptor.value;

package/src/api/transactionSubmission/management.ts

@@ -38,6 +38,7 @@ export class TransactionManagement extends EventEmitter<TransactionWorkerEvents>
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Implementation
    */
   constructor(config: AptosConfig) {
     super();
@@ -68,6 +69,7 @@ export class TransactionManagement extends EventEmitter<TransactionWorkerEvents>
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Implementation
    */
   private start(args: { sender: Account }): void {
     const { sender } = args;
@@ -108,6 +110,7 @@ export class TransactionManagement extends EventEmitter<TransactionWorkerEvents>
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Implementation
    */
   private push(args: {
     data: InputGenerateTransactionPayloadData[];
@@ -153,6 +156,7 @@ export class TransactionManagement extends EventEmitter<TransactionWorkerEvents>
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Implementation
    */
   private registerToEvents() {
     // TODO - Should we ask events to listen to this as an input?
@@ -188,6 +192,7 @@ export class TransactionManagement extends EventEmitter<TransactionWorkerEvents>
    * @param args.options optional. Transaction generation configurations (excluding accountSequenceNumber)
    *
    * @return void. Throws if any error
+   * @group Implementation
    */
   forSingleAccount(args: {
     sender: Account;

package/src/api/transactionSubmission/sign.ts

@@ -10,6 +10,7 @@ import { AptosConfig } from "../aptosConfig";
  * A class to handle all `Sign` transaction operations.
  *
  * @param config - The configuration object for Aptos.
+ * @group Implementation
  */
 export class Sign {
   readonly config: AptosConfig;
@@ -32,6 +33,7 @@ export class Sign {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Implementation
    */
   constructor(config: AptosConfig) {
     this.config = config;
@@ -72,6 +74,7 @@ export class Sign {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Implementation
    */
   // eslint-disable-next-line class-methods-use-this
   transaction(args: { signer: Account; transaction: AnyRawTransaction }): AccountAuthenticator {
@@ -116,6 +119,7 @@ export class Sign {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Implementation
    */
   // eslint-disable-next-line class-methods-use-this
   transactionAsFeePayer(args: { signer: Account; transaction: AnyRawTransaction }): AccountAuthenticator {

package/src/api/transactionSubmission/simulate.ts

@@ -10,6 +10,7 @@ import { ValidateFeePayerDataOnSimulation } from "./helpers";
 
 /**
  * A class to handle all `Simulate` transaction operations.
+ * @group Implementation
  */
 export class Simulate {
   readonly config: AptosConfig;
@@ -37,6 +38,7 @@ export class Simulate {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Implementation
    */
   constructor(config: AptosConfig) {
     this.config = config;
@@ -97,6 +99,7 @@ export class Simulate {
    *
    * example();
    * ```
+   * @group Implementation
    */
   @ValidateFeePayerDataOnSimulation
   async simple(args: {
@@ -174,6 +177,7 @@ export class Simulate {
    *
    * example();
    * ```
+   * @group Implementation
    */
   @ValidateFeePayerDataOnSimulation
   async multiAgent(args: {

package/src/api/transactionSubmission/submit.ts

@@ -9,6 +9,7 @@ import { ValidateFeePayerDataOnSubmission } from "./helpers";
 
 /**
  * A class to handle all `Submit` transaction operations.
+ * @group Implementation
  */
 export class Submit {
   readonly config: AptosConfig;
@@ -41,6 +42,7 @@ export class Submit {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Implementation
    */
   constructor(config: AptosConfig) {
     this.config = config;
@@ -82,6 +84,7 @@ export class Submit {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Implementation
    */
   @ValidateFeePayerDataOnSubmission
   async simple(args: {
@@ -135,6 +138,7 @@ export class Submit {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Implementation
    */
   @ValidateFeePayerDataOnSubmission
   async multiAgent(args: {

package/src/api/utils.ts

@@ -31,6 +31,7 @@ import { AnyNumber } from "../types";
  * }
  * runExample().catch(console.error);
  * ```
+ * @group Implementation
  */
 export async function waitForIndexerOnVersion(args: {
   config: AptosConfig;