@aptos-labs/ts-sdk 6.3.1 → 7.0.0

package/dist/api/object.d.ts

@@ -0,0 +1,74 @@
+import { AnyNumber, GetObjectDataQueryResponse, OrderByArg, PaginationArgs } from "../types/index.js";
+import { AccountAddressInput } from "../core/index.js";
+import { AptosConfig } from "./aptosConfig.js";
+/**
+ * A class to query all `Object` related queries on Aptos.
+ * @group Object
+ */
+export declare class AptosObject {
+    readonly config: AptosConfig;
+    /**
+     * Creates an instance of the Aptos client with the provided configuration.
+     * This allows interaction with the Aptos blockchain using the specified settings.
+     *
+     * @param config - The configuration settings for the Aptos client.
+     * @param config.network - The network to connect to (e.g., mainnet, testnet).
+     * @param config.nodeUrl - The URL of the Aptos node to connect to.
+     * @param config.faucetUrl - The URL of the faucet for funding accounts (optional).
+     *
+     * @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 desired network
+     *         nodeUrl: "https://testnet.aptos.dev", // Replace with your node URL
+     *     });
+     *
+     *     // Create an instance of the Aptos client
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client created successfully", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Object
+     */
+    constructor(config: AptosConfig);
+    /**
+     * Fetches the object data based on the specified object address.
+     *
+     * @param args.objectAddress - The object address to retrieve data for.
+     * @param args.minimumLedgerVersion - Optional minimum ledger version to wait for.
+     * @param args.options - Optional configuration options for pagination and ordering.
+     *
+     * @returns The object data corresponding to the provided address.
+     *
+     * @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 object data by object address
+     *   const objectData = await aptos.getObjectDataByObjectAddress({
+     *     objectAddress: "0x1", // replace with a real object address
+     *   });
+     *
+     *   console.log(objectData);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Object
+     */
+    getObjectDataByObjectAddress(args: {
+        objectAddress: AccountAddressInput;
+        minimumLedgerVersion?: AnyNumber;
+        options?: PaginationArgs & OrderByArg<GetObjectDataQueryResponse[0]>;
+    }): Promise<GetObjectDataQueryResponse[0]>;
+}
+//# sourceMappingURL=object.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/api/object.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,0BAA0B,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACtG,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAK/C;;;GAGG;AACH,qBAAa,WAAW;IA8BV,QAAQ,CAAC,MAAM,EAAE,WAAW;IA7BxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;gBACkB,MAAM,EAAE,WAAW;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,4BAA4B,CAAC,IAAI,EAAE;QACvC,aAAa,EAAE,mBAAmB,CAAC;QACnC,oBAAoB,CAAC,EAAE,SAAS,CAAC;QACjC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,CAAC;KACtE,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC;CAW3C"}

package/dist/api/object.js

@@ -0,0 +1,84 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { ProcessorType } from "../utils/index.js";
+import { waitForIndexerOnVersion } from "./utils.js";
+import { getObjectDataByObjectAddress } from "../internal/object.js";
+/**
+ * A class to query all `Object` related queries on Aptos.
+ * @group Object
+ */
+export class AptosObject {
+    config;
+    /**
+     * Creates an instance of the Aptos client with the provided configuration.
+     * This allows interaction with the Aptos blockchain using the specified settings.
+     *
+     * @param config - The configuration settings for the Aptos client.
+     * @param config.network - The network to connect to (e.g., mainnet, testnet).
+     * @param config.nodeUrl - The URL of the Aptos node to connect to.
+     * @param config.faucetUrl - The URL of the faucet for funding accounts (optional).
+     *
+     * @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 desired network
+     *         nodeUrl: "https://testnet.aptos.dev", // Replace with your node URL
+     *     });
+     *
+     *     // Create an instance of the Aptos client
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client created successfully", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Object
+     */
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * Fetches the object data based on the specified object address.
+     *
+     * @param args.objectAddress - The object address to retrieve data for.
+     * @param args.minimumLedgerVersion - Optional minimum ledger version to wait for.
+     * @param args.options - Optional configuration options for pagination and ordering.
+     *
+     * @returns The object data corresponding to the provided address.
+     *
+     * @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 object data by object address
+     *   const objectData = await aptos.getObjectDataByObjectAddress({
+     *     objectAddress: "0x1", // replace with a real object address
+     *   });
+     *
+     *   console.log(objectData);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Object
+     */
+    async getObjectDataByObjectAddress(args) {
+        await waitForIndexerOnVersion({
+            config: this.config,
+            minimumLedgerVersion: args.minimumLedgerVersion,
+            processorType: ProcessorType.OBJECT_PROCESSOR,
+        });
+        return getObjectDataByObjectAddress({
+            aptosConfig: this.config,
+            ...args,
+        });
+    }
+}
+//# sourceMappingURL=object.js.map

