@human-protocol/sdk 1.1.9 → 1.1.11

package/src/graphql/queries/statistics.ts

@@ -0,0 +1,88 @@
+import gql from 'graphql-tag';
+import { IStatisticsParams } from '../../interfaces';
+
+const HMTOKEN_STATISTICS_FRAGMENT = gql`
+  fragment HMTokenStatisticsFields on HMTokenStatistics {
+    totalTransferEventCount
+    totalBulkTransferEventCount
+    totalApprovalEventCount
+    totalBulkApprovalEventCount
+    totalValueTransfered
+    holders
+  }
+`;
+
+const ESCROW_STATISTICS_FRAGMENT = gql`
+  fragment EscrowStatisticsFields on EscrowStatistics {
+    fundEventCount
+    setupEventCount
+    storeResultsEventCount
+    bulkPayoutEventCount
+    pendingStatusEventCount
+    cancelledStatusEventCount
+    partialStatusEventCount
+    paidStatusEventCount
+    completedStatusEventCount
+    totalEventCount
+    totalEscrowCount
+  }
+`;
+
+const EVENT_DAY_DATA_FRAGMENT = gql`
+  fragment EventDayDataFields on EventDayData {
+    timestamp
+    dailyFundEventCount
+    dailySetupEventCount
+    dailyStoreResultsEventCount
+    dailyBulkPayoutEventCount
+    dailyPendingStatusEventCount
+    dailyCancelledStatusEventCount
+    dailyPartialStatusEventCount
+    dailyPaidStatusEventCount
+    dailyCompletedStatusEventCount
+    dailyTotalEventCount
+    dailyEscrowCount
+    dailyWorkerCount
+    dailyPayoutCount
+    dailyPayoutAmount
+    dailyHMTTransferCount
+    dailyHMTTransferAmount
+  }
+`;
+
+export const GET_HMTOKEN_STATISTICS_QUERY = gql`
+  query GetHMTokenStatistics {
+    hmtokenStatistics(id: "hmt-statistics-id") {
+      ...HMTokenStatisticsFields
+    }
+  }
+  ${HMTOKEN_STATISTICS_FRAGMENT}
+`;
+
+export const GET_ESCROW_STATISTICS_QUERY = gql`
+  query GetEscrowStatistics {
+    escrowStatistics(id: "escrow-statistics-id") {
+      ...EscrowStatisticsFields
+    }
+  }
+  ${ESCROW_STATISTICS_FRAGMENT}
+`;
+
+export const GET_EVENT_DAY_DATA_QUERY = (params: IStatisticsParams) => {
+  const { from, to } = params;
+  const WHERE_CLAUSE = `
+    where: {
+      ${from !== undefined ? `timestamp_gte: $from` : ''}
+      ${to !== undefined ? `timestamp_lte: $to` : ''}
+    }
+  `;
+
+  return gql`
+    query GetEscrowDayData($from: Int, $to: Int) {
+      eventDayDatas(${WHERE_CLAUSE}) {
+        ...EventDayDataFields
+      }
+    }
+    ${EVENT_DAY_DATA_FRAGMENT}
+  `;
+};

package/src/graphql/types.ts

