@aptos-labs/ts-sdk 6.3.1 → 7.0.1

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

@@ -1,134 +0,0 @@
-import { GetNumberOfDelegatorsResponse, GetDelegatedStakingActivitiesResponse } from '../types/indexer.mjs';
-import { x as AptosConfig, c as AccountAddressInput, p as AnyNumber, bK as OrderByArg } from '../account-sIOs_9XJ.mjs';
-import '../types/generated/operations.mjs';
-import '../types/generated/types.mjs';
-import '../utils/apiEndpoints.mjs';
-import '../utils/const.mjs';
-import '../core/common.mjs';
-
-/**
- * A class to query all `Staking` related queries on Aptos.
- * @group Staking
- */
-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>;
-}
-
-export { Staking };

package/dist/esm/api/staking.mjs

@@ -1,2 +0,0 @@
-import{oe as a}from"../chunk-IZF6POVR.mjs";import"../chunk-G3MHXDYA.mjs";import"../chunk-NNXTS2GB.mjs";import"../chunk-UYVPNUH3.mjs";import"../chunk-A5L76YP7.mjs";import"../chunk-3ZC6F5SJ.mjs";import"../chunk-2YA4KQUV.mjs";import"../chunk-NPWYZVHE.mjs";import"../chunk-UVNAHETD.mjs";import"../chunk-5HXLZHDW.mjs";import"../chunk-F45HI7LU.mjs";import"../chunk-LVZ7QMUH.mjs";import"../chunk-RB2GC7FW.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-ZOSOF6ST.mjs";import"../chunk-NHRPXEUE.mjs";import"../chunk-A5H5VKUI.mjs";import"../chunk-C3Q23D22.mjs";import"../chunk-UVJW4DPP.mjs";import"../chunk-V3MBJJTL.mjs";import"../chunk-ZP4DWSQA.mjs";import"../chunk-RZNP3WG4.mjs";import"../chunk-226FBOWQ.mjs";import"../chunk-4KEZEYCV.mjs";import"../chunk-NTMFADQ7.mjs";import"../chunk-WZZ7PJ3X.mjs";import"../chunk-MKTR4U2R.mjs";import"../chunk-G5OONGWS.mjs";import"../chunk-ODNZJSOC.mjs";import"../chunk-7ECCT6PK.mjs";import"../chunk-TBIK7DML.mjs";import"../chunk-DPHBSAZQ.mjs";import"../chunk-2DQRUJUC.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-ITZN23GU.mjs";import"../chunk-IEW452EO.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-2EBXCCLB.mjs";import"../chunk-WOPHK7LB.mjs";import"../chunk-F4RJMSAW.mjs";import"../chunk-KKPH2JUV.mjs";import"../chunk-M65PXVDO.mjs";import"../chunk-FAOLAKLJ.mjs";import"../chunk-P5HCJN3A.mjs";import"../chunk-GJYLYE6R.mjs";import"../chunk-GYYSHYO5.mjs";import"../chunk-6T2OBPIF.mjs";import"../chunk-DE5K76I2.mjs";import"../chunk-Q5ESW36C.mjs";import"../chunk-NP2IAUME.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-RUKFK3OC.mjs";import"../chunk-TAHLOBRG.mjs";import"../chunk-STY74NUA.mjs";import"../chunk-IF4UU2MT.mjs";import"../chunk-X2TPNKLV.mjs";import"../chunk-RYCI4VKO.mjs";import"../chunk-KDMSOCZY.mjs";export{a as Staking};
-//# sourceMappingURL=staking.mjs.map

package/dist/esm/api/staking.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

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

@@ -1,169 +0,0 @@
-import { GetTableItemsDataResponse, GetTableItemsMetadataResponse } from '../types/indexer.mjs';
-import { x as AptosConfig, cd as TableItemRequest, b0 as LedgerVersionArg, p as AnyNumber, bL as PaginationArgs, dn as WhereArg, bK as OrderByArg } from '../account-sIOs_9XJ.mjs';
-import { TableItemsBoolExp, TableMetadatasBoolExp } from '../types/generated/types.mjs';
-import '../types/generated/operations.mjs';
-import '../utils/apiEndpoints.mjs';
-import '../utils/const.mjs';
-import '../core/common.mjs';
-
-/**
- * A class to query all `Table` Aptos related queries.
- * @group Table
- */
-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>;
-}
-
-export { Table };

package/dist/esm/api/table.mjs

@@ -1,2 +0,0 @@
-import{a}from"../chunk-226FBOWQ.mjs";import"../chunk-4KEZEYCV.mjs";import"../chunk-NTMFADQ7.mjs";import"../chunk-WZZ7PJ3X.mjs";import"../chunk-MKTR4U2R.mjs";import"../chunk-G5OONGWS.mjs";import"../chunk-ODNZJSOC.mjs";import"../chunk-7ECCT6PK.mjs";import"../chunk-TBIK7DML.mjs";import"../chunk-DPHBSAZQ.mjs";import"../chunk-2DQRUJUC.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-ITZN23GU.mjs";import"../chunk-IEW452EO.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-2EBXCCLB.mjs";import"../chunk-WOPHK7LB.mjs";import"../chunk-F4RJMSAW.mjs";import"../chunk-KKPH2JUV.mjs";import"../chunk-M65PXVDO.mjs";import"../chunk-P5HCJN3A.mjs";import"../chunk-GJYLYE6R.mjs";import"../chunk-GYYSHYO5.mjs";import"../chunk-6T2OBPIF.mjs";import"../chunk-DE5K76I2.mjs";import"../chunk-Q5ESW36C.mjs";import"../chunk-NP2IAUME.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-RUKFK3OC.mjs";import"../chunk-TAHLOBRG.mjs";import"../chunk-STY74NUA.mjs";import"../chunk-IF4UU2MT.mjs";import"../chunk-X2TPNKLV.mjs";import"../chunk-RYCI4VKO.mjs";import"../chunk-KDMSOCZY.mjs";export{a as Table};
-//# sourceMappingURL=table.mjs.map

package/dist/esm/api/table.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}