@human-protocol/sdk 5.0.0 → 5.2.0

package/src/operator.ts

@@ -1,6 +1,10 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import gqlFetch from 'graphql-request';
-import { IOperator, IOperatorsFilter, IReward } from './interfaces';
+import {
+  IOperator,
+  IOperatorsFilter,
+  IReward,
+  SubgraphOptions,
+} from './interfaces';
 import { GET_REWARD_ADDED_EVENTS_QUERY } from './graphql/queries/reward';
 import {
   IOperatorSubgraph,
@@ -18,7 +22,7 @@ import {
   ErrorInvalidStakerAddressProvided,
   ErrorUnsupportedChainID,
 } from './error';
-import { getSubgraphUrl } from './utils';
+import { getSubgraphUrl, customGqlFetch } from './utils';
 import { ChainId, OrderDirection } from './enums';
 import { NETWORKS } from './constants';
 
@@ -28,6 +32,7 @@ export class OperatorUtils {
    *
    * @param {ChainId} chainId Network in which the operator is deployed
    * @param {string} address Operator address.
+   * @param {SubgraphOptions} options Optional configuration for subgraph requests.
    * @returns {Promise<IOperator | null>} - Returns the operator details or null if not found.
    *
    * **Code example**
@@ -40,7 +45,8 @@ export class OperatorUtils {
    */
   public static async getOperator(
     chainId: ChainId,
-    address: string
+    address: string,
+    options?: SubgraphOptions
   ): Promise<IOperator | null> {
     if (!ethers.isAddress(address)) {
       throw ErrorInvalidStakerAddressProvided;
@@ -51,10 +57,11 @@ export class OperatorUtils {
       throw ErrorUnsupportedChainID;
     }
 
-    const { operator } = await gqlFetch<{
+    const { operator } = await customGqlFetch<{
       operator: IOperatorSubgraph;
     }>(getSubgraphUrl(networkData), GET_LEADER_QUERY, {
       address: address.toLowerCase(),
+      options,
     });
 
     if (!operator) {
@@ -68,6 +75,7 @@ export class OperatorUtils {
    * This function returns all the operator details of the protocol.
    *
    * @param {IOperatorsFilter} filter Filter for the operators.
+   * @param {SubgraphOptions} options Optional configuration for subgraph requests.
    * @returns {Promise<IOperator[]>} Returns an array with all the operator details.
    *
    * **Code example**
@@ -82,7 +90,8 @@ export class OperatorUtils {
    * ```
    */
   public static async getOperators(
-    filter: IOperatorsFilter
+    filter: IOperatorsFilter,
+    options?: SubgraphOptions
   ): Promise<IOperator[]> {
     const first =
       filter.first !== undefined && filter.first > 0
@@ -107,16 +116,21 @@ export class OperatorUtils {
       throw ErrorUnsupportedChainID;
     }
 
-    const { operators } = await gqlFetch<{
+    const { operators } = await customGqlFetch<{
       operators: IOperatorSubgraph[];
-    }>(getSubgraphUrl(networkData), GET_LEADERS_QUERY(filter), {
-      minStakedAmount: filter?.minStakedAmount,
-      roles: filter?.roles,
-      orderBy: orderBy,
-      orderDirection: orderDirection,
-      first: first,
-      skip: skip,
-    });
+    }>(
+      getSubgraphUrl(networkData),
+      GET_LEADERS_QUERY(filter),
+      {
+        minStakedAmount: filter?.minStakedAmount,
+        roles: filter?.roles,
+        orderBy: orderBy,
+        orderDirection: orderDirection,
+        first: first,
+        skip: skip,
+      },
+      options
+    );
 
     if (!operators) {
       return [];
@@ -131,6 +145,7 @@ export class OperatorUtils {
    * @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.
+   * @param {SubgraphOptions} options Optional configuration for subgraph requests.
    * @returns {Promise<IOperator[]>} - Returns an array of operator details.
    *
    * **Code example**
@@ -144,19 +159,25 @@ export class OperatorUtils {
   public static async getReputationNetworkOperators(
     chainId: ChainId,
     address: string,
-    role?: string
+    role?: string,
+    options?: SubgraphOptions
   ): Promise<IOperator[]> {
     const networkData = NETWORKS[chainId];
 
     if (!networkData) {
       throw ErrorUnsupportedChainID;
     }
-    const { reputationNetwork } = await gqlFetch<{
+    const { reputationNetwork } = await customGqlFetch<{
       reputationNetwork: IReputationNetworkSubgraph;
-    }>(getSubgraphUrl(networkData), GET_REPUTATION_NETWORK_QUERY(role), {
-      address: address.toLowerCase(),
-      role: role,
-    });
+    }>(
+      getSubgraphUrl(networkData),
+      GET_REPUTATION_NETWORK_QUERY(role),
+      {
+        address: address.toLowerCase(),
+        role: role,
+      },
+      options
+    );
 
     if (!reputationNetwork) return [];
 
@@ -170,6 +191,7 @@ export class OperatorUtils {
    *
    * @param {ChainId} chainId Network in which the rewards are deployed
    * @param {string} slasherAddress Slasher address.
+   * @param {SubgraphOptions} options Optional configuration for subgraph requests.
    * @returns {Promise<IReward[]>} Returns an array of Reward objects that contain the rewards earned by the user through slashing other users.
    *
    * **Code example**
@@ -182,7 +204,8 @@ export class OperatorUtils {
    */
   public static async getRewards(
     chainId: ChainId,
-    slasherAddress: string
+    slasherAddress: string,
+    options?: SubgraphOptions
   ): Promise<IReward[]> {
     if (!ethers.isAddress(slasherAddress)) {
       throw ErrorInvalidSlasherAddressProvided;
@@ -193,11 +216,16 @@ export class OperatorUtils {
       throw ErrorUnsupportedChainID;
     }
 
-    const { rewardAddedEvents } = await gqlFetch<{
+    const { rewardAddedEvents } = await customGqlFetch<{
       rewardAddedEvents: RewardAddedEventData[];
-    }>(getSubgraphUrl(networkData), GET_REWARD_ADDED_EVENTS_QUERY, {
-      slasherAddress: slasherAddress.toLowerCase(),
-    });
+    }>(
+      getSubgraphUrl(networkData),
+      GET_REWARD_ADDED_EVENTS_QUERY,
+      {
+        slasherAddress: slasherAddress.toLowerCase(),
+      },
+      options
+    );
 
     if (!rewardAddedEvents) return [];
 

package/src/staking.ts

@@ -7,7 +7,6 @@ import {
   Staking__factory,
 } from '@human-protocol/core/typechain-types';
 import { ContractRunner, Overrides, ethers } from 'ethers';
-import gqlFetch from 'graphql-request';
 import { BaseEthersClient } from './base';
 import { NETWORKS } from './constants';
 import { requiresSigner } from './decorators';
@@ -23,10 +22,15 @@ import {
   ErrorStakerNotFound,
   ErrorUnsupportedChainID,
 } from './error';
-import { IStaker, IStakersFilter, StakerInfo } from './interfaces';
+import {
+  IStaker,
+  IStakersFilter,
+  StakerInfo,
+  SubgraphOptions,
+} from './interfaces';
 import { StakerData } from './graphql';
 import { NetworkData } from './types';
-import { getSubgraphUrl, throwError } from './utils';
+import { getSubgraphUrl, customGqlFetch, throwError } from './utils';
 import {
   GET_STAKER_BY_ADDRESS_QUERY,
   GET_STAKERS_QUERY,
@@ -214,7 +218,7 @@ export class StakingClient extends BaseEthersClient {
         await this.tokenContract.approve(
           await this.stakingContract.getAddress(),
           amount,
-          this.applyTxDefaults(txOptions)
+          txOptions
         )
       ).wait();
       return;
@@ -261,12 +265,7 @@ export class StakingClient extends BaseEthersClient {
     }
 
     try {
-      await (
-        await this.stakingContract.stake(
-          amount,
-          this.applyTxDefaults(txOptions)
-        )
-      ).wait();
+      await (await this.stakingContract.stake(amount, txOptions)).wait();
       return;
     } catch (e) {
       return throwError(e);
@@ -313,12 +312,7 @@ export class StakingClient extends BaseEthersClient {
     }
 
     try {
-      await (
-        await this.stakingContract.unstake(
-          amount,
-          this.applyTxDefaults(txOptions)
-        )
-      ).wait();
+      await (await this.stakingContract.unstake(amount, txOptions)).wait();
       return;
     } catch (e) {
       return throwError(e);
@@ -352,9 +346,7 @@ export class StakingClient extends BaseEthersClient {
   @requiresSigner
   public async withdraw(txOptions: Overrides = {}): Promise<void> {
     try {
-      await (
-        await this.stakingContract.withdraw(this.applyTxDefaults(txOptions))
-      ).wait();
+      await (await this.stakingContract.withdraw(txOptions)).wait();
       return;
     } catch (e) {
       return throwError(e);
@@ -421,7 +413,7 @@ export class StakingClient extends BaseEthersClient {
           staker,
           escrowAddress,
           amount,
-          this.applyTxDefaults(txOptions)
+          txOptions
         )
       ).wait();
 
@@ -458,7 +450,7 @@ export class StakingClient extends BaseEthersClient {
 
     try {
       const stakerInfo = await this.stakingContract.stakes(stakerAddress);
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+
       const currentBlock = await this.runner.provider!.getBlockNumber();
 
       const tokensWithdrawable =
@@ -495,11 +487,13 @@ export class StakingUtils {
    *
    * @param {ChainId} chainId Network in which the staking contract is deployed
    * @param {string} stakerAddress Address of the staker
+   * @param {SubgraphOptions} options Optional configuration for subgraph requests.
    * @returns {Promise<IStaker>} Staker info from subgraph
    */
   public static async getStaker(
     chainId: ChainId,
-    stakerAddress: string
+    stakerAddress: string,
+    options?: SubgraphOptions
   ): Promise<IStaker> {
     if (!ethers.isAddress(stakerAddress)) {
       throw ErrorInvalidStakerAddressProvided;
@@ -510,10 +504,11 @@ export class StakingUtils {
       throw ErrorUnsupportedChainID;
     }
 
-    const { staker } = await gqlFetch<{ staker: StakerData }>(
+    const { staker } = await customGqlFetch<{ staker: StakerData }>(
       getSubgraphUrl(networkData),
       GET_STAKER_BY_ADDRESS_QUERY,
-      { id: stakerAddress.toLowerCase() }
+      { id: stakerAddress.toLowerCase() },
+      options
     );
 
     if (!staker) {
@@ -526,9 +521,14 @@ export class StakingUtils {
   /**
    * Gets all stakers from the subgraph with filters, pagination and ordering.
    *
+   * @param {IStakersFilter} filter Stakers filter with pagination and ordering
+   * @param {SubgraphOptions} options Optional configuration for subgraph requests.
    * @returns {Promise<IStaker[]>} Array of stakers
    */
-  public static async getStakers(filter: IStakersFilter): Promise<IStaker[]> {
+  public static async getStakers(
+    filter: IStakersFilter,
+    options?: SubgraphOptions
+  ): Promise<IStaker[]> {
     const first =
       filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
     const skip = filter.skip || 0;
@@ -540,7 +540,7 @@ export class StakingUtils {
       throw ErrorUnsupportedChainID;
     }
 
-    const { stakers } = await gqlFetch<{ stakers: StakerData[] }>(
+    const { stakers } = await customGqlFetch<{ stakers: StakerData[] }>(
       getSubgraphUrl(networkData),
       GET_STAKERS_QUERY(filter),
       {
@@ -572,7 +572,8 @@ export class StakingUtils {
         orderDirection: orderDirection,
         first: first,
         skip: skip,
-      }
+      },
+      options
     );
     if (!stakers) {
       return [];

package/src/statistics.ts

@@ -1,6 +1,4 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import gqlFetch from 'graphql-request';
-
 import { OrderDirection } from './enums';
 import {
   EscrowStatisticsData,
@@ -21,9 +19,15 @@ import {
   IPaymentStatistics,
   IStatisticsFilter,
   IWorkerStatistics,
+  SubgraphOptions,
 } from './interfaces';
 import { NetworkData } from './types';
-import { getSubgraphUrl, getUnixTimestamp, throwError } from './utils';
+import {
+  getSubgraphUrl,
+  getUnixTimestamp,
+  customGqlFetch,
+  throwError,
+} from './utils';
 
 /**
  * ## Introduction
@@ -103,6 +107,7 @@ export class StatisticsClient {
    * ```
    *
    * @param {IStatisticsFilter} filter Statistics params with duration data
+   * @param {SubgraphOptions} options Optional configuration for subgraph requests.
    * @returns {Promise<IEscrowStatistics>} Escrow statistics data.
    *
    * **Code example**
@@ -120,7 +125,8 @@ export class StatisticsClient {
    * ```
    */
   async getEscrowStatistics(
-    filter: IStatisticsFilter = {}
+    filter: IStatisticsFilter = {},
+    options?: SubgraphOptions
   ): Promise<IEscrowStatistics> {
     try {
       const first =
@@ -128,19 +134,24 @@ export class StatisticsClient {
       const skip = filter.skip || 0;
       const orderDirection = filter.orderDirection || OrderDirection.ASC;
 
-      const { escrowStatistics } = await gqlFetch<{
+      const { escrowStatistics } = await customGqlFetch<{
         escrowStatistics: EscrowStatisticsData;
-      }>(this.subgraphUrl, GET_ESCROW_STATISTICS_QUERY);
+      }>(this.subgraphUrl, GET_ESCROW_STATISTICS_QUERY, options);
 
-      const { eventDayDatas } = await gqlFetch<{
+      const { eventDayDatas } = await customGqlFetch<{
         eventDayDatas: EventDayData[];
-      }>(this.subgraphUrl, GET_EVENT_DAY_DATA_QUERY(filter), {
-        from: filter.from ? getUnixTimestamp(filter.from) : undefined,
-        to: filter.to ? getUnixTimestamp(filter.to) : undefined,
-        orderDirection: orderDirection,
-        first: first,
-        skip: skip,
-      });
+      }>(
+        this.subgraphUrl,
+        GET_EVENT_DAY_DATA_QUERY(filter),
+        {
+          from: filter.from ? getUnixTimestamp(filter.from) : undefined,
+          to: filter.to ? getUnixTimestamp(filter.to) : undefined,
+          orderDirection: orderDirection,
+          first: first,
+          skip: skip,
+        },
+        options
+      );
 
       return {
         totalEscrows: escrowStatistics?.totalEscrowCount
@@ -187,6 +198,7 @@ export class StatisticsClient {
    * ```
    *
    * @param {IStatisticsFilter} filter Statistics params with duration data
+   * @param {SubgraphOptions} options Optional configuration for subgraph requests.
    * @returns {Promise<IWorkerStatistics>} Worker statistics data.
    *
    * **Code example**
@@ -204,7 +216,8 @@ export class StatisticsClient {
    * ```
    */
   async getWorkerStatistics(
-    filter: IStatisticsFilter = {}
+    filter: IStatisticsFilter = {},
+    options?: SubgraphOptions
   ): Promise<IWorkerStatistics> {
     try {
       const first =
@@ -212,15 +225,20 @@ export class StatisticsClient {
       const skip = filter.skip || 0;
       const orderDirection = filter.orderDirection || OrderDirection.ASC;
 
-      const { eventDayDatas } = await gqlFetch<{
+      const { eventDayDatas } = await customGqlFetch<{
         eventDayDatas: EventDayData[];
-      }>(this.subgraphUrl, GET_EVENT_DAY_DATA_QUERY(filter), {
-        from: filter.from ? getUnixTimestamp(filter.from) : undefined,
-        to: filter.to ? getUnixTimestamp(filter.to) : undefined,
-        orderDirection: orderDirection,
-        first: first,
-        skip: skip,
-      });
+      }>(
+        this.subgraphUrl,
+        GET_EVENT_DAY_DATA_QUERY(filter),
+        {
+          from: filter.from ? getUnixTimestamp(filter.from) : undefined,
+          to: filter.to ? getUnixTimestamp(filter.to) : undefined,
+          orderDirection: orderDirection,
+          first: first,
+          skip: skip,
+        },
+        options
+      );
 
       return {
         dailyWorkersData: eventDayDatas.map((eventDayData) => ({
@@ -262,6 +280,7 @@ export class StatisticsClient {
    * ```
    *
    * @param {IStatisticsFilter} filter Statistics params with duration data
+   * @param {SubgraphOptions} options Optional configuration for subgraph requests.
    * @returns {Promise<IPaymentStatistics>} Payment statistics data.
    *
    * **Code example**
@@ -300,7 +319,8 @@ export class StatisticsClient {
    * ```
    */
   async getPaymentStatistics(
-    filter: IStatisticsFilter = {}
+    filter: IStatisticsFilter = {},
+    options?: SubgraphOptions
   ): Promise<IPaymentStatistics> {
     try {
       const first =
@@ -308,15 +328,20 @@ export class StatisticsClient {
       const skip = filter.skip || 0;
       const orderDirection = filter.orderDirection || OrderDirection.ASC;
 
-      const { eventDayDatas } = await gqlFetch<{
+      const { eventDayDatas } = await customGqlFetch<{
         eventDayDatas: EventDayData[];
-      }>(this.subgraphUrl, GET_EVENT_DAY_DATA_QUERY(filter), {
-        from: filter.from ? getUnixTimestamp(filter.from) : undefined,
-        to: filter.to ? getUnixTimestamp(filter.to) : undefined,
-        orderDirection: orderDirection,
-        first: first,
-        skip: skip,
-      });
+      }>(
+        this.subgraphUrl,
+        GET_EVENT_DAY_DATA_QUERY(filter),
+        {
+          from: filter.from ? getUnixTimestamp(filter.from) : undefined,
+          to: filter.to ? getUnixTimestamp(filter.to) : undefined,
+          orderDirection: orderDirection,
+          first: first,
+          skip: skip,
+        },
+        options
+      );
 
       return {
         dailyPaymentsData: eventDayDatas.map((eventDayData) => ({
@@ -346,6 +371,7 @@ export class StatisticsClient {
    * };
    * ```
    *
+   * @param {SubgraphOptions} options Optional configuration for subgraph requests.
    * @returns {Promise<IHMTStatistics>} HMToken statistics data.
    *
    * **Code example**
@@ -363,11 +389,11 @@ export class StatisticsClient {
    * });
    * ```
    */
-  async getHMTStatistics(): Promise<IHMTStatistics> {
+  async getHMTStatistics(options?: SubgraphOptions): Promise<IHMTStatistics> {
     try {
-      const { hmtokenStatistics } = await gqlFetch<{
+      const { hmtokenStatistics } = await customGqlFetch<{
         hmtokenStatistics: HMTStatisticsData;
-      }>(this.subgraphUrl, GET_HMTOKEN_STATISTICS_QUERY);
+      }>(this.subgraphUrl, GET_HMTOKEN_STATISTICS_QUERY, options);
 
       return {
         totalTransferAmount: BigInt(hmtokenStatistics.totalValueTransfered),
@@ -385,6 +411,7 @@ export class StatisticsClient {
    * **Input parameters**
    *
    * @param {IHMTHoldersParams} params HMT Holders params with filters and ordering
+   * @param {SubgraphOptions} options Optional configuration for subgraph requests.
    * @returns {Promise<IHMTHolder[]>} List of HMToken holders.
    *
    * **Code example**
@@ -404,19 +431,23 @@ export class StatisticsClient {
    * })));
    * ```
    */
-  async getHMTHolders(params: IHMTHoldersParams = {}): Promise<IHMTHolder[]> {
+  async getHMTHolders(
+    params: IHMTHoldersParams = {},
+    options?: SubgraphOptions
+  ): Promise<IHMTHolder[]> {
     try {
       const { address, orderDirection } = params;
       const query = GET_HOLDERS_QUERY(address);
 
-      const { holders } = await gqlFetch<{ holders: HMTHolderData[] }>(
+      const { holders } = await customGqlFetch<{ holders: HMTHolderData[] }>(
         this.subgraphUrl,
         query,
         {
           address,
           orderBy: 'balance',
           orderDirection,
-        }
+        },
+        options
       );
 
       return holders.map((holder) => ({
@@ -454,6 +485,7 @@ export class StatisticsClient {
    * ```
    *
    * @param {IStatisticsFilter} filter Statistics params with duration data
+   * @param {SubgraphOptions} options Optional configuration for subgraph requests.
    * @returns {Promise<IDailyHMT[]>} Daily HMToken statistics data.
    *
    * **Code example**
@@ -475,22 +507,30 @@ export class StatisticsClient {
    * console.log('HMT statistics from 5/8 - 6/8:', hmtStatisticsRange);
    * ```
    */
-  async getHMTDailyData(filter: IStatisticsFilter = {}): Promise<IDailyHMT[]> {
+  async getHMTDailyData(
+    filter: IStatisticsFilter = {},
+    options?: SubgraphOptions
+  ): Promise<IDailyHMT[]> {
     try {
       const first =
         filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
       const skip = filter.skip || 0;
       const orderDirection = filter.orderDirection || OrderDirection.ASC;
 
-      const { eventDayDatas } = await gqlFetch<{
+      const { eventDayDatas } = await customGqlFetch<{
         eventDayDatas: EventDayData[];
-      }>(this.subgraphUrl, GET_EVENT_DAY_DATA_QUERY(filter), {
-        from: filter.from ? getUnixTimestamp(filter.from) : undefined,
-        to: filter.to ? getUnixTimestamp(filter.to) : undefined,
-        orderDirection: orderDirection,
-        first: first,
-        skip: skip,
-      });
+      }>(
+        this.subgraphUrl,
+        GET_EVENT_DAY_DATA_QUERY(filter),
+        {
+          from: filter.from ? getUnixTimestamp(filter.from) : undefined,
+          to: filter.to ? getUnixTimestamp(filter.to) : undefined,
+          orderDirection: orderDirection,
+          first: first,
+          skip: skip,
+        },
+        options
+      );
 
       return eventDayDatas.map((eventDayData) => ({
         timestamp: +eventDayData.timestamp * 1000,

package/src/storage.ts

@@ -79,7 +79,7 @@ export class StorageClient {
         accessKey: credentials?.accessKey ?? '',
         secretKey: credentials?.secretKey ?? '',
       });
-    } catch (e) {
+    } catch {
       throw ErrorStorageClientNotInitialized;
     }
   }
@@ -122,7 +122,7 @@ export class StorageClient {
           const content = response?.read();
 
           return { key, content: JSON.parse(content?.toString('utf-8') || '') };
-        } catch (e) {
+        } catch {
           throw ErrorStorageFileNotFound;
         }
       })
@@ -160,7 +160,7 @@ export class StorageClient {
       }
 
       return data;
-    } catch (e) {
+    } catch {
       throw ErrorStorageFileNotFound;
     }
   }
@@ -226,7 +226,7 @@ export class StorageClient {
             }/${bucket}/${key}`,
             hash,
           };
-        } catch (e) {
+        } catch {
           throw ErrorStorageFileNotUploaded;
         }
       })