@moveindustries/ts-sdk 5.1.4

package/src/api/staking.ts

@@ -0,0 +1,161 @@
+// Copyright © Move Industries
+// SPDX-License-Identifier: Apache-2.0
+
+import { AccountAddressInput } from "../core";
+import {
+  getDelegatedStakingActivities,
+  getNumberOfDelegators,
+  getNumberOfDelegatorsForAllPools,
+} from "../internal/staking";
+import { AnyNumber, GetDelegatedStakingActivitiesResponse, GetNumberOfDelegatorsResponse, OrderByArg } from "../types";
+import { ProcessorType } from "../utils/const";
+import { MovementConfig } from "./movementConfig";
+import { waitForIndexerOnVersion } from "./utils";
+
+/**
+ * A class to query all `Staking` related queries on Movement.
+ * @group Staking
+ */
+export class Staking {
+  /**
+   * 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(readonly 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
+   */
+  async getNumberOfDelegators(args: {
+    poolAddress: AccountAddressInput;
+    minimumLedgerVersion?: AnyNumber;
+  }): Promise<number> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args?.minimumLedgerVersion,
+      processorType: ProcessorType.STAKE_PROCESSOR,
+    });
+    return getNumberOfDelegators({ movementConfig: 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 { 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
+   */
+  async getNumberOfDelegatorsForAllPools(args?: {
+    minimumLedgerVersion?: AnyNumber;
+    options?: OrderByArg<GetNumberOfDelegatorsResponse[0]>;
+  }): Promise<GetNumberOfDelegatorsResponse> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args?.minimumLedgerVersion,
+      processorType: ProcessorType.STAKE_PROCESSOR,
+    });
+    return getNumberOfDelegatorsForAllPools({ movementConfig: 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 { 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
+   */
+  async getDelegatedStakingActivities(args: {
+    delegatorAddress: AccountAddressInput;
+    poolAddress: AccountAddressInput;
+    minimumLedgerVersion?: AnyNumber;
+  }): Promise<GetDelegatedStakingActivitiesResponse> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args?.minimumLedgerVersion,
+      processorType: ProcessorType.STAKE_PROCESSOR,
+    });
+    return getDelegatedStakingActivities({ movementConfig: this.config, ...args });
+  }
+}

package/src/api/table.ts

@@ -0,0 +1,193 @@
+import { getTableItem, getTableItemsData, getTableItemsMetadata } from "../internal/table";
+import {
+  AnyNumber,
+  GetTableItemsDataResponse,
+  GetTableItemsMetadataResponse,
+  LedgerVersionArg,
+  OrderByArg,
+  PaginationArgs,
+  TableItemRequest,
+  WhereArg,
+} from "../types";
+import { TableItemsBoolExp, TableMetadatasBoolExp } from "../types/generated/types";
+import { ProcessorType } from "../utils";
+import { MovementConfig } from "./movementConfig";
+import { waitForIndexerOnVersion } from "./utils";
+
+/**
+ * A class to query all `Table` Movement related queries.
+ * @group Table
+ */
+export 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) {
+    this.config = config;
+  }
+
+  /**
+   * Queries for a specific item in a table identified by the handle and the key for the item.
+   * This function allows you to retrieve structured data from a table in the 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
+   */
+  async getTableItem<T>(args: { handle: string; data: TableItemRequest; options?: LedgerVersionArg }): Promise<T> {
+    return getTableItem<T>({ movementConfig: this.config, ...args });
+  }
+
+  /**
+   * Queries for table items data with optional filtering and pagination.
+   * This function allows you to retrieve specific data from a table based on provided criteria.
+   *
+   * @param args - The arguments for querying table items data.
+   * @param args.minimumLedgerVersion - Optional minimum ledger version to wait for before querying.
+   * @param args.options - Optional parameters for pagination and filtering.
+   * @param args.options.where - Conditions to filter the response.
+   * @param args.options.offset - The number of items to skip before starting to collect the result set.
+   * @param args.options.limit - The maximum number of items to return.
+   * @param args.options.orderBy - The criteria to order the results.
+   *
+   * Note: This query calls the indexer server.
+   *
+   * @example
+   * ```typescript
+   * import { 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
+   */
+  async getTableItemsData(args: {
+    minimumLedgerVersion?: AnyNumber;
+    options?: PaginationArgs & WhereArg<TableItemsBoolExp> & OrderByArg<GetTableItemsDataResponse[0]>;
+  }): Promise<GetTableItemsDataResponse> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args.minimumLedgerVersion,
+      processorType: ProcessorType.DEFAULT,
+    });
+    return getTableItemsData({ movementConfig: this.config, ...args });
+  }
+
+  /**
+   * Queries for the metadata of table items, allowing for filtering and pagination.
+   *
+   * @param args - The parameters for the query.
+   * @param args.minimumLedgerVersion - Optional minimum ledger version to wait for before querying.
+   * @param args.options - Optional parameters for pagination and filtering.
+   * @param args.options.where - Conditions to filter the response.
+   * @param args.options.offset - The offset for pagination.
+   * @param args.options.limit - The maximum number of items to return.
+   * @param args.options.orderBy - The order in which to return the items.
+   *
+   * Note that this query calls the indexer server.
+   *
+   * @example
+   * ```typescript
+   * import { 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
+   */
+  async getTableItemsMetadata(args: {
+    minimumLedgerVersion?: AnyNumber;
+    options?: PaginationArgs & WhereArg<TableMetadatasBoolExp> & OrderByArg<GetTableItemsMetadataResponse[0]>;
+  }): Promise<GetTableItemsMetadataResponse> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args.minimumLedgerVersion,
+      processorType: ProcessorType.DEFAULT,
+    });
+    return getTableItemsMetadata({ movementConfig: this.config, ...args });
+  }
+}