package/dist/api/object.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.js","sourceRoot":"","sources":["../../src/api/object.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAKtC,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAC;AAErE;;;GAGG;AACH,MAAM,OAAO,WAAW;IA8BD;IA7BrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,YAAqB,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,4BAA4B,CAAC,IAIlC;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,aAAa,EAAE,aAAa,CAAC,gBAAgB;SAC9C,CAAC,CAAC;QACH,OAAO,4BAA4B,CAAC;YAClC,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,GAAG,IAAI;SACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/api/staking.d.ts

@@ -0,0 +1,128 @@
+import { AnyNumber, GetDelegatedStakingActivitiesResponse, GetNumberOfDelegatorsResponse, OrderByArg } from "../types/index.js";
+import { AccountAddressInput } from "../core/index.js";
+import { AptosConfig } from "./aptosConfig.js";
+/**
+ * A class to query all `Staking` related queries on Aptos.
+ * @group Staking
+ */
+export declare class Staking {
+    readonly config: AptosConfig;
+    /**
+     * Creates an 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.
+     * @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 your network
+     *
+     *     // Initialize the Aptos client with the configuration
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Staking
+     */
+    constructor(config: AptosConfig);
+    /**
+     * Queries the current number of delegators in a specified pool. Throws an error if the pool is not found.
+     *
+     * @param args - The parameters for the query.
+     * @param args.poolAddress - The address of the pool to query.
+     * @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.
+     * @returns The number of delegators for the given pool.
+     *
+     * @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 number of delegators for a specific pool
+     *   const delegators = await aptos.getNumberOfDelegators({ poolAddress: "0x1" }); // replace with a real pool address
+     *   console.log(`Number of delegators: ${delegators}`);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Staking
+     */
+    getNumberOfDelegators(args: {
+        poolAddress: AccountAddressInput;
+        minimumLedgerVersion?: AnyNumber;
+    }): Promise<number>;
+    /**
+     * Retrieves the current number of delegators across all pools.
+     *
+     * @param args Optional parameters for the query.
+     * @param args.minimumLedgerVersion Optional ledger version to sync up to before querying.
+     * @param args.options Optional ordering options for the response.
+     * @returns GetNumberOfDelegatorsForAllPoolsResponse response type containing the number of delegators per pool.
+     *
+     * @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 number of delegators for all pools
+     *   const delegators = await aptos.getNumberOfDelegatorsForAllPools();
+     *   console.log(delegators);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Staking
+     */
+    getNumberOfDelegatorsForAllPools(args?: {
+        minimumLedgerVersion?: AnyNumber;
+        options?: OrderByArg<GetNumberOfDelegatorsResponse[0]>;
+    }): Promise<GetNumberOfDelegatorsResponse>;
+    /**
+     * Queries delegated staking activities for a specific delegator and pool.
+     *
+     * @param args - The arguments for querying delegated staking activities.
+     * @param args.delegatorAddress - The address of the delegator.
+     * @param args.poolAddress - The address of the staking pool.
+     * @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.
+     * @returns The response containing delegated staking activities.
+     *
+     * @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 delegated staking activities for a specific delegator and pool
+     *   const activities = await aptos.getDelegatedStakingActivities({
+     *     delegatorAddress: "0x1", // replace with a real delegator address
+     *     poolAddress: "0x2", // replace with a real pool address
+     *     minimumLedgerVersion: 1, // specify your own if needed
+     *   });
+     *
+     *   console.log(activities);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Staking
+     */
+    getDelegatedStakingActivities(args: {
+        delegatorAddress: AccountAddressInput;
+        poolAddress: AccountAddressInput;
+        minimumLedgerVersion?: AnyNumber;
+    }): Promise<GetDelegatedStakingActivitiesResponse>;
+}
+//# sourceMappingURL=staking.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"staking.d.ts","sourceRoot":"","sources":["../../src/api/staking.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,SAAS,EACT,qCAAqC,EACrC,6BAA6B,EAC7B,UAAU,EACX,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEvD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG/C;;;GAGG;AACH,qBAAa,OAAO;IA0BN,QAAQ,CAAC,MAAM,EAAE,WAAW;IAzBxC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;gBACkB,MAAM,EAAE,WAAW;IAExC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,qBAAqB,CAAC,IAAI,EAAE;QAChC,WAAW,EAAE,mBAAmB,CAAC;QACjC,oBAAoB,CAAC,EAAE,SAAS,CAAC;KAClC,GAAG,OAAO,CAAC,MAAM,CAAC;IASnB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,gCAAgC,CAAC,IAAI,CAAC,EAAE;QAC5C,oBAAoB,CAAC,EAAE,SAAS,CAAC;QACjC,OAAO,CAAC,EAAE,UAAU,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,CAAC;KACxD,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAS1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,6BAA6B,CAAC,IAAI,EAAE;QACxC,gBAAgB,EAAE,mBAAmB,CAAC;QACtC,WAAW,EAAE,mBAAmB,CAAC;QACjC,oBAAoB,CAAC,EAAE,SAAS,CAAC;KAClC,GAAG,OAAO,CAAC,qCAAqC,CAAC;CAQnD"}

