@human-protocol/sdk 1.1.11 → 1.1.12

package/src/escrow.ts

@@ -35,11 +35,16 @@ import {
   ErrorTotalFeeMustBeLessThanHundred,
   ErrorUrlIsEmptyString,
   InvalidEthereumAddressError,
+  ErrorInvalidExchangeOracleAddressProvided,
 } from './error';
 import { IEscrowConfig, IEscrowsFilter } from './interfaces';
 import { EscrowStatus, NetworkData } from './types';
 import { isValidUrl, throwError } from './utils';
-import { EscrowData, GET_ESCROWS_QUERY } from './graphql';
+import {
+  EscrowData,
+  GET_ESCROWS_QUERY,
+  GET_ESCROW_BY_ADDRESS_QUERY,
+} from './graphql';
 
 export class EscrowClient {
   private escrowFactoryContract: EscrowFactory;
@@ -155,8 +160,10 @@ export class EscrowClient {
     const {
       recordingOracle,
       reputationOracle,
+      exchangeOracle,
       recordingOracleFee,
       reputationOracleFee,
+      exchangeOracleFee,
       manifestUrl,
       manifestHash,
     } = escrowConfig;
@@ -169,15 +176,25 @@ export class EscrowClient {
       throw ErrorInvalidReputationOracleAddressProvided;
     }
 
+    if (!ethers.utils.isAddress(exchangeOracle)) {
+      throw ErrorInvalidExchangeOracleAddressProvided;
+    }
+
     if (!ethers.utils.isAddress(escrowAddress)) {
       throw ErrorInvalidEscrowAddressProvided;
     }
 
-    if (recordingOracleFee.lte(0) || reputationOracleFee.lte(0)) {
+    if (
+      recordingOracleFee.lte(0) ||
+      reputationOracleFee.lte(0) ||
+      exchangeOracleFee.lte(0)
+    ) {
       throw ErrorAmountMustBeGreaterThanZero;
     }
 
-    if (recordingOracleFee.add(reputationOracleFee).gt(100)) {
+    if (
+      recordingOracleFee.add(reputationOracleFee).add(exchangeOracleFee).gt(100)
+    ) {
       throw ErrorTotalFeeMustBeLessThanHundred;
     }
 
@@ -205,8 +222,10 @@ export class EscrowClient {
       await this.escrowContract.setup(
         reputationOracle,
         recordingOracle,
+        exchangeOracle,
         reputationOracleFee,
         recordingOracleFee,
+        exchangeOracleFee,
         manifestUrl,
         manifestHash
       );
@@ -748,56 +767,40 @@ export class EscrowClient {
   }
 
   /**
-   * Returns the list of escrows for given filter
+   * Returns the recording oracle address of given escrow
    *
-   * @param {IEscrowsFilter} filter - Filter parameters.
-   * @returns {Promise<EscrowData[]>}
+   * @param {string} escrowAddress - Address of the escrow.
+   * @returns {Promise<string>} - Address of the recording oracle.
    * @throws {Error} - An error object if an error occurred.
    */
-  async getEscrows(filter: IEscrowsFilter = {}): Promise<EscrowData[]> {
-    if (filter.launcher && !ethers.utils.isAddress(filter.launcher)) {
-      throw ErrorInvalidAddress;
-    }
-
-    if (
-      filter.recordingOracle &&
-      !ethers.utils.isAddress(filter.recordingOracle)
-    ) {
-      throw ErrorInvalidAddress;
+  async getRecordingOracleAddress(escrowAddress: string): Promise<string> {
+    if (!ethers.utils.isAddress(escrowAddress)) {
+      throw ErrorInvalidEscrowAddressProvided;
     }
 
-    if (
-      filter.reputationOracle &&
-      !ethers.utils.isAddress(filter.reputationOracle)
-    ) {
-      throw ErrorInvalidAddress;
+    if (!(await this.escrowFactoryContract.hasEscrow(escrowAddress))) {
+      throw ErrorEscrowAddressIsNotProvidedByFactory;
     }
 
     try {
-      const { escrows } = await gqlFetch<{ escrows: EscrowData[] }>(
-        this.network.subgraphUrl,
-        GET_ESCROWS_QUERY(filter),
-        {
-          ...filter,
-          from: filter.from ? +filter.from.getTime() / 1000 : undefined,
-          to: filter.to ? +filter.to.getTime() / 1000 : undefined,
-        }
+      this.escrowContract = Escrow__factory.connect(
+        escrowAddress,
+        this.signerOrProvider
       );
-
-      return escrows;
+      return this.escrowContract.recordingOracle();
     } catch (e: any) {
       return throwError(e);
     }
   }
 
   /**
-   * Returns the recording oracle address of given escrow
+   * Returns the job launcher address of given escrow
    *
    * @param {string} escrowAddress - Address of the escrow.
-   * @returns {Promise<string>} - Address of the recording oracle.
+   * @returns {Promise<string>} - Address of the job launcher.
    * @throws {Error} - An error object if an error occurred.
    */
-  async getRecordingOracleAddress(escrowAddress: string): Promise<string> {
+  async getJobLauncherAddress(escrowAddress: string): Promise<string> {
     if (!ethers.utils.isAddress(escrowAddress)) {
       throw ErrorInvalidEscrowAddressProvided;
     }
@@ -811,20 +814,20 @@ export class EscrowClient {
         escrowAddress,
         this.signerOrProvider
       );
-      return this.escrowContract.recordingOracle();
+      return this.escrowContract.launcher();
     } catch (e: any) {
       return throwError(e);
     }
   }
 
   /**
-   * Returns the job launcher address of given escrow
+   * Returns the reputation oracle address of given escrow
    *
    * @param {string} escrowAddress - Address of the escrow.
-   * @returns {Promise<string>} - Address of the job launcher.
+   * @returns {Promise<string>} - Address of the reputation oracle.
    * @throws {Error} - An error object if an error occurred.
    */
-  async getJobLauncherAddress(escrowAddress: string): Promise<string> {
+  async getReputationOracleAddress(escrowAddress: string): Promise<string> {
     if (!ethers.utils.isAddress(escrowAddress)) {
       throw ErrorInvalidEscrowAddressProvided;
     }
@@ -838,7 +841,7 @@ export class EscrowClient {
         escrowAddress,
         this.signerOrProvider
       );
-      return this.escrowContract.launcher();
+      return this.escrowContract.reputationOracle();
     } catch (e: any) {
       return throwError(e);
     }
@@ -851,7 +854,7 @@ export class EscrowClient {
    * @returns {Promise<string>} - Address of the reputation oracle.
    * @throws {Error} - An error object if an error occurred.
    */
-  async getReputationOracleAddress(escrowAddress: string): Promise<string> {
+  async getExchangeOracleAddress(escrowAddress: string): Promise<string> {
     if (!ethers.utils.isAddress(escrowAddress)) {
       throw ErrorInvalidEscrowAddressProvided;
     }
@@ -865,7 +868,7 @@ export class EscrowClient {
         escrowAddress,
         this.signerOrProvider
       );
-      return this.escrowContract.reputationOracle();
+      return this.escrowContract.exchangeOracle();
     } catch (e: any) {
       return throwError(e);
     }
@@ -898,3 +901,111 @@ export class EscrowClient {
     }
   }
 }
+
+export class EscrowUtils {
+  /**
+   * Returns the list of escrows for given filter
+   *
+   * @param {IEscrowsFilter} filter - Filter parameters.
+   * @returns {Promise<EscrowData[]>}
+   * @throws {Error} - An error object if an error occurred.
+   */
+  public static async getEscrows(
+    filter: IEscrowsFilter
+  ): Promise<EscrowData[]> {
+    if (!filter?.networks?.length) {
+      throw ErrorUnsupportedChainID;
+    }
+    if (filter.launcher && !ethers.utils.isAddress(filter.launcher)) {
+      throw ErrorInvalidAddress;
+    }
+
+    if (
+      filter.recordingOracle &&
+      !ethers.utils.isAddress(filter.recordingOracle)
+    ) {
+      throw ErrorInvalidAddress;
+    }
+
+    if (
+      filter.reputationOracle &&
+      !ethers.utils.isAddress(filter.reputationOracle)
+    ) {
+      throw ErrorInvalidAddress;
+    }
+
+    if (
+      filter.exchangeOracle &&
+      !ethers.utils.isAddress(filter.exchangeOracle)
+    ) {
+      throw ErrorInvalidAddress;
+    }
+
+    try {
+      const escrowAddresses: EscrowData[] = [];
+      for (const chainId of filter.networks) {
+        const networkData = NETWORKS[chainId];
+
+        if (!networkData) {
+          throw ErrorUnsupportedChainID;
+        }
+
+        const { escrows } = await gqlFetch<{ escrows: EscrowData[] }>(
+          networkData.subgraphUrl,
+          GET_ESCROWS_QUERY(filter),
+          {
+            ...filter,
+            status: filter.status
+              ? Object.entries(EscrowStatus).find(
+                  ([, value]) => value === filter.status
+                )?.[0]
+              : undefined,
+            from: filter.from ? +filter.from.getTime() / 1000 : undefined,
+            to: filter.to ? +filter.to.getTime() / 1000 : undefined,
+          }
+        );
+        escrows.map((escrow) => (escrow.chainId = networkData.chainId));
+        escrowAddresses.push(...escrows);
+      }
+      escrowAddresses.sort((a, b) => Number(b.createdAt) - Number(a.createdAt));
+      return escrowAddresses;
+    } catch (e: any) {
+      return throwError(e);
+    }
+  }
+
+  /**
+   * Returns the escrow for a given address
+   *
+   * @param {string} escrowAddress - Escrow address.
+   * @param {ChainId} chainId - Chain id.
+   * @returns {Promise<EscrowData>}
+   * @throws {Error} - An error object if an error occurred.
+   */
+  public static async getEscrow(
+    chainId: ChainId,
+    escrowAddress: string
+  ): Promise<EscrowData> {
+    const networkData = NETWORKS[chainId];
+
+    if (!networkData) {
+      throw ErrorUnsupportedChainID;
+    }
+
+    if (escrowAddress && !ethers.utils.isAddress(escrowAddress)) {
+      throw ErrorInvalidAddress;
+    }
+
+    try {
+      const { escrow } = await gqlFetch<{ escrow: EscrowData }>(
+        networkData.subgraphUrl,
+        GET_ESCROW_BY_ADDRESS_QUERY(),
+        { escrowAddress }
+      );
+
+      return escrow || null;
+    } catch (e: any) {
+      return throwError(e);
+    }
+  }
+}

package/src/graphql/queries/escrow.ts

@@ -11,6 +11,7 @@ const ESCROW_FRAGMENT = gql`
     finalResultsUrl
     id
     intermediateResultsUrl
+    jobRequesterId
     launcher
     manifestHash
     manifestUrl
@@ -18,6 +19,8 @@ const ESCROW_FRAGMENT = gql`
     recordingOracleFee
     reputationOracle
     reputationOracleFee
+    exchangeOracle
+    exchangeOracleFee
     status
     token
     totalFundedAmount
@@ -25,15 +28,34 @@ const ESCROW_FRAGMENT = gql`
   }
 `;
 
+export const GET_ESCROW_BY_ADDRESS_QUERY = () => gql`
+  query getEscrowByAddress($escrowAddress: String!) {
+    escrow(id: $escrowAddress) {
+      ...EscrowFields
+    }
+  }
+  ${ESCROW_FRAGMENT}
+`;
+
 export const GET_ESCROWS_QUERY = (filter: IEscrowsFilter) => {
-  const { launcher, reputationOracle, recordingOracle, status, from, to } =
-    filter;
+  const {
+    launcher,
+    jobRequesterId,
+    reputationOracle,
+    recordingOracle,
+    exchangeOracle,
+    status,
+    from,
+    to,
+  } = filter;
 
   const WHERE_CLAUSE = `
     where: {
       ${launcher ? `launcher: $launcher` : ''}
+      ${jobRequesterId ? `jobRequesterId: $jobRequesterId` : ''}
       ${reputationOracle ? `reputationOracle: $reputationOracle` : ''}
       ${recordingOracle ? `recordingOracle: $recordingOracle` : ''}
+      ${exchangeOracle ? `exchangeOracle: $exchangeOracle` : ''}
       ${status ? `status: $status` : ''}
       ${from ? `createdAt_gte: $from` : ''}
       ${to ? `createdAt_lte: $to` : ''}
@@ -43,8 +65,10 @@ export const GET_ESCROWS_QUERY = (filter: IEscrowsFilter) => {
   return gql`
     query getEscrows(
       $launcher: String
+      $jobRequesterId: String
       $reputationOracle: String
       $recordingOracle: String
+      $exchangeOracle: String
       $status: String
       $from: Int
       $to: Int

package/src/graphql/queries/index.ts

@@ -2,3 +2,4 @@ export * from './escrow';
 export * from './hmtoken';
 export * from './reward';
 export * from './statistics';
+export * from './payout';

package/src/graphql/queries/payout.ts

@@ -0,0 +1,41 @@
+import gql from 'graphql-tag';
+import { IPayoutFilter } from '../../interfaces';
+
+const PAYOUT_FRAGMENT = gql`
+  fragment PayoutFields on Payout {
+    id
+    escrowAddress
+    recipient
+    amount
+    createdAt
+  }
+`;
+
+export const GET_PAYOUTS_QUERY = (filter: IPayoutFilter) => {
+  const { escrowAddress, recipient, from, to } = filter;
+
+  const WHERE_CLAUSE = `
+    where: {
+      ${escrowAddress ? `escrowAddress: $escrowAddress` : ''}
+      ${recipient ? `recipient: $recipient` : ''}
+      ${from ? `createdAt_gte: $from` : ''}
+      ${to ? `createdAt_lte: $to` : ''}
+    }
+  `;
+
+  return gql`
+    query getPayouts(
+      $escrowAddress: String
+      $recipient: String
+      $from: Int
+      $to: Int
+    ) {
+      payouts(
+        ${WHERE_CLAUSE}
+      ) {
+        ...PayoutFields
+      }
+    }
+    ${PAYOUT_FRAGMENT}
+  `;
+};

package/src/graphql/queries/staking.ts

@@ -0,0 +1,57 @@
+import gql from 'graphql-tag';
+import { ILeadersFilter } from 'src/interfaces';
+
+const LEADER_FRAGMENT = gql`
+  fragment LeaderFields on Leader {
+    id
+    address
+    amountStaked
+    amountAllocated
+    amountLocked
+    lockedUntilTimestamp
+    amountWithdrawn
+    amountSlashed
+    reputation
+    reward
+    amountJobsLaunched
+    role
+    fee
+    publicKey
+    webhookUrl
+    url
+  }
+`;
+
+export const GET_LEADERS_QUERY = (filter: ILeadersFilter) => {
+  const { role } = filter;
+
+  const WHERE_CLAUSE = `
+    where: {
+      ${role ? `role: $role` : ''}
+    }
+  `;
+
+  return gql`
+    query getLeaders(
+      $role: String
+    ) {
+      leaders(
+        ${WHERE_CLAUSE}
+        orderBy: amountStaked,
+        orderDirection: desc,
+      ) {
+        ...LeaderFields
+      }
+    }
+    ${LEADER_FRAGMENT}
+  `;
+};
+
+export const GET_LEADER_QUERY = gql`
+  query getLeader($address: String!) {
+    leader(id: $address) {
+      ...LeaderFields
+    }
+  }
+  ${LEADER_FRAGMENT}
+`;

package/src/graphql/queries/statistics.ts

@@ -69,17 +69,25 @@ export const GET_ESCROW_STATISTICS_QUERY = gql`
 `;
 
 export const GET_EVENT_DAY_DATA_QUERY = (params: IStatisticsParams) => {
-  const { from, to } = params;
+  const { from, to, limit } = 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) {
-      eventDayDatas(${WHERE_CLAUSE}) {
+      eventDayDatas(
+        ${WHERE_CLAUSE},
+        orderBy: timestamp,
+        orderDirection: desc,
+        ${LIMIT_CLAUSE}
+      ) {
         ...EventDayDataFields
       }
     }

package/src/graphql/types.ts

@@ -16,10 +16,21 @@ export type EscrowData = {
   recordingOracleFee?: string;
   reputationOracle?: string;
   reputationOracleFee?: string;
+  exchangeOracle?: string;
+  exchangeOracleFee?: string;
   status: string;
   token: string;
   totalFundedAmount: string;
   createdAt: string;
+  chainId: number;
+};
+
+export type PayoutData = {
+  id: string;
+  escrowAddress: string;
+  recipient: string;
+  amount: string;
+  createdAt: string;
 };
 
 export type HMTStatisticsData = {
@@ -130,3 +141,20 @@ export type HMTStatistics = {
   holders: HMTHolder[];
   dailyHMTData: DailyHMTData[];
 };
+
+export type IMDataEntity = {
+  served: number;
+  solved: number;
+};
+
+export type IMData = Record<string, IMDataEntity>;
+
+export type DailyTaskData = {
+  timestamp: Date;
+  tasksTotal: number;
+  tasksSolved: number;
+};
+
+export type TaskStatistics = {
+  dailyTasksData: DailyTaskData[];
+};

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;
 }