@human-protocol/sdk 5.2.0 → 6.0.0

package/dist/statistics.d.ts

@@ -1,46 +1,21 @@
 import { IDailyHMT, IEscrowStatistics, IHMTHolder, IHMTHoldersParams, IHMTStatistics, IPaymentStatistics, IStatisticsFilter, IWorkerStatistics, SubgraphOptions } from './interfaces';
 import { NetworkData } from './types';
 /**
- * ## Introduction
+ * Utility class for statistics-related queries.
  *
- * This client enables obtaining statistical information from the subgraph.
- *
- * Unlike other SDK clients, `StatisticsClient` does not require `signer` or `provider` to be provided.
- * We just need to create a client object using relevant network data.
+ * Unlike other SDK clients, `StatisticsUtils` does not require `signer` or `provider` to be provided.
+ * We just need to pass the network data to each static method.
  *
+ * @example
  * ```ts
- * constructor(network: NetworkData)
- * ```
- *
- * ## Installation
+ * import { StatisticsUtils, ChainId, NETWORKS } from '@human-protocol/sdk';
  *
- * ### npm
- * ```bash
- * npm install @human-protocol/sdk
- * ```
- *
- * ### yarn
- * ```bash
- * yarn install @human-protocol/sdk
- * ```
- *
- * ## Code example
- *
- * ```ts
- * import { StatisticsClient, ChainId, NETWORKS } from '@human-protocol/sdk';
- *
- * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
+ * const networkData = NETWORKS[ChainId.POLYGON_AMOY];
+ * const escrowStats = await StatisticsUtils.getEscrowStatistics(networkData);
+ * console.log('Total escrows:', escrowStats.totalEscrows);
  * ```
  */
