@aptos-labs/ts-sdk 6.3.1 → 7.0.1

package/dist/api/fungibleAsset.js

@@ -0,0 +1,314 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { getCurrentFungibleAssetBalances, getFungibleAssetActivities, getFungibleAssetMetadata, transferFungibleAsset, transferFungibleAssetBetweenStores, } from "../internal/fungibleAsset.js";
+import { ProcessorType } from "../utils/const.js";
+import { waitForIndexerOnVersion } from "./utils.js";
+import { AccountAddress } from "../core/index.js";
+/**
+ * A class for querying and managing fungible asset-related operations on the Aptos blockchain.
+ * @group FungibleAsset
+ */
+export class FungibleAsset {
+    config;
+    /**
+     * 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) {
+        this.config = config;
+    }
+    /**
+     * 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
+     */
+    async getFungibleAssetMetadata(args) {
+        await waitForIndexerOnVersion({
+            config: this.config,
+            minimumLedgerVersion: args?.minimumLedgerVersion,
+            processorType: ProcessorType.FUNGIBLE_ASSET_PROCESSOR,
+        });
+        return getFungibleAssetMetadata({ aptosConfig: this.config, ...args });
+    }
+    /**
+     * 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
+     */
+    async getFungibleAssetMetadataByAssetType(args) {
+        await waitForIndexerOnVersion({
+            config: this.config,
+            minimumLedgerVersion: args?.minimumLedgerVersion,
+            processorType: ProcessorType.FUNGIBLE_ASSET_PROCESSOR,
+        });
+        const data = await getFungibleAssetMetadata({
+            aptosConfig: this.config,
+            options: {
+                where: {
+                    asset_type: { _eq: args.assetType },
+                },
+            },
+        });
+        return data[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
+     */
+    async getFungibleAssetMetadataByCreatorAddress(args) {
+        await waitForIndexerOnVersion({
+            config: this.config,
+            minimumLedgerVersion: args?.minimumLedgerVersion,
+            processorType: ProcessorType.FUNGIBLE_ASSET_PROCESSOR,
+        });
+        const data = await getFungibleAssetMetadata({
+            aptosConfig: this.config,
+            options: {
+                where: {
+                    creator_address: { _eq: AccountAddress.from(args.creatorAddress).toStringLong() },
+                },
+            },
+        });
+        return data;
+    }
+    /**
+     * 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
+     */
+    async getFungibleAssetActivities(args) {
+        await waitForIndexerOnVersion({
+            config: this.config,
+            minimumLedgerVersion: args?.minimumLedgerVersion,
+            processorType: ProcessorType.FUNGIBLE_ASSET_PROCESSOR,
+        });
+        return getFungibleAssetActivities({ aptosConfig: this.config, ...args });
+    }
+    /**
+     * 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
+     */
+    async getCurrentFungibleAssetBalances(args) {
+        await waitForIndexerOnVersion({
+            config: this.config,
+            minimumLedgerVersion: args?.minimumLedgerVersion,
+            processorType: ProcessorType.FUNGIBLE_ASSET_PROCESSOR,
+        });
+        return getCurrentFungibleAssetBalances({ aptosConfig: this.config, ...args });
+    }
+    /**
+     * 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
+     */
+    async transferFungibleAsset(args) {
+        return transferFungibleAsset({ aptosConfig: this.config, ...args });
+    }
+    /**
+     * 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
+     */
+    async transferFungibleAssetBetweenStores(args) {
+        return transferFungibleAssetBetweenStores({ aptosConfig: this.config, ...args });
+    }
+}
+//# sourceMappingURL=fungibleAsset.js.map

package/dist/api/fungibleAsset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fungibleAsset.js","sourceRoot":"","sources":["../../src/api/fungibleAsset.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAUtC,OAAO,EACL,+BAA+B,EAC/B,0BAA0B,EAC1B,wBAAwB,EACxB,qBAAqB,EACrB,kCAAkC,GACnC,MAAM,8BAA8B,CAAC;AAMtC,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAErD,OAAO,EAAE,cAAc,EAAuB,MAAM,kBAAkB,CAAC;AAIvE;;;GAGG;AACH,MAAM,OAAO,aAAa;IAwBH;IAvBrB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,YAAqB,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,wBAAwB,CAAC,IAG9B;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,EAAE,oBAAoB;YAChD,aAAa,EAAE,aAAa,CAAC,wBAAwB;SACtD,CAAC,CAAC;QACH,OAAO,wBAAwB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,mCAAmC,CAAC,IAGzC;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,EAAE,oBAAoB;YAChD,aAAa,EAAE,aAAa,CAAC,wBAAwB;SACtD,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,wBAAwB,CAAC;YAC1C,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,UAAU,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,SAAS,EAAE;iBACpC;aACF;SACF,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,wCAAwC,CAAC,IAG9C;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,EAAE,oBAAoB;YAChD,aAAa,EAAE,aAAa,CAAC,wBAAwB;SACtD,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,wBAAwB,CAAC;YAC1C,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,eAAe,EAAE,EAAE,GAAG,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,YAAY,EAAE,EAAE;iBAClF;aACF;SACF,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,0BAA0B,CAAC,IAGhC;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,EAAE,oBAAoB;YAChD,aAAa,EAAE,aAAa,CAAC,wBAAwB;SACtD,CAAC,CAAC;QACH,OAAO,0BAA0B,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAK,CAAC,+BAA+B,CAAC,IAGrC;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,EAAE,oBAAoB;YAChD,aAAa,EAAE,aAAa,CAAC,wBAAwB;SACtD,CAAC,CAAC;QACH,OAAO,+BAA+B,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,KAAK,CAAC,qBAAqB,CAAC,IAM3B;QACC,OAAO,qBAAqB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,KAAK,CAAC,kCAAkC,CAAC,IAMxC;QACC,OAAO,kCAAkC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACnF,CAAC;CACF"}

package/dist/api/general.d.ts

@@ -0,0 +1,298 @@
+import { AptosConfig } from "./aptosConfig.js";
+import { AnyNumber, Block, GetChainTopUserTransactionsResponse, GetProcessorStatusResponse, GraphqlQuery, LedgerInfo, LedgerVersionArg, MoveValue } from "../types/index.js";
+import { ProcessorType } from "../utils/const.js";
+import { InputViewFunctionData, InputViewFunctionJsonData } from "../transactions/index.js";
+/**
+ * A class to query various Aptos-related information and perform operations on the Aptos blockchain.
+ * @group General
+ */
+export declare class General {
+    readonly config: AptosConfig;
+    /**
+     * Initializes a new instance of the Aptos client with the specified configuration.
+     * This allows users to interact with the Aptos blockchain using the provided settings.
+     *
+     * @param config - The configuration settings for the Aptos client.
+     * @param config.network - The network to connect to (e.g., TESTNET, MAINNET).
+     * @param config.nodeUrl - The URL of the Aptos node to connect to.
+     *
+     * @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 the network
+     *         nodeUrl: "https://testnet.aptos.dev" // specify the node URL
+     *     });
+     *
+     *     // Initialize the Aptos client with the configuration
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group General
+     */
+    constructor(config: AptosConfig);
+    /**
+     * Queries for the Aptos ledger information.
+     *
+     * @returns The Aptos Ledger Info, which includes details such as chain ID, epoch, and ledger version.
+     *
+     * @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 the ledger information
+     *   const ledgerInfo = await aptos.getLedgerInfo();
+     *
+     *   console.log(ledgerInfo);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group General
+     */
+    getLedgerInfo(): Promise<LedgerInfo>;
+    /**
+     * Retrieves the chain ID of the Aptos blockchain.
+     *
+     * @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 the chain ID
+     *   const chainId = await aptos.getChainId();
+     *   console.log("Chain ID:", chainId);
+     * }
+     * runExample().catch(console.error);
+     *
+     * @returns The chain ID of the Aptos blockchain.
+     * ```
+     * @group General
+     */
+    getChainId(): Promise<number>;
+    /**
+     * Retrieves block information by the specified ledger version.
+     *
+     * @param args - The arguments for retrieving the block.
+     * @param args.ledgerVersion - The ledger version to lookup block information for.
+     * @param args.options - Optional parameters for the request.
+     * @param args.options.withTransactions - If set to true, include all transactions in the block.
+     *
+     * @returns Block information with optional transactions.
+     *
+     * @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 block information for a specific ledger version
+     *   const block = await aptos.getBlockByVersion({ ledgerVersion: 5 });
+     *   console.log(block);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group General
+     */
+    getBlockByVersion(args: {
+        ledgerVersion: AnyNumber;
+        options?: {
+            withTransactions?: boolean;
+        };
+    }): Promise<Block>;
+    /**
+     * Retrieve a block by its height, allowing for the inclusion of transactions if specified.
+     *
+     * @param args - The parameters for the block retrieval.
+     * @param args.blockHeight - The block height to look up, starting at 0.
+     * @param args.options - Optional settings for the retrieval.
+     * @param args.options.withTransactions - If set to true, includes all transactions in the block.
+     *
+     * @returns The block with optional transactions included.
+     *
+     * @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 the block at height 5, including transactions
+     *   const block = await aptos.getBlockByHeight({ blockHeight: 5, options: { withTransactions: true } });
+     *   console.log(block);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group General
+     */
+    getBlockByHeight(args: {
+        blockHeight: AnyNumber;
+        options?: {
+            withTransactions?: boolean;
+        };
+    }): Promise<Block>;
+    /**
+     * Queries for a Move view function
+     * @param args.payload Payload for the view function
+     * @param args.options.ledgerVersion The ledger version to query, if not provided it will get the latest version
+     *
+     * @example
+     * const data = await aptos.view({
+     *  payload: {
+     *   function: "0x1::coin::balance",
+     *   typeArguments: ["0x1::aptos_coin::AptosCoin"],
+     *   functionArguments: [accountAddress],
+     *  }
+     * })
+     *
+     * @returns an array of Move values
+     * @group General
+     */
+    view<T extends Array<MoveValue>>(args: {
+        payload: InputViewFunctionData;
+        options?: LedgerVersionArg;
+    }): Promise<T>;
+    /**
+     * Queries for a Move view function with JSON, this provides compatability with the old `aptos` package
+     * @param args.payload Payload for the view function
+     * @param args.options.ledgerVersion The ledger version to query, if not provided it will get the latest version
+     *
+     * @example
+     * const data = await aptos.view({
+     *  payload: {
+     *   function: "0x1::coin::balance",
+     *   typeArguments: ["0x1::aptos_coin::AptosCoin"],
+     *   functionArguments: [accountAddress.toString()],
+     *  }
+     * })
+     *
+     * @returns an array of Move values
+     * @group General
+     */
+    viewJson<T extends Array<MoveValue>>(args: {
+        payload: InputViewFunctionJsonData;
+        options?: LedgerVersionArg;
+    }): Promise<T>;
+    /**
+     * Queries the top user transactions based on the specified limit.
+     *
+     * @param args - The arguments for querying top user transactions.
+     * @param args.limit - The number of transactions to return.
+     * @returns GetChainTopUserTransactionsResponse
+     *
+     * @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() {
+     *   // Fetch the top user transactions with a limit of 5
+     *   const topUserTransactions = await aptos.getChainTopUserTransactions({ limit: 5 });
+     *
+     *   console.log(topUserTransactions);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group General
+     */
+    getChainTopUserTransactions(args: {
+        limit: number;
+    }): Promise<GetChainTopUserTransactionsResponse>;
+    /**
+     * Retrieves data from the Aptos Indexer using a GraphQL query.
+     * This function allows you to execute complex queries to fetch specific data from the Aptos blockchain.
+     *
+     * @param args.query.query - A GraphQL query string.
+     * @param args.query.variables - The variables for the query (optional).
+     *
+     * @return The provided T type.
+     *
+     * @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() {
+     *   // Querying the Aptos Indexer for ledger information
+     *   const topUserTransactions = await aptos.queryIndexer({
+     *     query: { query: `query MyQuery {
+     *       ledger_infos {
+     *         chain_id
+     *       }
+     *     }`}
+     *   });
+     *
+     *   console.log(topUserTransactions);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group General
+     */
+    queryIndexer<T extends {}>(args: {
+        query: GraphqlQuery;
+    }): Promise<T>;
+    /**
+     * Queries for the last successful indexer version, providing insight into the ledger version the indexer is updated to, which
+     * may lag behind the full nodes.
+     *
+     * @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() {
+     *   // Get the last successful indexer version
+     *   const version = await aptos.getIndexerLastSuccessVersion();
+     *   console.log(`Last successful indexer version: ${version}`);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group General
+     */
+    getIndexerLastSuccessVersion(): Promise<bigint>;
+    /**
+     * Query the processor status for a specific processor type.
+     *
+     * @param processorType The processor type to query.
+     * @returns The status of the specified processor type.
+     *
+     * @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() {
+     *   // Get the processor status for the account transactions processor
+     *   const status = await aptos.getProcessorStatus("account_transactions_processor");
+     *   console.log(status);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group General
+     */
+    getProcessorStatus(processorType: ProcessorType): Promise<GetProcessorStatusResponse[0]>;
+}
+//# sourceMappingURL=general.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"general.d.ts","sourceRoot":"","sources":["../../src/api/general.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAU/C,OAAO,EACL,SAAS,EACT,KAAK,EACL,mCAAmC,EACnC,0BAA0B,EAC1B,YAAY,EACZ,UAAU,EACV,gBAAgB,EAChB,SAAS,EACV,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,qBAAqB,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAE5F;;;GAGG;AACH,qBAAa,OAAO;IAClB,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;gBACS,MAAM,EAAE,WAAW;IAI/B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,aAAa,IAAI,OAAO,CAAC,UAAU,CAAC;IAI1C;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IAKnC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,iBAAiB,CAAC,IAAI,EAAE;QAC5B,aAAa,EAAE,SAAS,CAAC;QACzB,OAAO,CAAC,EAAE;YAAE,gBAAgB,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC;KAC1C,GAAG,OAAO,CAAC,KAAK,CAAC;IAOlB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,gBAAgB,CAAC,IAAI,EAAE;QAAE,WAAW,EAAE,SAAS,CAAC;QAAC,OAAO,CAAC,EAAE;YAAE,gBAAgB,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,CAAC;IAIlH;;;;;;;;;;;;;;;;OAgBG;IACG,IAAI,CAAC,CAAC,SAAS,KAAK,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE;QAC3C,OAAO,EAAE,qBAAqB,CAAC;QAC/B,OAAO,CAAC,EAAE,gBAAgB,CAAC;KAC5B,GAAG,OAAO,CAAC,CAAC,CAAC;IAId;;;;;;;;;;;;;;;;OAgBG;IACG,QAAQ,CAAC,CAAC,SAAS,KAAK,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE;QAC/C,OAAO,EAAE,yBAAyB,CAAC;QACnC,OAAO,CAAC,EAAE,gBAAgB,CAAC;KAC5B,GAAG,OAAO,CAAC,CAAC,CAAC;IAId;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,2BAA2B,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,mCAAmC,CAAC;IAOxG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,YAAY,CAAC,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE;QAAE,KAAK,EAAE,YAAY,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAO3E;;;;;;;;;;;;;;;;;;;OAmBG;IACG,4BAA4B,IAAI,OAAO,CAAC,MAAM,CAAC;IAIrD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,kBAAkB,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC;CAG/F"}