@human-protocol/sdk 3.0.1 → 3.0.2

package/dist/statistics.js

@@ -9,6 +9,7 @@ const ethers_1 = require("ethers");
 const graphql_request_1 = __importDefault(require("graphql-request"));
 const graphql_1 = require("./graphql");
 const utils_1 = require("./utils");
+const enums_1 = require("./enums");
 /**
  * ## Introduction
  *
@@ -63,10 +64,12 @@ 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.
      * }
      * ```
      *
@@ -87,7 +90,7 @@ class StatisticsClient {
      * ```
      *
      *
-     * @param {IStatisticsParams} params Statistics params with duration data
+     * @param {IStatisticsFilter} filter Statistics params with duration data
      * @returns {EscrowStatistics} Escrow statistics data.
      *
      *
@@ -105,12 +108,18 @@ class StatisticsClient {
      * });
      * ```
      */
-    async getEscrowStatistics(params = {}) {
+    async getEscrowStatistics(filter = {}) {
         try {
+            const first = filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
+            const skip = filter.skip || 0;
+            const orderDirection = filter.orderDirection || enums_1.OrderDirection.ASC;
             const { escrowStatistics } = await (0, graphql_request_1.default)(this.subgraphUrl, graphql_1.GET_ESCROW_STATISTICS_QUERY);
-            const { eventDayDatas } = await (0, graphql_request_1.default)(this.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
-                from: params.from ? params.from.getTime() / 1000 : undefined,
-                to: params.to ? params.to.getTime() / 1000 : undefined,
+            const { eventDayDatas } = await (0, graphql_request_1.default)(this.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(filter), {
+                from: filter.from ? filter.from.getTime() / 1000 : undefined,
+                to: filter.to ? filter.to.getTime() / 1000 : undefined,
+                orderDirection: orderDirection,
+                first: first,
+                skip: skip,
             });
             return {
                 totalEscrows: +escrowStatistics.totalEscrowCount,
@@ -135,10 +144,12 @@ 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.
      * }
      * ```
      *
@@ -154,7 +165,7 @@ class StatisticsClient {
      * ```
      *
      *
-     * @param {IStatisticsParams} params Statistics params with duration data
+     * @param {IStatisticsFilter} filter Statistics params with duration data
      * @returns {WorkerStatistics} Worker statistics data.
      *
      *
@@ -172,11 +183,17 @@ class StatisticsClient {
      * });
      * ```
      */
-    async getWorkerStatistics(params = {}) {
+    async getWorkerStatistics(filter = {}) {
         try {
-            const { eventDayDatas } = await (0, graphql_request_1.default)(this.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
-                from: params.from ? params.from.getTime() / 1000 : undefined,
-                to: params.to ? params.to.getTime() / 1000 : undefined,
+            const first = filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
+            const skip = filter.skip || 0;
+            const orderDirection = filter.orderDirection || enums_1.OrderDirection.ASC;
+            const { eventDayDatas } = await (0, graphql_request_1.default)(this.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(filter), {
+                from: filter.from ? filter.from.getTime() / 1000 : undefined,
+                to: filter.to ? filter.to.getTime() / 1000 : undefined,
+                orderDirection: orderDirection,
+                first: first,
+                skip: skip,
             });
             return {
                 dailyWorkersData: eventDayDatas.map((eventDayData) => ({
@@ -196,10 +213,12 @@ 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.
      * }
      * ```
      *
@@ -217,7 +236,7 @@ class StatisticsClient {
      * ```
      *
      *
-     * @param {IStatisticsParams} params Statistics params with duration data
+     * @param {IStatisticsFilter} filter Statistics params with duration data
      * @returns {PaymentStatistics} Payment statistics data.
      *
      *
@@ -256,11 +275,17 @@ class StatisticsClient {
      * );
      * ```
      */
-    async getPaymentStatistics(params = {}) {
+    async getPaymentStatistics(filter = {}) {
         try {
-            const { eventDayDatas } = await (0, graphql_request_1.default)(this.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
-                from: params.from ? params.from.getTime() / 1000 : undefined,
-                to: params.to ? params.to.getTime() / 1000 : undefined,
+            const first = filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
+            const skip = filter.skip || 0;
+            const orderDirection = filter.orderDirection || enums_1.OrderDirection.ASC;
+            const { eventDayDatas } = await (0, graphql_request_1.default)(this.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(filter), {
+                from: filter.from ? filter.from.getTime() / 1000 : undefined,
+                to: filter.to ? filter.to.getTime() / 1000 : undefined,
+                orderDirection: orderDirection,
+                first: first,
+                skip: skip,
             });
             return {
                 dailyPaymentsData: eventDayDatas.map((eventDayData) => ({
@@ -282,39 +307,14 @@ class StatisticsClient {
      * This function returns the statistical data of HMToken.
      *
      *
-     * **Input parameters**
-     *
-     * ```ts
-     * interface IStatisticsParams {
-     *   from?: Date;
-     *   to?: Date;
-     *   limit?: number;
-     * }
-     * ```
-     *
-     * ```ts
-     * type HMTHolder = {
-     *   address: string;
-     *   balance: BigNumber;
-     * }
-     *
-     * type DailyHMTData = {
-     *   timestamp: Date;
-     *   totalTransactionAmount: BigNumber;
-     *   totalTransactionCount: number;
-     * };
-     *
      * type HMTStatistics = {
      *   totalTransferAmount: BigNumber;
      *   totalTransferCount: BigNumber;
      *   totalHolders: number;
-     *   holders: HMTHolder[];
-     *   dailyHMTData: DailyHMTData[];
      * };
      * ```
      *
      *
-     * @param {IStatisticsParams} params Statistics params with duration data
      * @returns {HMTStatistics} HMToken statistics data.
      *
      *
@@ -330,58 +330,16 @@ class StatisticsClient {
      * 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(),
-     *   })),
-     * });
-     *
-     * 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(),
-     *   })),
      * });
      * ```
      */
-    async getHMTStatistics(params = {}) {
+    async getHMTStatistics() {
         try {
             const { hmtokenStatistics } = await (0, graphql_request_1.default)(this.subgraphUrl, graphql_1.GET_HMTOKEN_STATISTICS_QUERY);
-            const { holders } = await (0, graphql_request_1.default)(this.subgraphUrl, (0, graphql_1.GET_HOLDERS_QUERY)());
-            const { eventDayDatas } = await (0, graphql_request_1.default)(this.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
-                from: params.from ? params.from.getTime() / 1000 : undefined,
-                to: params.to ? params.to.getTime() / 1000 : undefined,
-            });
             return {
                 totalTransferAmount: ethers_1.ethers.toBigInt(hmtokenStatistics.totalValueTransfered),
                 totalTransferCount: Number(hmtokenStatistics.totalTransferEventCount),
                 totalHolders: +hmtokenStatistics.holders,
-                holders: holders.map((holder) => ({
-                    address: holder.address,
-                    balance: ethers_1.ethers.toBigInt(holder.balance),
-                })),
-                dailyHMTData: eventDayDatas.map((eventDayData) => ({
-                    timestamp: new Date(+eventDayData.timestamp * 1000),
-                    totalTransactionAmount: ethers_1.ethers.toBigInt(eventDayData.dailyHMTTransferAmount),
-                    totalTransactionCount: +eventDayData.dailyHMTTransferCount,
-                    dailyUniqueSenders: +eventDayData.dailyUniqueSenders,
-                    dailyUniqueReceivers: +eventDayData.dailyUniqueReceivers,
-                })),
             };
         }
         catch (e) {
@@ -431,5 +389,79 @@ class StatisticsClient {
             return (0, utils_1.throwError)(e);
         }
     }
+    /**
+     * This function returns the statistical data of HMToken day by day.
+     *
+     *
+     * **Input parameters**
+     *
+     * ```ts
+     * interface IStatisticsFilter {
+     *   from?: Date;
+     *   to?: Date;
+     *   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 DailyHMTData = {
+     *   timestamp: Date;
+     *   totalTransactionAmount: bigint;
+     *   totalTransactionCount: number;
+     *   dailyUniqueSenders: number;
+     *   dailyUniqueReceivers: number;
+     * }
+     * ```
+     *
+     *
+     * @param {IStatisticsFilter} filter Statistics params with duration data
+     * @returns {DailyHMTData[]} Daily HMToken statistics data.
+     *
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { StatisticsClient, ChainId, NETWORKS } from '@human-protocol/sdk';
+     *
+     * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
+     *
+     * const dailyHMTStats = await statisticsClient.getHMTStatistics();
+     *
+     * 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);
+     * ```
+     */
+    async getHMTDailyData(filter = {}) {
+        try {
+            const first = filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
+            const skip = filter.skip || 0;
+            const orderDirection = filter.orderDirection || enums_1.OrderDirection.ASC;
+            const { eventDayDatas } = await (0, graphql_request_1.default)(this.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(filter), {
+                from: filter.from ? filter.from.getTime() / 1000 : undefined,
+                to: filter.to ? filter.to.getTime() / 1000 : undefined,
+                orderDirection: orderDirection,
+                first: first,
+                skip: skip,
+            });
+            return eventDayDatas.map((eventDayData) => ({
+                timestamp: new Date(+eventDayData.timestamp * 1000),
+                totalTransactionAmount: ethers_1.ethers.toBigInt(eventDayData.dailyHMTTransferAmount),
+                totalTransactionCount: +eventDayData.dailyHMTTransferCount,
+                dailyUniqueSenders: +eventDayData.dailyUniqueSenders,
+                dailyUniqueReceivers: +eventDayData.dailyUniqueReceivers,
+            }));
+        }
+        catch (e) {
+            return (0, utils_1.throwError)(e);
+        }
+    }
 }
 exports.StatisticsClient = StatisticsClient;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@human-protocol/sdk",
   "description": "Human Protocol SDK",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "files": [
     "src",
     "dist"

package/src/constants.ts

@@ -349,6 +349,7 @@ export const KVStoreKeys = {
   webhookUrl: 'webhook_url',
   url: 'url',
   jobTypes: 'job_types',
+  registrationNeeded: 'registration_needed',
 };
 
 export const Role = {

package/src/escrow.ts

@@ -1484,11 +1484,8 @@ export class EscrowUtils {
    *   manifestHash?: string;
    *   manifestUrl?: string;
    *   recordingOracle?: string;
-   *   recordingOracleFee?: string;
    *   reputationOracle?: string;
-   *   reputationOracleFee?: string;
    *   exchangeOracle?: string;
-   *   exchangeOracleFee?: string;
    *   status: EscrowStatus;
    *   token: string;
    *   totalFundedAmount: string;
@@ -1618,11 +1615,8 @@ export class EscrowUtils {
    *   manifestHash?: string;
    *   manifestUrl?: string;
    *   recordingOracle?: string;
-   *   recordingOracleFee?: string;
    *   reputationOracle?: string;
-   *   reputationOracleFee?: string;
    *   exchangeOracle?: string;
-   *   exchangeOracleFee?: string;
    *   status: EscrowStatus;
    *   token: string;
    *   totalFundedAmount: string;

package/src/graphql/queries/escrow.ts

@@ -16,11 +16,8 @@ const ESCROW_FRAGMENT = gql`
     manifestHash
     manifestUrl
     recordingOracle
-    recordingOracleFee
     reputationOracle
-    reputationOracleFee
     exchangeOracle
-    exchangeOracleFee
     status
     token
     totalFundedAmount

package/src/graphql/queries/kvstore.ts

@@ -21,3 +21,14 @@ export const GET_KVSTORE_BY_ADDRESS_QUERY = () => {
     ${KVSTORE_FRAGMENT}
   `;
 };
+
+export const GET_KVSTORE_BY_ADDRESS_AND_KEY_QUERY = () => {
+  return gql`
+    query getKVStoreDataByKey($address: String!, $key: String!) {
+      kvstores(where: { address: $address, key: $key }) {
+        ...KVStoreFields
+      }
+    }
+    ${KVSTORE_FRAGMENT}
+  `;
+};

package/src/graphql/queries/operator.ts

@@ -13,7 +13,7 @@ const LEADER_FRAGMENT = gql`
     amountSlashed
     reputation
     reward
-    amountJobsLaunched
+    amountJobsProcessed
     role
     fee
     publicKey

package/src/graphql/queries/statistics.ts

@@ -1,5 +1,5 @@
 import gql from 'graphql-tag';
-import { IStatisticsParams } from '../../interfaces';
+import { IStatisticsFilter } from '../../interfaces';
 
 const HMTOKEN_STATISTICS_FRAGMENT = gql`
   fragment HMTokenStatisticsFields on HMTokenStatistics {
@@ -70,25 +70,29 @@ export const GET_ESCROW_STATISTICS_QUERY = gql`
   ${ESCROW_STATISTICS_FRAGMENT}
 `;
 
-export const GET_EVENT_DAY_DATA_QUERY = (params: IStatisticsParams) => {
-  const { from, to, limit } = params;
+export const GET_EVENT_DAY_DATA_QUERY = (params: IStatisticsFilter) => {
+  const { from, to } = params;
   const WHERE_CLAUSE = `
     where: {
       ${from !== undefined ? `timestamp_gte: $from` : ''}
       ${to !== undefined ? `timestamp_lte: $to` : ''}
     }
   `;
-  const LIMIT_CLAUSE = `
-    first: ${limit ? `$limit` : `1000`}
-  `;
 
   return gql`
-    query GetEscrowDayData($from: Int, $to: Int) {
+    query GetEscrowDayData(
+        $from: Int, 
+        $to: Int,
+        $orderDirection: String
+        $first: Int
+        $skip: Int
+    ) {
       eventDayDatas(
         ${WHERE_CLAUSE},
         orderBy: timestamp,
-        orderDirection: desc,
-        ${LIMIT_CLAUSE}
+        orderDirection: $orderDirection,
+        first: $first,
+        skip: $skip
       ) {
         ...EventDayDataFields
       }

package/src/graphql/types.ts

@@ -13,11 +13,8 @@ export type EscrowData = {
   manifestHash?: string;
   manifestUrl?: string;
   recordingOracle?: string;
-  recordingOracleFee?: string;
   reputationOracle?: string;
-  reputationOracleFee?: string;
   exchangeOracle?: string;
-  exchangeOracleFee?: string;
   status: string;
   token: string;
   totalFundedAmount: string;
@@ -141,8 +138,6 @@ export type HMTStatistics = {
   totalTransferAmount: bigint;
   totalTransferCount: number;
   totalHolders: number;
-  holders: HMTHolder[];
-  dailyHMTData: DailyHMTData[];
 };
 
 export type IMDataEntity = {

package/src/index.ts

@@ -1,6 +1,6 @@
 import { StakingClient } from './staking';
 import { StorageClient } from './storage';
-import { KVStoreClient } from './kvstore';
+import { KVStoreClient, KVStoreUtils } from './kvstore';
 import { EscrowClient, EscrowUtils } from './escrow';
 import { StatisticsClient } from './statistics';
 import { Encryption, EncryptionUtils } from './encryption';
@@ -16,6 +16,7 @@ export {
   StakingClient,
   StorageClient,
   KVStoreClient,
+  KVStoreUtils,
   EscrowClient,
   EscrowUtils,
   StatisticsClient,

package/src/interfaces.ts

@@ -26,7 +26,7 @@ export interface ILeader {
   amountSlashed: bigint;
   reputation: bigint;
   reward: bigint;
-  amountJobsLaunched: bigint;
+  amountJobsProcessed: bigint;
   role?: string;
   fee?: bigint;
   publicKey?: string;
@@ -96,15 +96,13 @@ export interface IKeyPair {
   revocationCertificate?: string;
 }
 
-export interface IStatisticsParams {
+export interface IStatisticsFilter extends IPagination {
   from?: Date;
   to?: Date;
-  limit?: number;
 }
 
-export interface IHMTHoldersParams {
+export interface IHMTHoldersParams extends IPagination {
   address?: string;
-  orderDirection?: 'asc' | 'desc';
 }
 
 export interface IPayoutFilter {