@human-protocol/sdk 3.0.0 → 3.0.2

package/dist/operator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operator.d.ts","sourceRoot":"","sources":["../src/operator.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,OAAO,EAEP,cAAc,EACd,SAAS,EAET,OAAO,EACR,MAAM,cAAc,CAAC;AAetB,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAGlC,qBAAa,aAAa;IACxB;;;;;;;;;;;;;;OAcG;WACiB,SAAS,CAC3B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,OAAO,CAAC;IAkCnB;;;;;;;;;;;;;;;;;OAiBG;WACiB,UAAU,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IA0C1E;;;;;;;;;;;;;OAaG;WACiB,6BAA6B,CAC/C,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,SAAS,EAAE,CAAC;IAiCvB;;;;;;;;;;;;;;OAcG;WACiB,UAAU,CAC5B,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,OAAO,EAAE,CAAC;CA2BtB"}
+{"version":3,"file":"operator.d.ts","sourceRoot":"","sources":["../src/operator.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,OAAO,EAEP,cAAc,EACd,SAAS,EAET,OAAO,EACR,MAAM,cAAc,CAAC;AAetB,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAGlC,qBAAa,aAAa;IACxB;;;;;;;;;;;;;;OAcG;WACiB,SAAS,CAC3B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,OAAO,CAAC;IAkCnB;;;;;;;;;;;;;;;;;OAiBG;WACiB,UAAU,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAsC1E;;;;;;;;;;;;;OAaG;WACiB,6BAA6B,CAC/C,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,SAAS,EAAE,CAAC;IA6BvB;;;;;;;;;;;;;;OAcG;WACiB,UAAU,CAC5B,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,OAAO,EAAE,CAAC;CAuBtB"}

package/dist/operator.js

@@ -36,25 +36,23 @@ class OperatorUtils {
         if (!networkData) {
             throw error_1.ErrorUnsupportedChainID;
         }
-        try {
-            const { leader } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), operator_1.GET_LEADER_QUERY, {
-                address: address.toLowerCase(),
-            });
-            let jobTypes = [];
-            if (typeof leader.jobTypes === 'string') {
-                jobTypes = leader.jobTypes.split(',');
-            }
-            else if (Array.isArray(leader.jobTypes)) {
-                jobTypes = leader.jobTypes;
-            }
-            return {
-                ...leader,
-                jobTypes,
-            };
+        const { leader } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), operator_1.GET_LEADER_QUERY, {
+            address: address.toLowerCase(),
+        });
+        if (!leader) {
+            return leader || null;
+        }
+        let jobTypes = [];
+        if (typeof leader.jobTypes === 'string') {
+            jobTypes = leader.jobTypes.split(',');
         }
-        catch (e) {
-            return (0, utils_1.throwError)(e);
+        else if (Array.isArray(leader.jobTypes)) {
+            jobTypes = leader.jobTypes;
         }
+        return {
+            ...leader,
+            jobTypes,
+        };
     }
     /**
      * This function returns all the leader details of the protocol.
@@ -75,36 +73,31 @@ class OperatorUtils {
      * ```
      */
     static async getLeaders(filter) {
-        try {
-            let leaders_data = [];
-            const networkData = constants_1.NETWORKS[filter.chainId];
-            if (!networkData) {
-                throw error_1.ErrorUnsupportedChainID;
-            }
-            const { leaders } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, operator_1.GET_LEADERS_QUERY)(filter), {
-                role: filter?.role,
-            });
-            if (!leaders) {
-                return [];
-            }
-            leaders_data = leaders_data.concat(leaders.map((leader) => {
-                let jobTypes = [];
-                if (typeof leader.jobTypes === 'string') {
-                    jobTypes = leader.jobTypes.split(',');
-                }
-                else if (Array.isArray(leader.jobTypes)) {
-                    jobTypes = leader.jobTypes;
-                }
-                return {
-                    ...leader,
-                    jobTypes,
-                };
-            }));
-            return leaders_data;
+        let leaders_data = [];
+        const networkData = constants_1.NETWORKS[filter.chainId];
+        if (!networkData) {
+            throw error_1.ErrorUnsupportedChainID;
         }
-        catch (e) {
-            return (0, utils_1.throwError)(e);
+        const { leaders } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, operator_1.GET_LEADERS_QUERY)(filter), {
+            role: filter?.role,
+        });
+        if (!leaders) {
+            return [];
         }
