@aptos-labs/ts-sdk 6.3.0 → 7.0.0

package/dist/api/digitalAsset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"digitalAsset.js","sourceRoot":"","sources":["../../src/api/digitalAsset.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AActC,OAAO,EAAE,cAAc,EAAuB,MAAM,kBAAkB,CAAC;AAGvE,OAAO,EACL,kCAAkC,EAClC,uCAAuC,EACvC,2BAA2B,EAE3B,2BAA2B,EAC3B,qCAAqC,EACrC,iBAAiB,EACjB,+BAA+B,EAC/B,iCAAiC,EACjC,kDAAkD,EAClD,eAAe,EACf,+BAA+B,EAC/B,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,2BAA2B,EAC3B,wBAAwB,EAGxB,qCAAqC,EACrC,qCAAqC,EACrC,8BAA8B,EAC9B,6BAA6B,EAC7B,+BAA+B,EAC/B,uCAAuC,EACvC,qCAAqC,EACrC,0CAA0C,GAC3C,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAGrD;;;GAGG;AACH,MAAM,OAAO,YAAY;IAwBF;IAvBrB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,YAAqB,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,KAAK,CAAC,iBAAiB,CAAC,IAKvB;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,aAAa,EAAE,aAAa,CAAC,kBAAkB;SAChD,CAAC,CAAC;QAEH,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzD,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEpD,MAAM,cAAc,GAAQ;YAC1B,eAAe,EAAE,EAAE,GAAG,EAAE,cAAc,EAAE;YACxC,eAAe,EAAE,EAAE,GAAG,EAAE,OAAO,CAAC,YAAY,EAAE,EAAE;SACjD,CAAC;QACF,IAAI,OAAO,EAAE,aAAa,EAAE,CAAC;YAC3B,cAAc,CAAC,cAAc,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,aAAa,IAAI,IAAI,EAAE,CAAC;QAC1E,CAAC;QAED,OAAO,iBAAiB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,kDAAkD,CAAC,IAKxD;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,aAAa,EAAE,aAAa,CAAC,kBAAkB;SAChD,CAAC,CAAC;QAEH,OAAO,kDAAkD,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,KAAK,CAAC,iCAAiC,CAAC,IAIvC;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,aAAa,EAAE,aAAa,CAAC,kBAAkB;SAChD,CAAC,CAAC;QAEH,OAAO,iCAAiC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,+BAA+B,CAAC,IAIrC;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,aAAa,EAAE,aAAa,CAAC,kBAAkB;SAChD,CAAC,CAAC;QACH,OAAO,+BAA+B,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,eAAe,CAAC,IAKrB;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,aAAa,EAAE,aAAa,CAAC,kBAAkB;SAChD,CAAC,CAAC;QACH,OAAO,eAAe,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,mBAAmB,CAAC,IAGzB;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,aAAa,EAAE,aAAa,CAAC,kBAAkB;SAChD,CAAC,CAAC;QACH,OAAO,mBAAmB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,+BAA+B,CAAC,IAGrC;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,aAAa,EAAE,aAAa,CAAC,kBAAkB;SAChD,CAAC,CAAC;QACH,OAAO,+BAA+B,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,qBAAqB,CAAC,IAI3B;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,aAAa,EAAE,aAAa,CAAC,kBAAkB;SAChD,CAAC,CAAC;QACH,OAAO,qBAAqB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,uBAAuB,CAAC,IAI7B;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,aAAa,EAAE,aAAa,CAAC,kBAAkB;SAChD,CAAC,CAAC;QACH,OAAO,uBAAuB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,KAAK,CAAC,2BAA2B,CAC/B,IAM2B;QAE3B,OAAO,2BAA2B,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,KAAK,CAAC,2BAA2B,CAAC,IAUjC;QACC,OAAO,2BAA2B,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,KAAK,CAAC,+BAA+B,CAAC,IAMrC;QACC,OAAO,+BAA+B,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,KAAK,CAAC,wBAAwB,CAAC,IAW9B;QACC,OAAO,wBAAwB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,KAAK,CAAC,2BAA2B,CAAC,IAKjC;QACC,OAAO,2BAA2B,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,sCAAsC,CAAC,IAK5C;QACC,OAAO,qCAAqC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,qCAAqC;IACrC,KAAK,CAAC,wCAAwC,CAAC,IAK9C;QACC,OAAO,uCAAuC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,qCAAqC,CAAC,IAM3C;QACC,OAAO,qCAAqC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,KAAK,CAAC,8BAA8B,CAAC,IAMpC;QACC,OAAO,8BAA8B,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,6BAA6B,CAAC,IAMnC;QACC,OAAO,6BAA6B,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,KAAK,CAAC,kCAAkC,CAAC,IAQxC;QACC,OAAO,kCAAkC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,KAAK,CAAC,qCAAqC,CAAC,IAQ3C;QACC,OAAO,qCAAqC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,KAAK,CAAC,qCAAqC,CAAC,IAQ3C;QACC,OAAO,qCAAqC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,KAAK,CAAC,uCAAuC,CAAC,IAQ7C;QACC,OAAO,uCAAuC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,KAAK,CAAC,0CAA0C,CAAC,IAQhD;QACC,OAAO,0CAA0C,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAC3F,CAAC;CACF"}

