@aptos-labs/ts-sdk 1.12.2 → 1.13.0-zeta.0

package/src/api/account.ts

@@ -1,7 +1,8 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-import { AccountAddress, PrivateKey, Account as AccountModule, AccountAddressInput } from "../core";
+import { Account as AccountModule} from "../account"
+import { AccountAddress, PrivateKey, AccountAddressInput } from "../core";
 import {
   AccountData,
   AnyNumber,
@@ -99,7 +100,9 @@ export class Account {
    *
    * @returns Account module
    *
-   * @example An example of an account module
+   * @example
+   * const module = await aptos.getAccountModule({accountAddress:"0x456"})
+   * // An example of an account module response
    * ```
    * {
    *    bytecode: "0xa11ceb0b0600000006010002030206050807070f0d081c200",
@@ -121,6 +124,9 @@ export class Account {
    * Note: In order to get all account transactions, this function may call the API
    * multiple times as it auto paginates.
    *
+   * @example
+   * const transactions = await aptos.getAccountTransactions({accountAddress:"0x456"})
+   *
    * @param args.accountAddress Aptos account address
    * @param args.options.offset The number transaction to start returning results from
    * @param args.options.limit The number of results to return
@@ -143,6 +149,9 @@ export class Account {
    * Note: In order to get all account resources, this function may call the API
    * multiple times as it auto paginates.
    *
+   * @example
+   * const resources = await aptos.getAccountResources({accountAddress:"0x456"})
+   *
    * @param args.accountAddress Aptos account address
    * @param args.options.offset The number resource to start returning results from
    * @param args.options.limit The number of results to return
@@ -167,12 +176,9 @@ export class Account {
    *
    * @returns Account resource
    *
-   * @example An example of an account resource
-   * ```
-   * {
-   *    value: 6
-   * }
-   * ```
+   * @example
+   * const resource = await aptos.getAccountResource({accountAddress:"0x456"})
+   *
    */
   async getAccountResource<T extends {} = any>(args: {
     accountAddress: AccountAddressInput;
@@ -187,6 +193,9 @@ export class Account {
    *
    * This handles both if the account's authentication key has been rotated or not.
    *
+   * @example
+   * const accountAddress = await aptos.lookupOriginalAccountAddress({authenticationKey:account.accountAddress})
+   *
    * @param args.authenticationKey The authentication key
    * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
    * @param args.options.ledgerVersion The ledger version to query, if not provided it will get the latest version
@@ -203,6 +212,9 @@ export class Account {
   /**
    * Queries the current count of tokens owned by an account
    *
+   * @example
+   * const tokensCount = await aptos.getAccountTokensCount({accountAddress:"0x456"})
+   *
    * @param args.accountAddress The account address
    * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
    * @returns Current count of tokens owned by the account
@@ -228,6 +240,9 @@ export class Account {
    * This query returns all tokens (v1 and v2 standards) an account owns, including NFTs, fungible, soulbound, etc.
    * If you want to get only the token from a specific standard, you can pass an optional tokenStandard param
    *
+   * @example
+   * const accountOwnedTokens = await aptos.getAccountOwnedTokens({accountAddress:"0x456"})
+   *
    * @param args.accountAddress The account address we want to get the tokens for
    * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
    * @param args.options.tokenStandard The NFT standard to query for
@@ -258,6 +273,9 @@ export class Account {
    * This query returns all tokens (v1 and v2 standards) an account owns, including NFTs, fungible, soulbound, etc.
    * If you want to get only the token from a specific standard, you can pass an optional tokenStandard param
    *
+   * @example
+   * const accountOwnedTokens = await aptos.getAccountOwnedTokensFromCollectionAddress({accountAddress:"0x123", collectionAddress:"0x456"})
+   *
    * @param args.accountAddress The account address we want to get the tokens for
    * @param args.collectionAddress The address of the collection being queried
    * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
@@ -290,6 +308,9 @@ export class Account {
    * This query returns all tokens (v1 and v2 standards) an account owns, including NFTs, fungible, soulbound, etc.
    * If you want to get only the token from a specific standard, you can pass an optional tokenStandard param
    *
+   * @example
+   * const accountCollectionsWithOwnedTokens = await aptos.getAccountCollectionsWithOwnedTokens({accountAddress:"0x123"})
+   *
    * @param args.accountAddress The account address we want to get the collections for
    * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
    * @param args.options.tokenStandard The NFT standard to query for
@@ -317,6 +338,9 @@ export class Account {
   /**
    * Queries the current count of transactions submitted by an account
    *
+   * @example
+   * const accountTransactionsCount = await aptos.getAccountTransactionsCount({accountAddress:"0x123"})
+   *
    * @param args.accountAddress The account address we want to get the total count for
    * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
    * @returns Current count of transactions made by an account
@@ -339,6 +363,9 @@ export class Account {
   /**
    * Queries an account's coins data
    *
+   * @example
+   * const accountCoinsData = await aptos.getAccountCoinsData({accountAddress:"0x123"})
+   *
    * @param args.accountAddress The account address we want to get the coins data for
    * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
    * @param args.options.offset optional. The number coin to start returning results from
@@ -368,6 +395,9 @@ export class Account {
   /**
    * Queries the current count of an account's coins aggregated
    *
+   * @example
+   * const accountCoinsCount = await aptos.getAccountCoinsCount({accountAddress:"0x123"})
+   *
    * @param args.accountAddress The account address we want to get the total count for
    * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
    * @returns Current count of the aggregated count of all account's coins
@@ -387,6 +417,9 @@ export class Account {
   /**
    * Queries the account's APT amount
    *
+   * @example
+   * const accountAPTAmount = await aptos.getAccountAPTAmount({accountAddress:"0x123"})
+   *
    * @param args.accountAddress The account address we want to get the total count for
    * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
    * @returns Current amount of account's APT
@@ -401,6 +434,9 @@ export class Account {
   /**
    * Queries the account's coin amount by the coin type
    *
+   * @example
+   * const accountCoinAmount = await aptos.getAccountCoinAmount({accountAddress:"0x123", coinType:"0x1::aptos_coin::AptosCoin"})
+   *
    * @param args.accountAddress The account address we want to get the total count for
    * @param args.coinType The coin type to query
    * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
@@ -422,6 +458,9 @@ export class Account {
   /**
    * Queries an account's owned objects
    *
+   * @example
+   * const accountOwnedObjects = await aptos.getAccountOwnedObjects({accountAddress:"0x123"})
+   *
    * @param args.accountAddress The account address we want to get the objects for
    * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
    * @param args.options.offset The starting position to start returning results from
@@ -456,6 +495,9 @@ export class Account {
    * whether it is a Legacy ED25519 key or a Unified ED25519 key. It then derives the account based
    * on that.
    *
+   * @example
+   * const account = await aptos.deriveAccountFromPrivateKey({privateKey:new Ed25519PrivateKey("0x123")})
+   *
    * @param args.privateKey An account private key
    * @returns Account type
    */

package/src/api/ans.ts

@@ -1,7 +1,7 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-import { Account, AccountAddress, AccountAddressInput } from "../core";
+import { AccountAddress, AccountAddressInput } from "../core";
 import {
   RegisterNameParameters,
   getExpiration,
@@ -26,6 +26,7 @@ import { GetANSNameResponse } from "../types";
 import { InputGenerateTransactionOptions } from "../transactions/types";
 import { AptosConfig } from "./aptosConfig";
 import { SimpleTransaction } from "../transactions/instances/simpleTransaction";
+import { Account } from "../account";
 
 /**
  * A class to handle all `ANS` operations
@@ -36,11 +37,10 @@ export class ANS {
   /**
    * Retrieve the owner address of a domain name or subdomain name from the contract.
    *
-   * ```ts
+   * @example
    * // Will return the owner address of "test.aptos.apt" or undefined
    * const owner = await aptos.getOwnerAddress({name: "test.aptos"})
    * // owner = 0x123...
-   * ```
    *
    * @param args.name - A string of the name to retrieve
    *
@@ -53,11 +53,10 @@ export class ANS {
   /**
    * Retrieve the expiration time of a domain name or subdomain name from the contract.
    *
-   * ```ts
+   * @example
    * // Will return the expiration of "test.aptos.apt" or undefined
    * const exp = await aptos.getExpiration({name: "test.aptos"})
    * // new Date(exp) would give you the date in question: 2021-01-01T00:00:00.000Z
-   * ```
    *
    * @param args.name - A string of the name to retrieve
    *
@@ -72,10 +71,9 @@ export class ANS {
    * address the name points to for use on chain. Note, the target address can
    * point to addresses that are not the owner of the name
    *
-   * ```ts
+   * @example
    * const targetAddr = await aptos.getTargetAddress({name: "test.aptos"})
    * // targetAddr = 0x123...
-   * ```
    *
    * @param args.name - A string of the name: primary, primary.apt, secondary.primary, secondary.primary.apt, etc.
    *
@@ -90,11 +88,10 @@ export class ANS {
    * address the name points to for use on chain. Note, the target address can
    * point to addresses that are not the owner of the name
    *
-   * ```ts
+   * @example
    * await aptos.setTargetAddress({sender: alice, name: "test.aptos", address: bob.accountAddress})
    * const address = await aptos.getTargetAddress({name: "test.aptos"})
    * // address = bob.accountAddress
-   * ```
    *
    * @param args.name - A string of the name: test.aptos.apt, test.apt, test, test.aptos, etc.
    * @param args.address - A AccountAddressInput of the address to set the domain or subdomain to
@@ -115,10 +112,9 @@ export class ANS {
    * multiple names that target it, but only a single name that is primary. An
    * account also may not have a primary name.
    *
-   * ```ts
+   * @example
    * const name = await aptos.getPrimaryName({address: alice.accountAddress})
    * // name = test.aptos
-   * ```
    *
    * @param args.address - A AccountAddressInput (address) of the account
    *
@@ -133,11 +129,10 @@ export class ANS {
    * multiple names that target it, but only a single name that is primary. An
    * account also may not have a primary name.
    *
-   * ```ts
+   * @example
    * await aptos.setPrimaryName({sender: alice, name: "test.aptos"})
    * const primaryName = await aptos.getPrimaryName({address: alice.accountAddress})
    * // primaryName = test.aptos
-   * ```
    *
    * @param args.sender - The sender account
    * @param args.name - A string of the name: test, test.apt, test.aptos, test.aptos.apt, etc.
@@ -155,7 +150,7 @@ export class ANS {
   /**
    * Registers a new name
    *
-   * ```ts
+   * @example
    * // An example of registering a subdomain name assuming def.apt is already registered
    * // and belongs to the sender alice.
    *  const txn = aptos.registerName({
@@ -166,7 +161,6 @@ export class ANS {
    *      expirationDate: Date.now() + 30 * 24 * 60 * 60 * 1000,
    *    },
    *  });
-   * ```
    *
    * @param args.sender - The sender account
    * @param args.name - A string of the name to register. This can be inclusive or exclusive of the .apt suffix.
@@ -196,10 +190,9 @@ export class ANS {
    *
    * Note: If a domain name was minted with V1 of the contract, it will automatically be upgraded to V2 via this transaction.
    *
-   * ```ts
+   * @example
    * await aptos.renewDomain({sender: alice, name: "test"})
    * // test.apt will be renewed for one year
-   * ```
    *
    * @param args.sender - The sender account
    * @param args.name - A string of the domain the subdomain will be under. The signer must be the domain owner.

package/src/api/aptos.ts

@@ -12,6 +12,7 @@ import { General } from "./general";
 import { ANS } from "./ans";
 import { Staking } from "./staking";
 import { Transaction } from "./transaction";
+import { Keyless } from "./keyless";
 
 /**
  * This class is the main entry point into Aptos's
@@ -19,6 +20,10 @@ import { Transaction } from "./transaction";
  *
  * To use the SDK, create a new Aptos instance to get access
  * to all the sdk functionality.
+ *
+ * @example
+ *
+ * const aptos = new Aptos();
  */
 export class Aptos {
   readonly config: AptosConfig;
@@ -43,6 +48,8 @@ export class Aptos {
 
   readonly transaction: Transaction;
 
+  readonly keyless: Keyless;
+
   constructor(settings?: AptosConfig) {
     this.config = new AptosConfig(settings);
     this.account = new Account(this.config);
@@ -55,6 +62,7 @@ export class Aptos {
     this.general = new General(this.config);
     this.staking = new Staking(this.config);
     this.transaction = new Transaction(this.config);
+    this.keyless = new Keyless(this.config);
   }
 }
 
@@ -69,6 +77,7 @@ export interface Aptos
     Faucet,
     FungibleAsset,
     General,
+    Keyless,
     Staking,
     Omit<Transaction, "build" | "simulate" | "submit" | "batch"> {}
 
@@ -103,3 +112,4 @@ applyMixin(Aptos, FungibleAsset, "fungibleAsset");
 applyMixin(Aptos, General, "general");
 applyMixin(Aptos, Staking, "staking");
 applyMixin(Aptos, Transaction, "transaction");
+applyMixin(Aptos, Keyless, "keyless");

package/src/api/aptosConfig.ts

@@ -3,11 +3,22 @@
 
 import aptosClient from "@aptos-labs/aptos-client";
 import { AptosSettings, ClientConfig, Client, FullNodeConfig, IndexerConfig, FaucetConfig } from "../types";
-import { NetworkToNodeAPI, NetworkToFaucetAPI, NetworkToIndexerAPI, Network } from "../utils/apiEndpoints";
+import {
+  NetworkToNodeAPI,
+  NetworkToFaucetAPI,
+  NetworkToIndexerAPI,
+  Network,
+  NetworkToPepperAPI,
+  NetworkToProverAPI,
+} from "../utils/apiEndpoints";
 import { AptosApiType } from "../utils/const";
 
 /**
  * This class holds the config information for the SDK client instance.
+ *
+ * @example
+ *
+ * const aptosConfig = new AptosConfig({network:Network.TESTNET})
  */
 export class AptosConfig {
   /**
@@ -30,6 +41,16 @@ export class AptosConfig {
    */
   readonly faucet?: string;
 
+  /**
+   * The optional hardcoded pepper service URL to send requests to instead of using the network
+   */
+  readonly pepper?: string;
+
+  /**
+   * The optional hardcoded prover service URL to send requests to instead of using the network
+   */
+  readonly prover?: string;
+
   /**
    * The optional hardcoded indexer URL to send requests to instead of using the network
    */
@@ -59,6 +80,8 @@ export class AptosConfig {
     this.network = settings?.network ?? Network.DEVNET;
     this.fullnode = settings?.fullnode;
     this.faucet = settings?.faucet;
+    this.pepper = settings?.pepper;
+    this.prover = settings?.prover;
     this.indexer = settings?.indexer;
     this.client = settings?.client ?? { provider: aptosClient };
     this.clientConfig = settings?.clientConfig ?? {};
@@ -91,8 +114,34 @@ export class AptosConfig {
         if (this.indexer !== undefined) return this.indexer;
         if (this.network === Network.CUSTOM) throw new Error("Please provide a custom indexer url");
         return NetworkToIndexerAPI[this.network];
+      case AptosApiType.PEPPER:
+        if (this.pepper !== undefined) return this.pepper;
+        if (this.network === Network.CUSTOM) throw new Error("Please provide a custom pepper service url");
+        return NetworkToPepperAPI[this.network];
+      case AptosApiType.PROVER:
+        if (this.prover !== undefined) return this.prover;
+        if (this.network === Network.CUSTOM) throw new Error("Please provide a custom prover service url");
+        return NetworkToProverAPI[this.network];
       default:
         throw Error(`apiType ${apiType} is not supported`);
     }
   }
+
+  /**
+   * Checks if the URL is a known pepper service endpoint
+   *
+   * @internal
+   * */
+  isPepperServiceRequest(url: string): boolean {
+    return NetworkToPepperAPI[this.network] === url;
+  }
+  
+  /**
+   * Checks if the URL is a known prover service endpoint
+   *
+   * @internal
+   * */
+  isProverServiceRequest(url: string): boolean {
+    return NetworkToProverAPI[this.network] === url;
+  }
 }

package/src/api/coin.ts

@@ -17,6 +17,13 @@ export class Coin {
   /**
    * Generate a transfer coin transaction that can be simulated and/or signed and submitted
    *
+   * @example
+   * const transferCoinTransaction = await aptos.transferCoinTransaction({
+   * sender: "0x123",
+   * recipient:"0x456",
+   * amount: 10,
+   * })
+   *
    * @param args.sender The sender account
    * @param args.recipient The recipient address
    * @param args.amount The amount to transfer