+        leaders_data = leaders_data.concat(leaders.map((leader) => {
+            let jobTypes = [];
+            if (typeof leader.jobTypes === 'string') {
+                jobTypes = leader.jobTypes.split(',');
+            }
+            else if (Array.isArray(leader.jobTypes)) {
+                jobTypes = leader.jobTypes;
+            }
+            return {
+                ...leader,
+                jobTypes,
+            };
+        }));
+        return leaders_data;
     }
     /**
      * Retrieves the reputation network operators of the specified address.
@@ -125,28 +118,23 @@ class OperatorUtils {
         if (!networkData) {
             throw error_1.ErrorUnsupportedChainID;
         }
-        try {
-            const { reputationNetwork } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, operator_1.GET_REPUTATION_NETWORK_QUERY)(role), {
-                address: address.toLowerCase(),
-                role: role,
-            });
-            return reputationNetwork.operators.map((operator) => {
-                let jobTypes = [];
-                if (typeof operator.jobTypes === 'string') {
-                    jobTypes = operator.jobTypes.split(',');
-                }
-                else if (Array.isArray(operator.jobTypes)) {
-                    jobTypes = operator.jobTypes;
-                }
-                return {
-                    ...operator,
-                    jobTypes,
-                };
-            });
-        }
-        catch (e) {
-            return (0, utils_1.throwError)(e);
-        }
+        const { reputationNetwork } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, operator_1.GET_REPUTATION_NETWORK_QUERY)(role), {
+            address: address.toLowerCase(),
+            role: role,
+        });
+        return reputationNetwork.operators.map((operator) => {
+            let jobTypes = [];
+            if (typeof operator.jobTypes === 'string') {
+                jobTypes = operator.jobTypes.split(',');
+            }
+            else if (Array.isArray(operator.jobTypes)) {
+                jobTypes = operator.jobTypes;
+            }
+            return {
+                ...operator,
+                jobTypes,
+            };
+        });
     }
     /**
      * This function returns information about the rewards for a given slasher address.
@@ -171,20 +159,15 @@ class OperatorUtils {
         if (!networkData) {
             throw error_1.ErrorUnsupportedChainID;
         }
-        try {
-            const { rewardAddedEvents } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), reward_1.GET_REWARD_ADDED_EVENTS_QUERY, {
-                slasherAddress: slasherAddress.toLowerCase(),
-            });
-            return rewardAddedEvents.map((reward) => {
-                return {
-                    escrowAddress: reward.escrow,
-                    amount: reward.amount,
-                };
-            });
-        }
-        catch (e) {
-            return (0, utils_1.throwError)(e);
-        }
+        const { rewardAddedEvents } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), reward_1.GET_REWARD_ADDED_EVENTS_QUERY, {
+            slasherAddress: slasherAddress.toLowerCase(),
+        });
+        return rewardAddedEvents.map((reward) => {
+            return {
+                escrowAddress: reward.escrow,
+                amount: reward.amount,
+            };
+        });
     }
 }
 exports.OperatorUtils = OperatorUtils;

package/dist/statistics.d.ts

@@ -1,5 +1,5 @@
-import { EscrowStatistics, HMTStatistics, PaymentStatistics, WorkerStatistics } from './graphql';
-import { IStatisticsParams } from './interfaces';
+import { EscrowStatistics, HMTStatistics, PaymentStatistics, WorkerStatistics, HMTHolder, DailyHMTData } from './graphql';
+import { IHMTHoldersParams, IStatisticsFilter } from './interfaces';
 import { NetworkData } from './types';
 /**
  * ## Introduction
@@ -54,10 +54,12 @@ export declare class StatisticsClient {
      * **Input parameters**
      *
      * ```ts
-     * interface IStatisticsParams {
+     * interface IStatisticsFilter {
      *   from?: Date;
      *   to?: Date;
-     *   limit?: number;
+     *   first?: number; // (Optional) Number of transactions per page. Default is 10.
+     *   skip?: number; // (Optional) Number of transactions to skip. Default is 0.
+     *   orderDirection?: OrderDirection; // (Optional) Order of the results. Default is ASC.
      * }
      * ```
      *
@@ -78,7 +80,7 @@ export declare class StatisticsClient {
      * ```
      *
      *
-     * @param {IStatisticsParams} params Statistics params with duration data
+     * @param {IStatisticsFilter} filter Statistics params with duration data
      * @returns {EscrowStatistics} Escrow statistics data.
      *
      *
@@ -96,7 +98,7 @@ export declare class StatisticsClient {
      * });
      * ```
      */
