@moveindustries/ts-sdk 5.1.4

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

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

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

@@ -0,0 +1,7 @@
+export { M as MovementConfig } from '../accountAddress-CNXtapt1.mjs';
+import '../utils/apiEndpoints.mjs';
+import '../utils/const.mjs';
+import '../types/indexer.mjs';
+import '../types/generated/operations.mjs';
+import '../types/generated/types.mjs';
+import '../core/common.mjs';

package/dist/esm/api/movementConfig.mjs

@@ -0,0 +1,2 @@
+import{a}from"../chunk-I6YGBK5S.mjs";import"../chunk-PZ233FIY.mjs";import"../chunk-VW3WBAAD.mjs";import"../chunk-KDMSOCZY.mjs";export{a as MovementConfig};
+//# sourceMappingURL=movementConfig.mjs.map

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

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

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

@@ -0,0 +1,80 @@
+import { M as MovementConfig, s as AccountAddressInput, c3 as AnyNumber, c5 as PaginationArgs, c8 as OrderByArg } from '../accountAddress-CNXtapt1.mjs';
+import { GetObjectDataQueryResponse } from '../types/indexer.mjs';
+import '../utils/apiEndpoints.mjs';
+import '../utils/const.mjs';
+import '../core/common.mjs';
+import '../types/generated/operations.mjs';
+import '../types/generated/types.mjs';
+
+/**
+ * A class to query all `Object` related queries on Movement.
+ * @group Object
+ */
+declare class MovementObject {
+    readonly config: MovementConfig;
+    /**
+     * Creates an instance of the Movement client with the provided configuration.
+     * This allows interaction with the Movement blockchain using the specified settings.
+     *
+     * @param config - The configuration settings for the Movement client.
+     * @param config.network - The network to connect to (e.g., mainnet, testnet).
+     * @param config.nodeUrl - The URL of the Movement node to connect to.
+     * @param config.faucetUrl - The URL of the faucet for funding accounts (optional).
+     *
+     * @example
+     * ```typescript
+     * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a configuration for the Movement client
+     *     const config = new MovementConfig({
+     *         network: Network.TESTNET, // Specify the desired network
+     *         nodeUrl: "https://testnet.movement.dev", // Replace with your node URL
+     *     });
+     *
+     *     // Create an instance of the Movement client
+     *     const movement = new Movement(config);
+     *
+     *     console.log("Movement client created successfully", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Object
+     */
+    constructor(config: MovementConfig);
+    /**
+     * 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 { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+     *
+     * const config = new MovementConfig({ network: Network.TESTNET });
+     * const movement = new Movement(config);
+     *
+     * async function runExample() {
+     *   // Fetching object data by object address
+     *   const objectData = await movement.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]>;
+}
+
+export { MovementObject };

package/dist/esm/api/object.mjs

@@ -0,0 +1,2 @@
+import{le as a}from"../chunk-47V7UGV5.mjs";import"../chunk-A5L76YP7.mjs";import"../chunk-YFFYA5U3.mjs";import"../chunk-UYVPNUH3.mjs";import"../chunk-G3MHXDYA.mjs";import"../chunk-RUIFVDWM.mjs";import"../chunk-WVDICMU4.mjs";import"../chunk-2KDUIZKB.mjs";import"../chunk-OOOAVIMQ.mjs";import"../chunk-V3O2SBO4.mjs";import"../chunk-D6HPXGEP.mjs";import"../chunk-5HXLZHDW.mjs";import"../chunk-7TTTMBAK.mjs";import"../chunk-GOXRBEIJ.mjs";import"../chunk-2QTV4AOE.mjs";import"../chunk-PHRRBT44.mjs";import"../chunk-VEZCMPUG.mjs";import"../chunk-CHWDP6AR.mjs";import"../chunk-V3MBJJTL.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-ZP4DWSQA.mjs";import"../chunk-NUB6KE73.mjs";import"../chunk-I6YGBK5S.mjs";import"../chunk-S4D2KBYN.mjs";import"../chunk-CRCE7R4D.mjs";import"../chunk-NQUZ4UHR.mjs";import"../chunk-NMFJJOGW.mjs";import"../chunk-5ZKA765G.mjs";import"../chunk-FJRPU2NH.mjs";import"../chunk-UL777LTI.mjs";import"../chunk-7ECCT6PK.mjs";import"../chunk-SYXDZA4K.mjs";import"../chunk-R2G23RIY.mjs";import"../chunk-MEWW7VTQ.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-ANTEUWH6.mjs";import"../chunk-KPJGWDSQ.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-6NO4QKAO.mjs";import"../chunk-FS5ZJKO7.mjs";import"../chunk-UVP74ONT.mjs";import"../chunk-XCURF77K.mjs";import"../chunk-RXHPS4IU.mjs";import"../chunk-WFAH73WN.mjs";import"../chunk-Y6YW4BAZ.mjs";import"../chunk-DS6QB6HG.mjs";import"../chunk-FD6FGKYY.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-YOHEYPDP.mjs";import"../chunk-SRXFRTHK.mjs";import"../chunk-5IMQPJ6J.mjs";import"../chunk-RL4YPMN4.mjs";import"../chunk-UI4OF6CP.mjs";import"../chunk-PZ233FIY.mjs";import"../chunk-VW3WBAAD.mjs";import"../chunk-PCESRJYO.mjs";import"../chunk-KDMSOCZY.mjs";export{a as MovementObject};
+//# sourceMappingURL=object.mjs.map

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

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

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

@@ -0,0 +1,134 @@
+import { M as MovementConfig, s as AccountAddressInput, c3 as AnyNumber, c8 as OrderByArg } from '../accountAddress-CNXtapt1.mjs';
+import { GetNumberOfDelegatorsResponse, GetDelegatedStakingActivitiesResponse } from '../types/indexer.mjs';
+import '../utils/apiEndpoints.mjs';
+import '../utils/const.mjs';
+import '../core/common.mjs';
+import '../types/generated/operations.mjs';
+import '../types/generated/types.mjs';
+
+/**
+ * A class to query all `Staking` related queries on Movement.
+ * @group Staking
+ */
+declare class Staking {
+    readonly config: MovementConfig;
+    /**
+     * Creates an instance of the Movement client with the specified configuration.
+     * This allows you to interact with the Movement blockchain using the provided settings.
+     *
+     * @param config - The configuration settings for the Movement client.
+     * @param config.network - The network to connect to (e.g., TESTNET, MAINNET).
+     * @param config.nodeUrl - The URL of the Movement node to connect to.
+     *
+     * @example
+     * ```typescript
+     * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a configuration for the Movement client
+     *     const config = new MovementConfig({ network: Network.TESTNET }); // Specify your network
+     *
+     *     // Initialize the Movement client with the configuration
+     *     const movement = new Movement(config);
+     *
+     *     console.log("Movement client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Staking
+     */
+    constructor(config: MovementConfig);
+    /**
+     * 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 { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+     *
+     * const config = new MovementConfig({ network: Network.TESTNET });
+     * const movement = new Movement(config);
+     *
+     * async function runExample() {
+     *   // Get the number of delegators for a specific pool
+     *   const delegators = await movement.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 { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+     *
+     * const config = new MovementConfig({ network: Network.TESTNET });
+     * const movement = new Movement(config);
+     *
+     * async function runExample() {
+     *   // Retrieve the number of delegators for all pools
+     *   const delegators = await movement.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 { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+     *
+     * const config = new MovementConfig({ network: Network.TESTNET });
+     * const movement = new Movement(config);
+     *
+     * async function runExample() {
+     *   // Get delegated staking activities for a specific delegator and pool
+     *   const activities = await movement.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

@@ -0,0 +1,2 @@
+import{pe as a}from"../chunk-47V7UGV5.mjs";import"../chunk-A5L76YP7.mjs";import"../chunk-YFFYA5U3.mjs";import"../chunk-UYVPNUH3.mjs";import"../chunk-G3MHXDYA.mjs";import"../chunk-RUIFVDWM.mjs";import"../chunk-WVDICMU4.mjs";import"../chunk-2KDUIZKB.mjs";import"../chunk-OOOAVIMQ.mjs";import"../chunk-V3O2SBO4.mjs";import"../chunk-D6HPXGEP.mjs";import"../chunk-5HXLZHDW.mjs";import"../chunk-7TTTMBAK.mjs";import"../chunk-GOXRBEIJ.mjs";import"../chunk-2QTV4AOE.mjs";import"../chunk-PHRRBT44.mjs";import"../chunk-VEZCMPUG.mjs";import"../chunk-CHWDP6AR.mjs";import"../chunk-V3MBJJTL.mjs";import"../chunk-NECL5FCQ.mjs";import"../chunk-4QMXOWHP.mjs";import"../chunk-ZP4DWSQA.mjs";import"../chunk-NUB6KE73.mjs";import"../chunk-I6YGBK5S.mjs";import"../chunk-S4D2KBYN.mjs";import"../chunk-CRCE7R4D.mjs";import"../chunk-NQUZ4UHR.mjs";import"../chunk-NMFJJOGW.mjs";import"../chunk-5ZKA765G.mjs";import"../chunk-FJRPU2NH.mjs";import"../chunk-UL777LTI.mjs";import"../chunk-7ECCT6PK.mjs";import"../chunk-SYXDZA4K.mjs";import"../chunk-R2G23RIY.mjs";import"../chunk-MEWW7VTQ.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-ANTEUWH6.mjs";import"../chunk-KPJGWDSQ.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-6NO4QKAO.mjs";import"../chunk-FS5ZJKO7.mjs";import"../chunk-UVP74ONT.mjs";import"../chunk-XCURF77K.mjs";import"../chunk-RXHPS4IU.mjs";import"../chunk-WFAH73WN.mjs";import"../chunk-Y6YW4BAZ.mjs";import"../chunk-DS6QB6HG.mjs";import"../chunk-FD6FGKYY.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-YOHEYPDP.mjs";import"../chunk-SRXFRTHK.mjs";import"../chunk-5IMQPJ6J.mjs";import"../chunk-RL4YPMN4.mjs";import"../chunk-UI4OF6CP.mjs";import"../chunk-PZ233FIY.mjs";import"../chunk-VW3WBAAD.mjs";import"../chunk-PCESRJYO.mjs";import"../chunk-KDMSOCZY.mjs";export{a as Staking};
+//# sourceMappingURL=staking.mjs.map

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

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

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

@@ -0,0 +1,169 @@
+import { GetTableItemsDataResponse, GetTableItemsMetadataResponse } from '../types/indexer.mjs';
+import { M as MovementConfig, dH as TableItemRequest, co as LedgerVersionArg, c3 as AnyNumber, c5 as PaginationArgs, c9 as WhereArg, c8 as OrderByArg } from '../accountAddress-CNXtapt1.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` Movement related queries.
+ * @group Table
+ */
+declare class Table {
+    readonly config: MovementConfig;
+    /**
+     * Initializes a new instance of the Movement client with the specified configuration.
+     * This allows you to interact with the Movement blockchain using the provided settings.
+     *
+     * @param config - The configuration settings for the Movement client.
+     *
+     * @example
+     * ```typescript
+     * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a new Movement client with testnet configuration
+     *     const config = new MovementConfig({ network: Network.TESTNET });
+     *     const movement = new Movement(config);
+     *
+     *     console.log("Movement client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Table
+     */
+    constructor(config: MovementConfig);
+    /**
+     * 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 Movement 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 { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+     *
+     * const config = new MovementConfig({ network: Network.TESTNET });
+     * const movement = new Movement(config);
+     *
+     * async function runExample() {
+     *   // Retrieve a table item from the Movement blockchain
+     *   const tableItem = await movement.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 { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+     *
+     * const config = new MovementConfig({ network: Network.TESTNET });
+     * const movement = new Movement(config);
+     *
+     * async function runExample() {
+     *   // Retrieve table items data with specific filtering options
+     *   const data = await movement.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 { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+     *
+     * const config = new MovementConfig({ network: Network.TESTNET });
+     * const movement = new Movement(config);
+     *
+     * async function runExample() {
+     *   // Fetching table items metadata with a filter condition
+     *   const data = await movement.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

@@ -0,0 +1,2 @@
+import{a}from"../chunk-S4D2KBYN.mjs";import"../chunk-CRCE7R4D.mjs";import"../chunk-NQUZ4UHR.mjs";import"../chunk-NMFJJOGW.mjs";import"../chunk-5ZKA765G.mjs";import"../chunk-FJRPU2NH.mjs";import"../chunk-UL777LTI.mjs";import"../chunk-7ECCT6PK.mjs";import"../chunk-SYXDZA4K.mjs";import"../chunk-R2G23RIY.mjs";import"../chunk-MEWW7VTQ.mjs";import"../chunk-HGLO5LDS.mjs";import"../chunk-ANTEUWH6.mjs";import"../chunk-KPJGWDSQ.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-6NO4QKAO.mjs";import"../chunk-FS5ZJKO7.mjs";import"../chunk-UVP74ONT.mjs";import"../chunk-XCURF77K.mjs";import"../chunk-RXHPS4IU.mjs";import"../chunk-WFAH73WN.mjs";import"../chunk-Y6YW4BAZ.mjs";import"../chunk-DS6QB6HG.mjs";import"../chunk-FD6FGKYY.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-YOHEYPDP.mjs";import"../chunk-SRXFRTHK.mjs";import"../chunk-5IMQPJ6J.mjs";import"../chunk-RL4YPMN4.mjs";import"../chunk-UI4OF6CP.mjs";import"../chunk-PZ233FIY.mjs";import"../chunk-VW3WBAAD.mjs";import"../chunk-PCESRJYO.mjs";import"../chunk-KDMSOCZY.mjs";export{a as Table};
+//# sourceMappingURL=table.mjs.map

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

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