@aptos-labs/ts-sdk 1.33.1 → 1.33.2

package/src/api/account.ts

@@ -50,6 +50,7 @@ import { memoizeAsync } from "../utils/memoize";
 
 /**
  * A class to query all `Account` related queries on Aptos.
+ * @group Account
  */
 export class Account {
   /**
@@ -70,6 +71,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   constructor(readonly config: AptosConfig) {}
 
@@ -94,6 +96,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async getAccountInfo(args: { accountAddress: AccountAddressInput }): Promise<AccountData> {
     return getInfo({ aptosConfig: this.config, ...args });
@@ -104,7 +107,7 @@ export class Account {
    * This function may call the API multiple times to auto paginate through results.
    *
    * @param args.accountAddress - The Aptos account address to query modules for.
-   * @param args.options.offset - The number of modules to start returning results from.
+   * @param args.options.offset - The cursor to start returning results from.  Note, this is obfuscated and is not an index.
    * @param args.options.limit - The maximum number of results to return.
    * @param args.options.ledgerVersion - The ledger version to query; if not provided, it retrieves the latest version.
    *
@@ -131,6 +134,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async getAccountModules(args: {
     accountAddress: AccountAddressInput;
@@ -166,6 +170,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async getAccountModule(args: {
     accountAddress: AccountAddressInput;
@@ -207,6 +212,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async getAccountTransactions(args: {
     accountAddress: AccountAddressInput;
@@ -223,7 +229,7 @@ export class Account {
    * This function may call the API multiple times to auto paginate through results.
    *
    * @param args.accountAddress - The Aptos account address to query resources for.
-   * @param args.options.offset - The number of resources to start returning results from.
+   * @param args.options.offset - The cursor to start returning results from.  Note, this is obfuscated and is not an index.
    * @param args.options.limit - The maximum number of results to return.
    * @param args.options.ledgerVersion - The ledger version to query; if not provided, it will get the latest version.
    * @returns Account resources.
@@ -242,6 +248,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async getAccountResources(args: {
     accountAddress: AccountAddressInput;
@@ -277,6 +284,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async getAccountResource<T extends {} = any>(args: {
     accountAddress: AccountAddressInput;
@@ -311,6 +319,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async lookupOriginalAccountAddress(args: {
     authenticationKey: AccountAddressInput;
@@ -342,6 +351,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async getAccountTokensCount(args: {
     accountAddress: AccountAddressInput;
@@ -391,6 +401,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async getAccountOwnedTokens(args: {
     accountAddress: AccountAddressInput;
@@ -440,6 +451,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async getAccountOwnedTokensFromCollectionAddress(args: {
     accountAddress: AccountAddressInput;
@@ -491,6 +503,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async getAccountCollectionsWithOwnedTokens(args: {
     accountAddress: AccountAddressInput;
@@ -534,6 +547,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async getAccountTransactionsCount(args: {
     accountAddress: AccountAddressInput;
@@ -582,6 +596,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async getAccountCoinsData(args: {
     accountAddress: AccountAddressInput;
@@ -623,6 +638,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async getAccountCoinsCount(args: {
     accountAddress: AccountAddressInput;
@@ -658,6 +674,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async getAccountAPTAmount(args: {
     accountAddress: AccountAddressInput;
@@ -698,6 +715,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async getAccountCoinAmount(args: {
     accountAddress: AccountAddressInput;
@@ -823,6 +841,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async getAccountOwnedObjects(args: {
     accountAddress: AccountAddressInput;
@@ -870,6 +889,7 @@ export class Account {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Account
    */
   async deriveAccountFromPrivateKey(args: { privateKey: PrivateKey }): Promise<AccountModule> {
     return deriveAccountFromPrivateKey({ aptosConfig: this.config, ...args });

package/src/api/ans.ts

@@ -30,6 +30,7 @@ import { SimpleTransaction } from "../transactions/instances/simpleTransaction";
 
 /**
  * A class to handle all `ANS` operations.
+ * @group ANS
  */
 export class ANS {
   /**
@@ -56,6 +57,7 @@ export class ANS {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group ANS
    */
   constructor(readonly config: AptosConfig) {}
 
@@ -81,6 +83,7 @@ export class ANS {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group ANS
    */
   async getOwnerAddress(args: { name: string }): Promise<AccountAddress | undefined> {
     return getOwnerAddress({ aptosConfig: this.config, ...args });
@@ -110,6 +113,7 @@ export class ANS {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group ANS
    */
   async getExpiration(args: { name: string }): Promise<number | undefined> {
     return getExpiration({ aptosConfig: this.config, ...args });
@@ -140,6 +144,7 @@ export class ANS {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group ANS
    */
   async getTargetAddress(args: { name: string }): Promise<AccountAddress | undefined> {
     return getTargetAddress({ aptosConfig: this.config, ...args });
@@ -180,6 +185,7 @@ export class ANS {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group ANS
    */
   async setTargetAddress(args: {
     sender: Account;
@@ -212,6 +218,7 @@ export class ANS {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group ANS
    */
   async getPrimaryName(args: { address: AccountAddressInput }): Promise<string | undefined> {
     return getPrimaryName({ aptosConfig: this.config, ...args });
@@ -245,6 +252,7 @@ export class ANS {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group ANS
    */
   async setPrimaryName(args: {
     sender: Account;
@@ -299,6 +307,7 @@ export class ANS {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group ANS
    */
   async registerName(args: Omit<RegisterNameParameters, "aptosConfig">): Promise<SimpleTransaction> {
     return registerName({ aptosConfig: this.config, ...args });
@@ -334,6 +343,7 @@ export class ANS {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group ANS
    */
   async renewDomain(args: {
     sender: Account;
@@ -367,6 +377,7 @@ export class ANS {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group ANS
    */
   async getName(args: { name: string }): Promise<GetANSNameResponse[0] | undefined> {
     return getName({ aptosConfig: this.config, ...args });
@@ -406,6 +417,7 @@ export class ANS {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group ANS
    */
   async getAccountNames(args: GetAccountNamesArgs): Promise<GetANSNameResponse> {
     return getAccountNames({ aptosConfig: this.config, ...args });
@@ -448,6 +460,7 @@ export class ANS {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group ANS
    */
   async getAccountDomains(args: GetAccountDomainsArgs): Promise<GetANSNameResponse> {
     return getAccountDomains({ aptosConfig: this.config, ...args });
@@ -488,6 +501,7 @@ export class ANS {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group ANS
    */
   async getAccountSubdomains(args: GetAccountSubdomainsArgs): Promise<GetANSNameResponse> {
     return getAccountSubdomains({ aptosConfig: this.config, ...args });
@@ -528,6 +542,7 @@ export class ANS {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group ANS
    */
   async getDomainSubdomains(args: GetDomainSubdomainsArgs): Promise<GetANSNameResponse> {
     return getDomainSubdomains({ aptosConfig: this.config, ...args });

package/src/api/aptos.ts

@@ -39,6 +39,7 @@ import { AptosObject } from "./object";
  * }
  * runExample().catch(console.error);
  * ```
+ * @group Client
  */
 export class Aptos {
   readonly config: AptosConfig;
@@ -88,6 +89,7 @@ export class Aptos {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Client
    */
   constructor(settings?: AptosConfig) {
     this.config = new AptosConfig(settings);
@@ -131,6 +133,7 @@ that we can combine to form a single class that contains all the methods and pro
 {@link https://www.typescriptlang.org/docs/handbook/mixins.html#alternative-pattern}
 
 Here, we combine any subclass and the Aptos class.
+ * @group Client
 */
 function applyMixin(targetClass: any, baseClass: any, baseClassProp: string) {
   // Mixin instance methods

package/src/api/aptosConfig.ts

@@ -32,60 +32,72 @@ import { AptosApiType } from "../utils/const";
  * }
  * runExample().catch(console.error);
  * ```
+ * @group Client
  */
 export class AptosConfig {
   /**
    * The Network that this SDK is associated with. Defaults to DEVNET
+   * @group Client
    */
   readonly network: Network;
 
   /**
    * The client instance the SDK uses. Defaults to `@aptos-labs/aptos-client
+   * @group Client
    */
   readonly client: Client;
 
   /**
    * The optional hardcoded fullnode URL to send requests to instead of using the network
+   * @group Client
    */
   readonly fullnode?: string;
 
   /**
    * The optional hardcoded faucet URL to send requests to instead of using the network
+   * @group Client
    */
   readonly faucet?: string;
 
   /**
    * The optional hardcoded pepper service URL to send requests to instead of using the network
+   * @group Client
    */
   readonly pepper?: string;
 
   /**
    * The optional hardcoded prover service URL to send requests to instead of using the network
+   * @group Client
    */
   readonly prover?: string;
 
   /**
    * The optional hardcoded indexer URL to send requests to instead of using the network
+   * @group Client
    */
   readonly indexer?: string;
 
   /**
    * Optional client configurations
+   * @group Client
    */
   readonly clientConfig?: ClientConfig;
 
   /**
    * Optional specific Fullnode configurations
+   * @group Client
    */
   readonly fullnodeConfig?: FullNodeConfig;
 
   /**
    * Optional specific Indexer configurations
+   * @group Client
    */
   readonly indexerConfig?: IndexerConfig;
 
   /**
    * Optional specific Faucet configurations
+   * @group Client
    */
   readonly faucetConfig?: FaucetConfig;
 
@@ -119,6 +131,7 @@ export class AptosConfig {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Client
    */
   constructor(settings?: AptosSettings) {
     this.network = settings?.network ?? Network.DEVNET;
@@ -154,6 +167,7 @@ export class AptosConfig {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Client
    */
   getRequestUrl(apiType: AptosApiType): string {
     switch (apiType) {
@@ -163,6 +177,14 @@ export class AptosConfig {
         return NetworkToNodeAPI[this.network];
       case AptosApiType.FAUCET:
         if (this.faucet !== undefined) return this.faucet;
+        if (this.network === Network.TESTNET) {
+          throw new Error(
+            "There is no way to programmatically mint testnet APT, you must use the minting site at https://aptos.dev/network/faucet",
+          );
+        }
+        if (this.network === Network.MAINNET) {
+          throw new Error("There is no mainnet faucet");
+        }
         if (this.network === Network.CUSTOM) throw new Error("Please provide a custom faucet url");
         return NetworkToFaucetAPI[this.network];
       case AptosApiType.INDEXER:
@@ -204,6 +226,7 @@ export class AptosConfig {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Client
    */
   isPepperServiceRequest(url: string): boolean {
     return NetworkToPepperAPI[this.network] === url;
@@ -228,6 +251,7 @@ export class AptosConfig {
    *
    * console.log(`Is the URL a known prover service? ${isProver}`);
    * ```
+   * @group Client
    */
   isProverServiceRequest(url: string): boolean {
     return NetworkToProverAPI[this.network] === url;

package/src/api/coin.ts

@@ -10,6 +10,7 @@ import { AptosConfig } from "./aptosConfig";
 
 /**
  * A class to handle all `Coin` operations.
+ * @group Coin
  */
 export class Coin {
   /**
@@ -31,6 +32,7 @@ export class Coin {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Coin
    */
   constructor(readonly config: AptosConfig) {}
 
@@ -67,6 +69,7 @@ export class Coin {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Coin
    */
   async transferCoinTransaction(args: {
     sender: AccountAddressInput;

package/src/api/digitalAsset.ts

@@ -52,6 +52,7 @@ import { SimpleTransaction } from "../transactions/instances/simpleTransaction";
 
 /**
  * A class to query all `DigitalAsset` related queries on Aptos.
+ * @group DigitalAsset
  */
 export class DigitalAsset {
   /**
@@ -75,6 +76,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   constructor(readonly config: AptosConfig) {}
 
@@ -111,6 +113,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async getCollectionData(args: {
     creatorAddress: AccountAddressInput;
@@ -169,6 +172,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async getCollectionDataByCreatorAddressAndCollectionName(args: {
     creatorAddress: AccountAddressInput;
@@ -217,6 +221,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async getCollectionDataByCreatorAddress(args: {
     creatorAddress: AccountAddressInput;
@@ -257,6 +262,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async getCollectionDataByCollectionId(args: {
     collectionId: AccountAddressInput;
@@ -299,6 +305,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async getCollectionId(args: {
     creatorAddress: AccountAddressInput;
@@ -339,6 +346,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async getDigitalAssetData(args: {
     digitalAssetAddress: AccountAddressInput;
@@ -378,6 +386,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async getCurrentDigitalAssetOwnership(args: {
     digitalAssetAddress: AccountAddressInput;
@@ -417,6 +426,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async getOwnedDigitalAssets(args: {
     ownerAddress: AccountAddressInput;
@@ -458,6 +468,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async getDigitalAssetActivity(args: {
     digitalAssetAddress: AccountAddressInput;
@@ -519,6 +530,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async createCollectionTransaction(
     args: {
@@ -569,6 +581,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async mintDigitalAssetTransaction(args: {
     creator: Account;
@@ -616,6 +629,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async transferDigitalAssetTransaction(args: {
     sender: Account;
@@ -667,6 +681,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async mintSoulBoundTransaction(args: {
     account: Account;
@@ -712,6 +727,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async burnDigitalAssetTransaction(args: {
     creator: Account;
@@ -752,6 +768,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async freezeDigitalAssetTransaferTransaction(args: {
     creator: Account;
@@ -792,6 +809,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   // TODO: Rename Transafer to Transfer
   async unfreezeDigitalAssetTransaferTransaction(args: {
@@ -834,6 +852,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async setDigitalAssetDescriptionTransaction(args: {
     creator: Account;
@@ -879,6 +898,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async setDigitalAssetNameTransaction(args: {
     creator: Account;
@@ -920,6 +940,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async setDigitalAssetURITransaction(args: {
     creator: Account;
@@ -966,6 +987,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async addDigitalAssetPropertyTransaction(args: {
     creator: Account;
@@ -1015,6 +1037,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async removeDigitalAssetPropertyTransaction(args: {
     creator: Account;
@@ -1063,6 +1086,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async updateDigitalAssetPropertyTransaction(args: {
     creator: Account;
@@ -1113,6 +1137,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async addDigitalAssetTypedPropertyTransaction(args: {
     creator: Account;
@@ -1162,6 +1187,7 @@ export class DigitalAsset {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group DigitalAsset
    */
   async updateDigitalAssetTypedPropertyTransaction(args: {
     creator: Account;

package/src/api/event.ts

@@ -16,6 +16,7 @@ import { waitForIndexerOnVersion } from "./utils";
 
 /**
  * A class to query all `Event` Aptos related queries.
+ * @group Event
  */
 export class Event {
   /**
@@ -39,6 +40,7 @@ export class Event {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Event
    */
   constructor(readonly config: AptosConfig) {}
 
@@ -71,6 +73,7 @@ export class Event {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Event
    */
   async getModuleEventsByEventType(args: {
     eventType: MoveStructId;
@@ -113,6 +116,7 @@ export class Event {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Event
    */
   async getAccountEventsByCreationNumber(args: {
     accountAddress: AccountAddressInput;
@@ -156,6 +160,7 @@ export class Event {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Event
    */
   async getAccountEventsByEventType(args: {
     accountAddress: AccountAddressInput;
@@ -209,6 +214,7 @@ export class Event {
    * }
    * runExample().catch(console.error);
    * ```
+   * @group Event
    */
   async getEvents(args?: {
     minimumLedgerVersion?: AnyNumber;