@aptos-labs/ts-sdk 1.29.0 → 1.30.0

package/src/api/aptos.ts

@@ -17,15 +17,28 @@ import { Keyless } from "./keyless";
 import { AptosObject } from "./object";
 
 /**
- * This class is the main entry point into Aptos's
- * APIs and separates functionality into different namespaces.
+ * The main entry point for interacting with the Aptos APIs,
+ * providing access to various functionalities organized into
+ * distinct namespaces.
  *
- * To use the SDK, create a new Aptos instance to get access
- * to all the sdk functionality.
+ * To utilize the SDK, instantiate a new Aptos object to gain
+ * access to the complete range of SDK features.
  *
  * @example
+ * ```typescript
+ * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
  *
- * const aptos = new Aptos();
+ * async function runExample() {
+ *     // Create a configuration for connecting to the Aptos testnet
+ *     const config = new AptosConfig({ network: Network.TESTNET });
+ *
+ *     // Initialize the Aptos client with the configuration
+ *     const aptos = new Aptos(config);
+ *
+ *     console.log("Aptos client initialized:", aptos);
+ * }
+ * runExample().catch(console.error);
+ * ```
  */
 export class Aptos {
   readonly config: AptosConfig;
@@ -56,6 +69,26 @@ export class Aptos {
 
   readonly object: AptosObject;
 
+  /**
+   * Initializes a new instance of the Aptos client with the provided configuration settings.
+   * This allows you to interact with various Aptos functionalities such as accounts, transactions, and events.
+   *
+   * @param settings - Configuration settings for the Aptos client.
+   *
+   * @example
+   * ```typescript
+   * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+   *
+   * async function runExample() {
+   *     // Create a new Aptos client with default settings
+   *     const config = new AptosConfig({ network: Network.TESTNET }); // Specify your own settings if needed
+   *     const aptos = new Aptos(config);
+   *
+   *     console.log("Aptos client initialized:", aptos);
+   * }
+   * runExample().catch(console.error);
+   * ```
+   */
   constructor(settings?: AptosConfig) {
     this.config = new AptosConfig(settings);
     this.account = new Account(this.config);

package/src/api/aptosConfig.ts

@@ -14,11 +14,24 @@ import {
 import { AptosApiType } from "../utils/const";
 
 /**
- * This class holds the config information for the SDK client instance.
+ * Represents the configuration settings for an Aptos SDK client instance.
+ * This class allows customization of various endpoints and client settings.
  *
  * @example
+ * ```typescript
+ * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
  *
- * const aptosConfig = new AptosConfig({network:Network.TESTNET})
+ * async function runExample() {
+ *     // Create a configuration for connecting to the Aptos testnet
+ *     const config = new AptosConfig({ network: Network.TESTNET });
+ *
+ *     // Initialize the Aptos client with the configuration
+ *     const aptos = new Aptos(config);
+ *
+ *     console.log("Aptos client initialized:", aptos);
+ * }
+ * runExample().catch(console.error);
+ * ```
  */
 export class AptosConfig {
   /**
@@ -76,6 +89,37 @@ export class AptosConfig {
    */
   readonly faucetConfig?: FaucetConfig;
 
+  /**
+   * Initializes an instance of the Aptos client with the specified settings.
+   * This allows users to configure various aspects of the client, such as network and endpoints.
+   *
+   * @param settings - Optional configuration settings for the Aptos client.
+   * @param settings.network - The network to connect to, defaults to `Network.DEVNET`.
+   * @param settings.fullnode - The fullnode endpoint to use for requests.
+   * @param settings.faucet - The faucet endpoint for obtaining test tokens.
+   * @param settings.pepper - The pepper used for transaction signing.
+   * @param settings.prover - The prover endpoint for transaction verification.
+   * @param settings.indexer - The indexer endpoint for querying blockchain data.
+   * @param settings.client - Custom client settings, defaults to a standard Aptos client.
+   * @param settings.clientConfig - Additional configuration for the client.
+   * @param settings.fullnodeConfig - Additional configuration for the fullnode.
+   * @param settings.indexerConfig - Additional configuration for the indexer.
+   * @param settings.faucetConfig - Additional configuration for the faucet.
+   *
+   * @example
+   * ```typescript
+   * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+   *
+   * async function runExample() {
+   *     // Create a new Aptos client with default settings
+   *     const config = new AptosConfig({ network: Network.TESTNET }); // Specify the network
+   *     const aptos = new Aptos(config);
+   *
+   *     console.log("Aptos client initialized:", aptos);
+   * }
+   * runExample().catch(console.error);
+   * ```
+   */
   constructor(settings?: AptosSettings) {
     this.network = settings?.network ?? Network.DEVNET;
     this.fullnode = settings?.fullnode;
@@ -91,14 +135,25 @@ export class AptosConfig {
   }
 
   /**
-   * Returns the URL endpoint to send the request to.
-   * If a custom URL was provided in the config, that URL is returned.
-   * If a custom URL was provided but not URL endpoints, an error is thrown.
-   * Otherwise, the URL endpoint is derived from the network.
+   * Returns the URL endpoint to send the request to based on the specified API type.
+   * If a custom URL was provided in the configuration, that URL is returned. Otherwise, the URL endpoint is derived from the network.
+   *
+   * @param apiType - The type of Aptos API to get the URL for. This can be one of the following: FULLNODE, FAUCET, INDEXER, PEPPER, PROVER.
    *
-   * @param apiType - The type of Aptos API to get the URL for.
+   * @example
+   * ```typescript
+   * import { Aptos, AptosConfig, Network, AptosApiType } from "@aptos-labs/ts-sdk";
    *
-   * @internal
+   * const config = new AptosConfig({ network: Network.TESTNET });
+   * const aptos = new Aptos(config);
+   *
+   * async function runExample() {
+   *   // Getting the request URL for the FULLNODE API
+   *   const url = config.getRequestUrl(AptosApiType.FULLNODE);
+   *   console.log("Request URL for FULLNODE:", url);
+   * }
+   * runExample().catch(console.error);
+   * ```
    */
   getRequestUrl(apiType: AptosApiType): string {
     switch (apiType) {
@@ -128,19 +183,52 @@ export class AptosConfig {
   }
 
   /**
-   * Checks if the URL is a known pepper service endpoint
+   * Checks if the provided URL is a known pepper service endpoint.
+   *
+   * @param url - The URL to check against the known pepper service endpoints.
    *
-   * @internal
-   * */
+   * @example
+   * ```typescript
+   * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+   *
+   * const config = new AptosConfig({ network: Network.TESTNET });
+   * const aptos = new Aptos(config);
+   *
+   * async function runExample() {
+   *     const url = "https://example.pepper.service"; // replace with a real pepper service URL
+   *
+   *     // Check if the URL is a known pepper service endpoint
+   *     const isPepperService = config.isPepperServiceRequest(url);
+   *
+   *     console.log(`Is the URL a known pepper service? ${isPepperService}`);
+   * }
+   * runExample().catch(console.error);
+   * ```
+   */
   isPepperServiceRequest(url: string): boolean {
     return NetworkToPepperAPI[this.network] === url;
   }
 
   /**
-   * Checks if the URL is a known prover service endpoint
+   * Checks if the provided URL is a known prover service endpoint.
    *
-   * @internal
-   * */
+   * @param url - The URL to check against known prover service endpoints.
+   * @returns A boolean indicating whether the URL is a known prover service endpoint.
+   *
+   * @example
+   * ```typescript
+   * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+   *
+   * const config = new AptosConfig({ network: Network.TESTNET });
+   * const aptos = new Aptos(config);
+   *
+   * // Check if the URL is a known prover service endpoint
+   * const url = "https://prover.testnet.aptos.dev"; // replace with a real URL if needed
+   * const isProver = config.isProverServiceRequest(url);
+   *
+   * console.log(`Is the URL a known prover service? ${isProver}`);
+   * ```
+   */
   isProverServiceRequest(url: string): boolean {
     return NetworkToProverAPI[this.network] === url;
   }

package/src/api/coin.ts

@@ -9,27 +9,64 @@ import { AnyNumber, MoveStructId } from "../types";
 import { AptosConfig } from "./aptosConfig";
 
 /**
- * A class to handle all `Coin` operations
+ * A class to handle all `Coin` operations.
  */
 export class Coin {
+  /**
+   * Initializes a new instance of the Aptos client with the specified configuration.
+   * This allows you to interact with the Aptos blockchain using the provided settings.
+   *
+   * @param config - The configuration settings for the Aptos client.
+   *
+   * @example
+   * ```typescript
+   * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+   *
+   * async function runExample() {
+   *     // Create a new Aptos client with testnet configuration
+   *     const config = new AptosConfig({ network: Network.TESTNET });
+   *     const aptos = new Aptos(config);
+   *
+   *     console.log("Aptos client initialized:", aptos);
+   * }
+   * runExample().catch(console.error);
+   * ```
+   */
   constructor(readonly config: AptosConfig) {}
 
   /**
-   * Generate a transfer coin transaction that can be simulated and/or signed and submitted
+   * Generate a transfer coin transaction that can be simulated, signed, and submitted.
+   * This function helps you create a transaction to transfer a specified amount of coins
+   * from one account to another within the Aptos network.
+   *
+   * @param args The arguments for the transfer transaction.
+   * @param args.sender The sender account address.
+   * @param args.recipient The recipient account address.
+   * @param args.amount The amount of coins to transfer.
+   * @param args.coinType Optional. The coin struct type to transfer. Defaults to 0x1::aptos_coin::AptosCoin.
+   * @param args.options Optional. Additional options for generating the transaction.
+   *
+   * @returns SimpleTransaction
    *
    * @example
-   * const transferCoinTransaction = await aptos.transferCoinTransaction({
-   * sender: "0x123",
-   * recipient:"0x456",
-   * amount: 10,
-   * })
+   * ```typescript
+   * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
    *
-   * @param args.sender The sender account
-   * @param args.recipient The recipient address
-   * @param args.amount The amount to transfer
-   * @param args.coinType optional. The coin struct type to transfer. Defaults to 0x1::aptos_coin::AptosCoin
+   * const config = new AptosConfig({ network: Network.TESTNET });
+   * const aptos = new Aptos(config);
    *
-   * @returns SimpleTransaction
+   * async function runExample() {
+   *   // Generate a transfer coin transaction
+   *   const transaction = await aptos.transferCoinTransaction({
+   *     sender: "0x1", // replace with a real sender account address
+   *     recipient: "0x2", // replace with a real recipient account address
+   *     amount: 10,
+   *   });
+   *
+   *   console.log(transaction);
+   * }
+   * runExample().catch(console.error);
+   * ```
    */
   async transferCoinTransaction(args: {
     sender: AccountAddressInput;