@aptos-labs/ts-sdk 0.0.7 → 1.0.0

package/src/api/account.ts

@@ -1,26 +1,28 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-import { AptosConfig } from "./aptosConfig";
 import { AccountAddress, PrivateKey, Account as AccountModule, AccountAddressInput } from "../core";
 import {
   AccountData,
+  AnyNumber,
   GetAccountCoinsDataResponse,
   GetAccountCollectionsWithOwnedTokenResponse,
   GetAccountOwnedObjectsResponse,
   GetAccountOwnedTokensFromCollectionResponse,
   GetAccountOwnedTokensQueryResponse,
-  LedgerVersion,
+  LedgerVersionArg,
   MoveModuleBytecode,
   MoveResource,
   MoveStructId,
-  OrderBy,
+  OrderByArg,
   PaginationArgs,
-  TokenStandard,
+  TokenStandardArg,
   TransactionResponse,
+  WhereArg,
 } from "../types";
 import {
   deriveAccountFromPrivateKey,
+  getAccountCoinAmount,
   getAccountCoinsCount,
   getAccountCoinsData,
   getAccountCollectionsWithOwnedTokens,
@@ -37,16 +39,16 @@ import {
   getTransactions,
   lookupOriginalAccountAddress,
 } from "../internal/account";
+import { APTOS_COIN, ProcessorType } from "../utils/const";
+import { AptosConfig } from "./aptosConfig";
+import { waitForIndexerOnVersion } from "./utils";
+import { CurrentFungibleAssetBalancesBoolExp } from "../types/generated/types";
 
 /**
  * A class to query all `Account` related queries on Aptos.
  */
 export class Account {
-  readonly config: AptosConfig;
-
-  constructor(config: AptosConfig) {
-    this.config = config;
-  }
+  constructor(readonly config: AptosConfig) {}
 
   /**
    * Queries the current state for an Aptos account given its account address
@@ -83,7 +85,7 @@ export class Account {
 
   async getAccountModules(args: {
     accountAddress: AccountAddressInput;
-    options?: PaginationArgs & LedgerVersion;
+    options?: PaginationArgs & LedgerVersionArg;
   }): Promise<MoveModuleBytecode[]> {
     return getModules({ aptosConfig: this.config, ...args });
   }
@@ -108,7 +110,7 @@ export class Account {
   async getAccountModule(args: {
     accountAddress: AccountAddressInput;
     moduleName: string;
-    options?: LedgerVersion;
+    options?: LedgerVersionArg;
   }): Promise<MoveModuleBytecode> {
     return getModule({ aptosConfig: this.config, ...args });
   }
@@ -149,7 +151,7 @@ export class Account {
    */
   async getAccountResources(args: {
     accountAddress: AccountAddressInput;
-    options?: PaginationArgs & LedgerVersion;
+    options?: PaginationArgs & LedgerVersionArg;
   }): Promise<MoveResource[]> {
     return getResources({ aptosConfig: this.config, ...args });
   }
@@ -168,14 +170,14 @@ export class Account {
    * @example An example of an account resource
    * ```
    * {
-   *    data: { value: 6 }
+   *    value: 6
    * }
    * ```
    */
   async getAccountResource<T extends {} = any>(args: {
     accountAddress: AccountAddressInput;
     resourceType: MoveStructId;
-    options?: LedgerVersion;
+    options?: LedgerVersionArg;
   }): Promise<T> {
     return getResource<T>({ aptosConfig: this.config, ...args });
   }
@@ -186,13 +188,21 @@ export class Account {
    * This handles both if the account's authentication key has been rotated or not.
    *
    * @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
    * @returns Promise<AccountAddress> The accountAddress associated with the authentication key
    */
   async lookupOriginalAccountAddress(args: {
     authenticationKey: AccountAddressInput;
-    options?: LedgerVersion;
+    minimumLedgerVersion?: AnyNumber;
+    options?: LedgerVersionArg;
   }): Promise<AccountAddress> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args.minimumLedgerVersion,
+      processorTypes: [ProcessorType.ACCOUNT_TRANSACTION_PROCESSOR],
+    });
+
     return lookupOriginalAccountAddress({ aptosConfig: this.config, ...args });
   }
 
@@ -200,9 +210,18 @@ export class Account {
    * Queries the current count of tokens owned by an account
    *
    * @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
    */
-  async getAccountTokensCount(args: { accountAddress: AccountAddressInput }): Promise<number> {
+  async getAccountTokensCount(args: {
+    accountAddress: AccountAddressInput;
+    minimumLedgerVersion?: AnyNumber;
+  }): Promise<number> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args.minimumLedgerVersion,
+      processorTypes: [ProcessorType.ACCOUNT_TRANSACTION_PROCESSOR],
+    });
     return getAccountTokensCount({
       aptosConfig: this.config,
       ...args,
@@ -216,20 +235,23 @@ export class Account {
    * If you want to get only the token from a specific standard, you can pass an optional tokenStandard param
    *
    * @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
-   * @param args.options.pagination.offset The number token to start returning results from
-   * @param args.options.pagination.limit The number of results to return
+   * @param args.options.offset The number token to start returning results from
+   * @param args.options.limit The number of results to return
    * @param args.options.orderBy The order to sort the tokens by
    * @returns Tokens array with the token data
    */
   async getAccountOwnedTokens(args: {
     accountAddress: AccountAddressInput;
-    options?: {
-      tokenStandard?: TokenStandard;
-      pagination?: PaginationArgs;
-      orderBy?: OrderBy<GetAccountOwnedTokensQueryResponse[0]>;
-    };
+    minimumLedgerVersion?: AnyNumber;
+    options?: TokenStandardArg & PaginationArgs & OrderByArg<GetAccountOwnedTokensQueryResponse[0]>;
   }): Promise<GetAccountOwnedTokensQueryResponse> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args.minimumLedgerVersion,
+      processorTypes: [ProcessorType.ACCOUNT_TRANSACTION_PROCESSOR],
+    });
     return getAccountOwnedTokens({
       aptosConfig: this.config,
       ...args,
@@ -244,21 +266,24 @@ export class Account {
    *
    * @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
    * @param args.options.tokenStandard The NFT standard to query for
-   * @param args.options.pagination.offset The number token to start returning results from
-   * @param args.options.pagination.limit The number of results to return
+   * @param args.options.offset The number token to start returning results from
+   * @param args.options.limit The number of results to return
    * @param args.options.orderBy The order to sort the tokens by
    * @returns Tokens array with the token data
    */
   async getAccountOwnedTokensFromCollectionAddress(args: {
     accountAddress: AccountAddressInput;
     collectionAddress: AccountAddressInput;
-    options?: {
-      tokenStandard?: TokenStandard;
-      pagination?: PaginationArgs;
-      orderBy?: OrderBy<GetAccountOwnedTokensFromCollectionResponse[0]>;
-    };
+    minimumLedgerVersion?: AnyNumber;
+    options?: TokenStandardArg & PaginationArgs & OrderByArg<GetAccountOwnedTokensFromCollectionResponse[0]>;
   }): Promise<GetAccountOwnedTokensFromCollectionResponse> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args.minimumLedgerVersion,
+      processorTypes: [ProcessorType.ACCOUNT_TRANSACTION_PROCESSOR],
+    });
     return getAccountOwnedTokensFromCollectionAddress({
       aptosConfig: this.config,
       ...args,
@@ -272,20 +297,23 @@ export class Account {
    * If you want to get only the token from a specific standard, you can pass an optional tokenStandard param
    *
    * @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
-   * @param args.options.pagination.offset The number collection to start returning results from
-   * @param args.options.pagination.limit The number of results to return
+   * @param args.options.offset The number collection to start returning results from
+   * @param args.options.limit The number of results to return
    * @param args.options.orderBy The order to sort the tokens by
    * @returns Collections array with the collections data
    */
   async getAccountCollectionsWithOwnedTokens(args: {
     accountAddress: AccountAddressInput;
-    options?: {
-      tokenStandard?: TokenStandard;
-      pagination?: PaginationArgs;
-      orderBy?: OrderBy<GetAccountCollectionsWithOwnedTokenResponse[0]>;
-    };
+    minimumLedgerVersion?: AnyNumber;
+    options?: TokenStandardArg & PaginationArgs & OrderByArg<GetAccountCollectionsWithOwnedTokenResponse[0]>;
   }): Promise<GetAccountCollectionsWithOwnedTokenResponse> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args.minimumLedgerVersion,
+      processorTypes: [ProcessorType.ACCOUNT_TRANSACTION_PROCESSOR],
+    });
     return getAccountCollectionsWithOwnedTokens({
       aptosConfig: this.config,
       ...args,
@@ -296,9 +324,18 @@ export class Account {
    * Queries the current count of transactions submitted by an account
    *
    * @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
    */
-  async getAccountTransactionsCount(args: { accountAddress: AccountAddressInput }): Promise<number> {
+  async getAccountTransactionsCount(args: {
+    accountAddress: AccountAddressInput;
+    minimumLedgerVersion?: AnyNumber;
+  }): Promise<number> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args.minimumLedgerVersion,
+      processorTypes: [ProcessorType.ACCOUNT_TRANSACTION_PROCESSOR],
+    });
     return getAccountTransactionsCount({
       aptosConfig: this.config,
       ...args,
@@ -309,18 +346,25 @@ export class Account {
    * Queries an account's coins data
    *
    * @param args.accountAddress The account address we want to get the coins data for
-   * @param args.options.pagination.offset The number coin to start returning results from
-   * @param args.options.pagination.limit The number of results to return
-   * @param args.options.orderBy The order to sort the coins by
+   * @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
+   * @param args.options.limit optional. The number of results to return
+   * @param args.options.orderBy optional. The order to sort the coins by
+   * @param args.options.where optional. Filter the results by
    * @returns Array with the coins data
    */
   async getAccountCoinsData(args: {
     accountAddress: AccountAddressInput;
-    options?: {
-      pagination?: PaginationArgs;
-      orderBy?: OrderBy<GetAccountCoinsDataResponse[0]>;
-    };
+    minimumLedgerVersion?: AnyNumber;
+    options?: PaginationArgs &
+      OrderByArg<GetAccountCoinsDataResponse[0]> &
+      WhereArg<CurrentFungibleAssetBalancesBoolExp>;
   }): Promise<GetAccountCoinsDataResponse> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args.minimumLedgerVersion,
+      processorTypes: [ProcessorType.ACCOUNT_TRANSACTION_PROCESSOR],
+    });
     return getAccountCoinsData({
       aptosConfig: this.config,
       ...args,
@@ -331,28 +375,81 @@ export class Account {
    * Queries the current count of an account's coins aggregated
    *
    * @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
    */
-  async getAccountCoinsCount(args: { accountAddress: AccountAddressInput }): Promise<number> {
+  async getAccountCoinsCount(args: {
+    accountAddress: AccountAddressInput;
+    minimumLedgerVersion?: AnyNumber;
+  }): Promise<number> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args.minimumLedgerVersion,
+      processorTypes: [ProcessorType.ACCOUNT_TRANSACTION_PROCESSOR],
+    });
     return getAccountCoinsCount({ aptosConfig: this.config, ...args });
   }
 
+  /**
+   * Queries the account's APT amount
+   *
+   * @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
+   */
+  async getAccountAPTAmount(args: {
+    accountAddress: AccountAddressInput;
+    minimumLedgerVersion?: AnyNumber;
+  }): Promise<number> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args.minimumLedgerVersion,
+      processorTypes: [ProcessorType.ACCOUNT_TRANSACTION_PROCESSOR],
+    });
+    return getAccountCoinAmount({ aptosConfig: this.config, coinType: APTOS_COIN, ...args });
+  }
+
+  /**
+   * Queries the account's coin amount by the coin type
+   *
+   * @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
+   * @returns Current amount of account's coin
+   */
+  async getAccountCoinAmount(args: {
+    accountAddress: AccountAddressInput;
+    coinType: MoveStructId;
+    minimumLedgerVersion?: AnyNumber;
+  }): Promise<number> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args.minimumLedgerVersion,
+      processorTypes: [ProcessorType.ACCOUNT_TRANSACTION_PROCESSOR],
+    });
+    return getAccountCoinAmount({ aptosConfig: this.config, ...args });
+  }
+
   /**
    * Queries an account's owned objects
    *
    * @param args.accountAddress The account address we want to get the objects for
-   * @param args.options.pagination.offset The number coin to start returning results from
-   * @param args.options.pagination.limit The number of results to return
-   * @param args.options.orderBy The order to sort the coins by
+   * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
+   * @param args.options.offset The starting position to start returning results from
+   * @param args.options.limit The number of results to return
+   * @param args.options.orderBy The order to sort the objects by
    * @returns Objects array with the object data
    */
   async getAccountOwnedObjects(args: {
     accountAddress: AccountAddressInput;
-    options?: {
-      pagination?: PaginationArgs;
-      orderBy?: OrderBy<GetAccountOwnedObjectsResponse[0]>;
-    };
+    minimumLedgerVersion?: AnyNumber;
+    options?: PaginationArgs & OrderByArg<GetAccountOwnedObjectsResponse[0]>;
   }): Promise<GetAccountOwnedObjectsResponse> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args.minimumLedgerVersion,
+      processorTypes: [ProcessorType.ACCOUNT_TRANSACTION_PROCESSOR],
+    });
     return getAccountOwnedObjects({
       aptosConfig: this.config,
       ...args,

package/src/api/ans.ts

@@ -30,11 +30,7 @@ import { AptosConfig } from "./aptosConfig";
  * A class to handle all `ANS` operations
  */
 export class ANS {
-  readonly config: AptosConfig;
-
-  constructor(config: AptosConfig) {
-    this.config = config;
-  }
+  constructor(readonly config: AptosConfig) {}
 
   /**
    * Retrieve the owner address of a domain name or subdomain name from the contract.
@@ -64,7 +60,7 @@ export class ANS {
    *
    * @param args.name - A string of the name to retrieve
    *
-   * @returns number as a unix timestamp in seconds.
+   * @returns number as a unix timestamp in milliseconds.
    */
   async getExpiration(args: { name: string }): Promise<number | undefined> {
     return getExpiration({ aptosConfig: this.config, ...args });
@@ -94,9 +90,9 @@ export class ANS {
    * point to addresses that are not the owner of the name
    *
    * ```ts
-   * await aptos.setTargetAddress({sender: alice, name: "test.aptos", address: bob.accountAddress.toString})
+   * await aptos.setTargetAddress({sender: alice, name: "test.aptos", address: bob.accountAddress})
    * const address = await aptos.getTargetAddress({name: "test.aptos"})
-   * // address = bob.accountAddress.toString()
+   * // address = bob.accountAddress
    * ```
    *
    * @param args.name - A string of the name: test.aptos.apt, test.apt, test, test.aptos, etc.
@@ -119,7 +115,7 @@ export class ANS {
    * account also may not have a primary name.
    *
    * ```ts
-   * const name = await aptos.getPrimaryName({address: alice.accountAddress.toString()})
+   * const name = await aptos.getPrimaryName({address: alice.accountAddress})
    * // name = test.aptos
    * ```
    *
@@ -138,7 +134,7 @@ export class ANS {
    *
    * ```ts
    * await aptos.setPrimaryName({sender: alice, name: "test.aptos"})
-   * const primaryName = await aptos.getPrimaryName({address: alice.accountAddress.toString()})
+   * const primaryName = await aptos.getPrimaryName({address: alice.accountAddress})
    * // primaryName = test.aptos
    * ```
    *
@@ -149,7 +145,7 @@ export class ANS {
    */
   async setPrimaryName(args: {
     sender: Account;
-    name: string | null;
+    name?: string;
     options?: InputGenerateTransactionOptions;
   }): Promise<SingleSignerTransaction> {
     return setPrimaryName({ aptosConfig: this.config, ...args });
@@ -166,7 +162,7 @@ export class ANS {
    *    name: "test.aptos.apt",
    *    expiration: {
    *      policy: "subdomain:independent",
-   *      expirationDate: new Date(Date.now() + 30 * 24 * 60 * 60 * 1000),
+   *      expirationDate: Date.now() + 30 * 24 * 60 * 60 * 1000,
    *    },
    *  });
    * ```
@@ -179,8 +175,9 @@ export class ANS {
    * - domain: Years is required and the name will expire after the given number of years.
    * - subdomain:follow-domain: The name will expire at the same time as the domain name.
    * - subdomain:independent: The name will expire at the given date.
-   * @param args.expiration.expirationDate - A javascript date of when the subdomain will expire. Only applicable when
-   * the policy is set to 'subdomain:independent'.
+   * @param args.expiration.expirationDate - An epoch number in milliseconds of
+   * the date when the subdomain will expire. Only applicable when the policy is
+   * set to 'subdomain:independent'.
    * @param args.transferable  - Determines if the subdomain being minted is soul-bound. Applicable only to subdomains.
    * @param args.targetAddress optional - The address the domain name will resolve to. If not provided,
    * the sender's address will be used.
@@ -236,8 +233,8 @@ export class ANS {
    *
    * @param args
    * @param args.accountAddress - A AccountAddressInput of the address to retrieve names for.
-   * @param args.options.pagination.offset - Optional, the offset to start from when fetching names
-   * @param args.options.pagination.limit - Optional, A number of the names to fetch per request
+   * @param args.options.offset - Optional, the offset to start from when fetching names
+   * @param args.options.limit - Optional, A number of the names to fetch per request
    * @param args.options.orderBy - The order to sort the names by
    * @param args.options.where - Additional filters to apply to the query
    *
@@ -252,8 +249,8 @@ export class ANS {
    *
    * @param args
    * @param args.accountAddress - A AccountAddressInput of the address to retrieve domain names for.
-   * @param args.options.pagination.offset - Optional, the offset to start from when fetching names
-   * @param args.options.pagination.limit - Optional, A number of the names to fetch per request
+   * @param args.options.offset - Optional, the offset to start from when fetching names
+   * @param args.options.limit - Optional, A number of the names to fetch per request
    * @param args.options.orderBy - The order to sort the names by
    * @param args.options.where - Additional filters to apply to the query
    *
@@ -268,8 +265,8 @@ export class ANS {
    *
    * @param args
    * @param args.accountAddress - A AccountAddressInput of the address to retrieve subdomains names for.
-   * @param args.options.pagination.offset - Optional, the offset to start from when fetching names
-   * @param args.options.pagination.limit - Optional, A number of the names to fetch per request
+   * @param args.options.offset - Optional, the offset to start from when fetching names
+   * @param args.options.limit - Optional, A number of the names to fetch per request
    * @param args.options.orderBy - The order to sort the names by
    * @param args.options.where - Additional filters to apply to the query
    *
@@ -284,8 +281,8 @@ export class ANS {
    *
    * @param args
    * @param args.domain - A string of the domain name: eg. "test.apt" or "test" (without the suffix of .apt)
-   * @param args.options.pagination.offset - Optional, the offset to start from when fetching names
-   * @param args.options.pagination.limit - Optional, A number of the names to fetch per request
+   * @param args.options.offset - Optional, the offset to start from when fetching names
+   * @param args.options.limit - Optional, A number of the names to fetch per request
    * @param args.options.orderBy - The order to sort the names by
    * @param args.options.where - Additional filters to apply to the query
    *

package/src/api/aptosConfig.ts

@@ -10,11 +10,11 @@ import { AptosApiType, DEFAULT_NETWORK } from "../utils/const";
  * This class holds the config information for the SDK client instance.
  */
 export class AptosConfig {
-  /** The Network that this SDK is associated with. */
+  /** The Network that this SDK is associated with. Defaults to DEVNET */
   readonly network: Network;
 
   /**
-   * The client instance the SDK uses
+   * The client instance the SDK uses. Defaults to `@aptos-labs/aptos-client
    */
   readonly client: Client;
 

package/src/api/coin.ts

@@ -1,21 +1,17 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-import { AptosConfig } from "./aptosConfig";
 import { Account, AccountAddressInput } from "../core";
 import { transferCoinTransaction } from "../internal/coin";
 import { SingleSignerTransaction, InputGenerateTransactionOptions } from "../transactions/types";
 import { AnyNumber, MoveStructId } from "../types";
+import { AptosConfig } from "./aptosConfig";
 
 /**
  * A class to handle all `Coin` operations
  */
 export class Coin {
-  readonly config: AptosConfig;
-
-  constructor(config: AptosConfig) {
-    this.config = config;
-  }
+  constructor(readonly config: AptosConfig) {}
 
   /**
    * Generate a transfer coin transaction that can be simulated and/or signed and submitted