@aptos-labs/ts-sdk 1.29.0 → 1.30.0

package/dist/esm/api/object.d.mts

@@ -3,31 +3,75 @@ import { AccountAddressInput } from '../core/accountAddress.mjs';
 import { AptosConfig } from './aptosConfig.mjs';
 import { GetObjectDataQueryResponse } from '../types/indexer.mjs';
 import '../utils/apiEndpoints.mjs';
-import '../types/generated/operations.mjs';
-import '../types/generated/types.mjs';
 import '../bcs/serializer.mjs';
 import '../core/hex.mjs';
 import '../core/common.mjs';
 import '../bcs/deserializer.mjs';
 import '../transactions/instances/transactionArgument.mjs';
 import '../utils/const.mjs';
+import '../types/generated/operations.mjs';
+import '../types/generated/types.mjs';
 
 /**
  * A class to query all `Object` related queries on Aptos.
  */
 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);
+     * ```
+     */
     constructor(config: AptosConfig);
     /**
-     * Fetch the object data based on the oabject address
+     * 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
-     * const object = await aptos.getObjectDataByObjectAddress({objectAddress:"0x123"})
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
      *
-     * @param args.objectAddress The object address
-     * @param args.options Configuration options for waitForTransaction
+     * async function runExample() {
+     *   // Fetching object data by object address
+     *   const objectData = await aptos.getObjectDataByObjectAddress({
+     *     objectAddress: "0x1", // replace with a real object address
+     *   });
      *
-     * @returns The object data
+     *   console.log(objectData);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getObjectDataByObjectAddress(args: {
         objectAddress: AccountAddressInput;

package/dist/esm/api/object.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-GDUAFXIQ.mjs";import"../chunk-F76N4MQO.mjs";import"../chunk-SDWE6WMM.mjs";import"../chunk-FZ5EYP3D.mjs";import"../chunk-2BTTX2KO.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-WRRQ7L5K.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-45IUUCAV.mjs";import"../chunk-HHGJXVAE.mjs";import"../chunk-GMBSQDPO.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-GDO6Q2FI.mjs";import"../chunk-BA4RBST6.mjs";import"../chunk-G5XLMQ5E.mjs";import"../chunk-SRPI2FFA.mjs";import"../chunk-MQGW234H.mjs";import"../chunk-F63E4CR7.mjs";import"../chunk-GWSDIX6C.mjs";import"../chunk-MLDQ2TY2.mjs";import"../chunk-Q4XR6QOZ.mjs";import"../chunk-76OH2Z4Q.mjs";import"../chunk-LR65XHSF.mjs";import"../chunk-G5MGSV7Y.mjs";import"../chunk-OHRL766V.mjs";import"../chunk-AH44UPM4.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-YU3IYJRL.mjs";import"../chunk-CRA2MFJC.mjs";import"../chunk-XMW65WCQ.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-BSUYPXRD.mjs";import"../chunk-SCHZ67F3.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-LNEZEYYE.mjs";import"../chunk-YPHH6CAO.mjs";import"../chunk-P5V7OZNN.mjs";import"../chunk-H6YNXJNF.mjs";import"../chunk-44GYWUSH.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-A63SMUOU.mjs";import"../chunk-BCUSI3N6.mjs";import"../chunk-LG7RJQ57.mjs";import"../chunk-TDGQGILY.mjs";import"../chunk-EXP5STXZ.mjs";import"../chunk-UAL27G6B.mjs";import"../chunk-KEYAPEAX.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-UAEODDZS.mjs";import"../chunk-FVA2OPG4.mjs";export{a as AptosObject};
+import{a}from"../chunk-ZUTOMGB7.mjs";import"../chunk-EN2HDNFE.mjs";import"../chunk-TRU3EK64.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-PCLU4KLY.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-WIXNX7HY.mjs";import"../chunk-6AGTDRNM.mjs";import"../chunk-S3FVA55H.mjs";import"../chunk-DZJXOL64.mjs";import"../chunk-37UZKMJI.mjs";import"../chunk-5CCHECTE.mjs";import"../chunk-ONBFUPEC.mjs";import"../chunk-XHCALZ7X.mjs";import"../chunk-GMKKHGXK.mjs";import"../chunk-WSVOJSAC.mjs";import"../chunk-4OV7QU2U.mjs";import"../chunk-IBLZ6MZU.mjs";import"../chunk-KIW54KWR.mjs";import"../chunk-PHP47DI4.mjs";import"../chunk-PRZ7AIGA.mjs";import"../chunk-DCUVV3VY.mjs";import"../chunk-HDTKBFRX.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-HBIDHQ2M.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-OLPI7QAH.mjs";import"../chunk-WOOH5MMX.mjs";import"../chunk-CRL4WGOH.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-4CDDWSKZ.mjs";import"../chunk-LEKBJ2EG.mjs";import"../chunk-GQABU3RQ.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-IECDO22V.mjs";import"../chunk-OZN3OOJV.mjs";import"../chunk-JGNMNCQB.mjs";import"../chunk-6FLHGOKP.mjs";import"../chunk-N47FTRYO.mjs";import"../chunk-KM6UXNC7.mjs";import"../chunk-7XS45O6M.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-QQIVWB6G.mjs";import"../chunk-KFNDDPOW.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-UI3AKMZX.mjs";import"../chunk-D3OEQLUE.mjs";import"../chunk-J245N3XF.mjs";import"../chunk-KDMSOCZY.mjs";export{a as AptosObject};
 //# sourceMappingURL=object.mjs.map

package/dist/esm/api/staking.d.mts

@@ -3,58 +3,127 @@ import { AccountAddressInput } from '../core/accountAddress.mjs';
 import { AptosConfig } from './aptosConfig.mjs';
 import { GetNumberOfDelegatorsResponse, GetDelegatedStakingActivitiesResponse } from '../types/indexer.mjs';
 import '../utils/apiEndpoints.mjs';
-import '../types/generated/operations.mjs';
-import '../types/generated/types.mjs';
 import '../bcs/serializer.mjs';
 import '../core/hex.mjs';
 import '../core/common.mjs';
 import '../bcs/deserializer.mjs';
 import '../transactions/instances/transactionArgument.mjs';
 import '../utils/const.mjs';
+import '../types/generated/operations.mjs';
+import '../types/generated/types.mjs';
 
 /**
  * A class to query all `Staking` related queries on Aptos.
  */
 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);
+     * ```
+     */
     constructor(config: AptosConfig);
     /**
-     * Queries current number of delegators in a pool.  Throws an error if the pool is not found.
+     * 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
-     * const delegators = await aptos.getNumberOfDelegators({poolAddress:"0x123"})
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
      *
-     * @param args.poolAddress Pool address
-     * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
-     * @returns The number of delegators for the given pool
+     * 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);
+     * ```
      */
     getNumberOfDelegators(args: {
         poolAddress: AccountAddressInput;
         minimumLedgerVersion?: AnyNumber;
     }): Promise<number>;
     /**
-     * Queries current number of delegators in a pool.  Throws an error if the pool is not found.
+     * 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
-     * const delegators = await aptos.getNumberOfDelegatorsForAllPools()
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
      *
-     * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
-     * @returns GetNumberOfDelegatorsForAllPoolsResponse response type
+     * 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);
+     * ```
      */
     getNumberOfDelegatorsForAllPools(args?: {
         minimumLedgerVersion?: AnyNumber;
         options?: OrderByArg<GetNumberOfDelegatorsResponse[0]>;
     }): Promise<GetNumberOfDelegatorsResponse>;
     /**
-     * Queries delegated staking activities
+     * 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
-     * const delegators = await aptos.getDelegatedStakingActivities({delegatorAddress:"0x123",poolAddress:"0x456"})
+     * ```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
+     *   });
      *
-     * @param args.delegatorAddress Delegator address
-     * @param args.poolAddress Pool address
-     * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
-     * @returns GetDelegatedStakingActivitiesResponse response type
+     *   console.log(activities);
+     * }
+     * runExample().catch(console.error);
+     * ```
      */
     getDelegatedStakingActivities(args: {
         delegatorAddress: AccountAddressInput;

package/dist/esm/api/staking.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-ELYS7CWV.mjs";import"../chunk-OKAQO57B.mjs";import"../chunk-SDWE6WMM.mjs";import"../chunk-FZ5EYP3D.mjs";import"../chunk-2BTTX2KO.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-WRRQ7L5K.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-45IUUCAV.mjs";import"../chunk-HHGJXVAE.mjs";import"../chunk-GMBSQDPO.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-GDO6Q2FI.mjs";import"../chunk-BA4RBST6.mjs";import"../chunk-G5XLMQ5E.mjs";import"../chunk-SRPI2FFA.mjs";import"../chunk-MQGW234H.mjs";import"../chunk-F63E4CR7.mjs";import"../chunk-GWSDIX6C.mjs";import"../chunk-MLDQ2TY2.mjs";import"../chunk-Q4XR6QOZ.mjs";import"../chunk-76OH2Z4Q.mjs";import"../chunk-LR65XHSF.mjs";import"../chunk-G5MGSV7Y.mjs";import"../chunk-OHRL766V.mjs";import"../chunk-AH44UPM4.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-YU3IYJRL.mjs";import"../chunk-CRA2MFJC.mjs";import"../chunk-XMW65WCQ.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-BSUYPXRD.mjs";import"../chunk-SCHZ67F3.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-LNEZEYYE.mjs";import"../chunk-YPHH6CAO.mjs";import"../chunk-P5V7OZNN.mjs";import"../chunk-H6YNXJNF.mjs";import"../chunk-44GYWUSH.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-A63SMUOU.mjs";import"../chunk-BCUSI3N6.mjs";import"../chunk-LG7RJQ57.mjs";import"../chunk-TDGQGILY.mjs";import"../chunk-EXP5STXZ.mjs";import"../chunk-UAL27G6B.mjs";import"../chunk-KEYAPEAX.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-UAEODDZS.mjs";import"../chunk-FVA2OPG4.mjs";export{a as Staking};
+import{a}from"../chunk-GIQQF2PD.mjs";import"../chunk-BQXVHY7J.mjs";import"../chunk-TRU3EK64.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-PCLU4KLY.mjs";import"../chunk-HEZ2ZYZA.mjs";import"../chunk-KUX6GQ2E.mjs";import"../chunk-WIXNX7HY.mjs";import"../chunk-6AGTDRNM.mjs";import"../chunk-S3FVA55H.mjs";import"../chunk-DZJXOL64.mjs";import"../chunk-37UZKMJI.mjs";import"../chunk-5CCHECTE.mjs";import"../chunk-ONBFUPEC.mjs";import"../chunk-XHCALZ7X.mjs";import"../chunk-GMKKHGXK.mjs";import"../chunk-WSVOJSAC.mjs";import"../chunk-4OV7QU2U.mjs";import"../chunk-IBLZ6MZU.mjs";import"../chunk-KIW54KWR.mjs";import"../chunk-PHP47DI4.mjs";import"../chunk-PRZ7AIGA.mjs";import"../chunk-DCUVV3VY.mjs";import"../chunk-HDTKBFRX.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-HBIDHQ2M.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-OLPI7QAH.mjs";import"../chunk-WOOH5MMX.mjs";import"../chunk-CRL4WGOH.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-4CDDWSKZ.mjs";import"../chunk-LEKBJ2EG.mjs";import"../chunk-GQABU3RQ.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-IECDO22V.mjs";import"../chunk-OZN3OOJV.mjs";import"../chunk-JGNMNCQB.mjs";import"../chunk-6FLHGOKP.mjs";import"../chunk-N47FTRYO.mjs";import"../chunk-KM6UXNC7.mjs";import"../chunk-7XS45O6M.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-QQIVWB6G.mjs";import"../chunk-KFNDDPOW.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-UI3AKMZX.mjs";import"../chunk-D3OEQLUE.mjs";import"../chunk-J245N3XF.mjs";import"../chunk-KDMSOCZY.mjs";export{a as Staking};
 //# sourceMappingURL=staking.mjs.map

package/dist/esm/api/table.d.mts

@@ -3,36 +3,70 @@ import { TableItemsBoolExp, TableMetadatasBoolExp } from '../types/generated/typ
 import { AptosConfig } from './aptosConfig.mjs';
 import { GetTableItemsDataResponse, GetTableItemsMetadataResponse } from '../types/indexer.mjs';
 import '../utils/apiEndpoints.mjs';
-import '../types/generated/operations.mjs';
 import '../utils/const.mjs';
+import '../types/generated/operations.mjs';
 
 /**
- * A class to query all `Table` Aptos related queries
+ * A class to query all `Table` Aptos related queries.
  */
 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);
+     * ```
+     */
     constructor(config: AptosConfig);
     /**
-     * Queries for a table item for a table identified by the handle and the key for the item.
-     * Key and value types need to be passed in to help with key serialization and value deserialization.
-     *
-     * Note, this query calls the fullnode server
-     *
-     * @example https://api.devnet.aptoslabs.com/v1/accounts/0x1/resource/0x1::coin::CoinInfo%3C0x1::aptos_coin::AptosCoin%3E
-     * 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
-     *  },
-     * })
-     *
-     * @param args.handle A pointer to where that table is stored
-     * @param args.data Object that describes table item
-     * @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
+     * 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);
+     * ```
      */
     getTableItem<T>(args: {
         handle: string;
@@ -40,20 +74,43 @@ declare class Table {
         options?: LedgerVersionArg;
     }): Promise<T>;
     /**
-     * Queries for a table items data.
+     * 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.
      *
-     * Optional `options.where` param can be passed to filter the response.
+     * @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
+     * Note: This query calls the indexer server.
      *
      * @example
-     * const data = await aptos.getTableItemsData({
-     *  options: { where: {
-     *      table_handle: { _eq: "0x1b854694ae746cdbd8d44186ca4929b2b337df21d1c74633be19b2710552fdca" },
-     *      transaction_version: { _eq: "0" }
-     *    }
-     *  },
-     * });
+     * ```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
      */
@@ -62,16 +119,39 @@ declare class Table {
         options?: PaginationArgs & WhereArg<TableItemsBoolExp> & OrderByArg<GetTableItemsDataResponse[0]>;
     }): Promise<GetTableItemsDataResponse>;
     /**
-     * Queries for a table items metadata.
+     * Queries for the metadata of table items, allowing for filtering and pagination.
      *
-     * Optional `options.where` param can be passed to filter the response.
+     * @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, this query calls the indexer server
+     * Note that this query calls the indexer server.
      *
      * @example
-     * const data = await aptos.getTableItemsMetadata({
-     *  options: { where: { handle: { _eq: "0x1b854694ae746cdbd8d44186ca4929b2b337df21d1c74633be19b2710552fdca" } } },
-     * });
+     * ```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
      */

package/dist/esm/api/table.mjs

@@ -1,2 +1,2 @@
-import{a}from"../chunk-WJRZWAIS.mjs";import"../chunk-D3Q4BC3I.mjs";import"../chunk-SDWE6WMM.mjs";import"../chunk-FZ5EYP3D.mjs";import"../chunk-2BTTX2KO.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-AH44UPM4.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-YU3IYJRL.mjs";import"../chunk-CRA2MFJC.mjs";import"../chunk-XMW65WCQ.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-BSUYPXRD.mjs";import"../chunk-SCHZ67F3.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-LNEZEYYE.mjs";import"../chunk-YPHH6CAO.mjs";import"../chunk-P5V7OZNN.mjs";import"../chunk-H6YNXJNF.mjs";import"../chunk-44GYWUSH.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-A63SMUOU.mjs";import"../chunk-BCUSI3N6.mjs";import"../chunk-LG7RJQ57.mjs";import"../chunk-TDGQGILY.mjs";import"../chunk-EXP5STXZ.mjs";import"../chunk-UAL27G6B.mjs";import"../chunk-KEYAPEAX.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-UAEODDZS.mjs";import"../chunk-FVA2OPG4.mjs";export{a as Table};
+import{a}from"../chunk-XIY2VORC.mjs";import"../chunk-TRU3EK64.mjs";import"../chunk-Z36WHOZV.mjs";import"../chunk-DCUVV3VY.mjs";import"../chunk-HDTKBFRX.mjs";import"../chunk-VHNX2NUR.mjs";import"../chunk-HBIDHQ2M.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-OLPI7QAH.mjs";import"../chunk-WOOH5MMX.mjs";import"../chunk-CRL4WGOH.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-4CDDWSKZ.mjs";import"../chunk-LEKBJ2EG.mjs";import"../chunk-GQABU3RQ.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-IECDO22V.mjs";import"../chunk-OZN3OOJV.mjs";import"../chunk-JGNMNCQB.mjs";import"../chunk-6FLHGOKP.mjs";import"../chunk-N47FTRYO.mjs";import"../chunk-7XS45O6M.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-QQIVWB6G.mjs";import"../chunk-KFNDDPOW.mjs";import"../chunk-6Q2O5G3J.mjs";import"../chunk-56CNRT2K.mjs";import"../chunk-UI3AKMZX.mjs";import"../chunk-D3OEQLUE.mjs";import"../chunk-J245N3XF.mjs";import"../chunk-KDMSOCZY.mjs";export{a as Table};
 //# sourceMappingURL=table.mjs.map