@human-protocol/sdk 5.0.0-beta.1 → 5.0.0-beta.3

package/src/graphql/types.ts

@@ -1,4 +1,4 @@
-import { ChainId } from '../enums';
+import { IReputationNetwork } from '../interfaces';
 
 export type EscrowData = {
   id: string;
@@ -7,19 +7,56 @@ export type EscrowData = {
   balance: string;
   count: string;
   factoryAddress: string;
-  finalResultsUrl?: string;
-  intermediateResultsUrl?: string;
+  finalResultsUrl: string | null;
+  finalResultsHash: string | null;
+  intermediateResultsUrl: string | null;
+  intermediateResultsHash: string | null;
   launcher: string;
-  manifestHash?: string;
-  manifestUrl?: string;
-  recordingOracle?: string;
-  reputationOracle?: string;
-  exchangeOracle?: string;
+  jobRequesterId: string | null;
+  manifestHash: string | null;
+  manifest: string | null;
+  recordingOracle: string | null;
+  reputationOracle: string | null;
+  exchangeOracle: string | null;
+  recordingOracleFee: string | null;
+  reputationOracleFee: string | null;
+  exchangeOracleFee: string | null;
   status: string;
   token: string;
   totalFundedAmount: string;
   createdAt: string;
-  chainId: number;
+};
+
+export type WorkerData = {
+  id: string;
+  address: string;
+  totalHMTAmountReceived: string;
+  payoutCount: string;
+};
+
+export type InternalTransactionData = {
+  from: string;
+  to: string;
+  value: string;
+  method: string;
+  receiver: string | null;
+  escrow: string | null;
+  token: string | null;
+  id: string | null;
+};
+
+export type TransactionData = {
+  block: string;
+  txHash: string;
+  from: string;
+  to: string;
+  timestamp: string;
+  value: string;
+  method: string;
+  receiver: string | null;
+  escrow: string | null;
+  token: string | null;
+  internalTransactions: InternalTransactionData[];
 };
 
 export type HMTStatisticsData = {
@@ -72,86 +109,15 @@ export type RewardAddedEventData = {
   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;
-};
-
-export type WorkerStatistics = {
-  dailyWorkersData: DailyWorkerData[];
-};
-
-export type DailyPaymentData = {
-  timestamp: Date;
-  totalAmountPaid: bigint;
-  totalCount: number;
-  averageAmountPerWorker: bigint;
-};
-
-export type PaymentStatistics = {
-  dailyPaymentsData: DailyPaymentData[];
-};
-
 export type HMTHolderData = {
   address: string;
   balance: string;
 };
 
-export type HMTHolder = {
-  address: string;
-  balance: bigint;
-};
-
-export type DailyHMTData = {
-  timestamp: Date;
-  totalTransactionAmount: bigint;
-  totalTransactionCount: number;
-  dailyUniqueSenders: number;
-  dailyUniqueReceivers: number;
-};
-
-export type HMTStatistics = {
-  totalTransferAmount: bigint;
-  totalTransferCount: number;
-  totalHolders: number;
-};
-
-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[];
-};
-
 export type StatusEvent = {
-  timestamp: number;
+  timestamp: string;
   escrowAddress: string;
   status: string;
-  chainId: ChainId;
 };
 
 export type KVStoreData = {
@@ -160,5 +126,65 @@ export type KVStoreData = {
   key: string;
   value: string;
   timestamp: Date;
-  block: number;
+  block: string;
+};
+
+export type StakerData = {
+  id: string;
+  address: string;
+  stakedAmount: string;
+  lockedAmount: string;
+  withdrawnAmount: string;
+  slashedAmount: string;
+  lockedUntilTimestamp: string;
+  lastDepositTimestamp: string;
+};
+
+export interface IOperatorSubgraph {
+  id: string;
+  address: string;
+  amountJobsProcessed: string;
+  role: string | null;
+  fee: string | null;
+  publicKey: string | null;
+  webhookUrl: string | null;
+  website: string | null;
+  url: string | null;
+  registrationNeeded: boolean | null;
+  registrationInstructions: string | null;
+  name: string | null;
+  category: string | null;
+  jobTypes: string | string[] | null;
+  reputationNetworks: { address: string }[];
+  staker: {
+    stakedAmount: string;
+    lockedAmount: string;
+    lockedUntilTimestamp: string;
+    withdrawnAmount: string;
+    slashedAmount: string;
+    lastDepositTimestamp: string;
+  } | null;
+}
+
+export interface IReputationNetworkSubgraph
+  extends Omit<IReputationNetwork, 'operators'> {
+  operators: IOperatorSubgraph[];
+}
+
+export type PayoutData = {
+  id: string;
+  escrowAddress: string;
+  recipient: string;
+  amount: string;
+  createdAt: string;
+};
+
+export type CancellationRefundData = {
+  id: string;
+  escrowAddress: string;
+  receiver: string;
+  amount: string;
+  block: string;
+  timestamp: string;
+  txHash: string;
 };

package/src/index.ts

@@ -13,6 +13,18 @@ export * from './types';
 export * from './enums';
 export * from './interfaces';
 
+export {
+  EthereumError,
+  InvalidArgumentError,
+  ReplacementUnderpriced,
+  NumericFault,
+  NonceExpired,
+  TransactionReplaced,
+  ContractExecutionError,
+  InvalidEthereumAddressError,
+  InvalidKeyError,
+} from './error';
+
 export {
   StakingClient,
   StorageClient,

package/src/interfaces.ts

@@ -10,50 +10,24 @@ export interface IOperator {
   id: string;
   chainId: ChainId;
   address: string;
-  stakedAmount: bigint;
-  lockedAmount: bigint;
-  lockedUntilTimestamp: bigint;
-  withdrawnAmount: bigint;
-  slashedAmount: bigint;
-  amountJobsProcessed: bigint;
-  role?: string;
-  fee?: bigint;
-  publicKey?: string;
-  webhookUrl?: string;
-  website?: string;
-  url?: string;
-  jobTypes?: string[];
-  registrationNeeded?: boolean;
-  registrationInstructions?: string;
-  reputationNetworks?: string[];
-  name?: string;
-  category?: string;
-}
-
-export interface IOperatorSubgraph {
-  id: string;
-  address: string;
-  amountJobsProcessed: bigint;
-  role?: string;
-  fee?: bigint;
-  publicKey?: string;
-  webhookUrl?: string;
-  website?: string;
-  url?: string;
-  registrationNeeded?: boolean;
-  registrationInstructions?: string;
-  name?: string;
-  category?: string;
-  jobTypes?: string | string[];
-  reputationNetworks?: { address: string }[];
-  staker?: {
-    stakedAmount: bigint;
-    lockedAmount: bigint;
-    lockedUntilTimestamp: bigint;
-    withdrawnAmount: bigint;
-    slashedAmount: bigint;
-    lastDepositTimestamp: bigint;
-  };
+  stakedAmount: bigint | null;
+  lockedAmount: bigint | null;
+  lockedUntilTimestamp: number | null;
+  withdrawnAmount: bigint | null;
+  slashedAmount: bigint | null;
+  amountJobsProcessed: bigint | null;
+  role: string | null;
+  fee: bigint | null;
+  publicKey: string | null;
+  webhookUrl: string | null;
+  website: string | null;
+  url: string | null;
+  jobTypes: string[] | null;
+  registrationNeeded: boolean | null;
+  registrationInstructions: string | null;
+  reputationNetworks: string[];
+  name: string | null;
+  category: string | null;
 }
 
 export interface IOperatorsFilter extends IPagination {
@@ -69,30 +43,31 @@ export interface IReputationNetwork {
   operators: IOperator[];
 }
 
-export interface IReputationNetworkSubgraph
-  extends Omit<IReputationNetwork, 'operators'> {
-  operators: IOperatorSubgraph[];
-}
-
 export interface IEscrow {
   id: string;
   address: string;
-  amountPaid: string;
-  balance: string;
-  count: string;
+  amountPaid: bigint;
+  balance: bigint;
+  count: number;
   factoryAddress: string;
-  finalResultsUrl?: string;
-  intermediateResultsUrl?: string;
+  finalResultsUrl: string | null;
+  finalResultsHash: string | null;
+  intermediateResultsUrl: string | null;
+  intermediateResultsHash: string | null;
   launcher: string;
-  manifestHash?: string;
-  manifest?: string;
-  recordingOracle?: string;
-  reputationOracle?: string;
-  exchangeOracle?: string;
+  jobRequesterId: string | null;
+  manifestHash: string | null;
+  manifest: string | null;
+  recordingOracle: string | null;
+  reputationOracle: string | null;
+  exchangeOracle: string | null;
+  recordingOracleFee: number | null;
+  reputationOracleFee: number | null;
+  exchangeOracleFee: number | null;
   status: string;
   token: string;
-  totalFundedAmount: string;
-  createdAt: string;
+  totalFundedAmount: bigint;
+  createdAt: number;
   chainId: number;
 }
 
@@ -151,11 +126,11 @@ export interface IKVStore {
 export interface InternalTransaction {
   from: string;
   to: string;
-  value: string;
+  value: bigint;
   method: string;
-  receiver?: string;
-  escrow?: string;
-  token?: string;
+  receiver: string | null;
+  escrow: string | null;
+  token: string | null;
 }
 
 export interface ITransaction {
@@ -163,12 +138,12 @@ export interface ITransaction {
   txHash: string;
   from: string;
   to: string;
-  timestamp: bigint;
-  value: string;
+  timestamp: number;
+  value: bigint;
   method: string;
-  receiver?: string;
-  escrow?: string;
-  token?: string;
+  receiver: string | null;
+  escrow: string | null;
+  token: string | null;
   internalTransactions: InternalTransaction[];
 }
 
@@ -209,7 +184,7 @@ export interface IStatusEventFilter extends IPagination {
 export interface IWorker {
   id: string;
   address: string;
-  totalHMTAmountReceived: number;
+  totalHMTAmountReceived: bigint;
   payoutCount: number;
 }
 
@@ -223,10 +198,10 @@ export interface IStaker {
   address: string;
   stakedAmount: bigint;
   lockedAmount: bigint;
-  lockedUntil: bigint;
   withdrawableAmount: bigint;
   slashedAmount: bigint;
-  lastDepositTimestamp: bigint;
+  lockedUntil: number;
+  lastDepositTimestamp: number;
 }
 
 export interface IStakersFilter extends IPagination {
@@ -253,3 +228,87 @@ export interface ICancellationRefundFilter extends IPagination {
   from?: Date;
   to?: Date;
 }
+
+export interface IDailyEscrow {
+  timestamp: number;
+  escrowsTotal: number;
+  escrowsPending: number;
+  escrowsSolved: number;
+  escrowsPaid: number;
+  escrowsCancelled: number;
+}
+
+export interface IEscrowStatistics {
+  totalEscrows: number;
+  dailyEscrowsData: IDailyEscrow[];
+}
+
+export interface IDailyWorker {
+  timestamp: number;
+  activeWorkers: number;
+}
+
+export interface IWorkerStatistics {
+  dailyWorkersData: IDailyWorker[];
+}
+
+export interface IDailyPayment {
+  timestamp: number;
+  totalAmountPaid: bigint;
+  totalCount: number;
+  averageAmountPerWorker: bigint;
+}
+
+export interface IPaymentStatistics {
+  dailyPaymentsData: IDailyPayment[];
+}
+
+export interface IHMTStatistics {
+  totalTransferAmount: bigint;
+  totalTransferCount: number;
+  totalHolders: number;
+}
+
+export interface IHMTHolder {
+  address: string;
+  balance: bigint;
+}
+
+export interface IDailyHMT {
+  timestamp: number;
+  totalTransactionAmount: bigint;
+  totalTransactionCount: number;
+  dailyUniqueSenders: number;
+  dailyUniqueReceivers: number;
+}
+
+export interface IStatusEvent {
+  timestamp: number;
+  escrowAddress: string;
+  status: EscrowStatus;
+  chainId: ChainId;
+}
+
+export interface ICancellationRefund {
+  id: string;
+  escrowAddress: string;
+  receiver: string;
+  amount: bigint;
+  block: number;
+  timestamp: number;
+  txHash: string;
+}
+
+export interface IPayout {
+  id: string;
+  escrowAddress: string;
+  recipient: string;
+  amount: bigint;
+  createdAt: number;
+}
+
+export interface IEscrowWithdraw {
+  txHash: string;
+  tokenAddress: string;
+  withdrawnAmount: bigint;
+}

package/src/operator.ts

@@ -1,14 +1,12 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import gqlFetch from 'graphql-request';
+import { IOperator, IOperatorsFilter, IReward } from './interfaces';
+import { GET_REWARD_ADDED_EVENTS_QUERY } from './graphql/queries/reward';
 import {
-  IOperator,
   IOperatorSubgraph,
-  IOperatorsFilter,
   IReputationNetworkSubgraph,
-  IReward,
-} from './interfaces';
-import { GET_REWARD_ADDED_EVENTS_QUERY } from './graphql/queries/reward';
-import { RewardAddedEventData } from './graphql';
+  RewardAddedEventData,
+} from './graphql';
 import {
   GET_LEADER_QUERY,
   GET_LEADERS_QUERY,
@@ -30,7 +28,7 @@ export class OperatorUtils {
    *
    * @param {ChainId} chainId Network in which the operator is deployed
    * @param {string} address Operator address.
-   * @returns {Promise<IOperator>} Returns the operator details.
+   * @returns {Promise<IOperator | null>} - Returns the operator details or null if not found.
    *
    * **Code example**
    *
@@ -43,7 +41,7 @@ export class OperatorUtils {
   public static async getOperator(
     chainId: ChainId,
     address: string
-  ): Promise<IOperator> {
+  ): Promise<IOperator | null> {
     if (!ethers.isAddress(address)) {
       throw ErrorInvalidStakerAddressProvided;
     }
@@ -60,7 +58,7 @@ export class OperatorUtils {
     });
 
     if (!operator) {
-      return null as any;
+      return null;
     }
 
     return mapOperator(operator, chainId);
@@ -236,14 +234,20 @@ function mapOperator(operator: IOperatorSubgraph, chainId: ChainId): IOperator {
     id: operator.id,
     chainId,
     address: operator.address,
-    stakedAmount: BigInt(staker?.stakedAmount || 0),
-    lockedAmount: BigInt(staker?.lockedAmount || 0),
-    lockedUntilTimestamp: BigInt(staker?.lockedUntilTimestamp || 0),
-    withdrawnAmount: BigInt(staker?.withdrawnAmount || 0),
-    slashedAmount: BigInt(staker?.slashedAmount || 0),
-    amountJobsProcessed: BigInt(operator.amountJobsProcessed || 0),
+    stakedAmount: staker?.stakedAmount ? BigInt(staker?.stakedAmount) : null,
+    lockedAmount: staker?.lockedAmount ? BigInt(staker?.lockedAmount) : null,
+    lockedUntilTimestamp: staker?.lockedUntilTimestamp
+      ? Number(staker.lockedUntilTimestamp) * 1000
+      : null,
+    withdrawnAmount: staker?.withdrawnAmount
+      ? BigInt(staker?.withdrawnAmount)
+      : null,
+    slashedAmount: staker?.slashedAmount ? BigInt(staker?.slashedAmount) : null,
+    amountJobsProcessed: operator.amountJobsProcessed
+      ? BigInt(operator.amountJobsProcessed)
+      : null,
     role: operator.role,
-    fee: operator.fee ? BigInt(operator.fee) : undefined,
+    fee: operator.fee ? BigInt(operator.fee) : null,
     publicKey: operator.publicKey,
     webhookUrl: operator.webhookUrl,
     website: operator.website,

package/src/staking.ts

@@ -24,6 +24,7 @@ import {
   ErrorUnsupportedChainID,
 } from './error';
 import { IStaker, IStakersFilter, StakerInfo } from './interfaces';
+import { StakerData } from './graphql';
 import { NetworkData } from './types';
 import { getSubgraphUrl, throwError } from './utils';
 import {
@@ -509,7 +510,7 @@ export class StakingUtils {
       throw ErrorUnsupportedChainID;
     }
 
-    const { staker } = await gqlFetch<{ staker: IStaker }>(
+    const { staker } = await gqlFetch<{ staker: StakerData }>(
       getSubgraphUrl(networkData),
       GET_STAKER_BY_ADDRESS_QUERY,
       { id: stakerAddress.toLowerCase() }
@@ -519,7 +520,7 @@ export class StakingUtils {
       throw ErrorStakerNotFound;
     }
 
-    return staker;
+    return mapStaker(staker);
   }
 
   /**
@@ -539,7 +540,7 @@ export class StakingUtils {
       throw ErrorUnsupportedChainID;
     }
 
-    const { stakers } = await gqlFetch<{ stakers: IStaker[] }>(
+    const { stakers } = await gqlFetch<{ stakers: StakerData[] }>(
       getSubgraphUrl(networkData),
       GET_STAKERS_QUERY(filter),
       {
@@ -577,6 +578,18 @@ export class StakingUtils {
       return [];
     }
 
-    return stakers;
+    return stakers.map((s) => mapStaker(s));
   }
 }
+
+function mapStaker(s: StakerData): IStaker {
+  return {
+    address: s.address,
+    stakedAmount: BigInt(s.stakedAmount),
+    lockedAmount: BigInt(s.lockedAmount),
+    withdrawableAmount: BigInt(s.withdrawnAmount),
+    slashedAmount: BigInt(s.slashedAmount),
+    lockedUntil: Number(s.lockedUntilTimestamp) * 1000,
+    lastDepositTimestamp: Number(s.lastDepositTimestamp) * 1000,
+  };
+}