-export declare class StatisticsClient {
-    networkData: NetworkData;
-    subgraphUrl: string;
-    /**
-     * **StatisticsClient constructor**
-     *
-     * @param {NetworkData} networkData - The network information required to connect to the Statistics contract
-     */
-    constructor(networkData: NetworkData);
+export declare class StatisticsUtils {
     /**
      * This function returns the statistical data of escrows.
      *
@@ -72,25 +47,30 @@ export declare class StatisticsClient {
      * };
      * ```
      *
-     * @param {IStatisticsFilter} filter Statistics params with duration data
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IEscrowStatistics>} Escrow statistics data.
-     *
-     * **Code example**
+     * @param networkData - The network information required to connect to the subgraph
+     * @param filter - Statistics params with duration data
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Escrow statistics data.
      *
+     * @example
      * ```ts
-     * import { StatisticsClient, ChainId, NETWORKS } from '@human-protocol/sdk';
-     *
-     * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
-     *
-     * const escrowStatistics = await statisticsClient.getEscrowStatistics();
-     * const escrowStatisticsApril = await statisticsClient.getEscrowStatistics({
-     *    from: new Date('2021-04-01'),
-     *    to: new Date('2021-04-30'),
-     * });
+     * import { StatisticsUtils, ChainId, NETWORKS } from '@human-protocol/sdk';
+     *
+     * const networkData = NETWORKS[ChainId.POLYGON_AMOY];
+     * const escrowStats = await StatisticsUtils.getEscrowStatistics(networkData);
+     * console.log('Total escrows:', escrowStats.totalEscrows);
+     *
+     * const escrowStatsApril = await StatisticsUtils.getEscrowStatistics(
+     *   networkData,
+     *   {
+     *     from: new Date('2021-04-01'),
+     *     to: new Date('2021-04-30'),
+     *   }
+     * );
+     * console.log('April escrows:', escrowStatsApril.totalEscrows);
      * ```
      */
-    getEscrowStatistics(filter?: IStatisticsFilter, options?: SubgraphOptions): Promise<IEscrowStatistics>;
+    static getEscrowStatistics(networkData: NetworkData, filter?: IStatisticsFilter, options?: SubgraphOptions): Promise<IEscrowStatistics>;
     /**
      * This function returns the statistical data of workers.
      *
@@ -117,25 +97,30 @@ export declare class StatisticsClient {
      * };
      * ```
      *
-     * @param {IStatisticsFilter} filter Statistics params with duration data
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IWorkerStatistics>} Worker statistics data.
-     *
-     * **Code example**
+     * @param networkData - The network information required to connect to the subgraph
+     * @param filter - Statistics params with duration data
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Worker statistics data.
      *
+     * @example
      * ```ts
-     * import { StatisticsClient, ChainId, NETWORKS } from '@human-protocol/sdk';
-     *
-     * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
-     *
-     * const workerStatistics = await statisticsClient.getWorkerStatistics();
-     * const workerStatisticsApril = await statisticsClient.getWorkerStatistics({
-     *    from: new Date('2021-04-01'),
-     *    to: new Date('2021-04-30'),
-     * });
+     * import { StatisticsUtils, ChainId, NETWORKS } from '@human-protocol/sdk';
+     *
+     * const networkData = NETWORKS[ChainId.POLYGON_AMOY];
+     * const workerStats = await StatisticsUtils.getWorkerStatistics(networkData);
+     * console.log('Daily workers data:', workerStats.dailyWorkersData);
+     *
+     * const workerStatsApril = await StatisticsUtils.getWorkerStatistics(
+     *   networkData,
+     *   {
+     *     from: new Date('2021-04-01'),
+     *     to: new Date('2021-04-30'),
+     *   }
+     * );
+     * console.log('April workers:', workerStatsApril.dailyWorkersData.length);
      * ```
      */
-    getWorkerStatistics(filter?: IStatisticsFilter, options?: SubgraphOptions): Promise<IWorkerStatistics>;
+    static getWorkerStatistics(networkData: NetworkData, filter?: IStatisticsFilter, options?: SubgraphOptions): Promise<IWorkerStatistics>;
     /**
      * This function returns the statistical data of payments.
      *
@@ -164,46 +149,37 @@ export declare class StatisticsClient {
      * };
      * ```
      *
-     * @param {IStatisticsFilter} filter Statistics params with duration data
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IPaymentStatistics>} Payment statistics data.
-     *
-     * **Code example**
+     * @param networkData - The network information required to connect to the subgraph
+     * @param filter - Statistics params with duration data
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Payment statistics data.
      *
+     * @example
      * ```ts
-     * import { StatisticsClient, ChainId, NETWORKS } from '@human-protocol/sdk';
-     *
-     * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
+     * import { StatisticsUtils, ChainId, NETWORKS } from '@human-protocol/sdk';
      *
+     * const networkData = NETWORKS[ChainId.POLYGON_AMOY];
+     * const paymentStats = await StatisticsUtils.getPaymentStatistics(networkData);
      * console.log(
      *   'Payment statistics:',
-     *   (await statisticsClient.getPaymentStatistics()).dailyPaymentsData.map(
-     *     (p) => ({
-     *       ...p,
-     *       totalAmountPaid: p.totalAmountPaid.toString(),
-     *       averageAmountPerJob: p.averageAmountPerJob.toString(),
-     *       averageAmountPerWorker: p.averageAmountPerWorker.toString(),
-     *     })
-     *   )
-     * );
-     *
-     * console.log(
-     *   'Payment statistics from 5/8 - 6/8:',
-     *   (
-     *     await statisticsClient.getPaymentStatistics({
-     *       from: new Date(2023, 4, 8),
-     *       to: new Date(2023, 5, 8),
-     *     })
-     *   ).dailyPaymentsData.map((p) => ({
+     *   paymentStats.dailyPaymentsData.map((p) => ({
      *     ...p,
      *     totalAmountPaid: p.totalAmountPaid.toString(),
-     *     averageAmountPerJob: p.averageAmountPerJob.toString(),
      *     averageAmountPerWorker: p.averageAmountPerWorker.toString(),
      *   }))
      * );
+     *
+     * const paymentStatsRange = await StatisticsUtils.getPaymentStatistics(
+     *   networkData,
+     *   {
+     *     from: new Date(2023, 4, 8),
+     *     to: new Date(2023, 5, 8),
+     *   }
+     * );
+     * console.log('Payment statistics from 5/8 - 6/8:', paymentStatsRange.dailyPaymentsData.length);
      * ```
      */
-    getPaymentStatistics(filter?: IStatisticsFilter, options?: SubgraphOptions): Promise<IPaymentStatistics>;
+    static getPaymentStatistics(networkData: NetworkData, filter?: IStatisticsFilter, options?: SubgraphOptions): Promise<IPaymentStatistics>;
     /**
      * This function returns the statistical data of HMToken.
      *
@@ -215,52 +191,46 @@ export declare class StatisticsClient {
      * };
      * ```
      *
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IHMTStatistics>} HMToken statistics data.
-     *
-     * **Code example**
+     * @param networkData - The network information required to connect to the subgraph
+     * @param options - Optional configuration for subgraph requests.
+     * @returns HMToken statistics data.
      *
+     * @example
      * ```ts
-     * import { StatisticsClient, ChainId, NETWORKS } from '@human-protocol/sdk';
-     *
-     * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
-     *
-     * const hmtStatistics = await statisticsClient.getHMTStatistics();
+     * import { StatisticsUtils, ChainId, NETWORKS } from '@human-protocol/sdk';
      *
+     * const networkData = NETWORKS[ChainId.POLYGON_AMOY];
+     * const hmtStats = await StatisticsUtils.getHMTStatistics(networkData);
      * console.log('HMT statistics:', {
-     *   ...hmtStatistics,
-     *   totalTransferAmount: hmtStatistics.totalTransferAmount.toString(),
+     *   ...hmtStats,
+     *   totalTransferAmount: hmtStats.totalTransferAmount.toString(),
      * });
      * ```
      */
-    getHMTStatistics(options?: SubgraphOptions): Promise<IHMTStatistics>;
+    static getHMTStatistics(networkData: NetworkData, options?: SubgraphOptions): Promise<IHMTStatistics>;
     /**
      * This function returns the holders of the HMToken with optional filters and ordering.
      *
-     * **Input parameters**
-     *
-     * @param {IHMTHoldersParams} params HMT Holders params with filters and ordering
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IHMTHolder[]>} List of HMToken holders.
-     *
-     * **Code example**
+     * @param networkData - The network information required to connect to the subgraph
+     * @param params - HMT Holders params with filters and ordering
+     * @param options - Optional configuration for subgraph requests.
+     * @returns List of HMToken holders.
      *
+     * @example
      * ```ts
-     * import { StatisticsClient, ChainId, NETWORKS } from '@human-protocol/sdk';
+     * import { StatisticsUtils, ChainId, NETWORKS } from '@human-protocol/sdk';
      *
-     * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
-     *
-     * const hmtHolders = await statisticsClient.getHMTHolders({
+     * const networkData = NETWORKS[ChainId.POLYGON_AMOY];
+     * const hmtHolders = await StatisticsUtils.getHMTHolders(networkData, {
      *   orderDirection: 'asc',
      * });
-     *
      * console.log('HMT holders:', hmtHolders.map((h) => ({
      *   ...h,
      *   balance: h.balance.toString(),
      * })));
      * ```
      */
-    getHMTHolders(params?: IHMTHoldersParams, options?: SubgraphOptions): Promise<IHMTHolder[]>;
+    static getHMTHolders(networkData: NetworkData, params?: IHMTHoldersParams, options?: SubgraphOptions): Promise<IHMTHolder[]>;
     /**
      * This function returns the statistical data of HMToken day by day.
      *
@@ -286,29 +256,29 @@ export declare class StatisticsClient {
      * }
      * ```
      *
-     * @param {IStatisticsFilter} filter Statistics params with duration data
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IDailyHMT[]>} Daily HMToken statistics data.
-     *
-     * **Code example**
+     * @param networkData - The network information required to connect to the subgraph
+     * @param filter - Statistics params with duration data
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Daily HMToken statistics data.
      *
+     * @example
      * ```ts
-     * import { StatisticsClient, ChainId, NETWORKS } from '@human-protocol/sdk';
-     *
-     * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
-     *
-     * const dailyHMTStats = await statisticsClient.getHMTStatistics();
+     * import { StatisticsUtils, ChainId, NETWORKS } from '@human-protocol/sdk';
      *
+     * const networkData = NETWORKS[ChainId.POLYGON_AMOY];
+     * const dailyHMTStats = await StatisticsUtils.getHMTDailyData(networkData);
      * console.log('Daily HMT statistics:', dailyHMTStats);
      *
-     * const hmtStatisticsRange = await statisticsClient.getHMTStatistics({
-     *   from: new Date(2023, 4, 8),
-     *   to: new Date(2023, 5, 8),
-     * });
-     *
-     * console.log('HMT statistics from 5/8 - 6/8:', hmtStatisticsRange);
+     * const hmtStatsRange = await StatisticsUtils.getHMTDailyData(
+     *   networkData,
+     *   {
+     *     from: new Date(2023, 4, 8),
+     *     to: new Date(2023, 5, 8),
+     *   }
+     * );
+     * console.log('HMT statistics from 5/8 - 6/8:', hmtStatsRange.length);
      * ```
      */
-    getHMTDailyData(filter?: IStatisticsFilter, options?: SubgraphOptions): Promise<IDailyHMT[]>;
+    static getHMTDailyData(networkData: NetworkData, filter?: IStatisticsFilter, options?: SubgraphOptions): Promise<IDailyHMT[]>;
 }
 //# sourceMappingURL=statistics.d.ts.map

package/dist/statistics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"statistics.d.ts","sourceRoot":"","sources":["../src/statistics.ts"],"names":[],"mappings":"AAYA,OAAO,EACL,SAAS,EACT,iBAAiB,EACjB,UAAU,EACV,iBAAiB,EACjB,cAAc,EACd,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EAChB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAQtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,gBAAgB;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;gBACS,WAAW,EAAE,WAAW;IAKpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACG,mBAAmB,CACvB,MAAM,GAAE,iBAAsB,EAC9B,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,iBAAiB,CAAC;IA4C7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACG,mBAAmB,CACvB,MAAM,GAAE,iBAAsB,EAC9B,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,iBAAiB,CAAC;IAiC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACG,oBAAoB,CACxB,MAAM,GAAE,iBAAsB,EAC9B,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,kBAAkB,CAAC;IAuC9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,gBAAgB,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IAgB1E;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,aAAa,CACjB,MAAM,GAAE,iBAAsB,EAC9B,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,UAAU,EAAE,CAAC;IAyBxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACG,eAAe,CACnB,MAAM,GAAE,iBAAsB,EAC9B,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,SAAS,EAAE,CAAC;CAiCxB"}
+{"version":3,"file":"statistics.d.ts","sourceRoot":"","sources":["../src/statistics.ts"],"names":[],"mappings":"AAYA,OAAO,EACL,SAAS,EACT,iBAAiB,EACjB,UAAU,EACV,iBAAiB,EACjB,cAAc,EACd,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EAChB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAQtC;;;;;;;;;;;;;;GAcG;AACH,qBAAa,eAAe;IAC1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;WACU,mBAAmB,CAC9B,WAAW,EAAE,WAAW,EACxB,MAAM,GAAE,iBAAsB,EAC9B,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,iBAAiB,CAAC;IA6C7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;WACU,mBAAmB,CAC9B,WAAW,EAAE,WAAW,EACxB,MAAM,GAAE,iBAAsB,EAC9B,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,iBAAiB,CAAC;IAkC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;WACU,oBAAoB,CAC/B,WAAW,EAAE,WAAW,EACxB,MAAM,GAAE,iBAAsB,EAC9B,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,kBAAkB,CAAC;IAwC9B;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;WACU,gBAAgB,CAC3B,WAAW,EAAE,WAAW,EACxB,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,cAAc,CAAC;IAiB1B;;;;;;;;;;;;;;;;;;;;;OAqBG;WACU,aAAa,CACxB,WAAW,EAAE,WAAW,EACxB,MAAM,GAAE,iBAAsB,EAC9B,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,UAAU,EAAE,CAAC;IA0BxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;WACU,eAAe,CAC1B,WAAW,EAAE,WAAW,EACxB,MAAM,GAAE,iBAAsB,EAC9B,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,SAAS,EAAE,CAAC;CAkCxB"}