@human-protocol/sdk 1.1.11 → 1.1.13

package/src/index.ts

@@ -1,7 +1,7 @@
 import { StakingClient } from './staking';
 import { StorageClient } from './storage';
 import { KVStoreClient } from './kvstore';
-import { EscrowClient } from './escrow';
+import { EscrowClient, EscrowUtils } from './escrow';
 import { StatisticsClient } from './statistics';
 
 export * from './constants';
@@ -14,5 +14,6 @@ export {
   StorageClient,
   KVStoreClient,
   EscrowClient,
+  EscrowUtils,
   StatisticsClient,
 };

package/src/interfaces.ts

@@ -1,4 +1,6 @@
 import { BigNumber } from 'ethers';
+import { EscrowStatus } from './types';
+import { ChainId } from './enums';
 
 export interface IAllocation {
   escrowAddress: string;
@@ -13,37 +15,48 @@ export interface IReward {
   amount: BigNumber;
 }
 
-export interface IStaker {
-  staker: string;
-  tokensStaked: BigNumber;
-  tokensAllocated: BigNumber;
-  tokensLocked: BigNumber;
-  tokensLockedUntil: BigNumber;
-  tokensAvailable: BigNumber;
+export interface ILeader {
+  id: string;
+  address: string;
+  amountStaked: BigNumber;
+  amountAllocated: BigNumber;
+  amountLocked: BigNumber;
+  lockedUntilTimestamp: BigNumber;
+  amountWithdrawn: BigNumber;
+  amountSlashed: BigNumber;
+  reputation: BigNumber;
+  reward: BigNumber;
+  amountJobsLaunched: BigNumber;
+  role?: string;
+  fee?: BigNumber;
+  publicKey?: string;
+  webhookUrl?: string;
+  url?: string;
 }
 
-type EscrowStatus =
-  | 'Launched'
-  | 'Pending'
-  | 'Partial'
-  | 'Paid'
-  | 'Complete'
-  | 'Cancelled';
+export interface ILeadersFilter {
+  role?: string;
+}
 
 export interface IEscrowsFilter {
   launcher?: string;
   reputationOracle?: string;
   recordingOracle?: string;
+  exchangeOracle?: string;
+  jobRequesterId?: string;
   status?: EscrowStatus;
   from?: Date;
   to?: Date;
+  networks: ChainId[];
 }
 
 export interface IEscrowConfig {
   recordingOracle: string;
   reputationOracle: string;
+  exchangeOracle: string;
   recordingOracleFee: BigNumber;
   reputationOracleFee: BigNumber;
+  exchangeOracleFee: BigNumber;
   manifestUrl: string;
   manifestHash: string;
 }
@@ -58,4 +71,12 @@ export interface IKeyPair {
 export interface IStatisticsParams {
   from?: Date;
   to?: Date;
+  limit?: number;
+}
+
+export interface IPayoutFilter {
+  escrowAddress?: string;
+  recipient?: string;
+  from?: Date;
+  to?: Date;
 }

package/src/staking.ts

@@ -24,14 +24,14 @@ import {
   ErrorInvalidStakingValueSign,
   ErrorInvalidStakingValueType,
   ErrorProviderDoesNotExist,
-  ErrorStakingGetStakers,
   ErrorUnsupportedChainID,
 } from './error';
-import { IAllocation, IReward, IStaker } from './interfaces';
+import { IAllocation, ILeader, ILeadersFilter, IReward } from './interfaces';
 import { NetworkData } from './types';
 import { throwError } from './utils';
 import { GET_REWARD_ADDED_EVENTS_QUERY } from './graphql/queries/reward';
 import { RewardAddedEventData } from './graphql';
+import { GET_LEADER_QUERY, GET_LEADERS_QUERY } from './graphql/queries/staking';
 
 export class StakingClient {
   public signerOrProvider: Signer | Provider;
@@ -333,75 +333,45 @@ export class StakingClient {
   }
 
   /**
-   * **Returns the staking information about an staker address.*
+   * **Returns the leader details for a given address**
    *
-   * @param {string} staker - Address of the staker
-   * @returns {Promise<IStaker>} - Return staking information of the specified address
+   * @param {string} address - Leader address
+   * @returns {Promise<ILeader>} - Return leader details
    * @throws {Error} - An error object if an error occurred, result otherwise
    */
-  public async getStaker(staker: string): Promise<IStaker> {
-    if (!ethers.utils.isAddress(staker)) {
+  public async getLeader(address: string): Promise<ILeader> {
+    if (!ethers.utils.isAddress(address)) {
       throw ErrorInvalidStakerAddressProvided;
     }
 
     try {
-      const result = await this.stakingContract.getStaker(staker);
-
-      const tokensStaked = BigNumber.from(result.tokensStaked),
-        tokensAllocated = BigNumber.from(result.tokensAllocated),
-        tokensLocked = BigNumber.from(result.tokensLocked),
-        tokensLockedUntil = BigNumber.from(result.tokensLockedUntil);
-
-      const tokensAvailable = tokensStaked
-        .sub(tokensAllocated)
-        .sub(tokensLocked);
-
-      return {
-        staker,
-        tokensStaked,
-        tokensAllocated,
-        tokensLocked,
-        tokensLockedUntil,
-        tokensAvailable,
-      };
+      const { leader } = await gqlFetch<{
+        leader: ILeader;
+      }>(this.network.subgraphUrl, GET_LEADER_QUERY, {
+        address,
+      });
+
+      return leader;
     } catch (e) {
       return throwError(e);
     }
   }
 
   /**
-   * **Returns the staking information about all stakers of the protocol.*
+   * **Returns the leaders data **
    *
-   * @returns {Promise<IStaker[]>} - Return an array with all stakers information
+   * @returns {Promise<ILeader[]>} - Return an array with leaders data
    * @throws {Error} - An error object if an error occurred, results otherwise
    */
-  public async getAllStakers(): Promise<IStaker[]> {
+  public async getLeaders(filter: ILeadersFilter = {}): Promise<ILeader[]> {
     try {
-      const result = await this.stakingContract.getListOfStakers();
-
-      if (result[1].length === 0) {
-        throw ErrorStakingGetStakers;
-      }
-
-      return result[1].map((staker: any, index: number) => {
-        const tokensStaked = BigNumber.from(staker.tokensStaked),
-          tokensAllocated = BigNumber.from(staker.tokensAllocated),
-          tokensLocked = BigNumber.from(staker.tokensLocked),
-          tokensLockedUntil = BigNumber.from(staker.tokensLockedUntil);
-
-        const tokensAvailable = tokensStaked
-          .sub(tokensAllocated)
-          .sub(tokensLocked);
-
-        return {
-          staker: result[0][index],
-          tokensStaked,
-          tokensAllocated,
-          tokensLocked,
-          tokensLockedUntil,
-          tokensAvailable,
-        };
+      const { leaders } = await gqlFetch<{
+        leaders: ILeader[];
+      }>(this.network.subgraphUrl, GET_LEADERS_QUERY(filter), {
+        role: filter.role,
       });
+
+      return leaders;
     } catch (e) {
       return throwError(e);
     }

package/src/statistics.ts

@@ -1,4 +1,5 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
+import { BigNumber } from 'ethers';
 import gqlFetch from 'graphql-request';
 
 import {
@@ -18,7 +19,6 @@ import {
 import { IStatisticsParams } from './interfaces';
 import { NetworkData } from './types';
 import { throwError } from './utils';
-import { BigNumber } from 'ethers';
 
 export class StatisticsClient {
   public network: NetworkData;
@@ -92,11 +92,6 @@ export class StatisticsClient {
         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) {
@@ -127,12 +122,6 @@ export class StatisticsClient {
           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)
@@ -176,6 +165,7 @@ export class StatisticsClient {
         totalTransferAmount: BigNumber.from(
           hmtokenStatistics.totalValueTransfered
         ),
+        totalTransferCount: Number(hmtokenStatistics.totalTransferEventCount),
         totalHolders: +hmtokenStatistics.holders,
         holders: holders.map((holder) => ({
           address: holder.address,

package/src/storage.ts

@@ -13,6 +13,9 @@ import { UploadFile, StorageCredentials, StorageParams } from './types';
 import { isValidUrl } from './utils';
 import { HttpStatus } from './constants';
 
+/**
+ * @deprecated StorageClient is deprecated. Use Minio.Client directly.
+ */
 export class StorageClient {
   private client: Minio.Client;
   private clientParams: StorageParams;

package/src/types.ts

@@ -1,3 +1,5 @@
+import { BigNumber } from 'ethers';
+
 /**
  * Enum for escrow statuses.
  * @readonly
@@ -33,6 +35,7 @@ export enum EscrowStatus {
 /**
  * AWS/GCP cloud storage access data
  * @readonly
+ * @deprecated StorageClient is deprecated. Use Minio.Client directly.
  */
 export type StorageCredentials = {
   /**
@@ -45,6 +48,9 @@ export type StorageCredentials = {
   secretKey: string;
 };
 
+/**
+ * @deprecated StorageClient is deprecated. Use Minio.Client directly.
+ */
 export type StorageParams = {
   /**
    * Request endPoint
@@ -132,3 +138,17 @@ export type NetworkData = {
    */
   oldFactoryAddress: string;
 };
+
+/**
+ * Represents the response data for an escrow cancellation.
+ */
+export type EscrowCancel = {
+  /**
+   * The hash of the transaction associated with the escrow cancellation.
+   */
+  txHash: string;
+  /**
+   * The amount refunded in the escrow cancellation.
+   */
+  amountRefunded: BigNumber;
+};