@human-protocol/sdk 3.0.7 → 4.0.0

package/src/graphql/queries/operator.ts

@@ -6,42 +6,50 @@ const LEADER_FRAGMENT = gql`
     id
     address
     amountStaked
-    amountAllocated
     amountLocked
     lockedUntilTimestamp
     amountWithdrawn
     amountSlashed
-    reputation
     reward
     amountJobsProcessed
     role
     fee
     publicKey
     webhookUrl
+    website
     url
     jobTypes
     registrationNeeded
     registrationInstructions
+    reputationNetworks
   }
 `;
 
 export const GET_LEADERS_QUERY = (filter: ILeadersFilter) => {
-  const { role } = filter;
+  const { roles, minAmountStaked } = filter;
 
   const WHERE_CLAUSE = `
     where: {
-      ${role ? `role: $role` : ''}
+      ${minAmountStaked ? `amountStaked_gte: $minAmountStaked` : ''}
+      ${roles ? `role_in: $roles` : ''}
     }
   `;
 
   return gql`
     query getLeaders(
-      $role: String
+      $minAmountStaked: Int,
+      $roles: [String!]
+      $first: Int
+      $skip: Int
+      $orderBy: String
+      $orderDirection: String
     ) {
       leaders(
         ${WHERE_CLAUSE}
-        orderBy: amountStaked,
-        orderDirection: desc,
+        first: $first
+        skip: $skip
+        orderBy: $orderBy
+        orderDirection: $orderDirection
       ) {
         ...LeaderFields
       }

package/src/graphql/queries/statistics.ts

@@ -15,7 +15,6 @@ const HMTOKEN_STATISTICS_FRAGMENT = gql`
 const ESCROW_STATISTICS_FRAGMENT = gql`
   fragment EscrowStatisticsFields on EscrowStatistics {
     fundEventCount
-    setupEventCount
     storeResultsEventCount
     bulkPayoutEventCount
     pendingStatusEventCount
@@ -32,7 +31,6 @@ const EVENT_DAY_DATA_FRAGMENT = gql`
   fragment EventDayDataFields on EventDayData {
     timestamp
     dailyFundEventCount
-    dailySetupEventCount
     dailyStoreResultsEventCount
     dailyBulkPayoutEventCount
     dailyPendingStatusEventCount

package/src/graphql/queries/transaction.ts

@@ -10,35 +10,45 @@ const TRANSACTION_FRAGMENT = gql`
     timestamp
     value
     method
+    receiver
+    escrow
+    token
+    internalTransactions {
+      from
+      id
+      to
+      value
+      receiver
+      escrow
+      token
+      method
+    }
   }
 `;
 
 export const GET_TRANSACTIONS_QUERY = (filter: ITransactionsFilter) => {
   const { startDate, endDate, startBlock, endBlock, fromAddress, toAddress } =
     filter;
-
   const addressCondition =
     fromAddress === toAddress
       ? `
         ${fromAddress ? `{ from: $fromAddress }` : ''}
-        ${toAddress ? `{ to: $toAddress }` : ''}
+        ${toAddress ? `{ or: [{ or: [{ to: $toAddress }, { receiver: $toAddress }] }, {internalTransactions_: { or: [{ to: $toAddress }, { receiver: $toAddress }] } }] }` : ''}
       `
       : `
-        ${fromAddress ? `from: $fromAddress` : ''}
-        ${toAddress ? `to: $toAddress` : ''}
+        ${fromAddress ? `{ from: $fromAddress }` : ''}
+        ${toAddress ? `{ or: [{ or: [{ to: $toAddress }, { receiver: $toAddress }] }, { internalTransactions_: { or: [{ to: $toAddress }, { receiver: $toAddress }] } }] }` : ''}
       `;
 
   const WHERE_CLAUSE = `
       where: {
-        ${
-          fromAddress === toAddress
-            ? `or: [ ${addressCondition} ],`
-            : addressCondition
-        }
-        ${startDate ? `timestamp_gte: $startDate,` : ''}
-        ${endDate ? `timestamp_lte: $endDate,` : ''}
-        ${startBlock ? `block_gte: $startBlock,` : ''}
-        ${endBlock ? `block_lte: $endBlock,` : ''}
+      and: [
+        ${fromAddress && fromAddress === toAddress ? `{or: [ ${addressCondition} ]},` : `${addressCondition}`}
+        ${startDate ? `{timestamp_gte: $startDate},` : ''}
+        ${endDate ? `{timestamp_lte: $endDate},` : ''}
+        ${startBlock ? `{block_gte: $startBlock},` : ''}
+        ${endBlock ? `{block_lte: $endBlock},` : ''}
+      ]
       }
     `;
 

package/src/graphql/types.ts

@@ -41,7 +41,6 @@ export type HMTStatisticsData = {
 
 export type EscrowStatisticsData = {
   fundEventCount: string;
-  setupEventCount: string;
   storeResultsEventCount: string;
   bulkPayoutEventCount: string;
   pendingStatusEventCount: string;
@@ -56,7 +55,6 @@ export type EscrowStatisticsData = {
 export type EventDayData = {
   timestamp: string;
   dailyFundEventCount: string;
-  dailySetupEventCount: string;
   dailyStoreResultsEventCount: string;
   dailyBulkPayoutEventCount: string;
   dailyPendingStatusEventCount: string;

package/src/interfaces.ts

@@ -1,14 +1,6 @@
 import { EscrowStatus } from './types';
 import { ChainId, OrderDirection } from './enums';
 
-export interface IAllocation {
-  escrowAddress: string;
-  staker: string;
-  tokens: bigint;
-  createdAt: bigint;
-  closedAt: bigint;
-}
-
 export interface IReward {
   escrowAddress: string;
   amount: bigint;
@@ -19,31 +11,35 @@ export interface ILeader {
   chainId: ChainId;
   address: string;
   amountStaked: bigint;
-  amountAllocated: bigint;
   amountLocked: bigint;
   lockedUntilTimestamp: bigint;
   amountWithdrawn: bigint;
   amountSlashed: bigint;
-  reputation: bigint;
   reward: bigint;
   amountJobsProcessed: bigint;
   role?: string;
   fee?: bigint;
   publicKey?: string;
   webhookUrl?: string;
+  website?: string;
   url?: string;
   jobTypes?: string[];
   registrationNeeded?: boolean;
   registrationInstructions?: string;
+  reputationNetworks?: string[];
 }
 
-export interface ILeaderSubgraph extends Omit<ILeader, 'jobTypes'> {
+export interface ILeaderSubgraph
+  extends Omit<ILeader, 'jobTypes' | 'reputationNetworks' | 'chainId'> {
   jobTypes?: string;
+  reputationNetworks?: { address: string }[];
 }
 
-export interface ILeadersFilter {
+export interface ILeadersFilter extends IPagination {
   chainId: ChainId;
-  role?: string;
+  roles?: string[];
+  minAmountStaked?: number;
+  orderBy?: string;
 }
 
 export interface IReputationNetwork {
@@ -121,6 +117,16 @@ export interface IKVStore {
   value: string;
 }
 
+export interface InternalTransaction {
+  from: string;
+  to: string;
+  value: string;
+  method: string;
+  receiver?: string;
+  escrow?: string;
+  token?: string;
+}
+
 export interface ITransaction {
   block: bigint;
   txHash: string;
@@ -129,6 +135,10 @@ export interface ITransaction {
   timestamp: bigint;
   value: string;
   method: string;
+  receiver?: string;
+  escrow?: string;
+  token?: string;
+  internalTransactions: InternalTransaction[];
 }
 
 export interface ITransactionsFilter extends IPagination {
@@ -146,3 +156,10 @@ export interface IPagination {
   skip?: number;
   orderDirection?: OrderDirection;
 }
+
+export interface StakerInfo {
+  stakedAmount: bigint;
+  lockedAmount: bigint;
+  lockedUntil: bigint;
+  withdrawableAmount: bigint;
+}

package/src/kvstore.ts

@@ -29,19 +29,19 @@ import { IKVStore } from './interfaces';
 /**
  * ## Introduction
  *
- * This client enables to perform actions on KVStore contract and obtain information from both the contracts and subgraph.
+ * This client enables performing actions on KVStore contract and obtaining information from both the contracts and subgraph.
  *
  * Internally, the SDK will use one network or another according to the network ID of the `runner`.
  * To use this client, it is recommended to initialize it using the static `build` method.
  *
  * ```ts
- * static async build(runner: ContractRunner);
+ * static async build(runner: ContractRunner): Promise<KVStoreClient>;
  * ```
  *
  * A `Signer` or a `Provider` should be passed depending on the use case of this module:
  *
- * - **Signer**: when the user wants to use this model in order to send transactions caling the contract functions.
- * - **Provider**: when the user wants to use this model in order to get information from the contracts or subgraph.
+ * - **Signer**: when the user wants to use this model to send transactions calling the contract functions.
+ * - **Provider**: when the user wants to use this model to get information from the contracts or subgraph.
  *
  * ## Installation
  *
@@ -59,21 +59,21 @@ import { IKVStore } from './interfaces';
  *
  * ### Signer
  *
- * **Using private key(backend)**
+ * **Using private key (backend)**
  *
  * ```ts
  * import { KVStoreClient } from '@human-protocol/sdk';
  * import { Wallet, providers } from 'ethers';
  *
  * const rpcUrl = 'YOUR_RPC_URL';
- * const privateKey = 'YOUR_PRIVATE_KEY'
+ * const privateKey = 'YOUR_PRIVATE_KEY';
  *
  * const provider = new providers.JsonRpcProvider(rpcUrl);
  * const signer = new Wallet(privateKey, provider);
  * const kvstoreClient = await KVStoreClient.build(signer);
  * ```
  *
- * **Using Wagmi(frontend)**
+ * **Using Wagmi (frontend)**
  *
  * ```ts
  * import { useSigner, useChainId } from 'wagmi';
@@ -92,7 +92,7 @@ import { IKVStore } from './interfaces';
  * const rpcUrl = 'YOUR_RPC_URL';
  *
  * const provider = new providers.JsonRpcProvider(rpcUrl);
- * const kvstoreClient = await KVStoreClient.build(signer);
+ * const kvstoreClient = await KVStoreClient.build(provider);
  * ```
  */
 
@@ -103,7 +103,7 @@ export class KVStoreClient extends BaseEthersClient {
    * **KVStoreClient constructor**
    *
    * @param {ContractRunner} runner - The Runner object to interact with the Ethereum network
-   * @param {NetworkData} network - The network information required to connect to the KVStore contract
+   * @param {NetworkData} networkData - The network information required to connect to the KVStore contract
    */
   constructor(runner: ContractRunner, networkData: NetworkData) {
     super(runner, networkData);
@@ -123,7 +123,7 @@ export class KVStoreClient extends BaseEthersClient {
    * @throws {ErrorProviderDoesNotExist} - Thrown if the provider does not exist for the provided Signer
    * @throws {ErrorUnsupportedChainID} - Thrown if the network's chainId is not supported
    */
-  public static async build(runner: ContractRunner) {
+  public static async build(runner: ContractRunner): Promise<KVStoreClient> {
     if (!runner.provider) {
       throw ErrorProviderDoesNotExist;
     }
@@ -158,7 +158,7 @@ export class KVStoreClient extends BaseEthersClient {
    * import { KVStoreClient } from '@human-protocol/sdk';
    *
    * const rpcUrl = 'YOUR_RPC_URL';
-   * const privateKey = 'YOUR_PRIVATE_KEY'
+   * const privateKey = 'YOUR_PRIVATE_KEY';
    *
    * const provider = new providers.JsonRpcProvider(rpcUrl);
    * const signer = new Wallet(privateKey, provider);
@@ -199,7 +199,7 @@ export class KVStoreClient extends BaseEthersClient {
    * import { KVStoreClient } from '@human-protocol/sdk';
    *
    * const rpcUrl = 'YOUR_RPC_URL';
-   * const privateKey = 'YOUR_PRIVATE_KEY'
+   * const privateKey = 'YOUR_PRIVATE_KEY';
    *
    * const provider = new providers.JsonRpcProvider(rpcUrl);
    * const signer = new Wallet(privateKey, provider);
@@ -207,7 +207,7 @@ export class KVStoreClient extends BaseEthersClient {
    *
    * const keys = ['role', 'webhook_url'];
    * const values = ['RecordingOracle', 'http://localhost'];
-   * await kvstoreClient.set(keys, values);
+   * await kvstoreClient.setBulk(keys, values);
    * ```
    */
   @requiresSigner
@@ -243,14 +243,14 @@ export class KVStoreClient extends BaseEthersClient {
    * import { KVStoreClient } from '@human-protocol/sdk';
    *
    * const rpcUrl = 'YOUR_RPC_URL';
-   * const privateKey = 'YOUR_PRIVATE_KEY'
+   * const privateKey = 'YOUR_PRIVATE_KEY';
    *
    * const provider = new providers.JsonRpcProvider(rpcUrl);
    * const signer = new Wallet(privateKey, provider);
    * const kvstoreClient = await KVStoreClient.build(signer);
    *
    * await kvstoreClient.setFileUrlAndHash('example.com');
-   * await kvstoreClient.setFileUrlAndHash('linkedin.com/example', 'linkedin_url);
+   * await kvstoreClient.setFileUrlAndHash('linkedin.com/example', 'linkedin_url');
    * ```
    */
   @requiresSigner
@@ -309,9 +309,9 @@ export class KVStoreClient extends BaseEthersClient {
  * ```ts
  * import { ChainId, KVStoreUtils } from '@human-protocol/sdk';
  *
- * const KVStoreAddresses = new KVStoreUtils.getKVStoreData({
+ * const KVStoreAddresses = await KVStoreUtils.getKVStoreData(
  *   ChainId.POLYGON_AMOY,
- *   "0x1234567890123456789012345678901234567890",
+ *   "0x1234567890123456789012345678901234567890"
  * );
  * ```
  */

package/src/operator.ts

@@ -22,16 +22,16 @@ import {
   ErrorUnsupportedChainID,
 } from './error';
 import { getSubgraphUrl } from './utils';
-import { ChainId } from './enums';
+import { ChainId, OrderDirection } from './enums';
 import { NETWORKS } from './constants';
 
 export class OperatorUtils {
   /**
    * This function returns the leader data for the given address.
    *
+   * @param {ChainId} chainId Network in which the leader is deployed
    * @param {string} address Leader address.
-   * @returns {ILeader} Returns the leader details.
-   *
+   * @returns {Promise<ILeader>} Returns the leader details.
    *
    * **Code example**
    *
@@ -65,6 +65,7 @@ export class OperatorUtils {
     }
 
     let jobTypes: string[] = [];
+    let reputationNetworks: string[] = [];
 
     if (typeof leader.jobTypes === 'string') {
       jobTypes = leader.jobTypes.split(',');
@@ -72,9 +73,17 @@ export class OperatorUtils {
       jobTypes = leader.jobTypes;
     }
 
+    if (leader.reputationNetworks && Array.isArray(leader.reputationNetworks)) {
+      reputationNetworks = leader.reputationNetworks.map(
+        (network) => network.address
+      );
+    }
+
     return {
       ...leader,
       jobTypes,
+      reputationNetworks,
+      chainId,
     };
   }
 
@@ -82,13 +91,12 @@ export class OperatorUtils {
    * This function returns all the leader details of the protocol.
    *
    * @param {ILeadersFilter} filter Filter for the leaders.
-   * @returns {ILeader[]} Returns an array with all the leader details.
-   *
+   * @returns {Promise<ILeader[]>} Returns an array with all the leader details.
    *
    * **Code example**
    *
    * ```ts
-   * import { OperatorUtils } from '@human-protocol/sdk';
+   * import { OperatorUtils, ChainId } from '@human-protocol/sdk';
    *
    * const filter: ILeadersFilter = {
    *  chainId: ChainId.POLYGON
@@ -99,6 +107,14 @@ export class OperatorUtils {
   public static async getLeaders(filter: ILeadersFilter): Promise<ILeader[]> {
     let leaders_data: ILeader[] = [];
 
+    const first =
+      filter.first !== undefined && filter.first > 0
+        ? Math.min(filter.first, 1000)
+        : 10;
+    const skip =
+      filter.skip !== undefined && filter.skip >= 0 ? filter.skip : 0;
+    const orderDirection = filter.orderDirection || OrderDirection.DESC;
+
     const networkData = NETWORKS[filter.chainId];
 
     if (!networkData) {
@@ -108,7 +124,12 @@ export class OperatorUtils {
     const { leaders } = await gqlFetch<{
       leaders: ILeaderSubgraph[];
     }>(getSubgraphUrl(networkData), GET_LEADERS_QUERY(filter), {
-      role: filter?.role,
+      minAmountStaked: filter?.minAmountStaked,
+      roles: filter?.roles,
+      orderBy: filter?.orderBy,
+      orderDirection: orderDirection,
+      first: first,
+      skip: skip,
     });
 
     if (!leaders) {
@@ -118,6 +139,7 @@ export class OperatorUtils {
     leaders_data = leaders_data.concat(
       leaders.map((leader) => {
         let jobTypes: string[] = [];
+        let reputationNetworks: string[] = [];
 
         if (typeof leader.jobTypes === 'string') {
           jobTypes = leader.jobTypes.split(',');
@@ -125,9 +147,20 @@ export class OperatorUtils {
           jobTypes = leader.jobTypes;
         }
 
+        if (
+          leader.reputationNetworks &&
+          Array.isArray(leader.reputationNetworks)
+        ) {
+          reputationNetworks = leader.reputationNetworks.map(
+            (network) => network.address
+          );
+        }
+
         return {
           ...leader,
           jobTypes,
+          reputationNetworks,
+          chainId: filter.chainId,
         };
       })
     );
@@ -137,12 +170,14 @@ export class OperatorUtils {
   /**
    * Retrieves the reputation network operators of the specified address.
    *
-   * @param {string} address - Address of the reputation oracle.
+   * @param {ChainId} chainId Network in which the reputation network is deployed
+   * @param {string} address Address of the reputation oracle.
    * @param {string} [role] - (Optional) Role of the operator.
    * @returns {Promise<IOperator[]>} - Returns an array of operator details.
    *
-   * @example
-   * ```typescript
+   * **Code example**
+   *
+   * ```ts
    * import { OperatorUtils, ChainId } from '@human-protocol/sdk';
    *
    * const operators = await OperatorUtils.getReputationNetworkOperators(ChainId.POLYGON_AMOY, '0x62dD51230A30401C455c8398d06F85e4EaB6309f');
@@ -186,9 +221,9 @@ export class OperatorUtils {
   /**
    * This function returns information about the rewards for a given slasher address.
    *
+   * @param {ChainId} chainId Network in which the rewards are deployed
    * @param {string} slasherAddress Slasher address.
-   * @returns {IReward[]} Returns an array of Reward objects that contain the rewards earned by the user through slashing other users.
-   *
+   * @returns {Promise<IReward[]>} Returns an array of Reward objects that contain the rewards earned by the user through slashing other users.
    *
    * **Code example**
    *