-    getEscrowStatistics(params?: IStatisticsParams): Promise<EscrowStatistics>;
+    getEscrowStatistics(filter?: IStatisticsFilter): Promise<EscrowStatistics>;
     /**
      * This function returns the statistical data of workers.
      *
@@ -104,10 +106,12 @@ export declare class StatisticsClient {
      * **Input parameters**
      *
      * ```ts
-     * interface IStatisticsParams {
+     * interface IStatisticsFilter {
      *   from?: Date;
      *   to?: Date;
-     *   limit?: number;
+     *   first?: number; // (Optional) Number of transactions per page. Default is 10.
+     *   skip?: number; // (Optional) Number of transactions to skip. Default is 0.
+     *   orderDirection?: OrderDirection; // (Optional) Order of the results. Default is ASC.
      * }
      * ```
      *
@@ -123,7 +127,7 @@ export declare class StatisticsClient {
      * ```
      *
      *
-     * @param {IStatisticsParams} params Statistics params with duration data
+     * @param {IStatisticsFilter} filter Statistics params with duration data
      * @returns {WorkerStatistics} Worker statistics data.
      *
      *
@@ -141,7 +145,7 @@ export declare class StatisticsClient {
      * });
      * ```
      */
-    getWorkerStatistics(params?: IStatisticsParams): Promise<WorkerStatistics>;
+    getWorkerStatistics(filter?: IStatisticsFilter): Promise<WorkerStatistics>;
     /**
      * This function returns the statistical data of payments.
      *
@@ -149,10 +153,12 @@ export declare class StatisticsClient {
      * **Input parameters**
      *
      * ```ts
-     * interface IStatisticsParams {
+     * interface IStatisticsFilter {
      *   from?: Date;
      *   to?: Date;
-     *   limit?: number;
+     *   first?: number; // (Optional) Number of transactions per page. Default is 10.
+     *   skip?: number; // (Optional) Number of transactions to skip. Default is 0.
+     *   orderDirection?: OrderDirection; // (Optional) Order of the results. Default is ASC.
      * }
      * ```
      *
@@ -170,7 +176,7 @@ export declare class StatisticsClient {
      * ```
      *
      *
-     * @param {IStatisticsParams} params Statistics params with duration data
+     * @param {IStatisticsFilter} filter Statistics params with duration data
      * @returns {PaymentStatistics} Payment statistics data.
      *
      *
@@ -209,45 +215,93 @@ export declare class StatisticsClient {
      * );
      * ```
      */