package/dist/api/staking.js

@@ -0,0 +1,143 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { getDelegatedStakingActivities, getNumberOfDelegators, getNumberOfDelegatorsForAllPools, } from "../internal/staking.js";
+import { ProcessorType } from "../utils/const.js";
+import { waitForIndexerOnVersion } from "./utils.js";
+/**
+ * A class to query all `Staking` related queries on Aptos.
+ * @group Staking
+ */
+export class Staking {
+    config;
+    /**
+     * Creates an 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.
+     * @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 your network
+     *
+     *     // Initialize the Aptos client with the configuration
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Staking
+     */
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * Queries the current number of delegators in a specified pool. Throws an error if the pool is not found.
+     *
+     * @param args - The parameters for the query.
+     * @param args.poolAddress - The address of the pool to query.
+     * @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.
+     * @returns The number of delegators for the given pool.
+     *
+     * @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 number of delegators for a specific pool
+     *   const delegators = await aptos.getNumberOfDelegators({ poolAddress: "0x1" }); // replace with a real pool address
+     *   console.log(`Number of delegators: ${delegators}`);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Staking
+     */
+    async getNumberOfDelegators(args) {
+        await waitForIndexerOnVersion({
+            config: this.config,
+            minimumLedgerVersion: args?.minimumLedgerVersion,
+            processorType: ProcessorType.STAKE_PROCESSOR,
+        });
+        return getNumberOfDelegators({ aptosConfig: this.config, ...args });
+    }
+    /**
+     * Retrieves the current number of delegators across all pools.
+     *
+     * @param args Optional parameters for the query.
+     * @param args.minimumLedgerVersion Optional ledger version to sync up to before querying.
+     * @param args.options Optional ordering options for the response.
+     * @returns GetNumberOfDelegatorsForAllPoolsResponse response type containing the number of delegators per pool.
+     *
+     * @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 number of delegators for all pools
+     *   const delegators = await aptos.getNumberOfDelegatorsForAllPools();
+     *   console.log(delegators);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Staking
+     */
+    async getNumberOfDelegatorsForAllPools(args) {
+        await waitForIndexerOnVersion({
+            config: this.config,
+            minimumLedgerVersion: args?.minimumLedgerVersion,
+            processorType: ProcessorType.STAKE_PROCESSOR,
+        });
+        return getNumberOfDelegatorsForAllPools({ aptosConfig: this.config, ...args });
+    }
+    /**
+     * Queries delegated staking activities for a specific delegator and pool.
+     *
+     * @param args - The arguments for querying delegated staking activities.
+     * @param args.delegatorAddress - The address of the delegator.
+     * @param args.poolAddress - The address of the staking pool.
+     * @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.
+     * @returns The response containing delegated staking activities.
+     *
+     * @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 delegated staking activities for a specific delegator and pool
+     *   const activities = await aptos.getDelegatedStakingActivities({
+     *     delegatorAddress: "0x1", // replace with a real delegator address
+     *     poolAddress: "0x2", // replace with a real pool address
+     *     minimumLedgerVersion: 1, // specify your own if needed
+     *   });
+     *
+     *   console.log(activities);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Staking
+     */
+    async getDelegatedStakingActivities(args) {
+        await waitForIndexerOnVersion({
+            config: this.config,
+            minimumLedgerVersion: args?.minimumLedgerVersion,
+            processorType: ProcessorType.STAKE_PROCESSOR,
+        });
+        return getDelegatedStakingActivities({ aptosConfig: this.config, ...args });
+    }
+}
+//# sourceMappingURL=staking.js.map