package/dist/api/faucet.d.ts

@@ -0,0 +1,74 @@
+import { UserTransactionResponse, WaitForTransactionOptions } from "../types/index.js";
+import { AccountAddressInput } from "../core/index.js";
+import { AptosConfig } from "./aptosConfig.js";
+/**
+ * A class to query all `Faucet` related queries on Aptos.
+ * @group Faucet
+ */
+export declare class Faucet {
+    readonly config: AptosConfig;
+    /**
+     * 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
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a configuration for the Aptos client
+     *     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);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Faucet
+     */
+    constructor(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.
+     * @param args.options - Configuration options for waiting for the transaction.
+     * @returns Transaction hash of the transaction that funded the account.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.DEVNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Fund an account with a specified amount of tokens
+     *   const transaction = await aptos.fundAccount({
+     *     accountAddress: "0x1", // replace with your account address
+     *     amount: 100,
+     *   });
+     *
+     *   console.log("Transaction hash:", transaction.hash);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Faucet
+     */
+    fundAccount(args: {
+        accountAddress: AccountAddressInput;
+        amount: number;
+        options?: WaitForTransactionOptions;
+    }): Promise<UserTransactionResponse>;
+}
+//# sourceMappingURL=faucet.d.ts.map

package/dist/api/faucet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"faucet.d.ts","sourceRoot":"","sources":["../../src/api/faucet.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AACvF,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAI/C;;;GAGG;AACH,qBAAa,MAAM;IA0BL,QAAQ,CAAC,MAAM,EAAE,WAAW;IAzBxC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;gBACkB,MAAM,EAAE,WAAW;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,WAAW,CAAC,IAAI,EAAE;QACtB,cAAc,EAAE,mBAAmB,CAAC;QACpC,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,yBAAyB,CAAC;KACrC,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAerC"}

package/dist/api/faucet.js

@@ -0,0 +1,86 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { fundAccount } from "../internal/faucet.js";
+import { waitForIndexer } from "../internal/transaction.js";
+import { ProcessorType } from "../utils/index.js";
+/**
+ * A class to query all `Faucet` related queries on Aptos.
+ * @group Faucet
+ */
+export class Faucet {
+    config;
+    /**
+     * 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
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a configuration for the Aptos client
+     *     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);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Faucet
+     */
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * 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.
+     * @param args.options - Configuration options for waiting for the transaction.
+     * @returns Transaction hash of the transaction that funded the account.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.DEVNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Fund an account with a specified amount of tokens
+     *   const transaction = await aptos.fundAccount({
+     *     accountAddress: "0x1", // replace with your account address
+     *     amount: 100,
+     *   });
+     *
+     *   console.log("Transaction hash:", transaction.hash);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Faucet
+     */
+    async fundAccount(args) {
+        const fundTxn = await fundAccount({ aptosConfig: this.config, ...args });
+        // If the user explicitly says to NOT wait by setting waitForIndexer to false, then we skip this.
+        // But, by default we want to wait for the indexer.
+        if (args.options?.waitForIndexer === undefined || args.options?.waitForIndexer) {
+            await waitForIndexer({
+                aptosConfig: this.config,
+                minimumLedgerVersion: BigInt(fundTxn.version),
+                processorType: ProcessorType.FUNGIBLE_ASSET_PROCESSOR,
+            });
+        }
+        return fundTxn;
+    }
+}
+//# sourceMappingURL=faucet.js.map

package/dist/api/faucet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"faucet.js","sourceRoot":"","sources":["../../src/api/faucet.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAEtC,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAIpD,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD;;;GAGG;AACH,MAAM,OAAO,MAAM;IA0BI;IAzBrB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,YAAqB,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,WAAW,CAAC,IAIjB;QACC,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;QAEzE,iGAAiG;QACjG,mDAAmD;QACnD,IAAI,IAAI,CAAC,OAAO,EAAE,cAAc,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE,cAAc,EAAE,CAAC;YAC/E,MAAM,cAAc,CAAC;gBACnB,WAAW,EAAE,IAAI,CAAC,MAAM;gBACxB,oBAAoB,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;gBAC7C,aAAa,EAAE,aAAa,CAAC,wBAAwB;aACtD,CAAC,CAAC;QACL,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;CACF"}

package/dist/api/fungibleAsset.d.ts

@@ -0,0 +1,285 @@
+import { AnyNumber, GetCurrentFungibleAssetBalancesResponse, GetFungibleAssetActivitiesResponse, GetFungibleAssetMetadataResponse, PaginationArgs, WhereArg } from "../types/index.js";
+import { CurrentFungibleAssetBalancesBoolExp, FungibleAssetActivitiesBoolExp, FungibleAssetMetadataBoolExp } from "../types/generated/types.js";
+import { AptosConfig } from "./aptosConfig.js";
+import { Account } from "../account/index.js";
+import { AccountAddressInput } from "../core/index.js";
+import { InputGenerateTransactionOptions } from "../transactions/index.js";
+import { SimpleTransaction } from "../transactions/instances/simpleTransaction.js";
+/**
+ * A class for querying and managing fungible asset-related operations on the Aptos blockchain.
+ * @group FungibleAsset
+ */
+export declare class FungibleAsset {
+    readonly config: AptosConfig;
+    /**
+     * Initializes a new instance of the Aptos class with the provided configuration.
+     * This allows you to interact with the Aptos blockchain using the specified network settings.
+     *
+     * @param config - The configuration settings for connecting to the Aptos network.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a configuration for the Aptos client
+     *     const config = new AptosConfig({ network: Network.TESTNET }); // Specify your own network if needed
+     *
+     *     // Initialize the Aptos client with the configuration
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group FungibleAsset
+     */
+    constructor(config: AptosConfig);
+    /**
+     * Queries all fungible asset metadata.
+     *
+     * @param args Optional parameters for the query.
+     * @param args.minimumLedgerVersion Optional ledger version to sync up to before querying.
+     * @param args.options Optional configuration for pagination and filtering.
+     *
+     * @returns A list of fungible asset metadata.
+     *
+     * @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() {
+     *   // Fetching fungible asset metadata
+     *   const fungibleAssets = await aptos.getFungibleAssetMetadata();
+     *   console.log(fungibleAssets);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group FungibleAsset
+     */
+    getFungibleAssetMetadata(args?: {
+        minimumLedgerVersion?: AnyNumber;
+        options?: PaginationArgs & WhereArg<FungibleAssetMetadataBoolExp>;
+    }): Promise<GetFungibleAssetMetadataResponse>;
+    /**
+     * Queries the fungible asset metadata for a specific asset type.
+     * This function helps retrieve detailed information about a fungible asset based on its type.
+     *
+     * @param args - The parameters for the query.
+     * @param args.assetType - The asset type of the fungible asset, e.g., "0x1::aptos_coin::AptosCoin" for Aptos Coin.
+     * @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.
+     *
+     * @returns A fungible asset metadata item.
+     *
+     * @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() {
+     *   // Retrieve fungible asset metadata by asset type
+     *   const fungibleAsset = await aptos.getFungibleAssetMetadataByAssetType({
+     *     assetType: "0x1::aptos_coin::AptosCoin" // replace with your asset type
+     *   });
+     *
+     *   console.log(fungibleAsset);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group FungibleAsset
+     */
+    getFungibleAssetMetadataByAssetType(args: {
+        assetType: string;
+        minimumLedgerVersion?: AnyNumber;
+    }): Promise<GetFungibleAssetMetadataResponse[0]>;
+    /**
+     * Retrieves fungible asset metadata based on the creator address.
+     *
+     * This function allows you to query metadata for a specific fungible asset created by a given address.
+     *
+     * @param args - The parameters for the query.
+     * @param args.creatorAddress - The creator address of the fungible asset.
+     * @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.
+     *
+     * @returns A fungible asset metadata item.
+     *
+     * @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() {
+     *   // Retrieve fungible asset metadata by creator address
+     *   const fungibleAsset = await aptos.getFungibleAssetMetadataByCreatorAddress({
+     *     creatorAddress: "0x123", // replace with a real creator address
+     *   });
+     *
+     *   console.log(fungibleAsset);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group FungibleAsset
+     */
+    getFungibleAssetMetadataByCreatorAddress(args: {
+        creatorAddress: AccountAddressInput;
+        minimumLedgerVersion?: AnyNumber;
+    }): Promise<GetFungibleAssetMetadataResponse>;
+    /**
+     * Queries all fungible asset activities and returns a list of their metadata.
+     *
+     * @param args Optional parameters for the query.
+     * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying.
+     * @param args.options Optional configuration for pagination and filtering.
+     * @returns A list of fungible asset metadata.
+     *
+     * @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() {
+     *   // Fetching fungible asset activities
+     *   const fungibleAssetActivities = await aptos.getFungibleAssetActivities();
+     *   console.log(fungibleAssetActivities);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group FungibleAsset
+     */
+    getFungibleAssetActivities(args?: {
+        minimumLedgerVersion?: AnyNumber;
+        options?: PaginationArgs & WhereArg<FungibleAssetActivitiesBoolExp>;
+    }): Promise<GetFungibleAssetActivitiesResponse>;
+    /**
+     * Queries all fungible asset balances.
+     *
+     * @param args Optional parameters for the query.
+     * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying.
+     * @param args.options Optional configuration for pagination and filtering.
+     *
+     * @returns A list of fungible asset metadata.
+     *
+     * @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() {
+     *   // Fetching current fungible asset balances
+     *   const fungibleAssetBalances = await aptos.getCurrentFungibleAssetBalances();
+     *
+     *   console.log(fungibleAssetBalances);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group FungibleAsset
+     */
+    getCurrentFungibleAssetBalances(args?: {
+        minimumLedgerVersion?: AnyNumber;
+        options?: PaginationArgs & WhereArg<CurrentFungibleAssetBalancesBoolExp>;
+    }): Promise<GetCurrentFungibleAssetBalancesResponse>;
+    /**
+     * Transfer a specified amount of fungible asset from the sender's primary store to the recipient's primary store.
+     * This method allows you to transfer any fungible asset, including fungible tokens.
+     *
+     * @param args - The arguments for the transfer operation.
+     * @param args.sender - The sender account.
+     * @param args.fungibleAssetMetadataAddress - The fungible asset account address. For example, if you're transferring USDT,
+     * this would be the USDT address.
+     * @param args.recipient - The recipient account address.
+     * @param args.amount - The number of assets to transfer.
+     * @param args.options - Optional parameters for generating the transaction.
+     *
+     * @returns A SimpleTransaction that can be simulated or submitted to the chain.
+     *
+     * @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() {
+     *   // Transfer fungible asset from sender to recipient
+     *   const transaction = await aptos.transferFungibleAsset({
+     *     sender: Account.generate(), // replace with a real sender account
+     *     fungibleAssetMetadataAddress: "0x123", // replace with a real fungible asset address
+     *     recipient: "0x456", // replace with a real recipient account
+     *     amount: 5
+     *   });
+     *
+     *   console.log(transaction);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group FungibleAsset
+     */
+    transferFungibleAsset(args: {
+        sender: Account;
+        fungibleAssetMetadataAddress: AccountAddressInput;
+        recipient: AccountAddressInput;
+        amount: AnyNumber;
+        options?: InputGenerateTransactionOptions;
+    }): Promise<SimpleTransaction>;
+    /**
+     * Transfer a specified amount of fungible asset from the sender's any (primary or secondary) fungible store to any (primary or secondary) fungible store.
+     * This method allows you to transfer any fungible asset, including fungible tokens.
+     *
+     * @param args - The arguments for the transfer operation.
+     * @param args.sender - The sender account initiating the transfer.
+     * @param args.fromStore - The fungible store address initiating the transfer.
+     * @param args.toStore - The fungible store address receiving the asset.
+     * @param args.amount - The number of assets to transfer. Must be a positive number.
+     * @param args.options - Optional parameters for generating the transaction.
+     *
+     * @returns A SimpleTransaction that can be simulated or submitted to the chain.
+     *
+     * @throws Error if:
+     * - The sender account is invalid
+     * - The store addresses are invalid
+     * - The amount is negative or zero
+     * - The transaction fails to generate
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network, Account } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function transferAssets() {
+     *   // Transfer 100 units of the asset from senderStore to recipientStore
+     *   const transaction = await aptos.transferFungibleAssetBetweenStores({
+     *     sender: Account.generate(), // replace with a real sender account
+     *     fromStore: "0x123", // replace with a real fungible store address
+     *     toStore: "0x456", // replace with a real fungible store address
+     *     amount: 100
+     *   });
+     *
+     *   console.log(transaction);
+     * }
+     *
+     * transferAssets().catch(console.error);
+     * ```
+     * @group FungibleAsset
+     */
+    transferFungibleAssetBetweenStores(args: {
+        sender: Account;
+        fromStore: AccountAddressInput;
+        toStore: AccountAddressInput;
+        amount: AnyNumber;
+        options?: InputGenerateTransactionOptions;
+    }): Promise<SimpleTransaction>;
+}
+//# sourceMappingURL=fungibleAsset.d.ts.map

package/dist/api/fungibleAsset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fungibleAsset.d.ts","sourceRoot":"","sources":["../../src/api/fungibleAsset.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,SAAS,EACT,uCAAuC,EACvC,kCAAkC,EAClC,gCAAgC,EAChC,cAAc,EACd,QAAQ,EACT,MAAM,mBAAmB,CAAC;AAQ3B,OAAO,EACL,mCAAmC,EACnC,8BAA8B,EAC9B,4BAA4B,EAC7B,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAkB,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,+BAA+B,EAAE,MAAM,0BAA0B,CAAC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,gDAAgD,CAAC;AAEnF;;;GAGG;AACH,qBAAa,aAAa;IAwBZ,QAAQ,CAAC,MAAM,EAAE,WAAW;IAvBxC;;;;;;;;;;;;;;;;;;;;;;OAsBG;gBACkB,MAAM,EAAE,WAAW;IAExC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,wBAAwB,CAAC,IAAI,CAAC,EAAE;QACpC,oBAAoB,CAAC,EAAE,SAAS,CAAC;QACjC,OAAO,CAAC,EAAE,cAAc,GAAG,QAAQ,CAAC,4BAA4B,CAAC,CAAC;KACnE,GAAG,OAAO,CAAC,gCAAgC,CAAC;IAS7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,mCAAmC,CAAC,IAAI,EAAE;QAC9C,SAAS,EAAE,MAAM,CAAC;QAClB,oBAAoB,CAAC,EAAE,SAAS,CAAC;KAClC,GAAG,OAAO,CAAC,gCAAgC,CAAC,CAAC,CAAC,CAAC;IAkBhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,wCAAwC,CAAC,IAAI,EAAE;QACnD,cAAc,EAAE,mBAAmB,CAAC;QACpC,oBAAoB,CAAC,EAAE,SAAS,CAAC;KAClC,GAAG,OAAO,CAAC,gCAAgC,CAAC;IAkB7C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,0BAA0B,CAAC,IAAI,CAAC,EAAE;QACtC,oBAAoB,CAAC,EAAE,SAAS,CAAC;QACjC,OAAO,CAAC,EAAE,cAAc,GAAG,QAAQ,CAAC,8BAA8B,CAAC,CAAC;KACrE,GAAG,OAAO,CAAC,kCAAkC,CAAC;IAS/C;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,+BAA+B,CAAC,IAAI,CAAC,EAAE;QAC3C,oBAAoB,CAAC,EAAE,SAAS,CAAC;QACjC,OAAO,CAAC,EAAE,cAAc,GAAG,QAAQ,CAAC,mCAAmC,CAAC,CAAC;KAC1E,GAAG,OAAO,CAAC,uCAAuC,CAAC;IASpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACG,qBAAqB,CAAC,IAAI,EAAE;QAChC,MAAM,EAAE,OAAO,CAAC;QAChB,4BAA4B,EAAE,mBAAmB,CAAC;QAClD,SAAS,EAAE,mBAAmB,CAAC;QAC/B,MAAM,EAAE,SAAS,CAAC;QAClB,OAAO,CAAC,EAAE,+BAA+B,CAAC;KAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACG,kCAAkC,CAAC,IAAI,EAAE;QAC7C,MAAM,EAAE,OAAO,CAAC;QAChB,SAAS,EAAE,mBAAmB,CAAC;QAC/B,OAAO,EAAE,mBAAmB,CAAC;QAC7B,MAAM,EAAE,SAAS,CAAC;QAClB,OAAO,CAAC,EAAE,+BAA+B,CAAC;KAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAG/B"}