-    getPaymentStatistics(params?: IStatisticsParams): Promise<PaymentStatistics>;
+    getPaymentStatistics(filter?: IStatisticsFilter): Promise<PaymentStatistics>;
     /**
      * This function returns the statistical data of HMToken.
      *
      *
+     * type HMTStatistics = {
+     *   totalTransferAmount: BigNumber;
+     *   totalTransferCount: BigNumber;
+     *   totalHolders: number;
+     * };
+     * ```
+     *
+     *
+     * @returns {HMTStatistics} HMToken statistics data.
+     *
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { StatisticsClient, ChainId, NETWORKS } from '@human-protocol/sdk';
+     *
+     * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
+     *
+     * const hmtStatistics = await statisticsClient.getHMTStatistics();
+     *
+     * console.log('HMT statistics:', {
+     *   ...hmtStatistics,
+     *   totalTransferAmount: hmtStatistics.totalTransferAmount.toString(),
+     * });
+     * ```
+     */
+    getHMTStatistics(): Promise<HMTStatistics>;
+    /**
+     * 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
+     * @returns {HMTHolder[]} List of HMToken holders.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { StatisticsClient, ChainId, NETWORKS } from '@human-protocol/sdk';
+     *
+     * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
+     *
+     * const hmtHolders = await statisticsClient.getHMTHolders({
+     *   orderDirection: 'asc',
+     * });
+     *
+     * console.log('HMT holders:', hmtHolders.map((h) => ({
+     *   ...h,
+     *   balance: h.balance.toString(),
+     * })));
+     * ```
+     */
+    getHMTHolders(params?: IHMTHoldersParams): Promise<HMTHolder[]>;
+    /**
+     * This function returns the statistical data of HMToken day by day.
+     *
+     *
      * **Input parameters**
      *
      * ```ts
-     * interface IStatisticsParams {
+     * interface IStatisticsFilter {
      *   from?: Date;
      *   to?: Date;
-     *   limit?: number;
+     *   first?: number; // (Optional) Number of transactions per page. Default is 10.
+     *   skip?: number; // (Optional) Number of transactions to skip. Default is 0.
+     *   orderDirection?: OrderDirection; // (Optional) Order of the results. Default is ASC.
      * }
      * ```
      *
      * ```ts
-     * type HMTHolder = {
-     *   address: string;
-     *   balance: BigNumber;
-     * }
-     *
      * type DailyHMTData = {
      *   timestamp: Date;
-     *   totalTransactionAmount: BigNumber;
+     *   totalTransactionAmount: bigint;
      *   totalTransactionCount: number;
-     * };
-     *
-     * type HMTStatistics = {
-     *   totalTransferAmount: BigNumber;
-     *   totalTransferCount: BigNumber;
-     *   totalHolders: number;
-     *   holders: HMTHolder[];
-     *   dailyHMTData: DailyHMTData[];
-     * };
+     *   dailyUniqueSenders: number;
+     *   dailyUniqueReceivers: number;
+     * }
      * ```
      *
      *
-     * @param {IStatisticsParams} params Statistics params with duration data
-     * @returns {HMTStatistics} HMToken statistics data.
+     * @param {IStatisticsFilter} filter Statistics params with duration data
+     * @returns {DailyHMTData[]} Daily HMToken statistics data.
      *
      *
      * **Code example**
@@ -257,40 +311,18 @@ export declare class StatisticsClient {
      *
      * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
      *
-     * const hmtStatistics = await statisticsClient.getHMTStatistics();
+     * const dailyHMTStats = await statisticsClient.getHMTStatistics();
      *
-     * console.log('HMT statistics:', {
-     *   ...hmtStatistics,
-     *   totalTransferAmount: hmtStatistics.totalTransferAmount.toString(),
-     *   holders: hmtStatistics.holders.map((h) => ({
-     *     ...h,
-     *     balance: h.balance.toString(),
-     *   })),
-     *   dailyHMTData: hmtStatistics.dailyHMTData.map((d) => ({
-     *     ...d,
-     *     totalTransactionAmount: d.totalTransactionAmount.toString(),
-     *   })),
-     * });
+     * 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,
-     *   totalTransferAmount: hmtStatisticsRange.totalTransferAmount.toString(),
-     *   holders: hmtStatisticsRange.holders.map((h) => ({
-     *     ...h,
-     *     balance: h.balance.toString(),
-     *   })),
-     *   dailyHMTData: hmtStatisticsRange.dailyHMTData.map((d) => ({
-     *     ...d,
-     *     totalTransactionAmount: d.totalTransactionAmount.toString(),
-     *   })),
-     * });
+     * console.log('HMT statistics from 5/8 - 6/8:', hmtStatisticsRange);
      * ```
      */
-    getHMTStatistics(params?: IStatisticsParams): Promise<HMTStatistics>;
+    getHMTDailyData(filter?: IStatisticsFilter): Promise<DailyHMTData[]>;
 }
 //# 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":"AAIA,OAAO,EAKL,gBAAgB,EAGhB,aAAa,EAEb,iBAAiB,EACjB,gBAAgB,EAEjB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;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,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IA6B5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACG,mBAAmB,CACvB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAoB5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACG,oBAAoB,CACxB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IA0B7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgFG;IACG,gBAAgB,CACpB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,aAAa,CAAC;CAuC1B"}
+{"version":3,"file":"statistics.d.ts","sourceRoot":"","sources":["../src/statistics.ts"],"names":[],"mappings":"AAIA,OAAO,EAKL,gBAAgB,EAGhB,aAAa,EAEb,iBAAiB,EACjB,gBAAgB,EAEhB,SAAS,EACT,YAAY,EACb,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAItC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,gBAAgB;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;gBACS,WAAW,EAAE,WAAW;IAKpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACG,mBAAmB,CACvB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAqC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,mBAAmB,CACvB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IA4B5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoEG;IACG,oBAAoB,CACxB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IAkC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,gBAAgB,IAAI,OAAO,CAAC,aAAa,CAAC;IAkBhD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,aAAa,CAAC,MAAM,GAAE,iBAAsB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAwBzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IACG,eAAe,CACnB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,YAAY,EAAE,CAAC;CA8B3B"}