package/dist/api/staking.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"staking.js","sourceRoot":"","sources":["../../src/api/staking.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAEtC,OAAO,EACL,6BAA6B,EAC7B,qBAAqB,EACrB,gCAAgC,GACjC,MAAM,wBAAwB,CAAC;AAQhC,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAErD;;;GAGG;AACH,MAAM,OAAO,OAAO;IA0BG;IAzBrB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,YAAqB,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,qBAAqB,CAAC,IAG3B;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,EAAE,oBAAoB;YAChD,aAAa,EAAE,aAAa,CAAC,eAAe;SAC7C,CAAC,CAAC;QACH,OAAO,qBAAqB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,gCAAgC,CAAC,IAGtC;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,EAAE,oBAAoB;YAChD,aAAa,EAAE,aAAa,CAAC,eAAe;SAC7C,CAAC,CAAC;QACH,OAAO,gCAAgC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,6BAA6B,CAAC,IAInC;QACC,MAAM,uBAAuB,CAAC;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,oBAAoB,EAAE,IAAI,EAAE,oBAAoB;YAChD,aAAa,EAAE,aAAa,CAAC,eAAe;SAC7C,CAAC,CAAC;QACH,OAAO,6BAA6B,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF"}

package/dist/api/table.d.ts

@@ -0,0 +1,163 @@
+import { TableItemRequest, LedgerVersionArg, AnyNumber, PaginationArgs, WhereArg, OrderByArg, GetTableItemsDataResponse, GetTableItemsMetadataResponse } from "../types/index.js";
+import { TableItemsBoolExp, TableMetadatasBoolExp } from "../types/generated/types.js";
+import { AptosConfig } from "./aptosConfig.js";
+/**
+ * A class to query all `Table` Aptos related queries.
+ * @group Table
+ */
+export declare class Table {
+    readonly config: AptosConfig;
+    /**
+     * 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: AptosConfig);
+    /**
+     * 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
+     */
+    getTableItem<T>(args: {
+        handle: string;
+        data: TableItemRequest;
+        options?: LedgerVersionArg;
+    }): Promise<T>;
+    /**
+     * 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
+     */
+    getTableItemsData(args: {
+        minimumLedgerVersion?: AnyNumber;
+        options?: PaginationArgs & WhereArg<TableItemsBoolExp> & OrderByArg<GetTableItemsDataResponse[0]>;
+    }): Promise<GetTableItemsDataResponse>;
+    /**
+     * 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
+     */
+    getTableItemsMetadata(args: {
+        minimumLedgerVersion?: AnyNumber;
+        options?: PaginationArgs & WhereArg<TableMetadatasBoolExp> & OrderByArg<GetTableItemsMetadataResponse[0]>;
+    }): Promise<GetTableItemsMetadataResponse>;
+}
+//# sourceMappingURL=table.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../../src/api/table.ts"],"names":[],"mappings":"AACA,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,SAAS,EACT,cAAc,EACd,QAAQ,EACR,UAAU,EACV,yBAAyB,EACzB,6BAA6B,EAC9B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEvF,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG/C;;;GAGG;AACH,qBAAa,KAAK;IAChB,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAE7B;;;;;;;;;;;;;;;;;;;;OAoBG;gBACS,MAAM,EAAE,WAAW;IAI/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACG,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,gBAAgB,CAAC;QAAC,OAAO,CAAC,EAAE,gBAAgB,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAI/G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACG,iBAAiB,CAAC,IAAI,EAAE;QAC5B,oBAAoB,CAAC,EAAE,SAAS,CAAC;QACjC,OAAO,CAAC,EAAE,cAAc,GAAG,QAAQ,CAAC,iBAAiB,CAAC,GAAG,UAAU,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,CAAC;KACnG,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAStC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACG,qBAAqB,CAAC,IAAI,EAAE;QAChC,oBAAoB,CAAC,EAAE,SAAS,CAAC;QACjC,OAAO,CAAC,EAAE,cAAc,GAAG,QAAQ,CAAC,qBAAqB,CAAC,GAAG,UAAU,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,CAAC;KAC3G,GAAG,OAAO,CAAC,6BAA6B,CAAC;CAQ3C"}