@@ -1,3 +1,5 @@
+import { BigNumber } from 'ethers';
+
 export type EscrowData = {
   id: string;
   address: string;
@@ -17,6 +19,50 @@ export type EscrowData = {
   status: string;
   token: string;
   totalFundedAmount: string;
+  createdAt: string;
+};
+
+export type HMTStatisticsData = {
+  totalTransferEventCount: string;
+  totalBulkTransferEventCount: string;
+  totalApprovalEventCount: string;
+  totalBulkApprovalEventCount: string;
+  totalValueTransfered: string;
+  holders: string;
+};
+
+export type EscrowStatisticsData = {
+  fundEventCount: string;
+  setupEventCount: string;
+  storeResultsEventCount: string;
+  bulkPayoutEventCount: string;
+  pendingStatusEventCount: string;
+  cancelledStatusEventCount: string;
+  partialStatusEventCount: string;
+  paidStatusEventCount: string;
+  completedStatusEventCount: string;
+  totalEventCount: string;
+  totalEscrowCount: string;
+};
+
+export type EventDayData = {
+  timestamp: string;
+  dailyFundEventCount: string;
+  dailySetupEventCount: string;
+  dailyStoreResultsEventCount: string;
+  dailyBulkPayoutEventCount: string;
+  dailyPendingStatusEventCount: string;
+  dailyCancelledStatusEventCount: string;
+  dailyPartialStatusEventCount: string;
+  dailyPaidStatusEventCount: string;
+  dailyCompletedStatusEventCount: string;
+  dailyTotalEventCount: string;
+  dailyEscrowCount: string;
+  dailyWorkerCount: string;
+  dailyPayoutCount: string;
+  dailyPayoutAmount: string;
+  dailyHMTTransferCount: string;
+  dailyHMTTransferAmount: string;
 };
 
 export type RewardAddedEventData = {
@@ -25,3 +71,62 @@ export type RewardAddedEventData = {
   slasher: string;
   amount: string;
 };
+
+export type DailyEscrowData = {
+  timestamp: Date;
+  escrowsTotal: number;
+  escrowsPending: number;
+  escrowsSolved: number;
+  escrowsPaid: number;
+  escrowsCancelled: number;
+};
+
+export type EscrowStatistics = {
+  totalEscrows: number;
+  dailyEscrowsData: DailyEscrowData[];
+};
+
+export type DailyWorkerData = {
+  timestamp: Date;
+  activeWorkers: number;
+  averageJobsSolved: number;
+};
+
+export type WorkerStatistics = {
+  dailyWorkersData: DailyWorkerData[];
+};
+
+export type DailyPaymentData = {
+  timestamp: Date;
+  totalAmountPaid: BigNumber;
+  totalCount: number;
+  averageAmountPerJob: BigNumber;
+  averageAmountPerWorker: BigNumber;
+};
+
+export type PaymentStatistics = {
+  dailyPaymentsData: DailyPaymentData[];
+};
+
+export type HMTHolderData = {
+  address: string;
+  balance: string;
+};
+
+export type HMTHolder = {
+  address: string;
+  balance: BigNumber;
+};
+
+export type DailyHMTData = {
+  timestamp: Date;
+  totalTransactionAmount: BigNumber;
+  totalTransactionCount: number;
+};
+
+export type HMTStatistics = {
+  totalTransferAmount: BigNumber;
+  totalHolders: number;
+  holders: HMTHolder[];
+  dailyHMTData: DailyHMTData[];
+};

package/src/index.ts

@@ -2,10 +2,17 @@ import { StakingClient } from './staking';
 import { StorageClient } from './storage';
 import { KVStoreClient } from './kvstore';
 import { EscrowClient } from './escrow';
+import { StatisticsClient } from './statistics';
 
 export * from './constants';
 export * from './types';
 export * from './enums';
 export * from './interfaces';
 
-export { StakingClient, StorageClient, KVStoreClient, EscrowClient };
+export {
+  StakingClient,
+  StorageClient,
+  KVStoreClient,
+  EscrowClient,
+  StatisticsClient,
+};

package/src/interfaces.ts

@@ -1,5 +1,4 @@
 import { BigNumber } from 'ethers';
-import { EscrowStatus } from './types';
 
 export interface IAllocation {
   escrowAddress: string;
@@ -23,9 +22,18 @@ export interface IStaker {
   tokensAvailable: BigNumber;
 }
 
+type EscrowStatus =
+  | 'Launched'
+  | 'Pending'
+  | 'Partial'
+  | 'Paid'
+  | 'Complete'
+  | 'Cancelled';
+
 export interface IEscrowsFilter {
-  launcherAddress?: string;
-  role?: number;
+  launcher?: string;
+  reputationOracle?: string;
+  recordingOracle?: string;
   status?: EscrowStatus;
   from?: Date;
   to?: Date;
@@ -46,3 +54,8 @@ export interface IKeyPair {
   passphrase: string;
   revocationCertificate?: string;
 }
+
+export interface IStatisticsParams {
+  from?: Date;
+  to?: Date;
+}

package/src/statistics.ts

@@ -0,0 +1,196 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import gqlFetch from 'graphql-request';
+
+import {
+  GET_ESCROW_STATISTICS_QUERY,
+  GET_EVENT_DAY_DATA_QUERY,
+  GET_HOLDERS_QUERY,
+  GET_HMTOKEN_STATISTICS_QUERY,
+  EscrowStatistics,
+  EscrowStatisticsData,
+  EventDayData,
+  HMTStatistics,
+  HMTStatisticsData,
+  PaymentStatistics,
+  WorkerStatistics,
+  HMTHolderData,
+} from './graphql';
+import { IStatisticsParams } from './interfaces';
+import { NetworkData } from './types';
+import { throwError } from './utils';
+import { BigNumber } from 'ethers';
+
+export class StatisticsClient {
+  public network: NetworkData;
+
+  /**
+   * **StatisticsClient constructor**
+   *
+   * @param {NetworkData} network - The network information required to connect to the Statistics contract
+   */
+  constructor(network: NetworkData) {
+    this.network = network;
+  }
+
+  /**
+   * Returns the escrow statistics data for the given date range
+   *
+   * @param {IStatisticsParams} params - Filter parameters.
+   * @returns {Promise<EscrowStatistics>}
+   * @throws {Error} - An error object if an error occurred.
+   */
+  async getEscrowStatistics(
+    params: IStatisticsParams = {}
+  ): Promise<EscrowStatistics> {
+    try {
+      const { escrowStatistics } = await gqlFetch<{
+        escrowStatistics: EscrowStatisticsData;
+      }>(this.network.subgraphUrl, GET_ESCROW_STATISTICS_QUERY);
+
+      const { eventDayDatas } = await gqlFetch<{
+        eventDayDatas: EventDayData[];
+      }>(this.network.subgraphUrl, GET_EVENT_DAY_DATA_QUERY(params), {
+        from: params.from ? params.from.getTime() / 1000 : undefined,
+        to: params.to ? params.to.getTime() / 1000 : undefined,
+      });
+
+      return {
+        totalEscrows: +escrowStatistics.totalEscrowCount,
+        dailyEscrowsData: eventDayDatas.map((eventDayData) => ({
+          timestamp: new Date(+eventDayData.timestamp * 1000),
+          escrowsTotal: +eventDayData.dailyEscrowCount,
+          escrowsPending: +eventDayData.dailyPendingStatusEventCount,
+          escrowsSolved: +eventDayData.dailyCompletedStatusEventCount,
+          escrowsPaid: +eventDayData.dailyPaidStatusEventCount,
+          escrowsCancelled: +eventDayData.dailyCancelledStatusEventCount,
+        })),
+      };
+    } catch (e: any) {
+      return throwError(e);
+    }
+  }
+
+  /**
+   * Returns the worker statistics data for the given date range
+   *
+   * @param {IStatisticsParams} params - Filter parameters.
+   * @returns {Promise<WorkerStatistics>}
+   * @throws {Error} - An error object if an error occurred.
+   */
+  async getWorkerStatistics(
+    params: IStatisticsParams = {}
+  ): Promise<WorkerStatistics> {
+    try {
+      const { eventDayDatas } = await gqlFetch<{
+        eventDayDatas: EventDayData[];
+      }>(this.network.subgraphUrl, GET_EVENT_DAY_DATA_QUERY(params), {
+        from: params.from ? params.from.getTime() / 1000 : undefined,
+        to: params.to ? params.to.getTime() / 1000 : undefined,
+      });
+
+      return {
+        dailyWorkersData: eventDayDatas.map((eventDayData) => ({
+          timestamp: new Date(+eventDayData.timestamp * 1000),
+          activeWorkers: +eventDayData.dailyWorkerCount,
+          averageJobsSolved:
+            eventDayData.dailyWorkerCount === '0'
+              ? 0
+              : +eventDayData.dailyBulkPayoutEventCount /
+                +eventDayData.dailyWorkerCount,
+        })),
+      };
+    } catch (e: any) {
+      return throwError(e);
+    }
+  }
+
+  /**
+   * Returns the payment statistics data for the given date range
+   *
+   * @param {IStatisticsParams} params - Filter parameters.
+   * @returns {Promise<PaymentStatistics>}
+   * @throws {Error} - An error object if an error occurred.
+   */
+  async getPaymentStatistics(
+    params: IStatisticsParams = {}
+  ): Promise<PaymentStatistics> {
+    try {
+      const { eventDayDatas } = await gqlFetch<{
+        eventDayDatas: EventDayData[];
+      }>(this.network.subgraphUrl, GET_EVENT_DAY_DATA_QUERY(params), {
+        from: params.from ? params.from.getTime() / 1000 : undefined,
+        to: params.to ? params.to.getTime() / 1000 : undefined,
+      });
+
+      return {
+        dailyPaymentsData: eventDayDatas.map((eventDayData) => ({
+          timestamp: new Date(+eventDayData.timestamp * 1000),
+          totalAmountPaid: BigNumber.from(eventDayData.dailyPayoutAmount),
+          totalCount: +eventDayData.dailyPayoutCount,
+          averageAmountPerJob:
+            eventDayData.dailyBulkPayoutEventCount === '0'
+              ? BigNumber.from(0)
+              : BigNumber.from(eventDayData.dailyPayoutAmount).div(
+                  eventDayData.dailyBulkPayoutEventCount
+                ),
+          averageAmountPerWorker:
+            eventDayData.dailyWorkerCount === '0'
+              ? BigNumber.from(0)
+              : BigNumber.from(eventDayData.dailyPayoutAmount).div(
+                  eventDayData.dailyWorkerCount
+                ),
+        })),
+      };
+    } catch (e: any) {
+      return throwError(e);
+    }
+  }
+
+  /**
+   * Returns the HMToken statistics data for the given date range
+   *
+   * @param {IStatisticsParams} params - Filter parameters.
+   * @returns {Promise<HMTStatistics>}
+   * @throws {Error} - An error object if an error occurred.
+   */
+  async getHMTStatistics(
+    params: IStatisticsParams = {}
+  ): Promise<HMTStatistics> {
+    try {
+      const { hmtokenStatistics } = await gqlFetch<{
+        hmtokenStatistics: HMTStatisticsData;
+      }>(this.network.subgraphUrl, GET_HMTOKEN_STATISTICS_QUERY);
+
+      const { holders } = await gqlFetch<{
+        holders: HMTHolderData[];
+      }>(this.network.subgraphUrl, GET_HOLDERS_QUERY);
+
+      const { eventDayDatas } = await gqlFetch<{
+        eventDayDatas: EventDayData[];
+      }>(this.network.subgraphUrl, GET_EVENT_DAY_DATA_QUERY(params), {
+        from: params.from ? params.from.getTime() / 1000 : undefined,
+        to: params.to ? params.to.getTime() / 1000 : undefined,
+      });
+
+      return {
+        totalTransferAmount: BigNumber.from(
+          hmtokenStatistics.totalValueTransfered
+        ),
+        totalHolders: +hmtokenStatistics.holders,
+        holders: holders.map((holder) => ({
+          address: holder.address,
+          balance: BigNumber.from(holder.balance),
+        })),
+        dailyHMTData: eventDayDatas.map((eventDayData) => ({
+          timestamp: new Date(+eventDayData.timestamp * 1000),
+          totalTransactionAmount: BigNumber.from(
+            eventDayData.dailyHMTTransferAmount
+          ),
+          totalTransactionCount: +eventDayData.dailyHMTTransferCount,
+        })),
+      };
+    } catch (e: any) {
+      return throwError(e);
+    }
+  }
+}

package/src/storage.ts

@@ -20,17 +20,17 @@ export class StorageClient {
   /**
    * **Storage client constructor**
    *
-   * @param {StorageCredentials} credentials - Cloud storage access data
    * @param {StorageParams} params - Cloud storage params
+   * @param {StorageCredentials} credentials - Optional. Cloud storage access data. If credentials is not provided - use an anonymous access to the bucket
    */
-  constructor(credentials: StorageCredentials, params: StorageParams) {
+  constructor(params: StorageParams, credentials?: StorageCredentials) {
     try {
       this.clientParams = params;
 
       this.client = new Minio.Client({
         ...params,
-        accessKey: credentials.accessKey,
-        secretKey: credentials.secretKey,
+        accessKey: credentials?.accessKey ?? '',
+        secretKey: credentials?.secretKey ?? '',
       });
     } catch (e) {
       throw ErrorStorageClientNotInitialized;