@aptos-labs/ts-sdk 6.3.0 → 7.0.0

package/dist/api/table.js

@@ -0,0 +1,171 @@
+import { getTableItem, getTableItemsData, getTableItemsMetadata } from "../internal/table.js";
+import { ProcessorType } from "../utils/index.js";
+import { waitForIndexerOnVersion } from "./utils.js";
+/**
+ * A class to query all `Table` Aptos related queries.
+ * @group Table
+ */
+export class Table {
+    config;
+    /**
+     * Initializes a new instance of the Aptos client with the specified configuration.
+     * This allows you to interact with the Aptos blockchain using the provided settings.
+     *
+     * @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 new Aptos client with testnet configuration
+     *     const config = new AptosConfig({ network: Network.TESTNET });
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Table
+     */
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * Queries for a specific item in a table identified by the handle and the key for the item.
+     * This function allows you to retrieve structured data from a table in the Aptos blockchain.
+     *
+     * @param args.handle A pointer to where that table is stored.
+     * @param args.data Object that describes the table item, including key and value types.
+     * @param args.data.key_type The Move type of the table key.
+     * @param args.data.value_type The Move type of the table value.
+     * @param args.data.key The value of the table key.
+     * @param args.options.ledgerVersion The ledger version to query; if not provided, it will get the latest version.
+     *
+     * @returns Table item value rendered in JSON.
+     *
+     * @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 a table item from the Aptos blockchain
+     *   const tableItem = await aptos.getTableItem({
+     *     handle: "0x1b854694ae746cdbd8d44186ca4929b2b337df21d1c74633be19b2710552fdca",
+     *     data: {
+     *       key_type: "address", // Move type of table key
+     *       value_type: "u128", // Move type of table value
+     *       key: "0x619dc29a0aac8fa146714058e8dd6d2d0f3bdf5f6331907bf91f3acd81e6935" // Value of table key
+     *     },
+     *   });
+     *
+     *   console.log(tableItem);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Table
+     */
+    async getTableItem(args) {
+        return getTableItem({ aptosConfig: this.config, ...args });
+    }
+    /**
+     * Queries for table items data with optional filtering and pagination.
+     * This function allows you to retrieve specific data from a table based on provided criteria.
+     *
+     * @param args - The arguments for querying table items data.
+     * @param args.minimumLedgerVersion - Optional minimum ledger version to wait for before querying.
+     * @param args.options - Optional parameters for pagination and filtering.
+     * @param args.options.where - Conditions to filter the response.
+     * @param args.options.offset - The number of items to skip before starting to collect the result set.
+     * @param args.options.limit - The maximum number of items to return.
+     * @param args.options.orderBy - The criteria to order the results.
+     *
+     * Note: This query calls the indexer server.
+     *
+     * @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 table items data with specific filtering options
+     *   const data = await aptos.getTableItemsData({
+     *     minimumLedgerVersion: 1, // specify your own minimum ledger version if needed
+     *     options: {
+     *       where: {
+     *         table_handle: { _eq: "0x1b854694ae746cdbd8d44186ca4929b2b337df21d1c74633be19b2710552fdca" },
+     *         transaction_version: { _eq: "0" }
+     *       },
+     *       limit: 10, // specify your own limit if needed
+     *     },
+     *   });
+     *
+     *   console.log(data);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     *
+     * @returns GetTableItemsDataResponse
+     * @group Table
+     */
+    async getTableItemsData(args) {
+        await waitForIndexerOnVersion({
+            config: this.config,
+            minimumLedgerVersion: args.minimumLedgerVersion,
+            processorType: ProcessorType.DEFAULT,
+        });
+        return getTableItemsData({ aptosConfig: this.config, ...args });
+    }
+    /**
+     * Queries for the metadata of table items, allowing for filtering and pagination.
+     *
+     * @param args - The parameters for the query.
+     * @param args.minimumLedgerVersion - Optional minimum ledger version to wait for before querying.
+     * @param args.options - Optional parameters for pagination and filtering.
+     * @param args.options.where - Conditions to filter the response.
+     * @param args.options.offset - The offset for pagination.
+     * @param args.options.limit - The maximum number of items to return.
+     * @param args.options.orderBy - The order in which to return the items.
+     *
+     * Note that this query calls the indexer server.
+     *
+     * @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 table items metadata with a filter condition
+     *   const data = await aptos.getTableItemsMetadata({
+     *     minimumLedgerVersion: 1, // specify your own minimum ledger version if needed
+     *     options: {
+     *       where: { handle: { _eq: "0x1b854694ae746cdbd8d44186ca4929b2b337df21d1c74633be19b2710552fdca" } },
+     *       limit: 10, // specify your own limit if needed
+     *     },
+     *   });
+     *
+     *   console.log(data);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     *
+     * @returns GetTableItemsMetadataResponse
+     * @group Table
+     */
+    async getTableItemsMetadata(args) {
+        await waitForIndexerOnVersion({
+            config: this.config,
+            minimumLedgerVersion: args.minimumLedgerVersion,
+            processorType: ProcessorType.DEFAULT,
+        });
+        return getTableItemsMetadata({ aptosConfig: this.config, ...args });
+    }
+}
+//# sourceMappingURL=table.js.map

package/dist/api/table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.js","sourceRoot":"","sources":["../../src/api/table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAY9F,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAErD;;;GAGG;AACH,MAAM,OAAO,KAAK;IACP,MAAM,CAAc;IAE7B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,YAAY,MAAmB;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,KAAK,CAAC,YAAY,CAAI,IAA4E;QAChG,OAAO,YAAY,CAAI,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,KAAK,CAAC,iBAAiB,CAAC,IAGvB;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,aAAa,EAAE,aAAa,CAAC,OAAO;SACrC,CAAC,CAAC;QACH,OAAO,iBAAiB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,KAAK,CAAC,qBAAqB,CAAC,IAG3B;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,aAAa,EAAE,aAAa,CAAC,OAAO;SACrC,CAAC,CAAC;QACH,OAAO,qBAAqB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}