@human-protocol/sdk 6.0.0 → 7.0.0

package/src/{staking.ts → staking/staking_client.ts}

@@ -6,11 +6,11 @@ import {
   Staking,
   Staking__factory,
 } from '@human-protocol/core/typechain-types';
-import { ContractRunner, Overrides, ethers } from 'ethers';
-import { BaseEthersClient } from './base';
-import { NETWORKS } from './constants';
-import { requiresSigner } from './decorators';
-import { ChainId, OrderDirection } from './enums';
+import { ContractRunner, ethers } from 'ethers';
+import { BaseEthersClient } from '../base';
+import { NETWORKS } from '../constants';
+import { requiresSigner } from '../decorators';
+import { ChainId } from '../enums';
 import {
   ErrorEscrowAddressIsNotProvidedByFactory,
   ErrorInvalidEscrowAddressProvided,
@@ -19,22 +19,11 @@ import {
   ErrorInvalidStakingValueSign,
   ErrorInvalidStakingValueType,
   ErrorProviderDoesNotExist,
-  ErrorStakerNotFound,
   ErrorUnsupportedChainID,
-} from './error';
-import {
-  IStaker,
-  IStakersFilter,
-  StakerInfo,
-  SubgraphOptions,
-} from './interfaces';
-import { StakerData } from './graphql';
-import { NetworkData } from './types';
-import { getSubgraphUrl, customGqlFetch, throwError } from './utils';
-import {
-  GET_STAKER_BY_ADDRESS_QUERY,
-  GET_STAKERS_QUERY,
-} from './graphql/queries/staking';
+} from '../error';
+import { StakerInfo } from '../interfaces';
+import { NetworkData, TransactionOverrides } from '../types';
+import { throwError } from '../utils';
 
 /**
  * Client for staking actions on HUMAN Protocol.
@@ -194,7 +183,7 @@ export class StakingClient extends BaseEthersClient {
   @requiresSigner
   public async approveStake(
     amount: bigint,
-    txOptions: Overrides = {}
+    txOptions: TransactionOverrides = {}
   ): Promise<void> {
     if (typeof amount !== 'bigint') {
       throw ErrorInvalidStakingValueType;
@@ -205,13 +194,15 @@ export class StakingClient extends BaseEthersClient {
     }
 
     try {
-      await (
-        await this.tokenContract.approve(
-          await this.stakingContract.getAddress(),
-          amount,
-          txOptions
-        )
-      ).wait();
+      await this.sendTxAndWait(
+        async (overrides) =>
+          this.tokenContract.approve(
+            await this.stakingContract.getAddress(),
+            amount,
+            overrides
+          ),
+        txOptions
+      );
       return;
     } catch (e) {
       return throwError(e);
@@ -240,7 +231,10 @@ export class StakingClient extends BaseEthersClient {
    * ```
    */
   @requiresSigner
-  public async stake(amount: bigint, txOptions: Overrides = {}): Promise<void> {
+  public async stake(
+    amount: bigint,
+    txOptions: TransactionOverrides = {}
+  ): Promise<void> {
     if (typeof amount !== 'bigint') {
       throw ErrorInvalidStakingValueType;
     }
@@ -250,7 +244,10 @@ export class StakingClient extends BaseEthersClient {
     }
 
     try {
-      await (await this.stakingContract.stake(amount, txOptions)).wait();
+      await this.sendTxAndWait(
+        (overrides) => this.stakingContract.stake(amount, overrides),
+        txOptions
+      );
       return;
     } catch (e) {
       return throwError(e);
@@ -280,7 +277,7 @@ export class StakingClient extends BaseEthersClient {
   @requiresSigner
   public async unstake(
     amount: bigint,
-    txOptions: Overrides = {}
+    txOptions: TransactionOverrides = {}
   ): Promise<void> {
     if (typeof amount !== 'bigint') {
       throw ErrorInvalidStakingValueType;
@@ -291,7 +288,10 @@ export class StakingClient extends BaseEthersClient {
     }
 
     try {
-      await (await this.stakingContract.unstake(amount, txOptions)).wait();
+      await this.sendTxAndWait(
+        (overrides) => this.stakingContract.unstake(amount, overrides),
+        txOptions
+      );
       return;
     } catch (e) {
       return throwError(e);
@@ -312,9 +312,12 @@ export class StakingClient extends BaseEthersClient {
    * ```
    */
   @requiresSigner
-  public async withdraw(txOptions: Overrides = {}): Promise<void> {
+  public async withdraw(txOptions: TransactionOverrides = {}): Promise<void> {
     try {
-      await (await this.stakingContract.withdraw(txOptions)).wait();
+      await this.sendTxAndWait(
+        (overrides) => this.stakingContract.withdraw(overrides),
+        txOptions
+      );
       return;
     } catch (e) {
       return throwError(e);
@@ -356,7 +359,7 @@ export class StakingClient extends BaseEthersClient {
     staker: string,
     escrowAddress: string,
     amount: bigint,
-    txOptions: Overrides = {}
+    txOptions: TransactionOverrides = {}
   ): Promise<void> {
     if (typeof amount !== 'bigint') {
       throw ErrorInvalidStakingValueType;
@@ -377,15 +380,17 @@ export class StakingClient extends BaseEthersClient {
     await this.checkValidEscrow(escrowAddress);
 
     try {
-      await (
-        await this.stakingContract.slash(
-          slasher,
-          staker,
-          escrowAddress,
-          amount,
-          txOptions
-        )
-      ).wait();
+      await this.sendTxAndWait(
+        (overrides) =>
+          this.stakingContract.slash(
+            slasher,
+            staker,
+            escrowAddress,
+            amount,
+            overrides
+          ),
+        txOptions
+      );
 
       return;
     } catch (e) {
@@ -440,158 +445,3 @@ export class StakingClient extends BaseEthersClient {
     }
   }
 }
-
-/**
- * Utility helpers for Staking-related queries.
- *
- * @example
- * ```ts
- * import { StakingUtils, ChainId } from '@human-protocol/sdk';
- *
- * const staker = await StakingUtils.getStaker(
- *   ChainId.POLYGON_AMOY,
- *   '0xYourStakerAddress'
- * );
- * console.log('Staked amount:', staker.stakedAmount);
- * ```
- */
-export class StakingUtils {
-  /**
-   * Gets staking info for a staker from the subgraph.
-   *
-   * @param chainId - Network in which the staking contract is deployed
-   * @param stakerAddress - Address of the staker
-   * @param options - Optional configuration for subgraph requests.
-   * @returns Staker info from subgraph
-   * @throws ErrorInvalidStakerAddressProvided If the staker address is invalid
-   * @throws ErrorUnsupportedChainID If the chain ID is not supported
-   * @throws ErrorStakerNotFound If the staker is not found
-   *
-   * @example
-   * ```ts
-   * import { StakingUtils, ChainId } from '@human-protocol/sdk';
-   *
-   * const staker = await StakingUtils.getStaker(
-   *   ChainId.POLYGON_AMOY,
-   *   '0xYourStakerAddress'
-   * );
-   * console.log('Staked amount:', staker.stakedAmount);
-   * ```
-   */
-  public static async getStaker(
-    chainId: ChainId,
-    stakerAddress: string,
-    options?: SubgraphOptions
-  ): Promise<IStaker> {
-    if (!ethers.isAddress(stakerAddress)) {
-      throw ErrorInvalidStakerAddressProvided;
-    }
-
-    const networkData: NetworkData | undefined = NETWORKS[chainId];
-    if (!networkData) {
-      throw ErrorUnsupportedChainID;
-    }
-
-    const { staker } = await customGqlFetch<{ staker: StakerData }>(
-      getSubgraphUrl(networkData),
-      GET_STAKER_BY_ADDRESS_QUERY,
-      { id: stakerAddress.toLowerCase() },
-      options
-    );
-
-    if (!staker) {
-      throw ErrorStakerNotFound;
-    }
-
-    return mapStaker(staker);
-  }
-
-  /**
-   * Gets all stakers from the subgraph with filters, pagination and ordering.
-   *
-   * @param filter - Stakers filter with pagination and ordering
-   * @param options - Optional configuration for subgraph requests.
-   * @returns Array of stakers
-   * @throws ErrorUnsupportedChainID If the chain ID is not supported
-   *
-   * @example
-   * ```ts
-   * import { ChainId } from '@human-protocol/sdk';
-   *
-   * const filter = {
-   *   chainId: ChainId.POLYGON_AMOY,
-   *   minStakedAmount: '1000000000000000000', // 1 token in WEI
-   * };
-   * const stakers = await StakingUtils.getStakers(filter);
-   * console.log('Stakers:', stakers.length);
-   * ```
-   */
-  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;
-    const orderDirection = filter.orderDirection || OrderDirection.DESC;
-    const orderBy = filter.orderBy || 'lastDepositTimestamp';
-
-    const networkData = NETWORKS[filter.chainId];
-    if (!networkData) {
-      throw ErrorUnsupportedChainID;
-    }
-
-    const { stakers } = await customGqlFetch<{ stakers: StakerData[] }>(
-      getSubgraphUrl(networkData),
-      GET_STAKERS_QUERY(filter),
-      {
-        minStakedAmount: filter.minStakedAmount
-          ? filter.minStakedAmount
-          : undefined,
-        maxStakedAmount: filter.maxStakedAmount
-          ? filter.maxStakedAmount
-          : undefined,
-        minLockedAmount: filter.minLockedAmount
-          ? filter.minLockedAmount
-          : undefined,
-        maxLockedAmount: filter.maxLockedAmount
-          ? filter.maxLockedAmount
-          : undefined,
-        minWithdrawnAmount: filter.minWithdrawnAmount
-          ? filter.minWithdrawnAmount
-          : undefined,
-        maxWithdrawnAmount: filter.maxWithdrawnAmount
-          ? filter.maxWithdrawnAmount
-          : undefined,
-        minSlashedAmount: filter.minSlashedAmount
-          ? filter.minSlashedAmount
-          : undefined,
-        maxSlashedAmount: filter.maxSlashedAmount
-          ? filter.maxSlashedAmount
-          : undefined,
-        orderBy: orderBy,
-        orderDirection: orderDirection,
-        first: first,
-        skip: skip,
-      },
-      options
-    );
-    if (!stakers) {
-      return [];
-    }
-
-    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,
-  };
-}

package/src/staking/staking_utils.ts

@@ -0,0 +1,170 @@
+import { ethers } from 'ethers';
+import { NETWORKS } from '../constants';
+import { ChainId, OrderDirection } from '../enums';
+import {
+  ErrorInvalidStakerAddressProvided,
+  ErrorStakerNotFound,
+  ErrorUnsupportedChainID,
+} from '../error';
+import { StakerData } from '../graphql';
+import {
+  GET_STAKER_BY_ADDRESS_QUERY,
+  GET_STAKERS_QUERY,
+} from '../graphql/queries/staking';
+import { IStaker, IStakersFilter, SubgraphOptions } from '../interfaces';
+import { NetworkData } from '../types';
+import { customGqlFetch, getSubgraphUrl } from '../utils';
+/**
+ * Utility helpers for Staking-related queries.
+ *
+ * @example
+ * ```ts
+ * import { StakingUtils, ChainId } from '@human-protocol/sdk';
+ *
+ * const staker = await StakingUtils.getStaker(
+ *   ChainId.POLYGON_AMOY,
+ *   '0xYourStakerAddress'
+ * );
+ * console.log('Staked amount:', staker.stakedAmount);
+ * ```
+ */
+export class StakingUtils {
+  /**
+   * Gets staking info for a staker from the subgraph.
+   *
+   * @param chainId - Network in which the staking contract is deployed
+   * @param stakerAddress - Address of the staker
+   * @param options - Optional configuration for subgraph requests.
+   * @returns Staker info from subgraph
+   * @throws ErrorInvalidStakerAddressProvided If the staker address is invalid
+   * @throws ErrorUnsupportedChainID If the chain ID is not supported
+   * @throws ErrorStakerNotFound If the staker is not found
+   *
+   * @example
+   * ```ts
+   * import { StakingUtils, ChainId } from '@human-protocol/sdk';
+   *
+   * const staker = await StakingUtils.getStaker(
+   *   ChainId.POLYGON_AMOY,
+   *   '0xYourStakerAddress'
+   * );
+   * console.log('Staked amount:', staker.stakedAmount);
+   * ```
+   */
+  public static async getStaker(
+    chainId: ChainId,
+    stakerAddress: string,
+    options?: SubgraphOptions
+  ): Promise<IStaker> {
+    if (!ethers.isAddress(stakerAddress)) {
+      throw ErrorInvalidStakerAddressProvided;
+    }
+
+    const networkData: NetworkData | undefined = NETWORKS[chainId];
+    if (!networkData) {
+      throw ErrorUnsupportedChainID;
+    }
+
+    const { staker } = await customGqlFetch<{ staker: StakerData }>(
+      getSubgraphUrl(networkData),
+      GET_STAKER_BY_ADDRESS_QUERY,
+      { id: stakerAddress.toLowerCase() },
+      options
+    );
+
+    if (!staker) {
+      throw ErrorStakerNotFound;
+    }
+
+    return mapStaker(staker);
+  }
+
+  /**
+   * Gets all stakers from the subgraph with filters, pagination and ordering.
+   *
+   * @param filter - Stakers filter with pagination and ordering
+   * @param options - Optional configuration for subgraph requests.
+   * @returns Array of stakers
+   * @throws ErrorUnsupportedChainID If the chain ID is not supported
+   *
+   * @example
+   * ```ts
+   * import { ChainId } from '@human-protocol/sdk';
+   *
+   * const filter = {
+   *   chainId: ChainId.POLYGON_AMOY,
+   *   minStakedAmount: '1000000000000000000', // 1 token in WEI
+   * };
+   * const stakers = await StakingUtils.getStakers(filter);
+   * console.log('Stakers:', stakers.length);
+   * ```
+   */
+  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;
+    const orderDirection = filter.orderDirection || OrderDirection.DESC;
+    const orderBy = filter.orderBy || 'lastDepositTimestamp';
+
+    const networkData = NETWORKS[filter.chainId];
+    if (!networkData) {
+      throw ErrorUnsupportedChainID;
+    }
+
+    const { stakers } = await customGqlFetch<{ stakers: StakerData[] }>(
+      getSubgraphUrl(networkData),
+      GET_STAKERS_QUERY(filter),
+      {
+        minStakedAmount: filter.minStakedAmount
+          ? filter.minStakedAmount
+          : undefined,
+        maxStakedAmount: filter.maxStakedAmount
+          ? filter.maxStakedAmount
+          : undefined,
+        minLockedAmount: filter.minLockedAmount
+          ? filter.minLockedAmount
+          : undefined,
+        maxLockedAmount: filter.maxLockedAmount
+          ? filter.maxLockedAmount
+          : undefined,
+        minWithdrawnAmount: filter.minWithdrawnAmount
+          ? filter.minWithdrawnAmount
+          : undefined,
+        maxWithdrawnAmount: filter.maxWithdrawnAmount
+          ? filter.maxWithdrawnAmount
+          : undefined,
+        minSlashedAmount: filter.minSlashedAmount
+          ? filter.minSlashedAmount
+          : undefined,
+        maxSlashedAmount: filter.maxSlashedAmount
+          ? filter.maxSlashedAmount
+          : undefined,
+        orderBy: orderBy,
+        orderDirection: orderDirection,
+        first: first,
+        skip: skip,
+      },
+      options
+    );
+    if (!stakers) {
+      return [];
+    }
+
+    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,
+  };
+}

package/src/statistics/index.ts

@@ -0,0 +1 @@
+export { StatisticsUtils } from './statistics_utils';

package/src/{statistics.ts → statistics/statistics_utils.ts}

@@ -1,15 +1,17 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import { OrderDirection } from './enums';
+import { OrderDirection } from '../enums';
 import {
   EscrowStatisticsData,
   EventDayData,
+  HMTEventDayData,
   GET_ESCROW_STATISTICS_QUERY,
   GET_EVENT_DAY_DATA_QUERY,
+  GET_HMT_EVENT_DAY_DATA_QUERY,
   GET_HMTOKEN_STATISTICS_QUERY,
   GET_HOLDERS_QUERY,
   HMTHolderData,
   HMTStatisticsData,
-} from './graphql';
+} from '../graphql';
 import {
   IDailyHMT,
   IEscrowStatistics,
@@ -20,14 +22,15 @@ import {
   IStatisticsFilter,
   IWorkerStatistics,
   SubgraphOptions,
-} from './interfaces';
-import { NetworkData } from './types';
+} from '../interfaces';
+import { NetworkData } from '../types';
 import {
+  getHMTSubgraphUrl,
   getSubgraphUrl,
   getUnixTimestamp,
   customGqlFetch,
   throwError,
-} from './utils';
+} from '../utils';
 
 /**
  * Utility class for statistics-related queries.
@@ -253,9 +256,7 @@ export class StatisticsUtils {
    * ```ts
    * interface IDailyPayment {
    *   timestamp: number;
-   *   totalAmountPaid: bigint;
    *   totalCount: number;
-   *   averageAmountPerWorker: bigint;
    * };
    *
    * interface IPaymentStatistics {
@@ -274,14 +275,7 @@ export class StatisticsUtils {
    *
    * const networkData = NETWORKS[ChainId.POLYGON_AMOY];
    * const paymentStats = await StatisticsUtils.getPaymentStatistics(networkData);
-   * console.log(
-   *   'Payment statistics:',
-   *   paymentStats.dailyPaymentsData.map((p) => ({
-   *     ...p,
-   *     totalAmountPaid: p.totalAmountPaid.toString(),
-   *     averageAmountPerWorker: p.averageAmountPerWorker.toString(),
-   *   }))
-   * );
+   * console.log('Payment statistics:', paymentStats.dailyPaymentsData);
    *
    * const paymentStatsRange = await StatisticsUtils.getPaymentStatistics(
    *   networkData,
@@ -323,13 +317,7 @@ export class StatisticsUtils {
       return {
         dailyPaymentsData: eventDayDatas.map((eventDayData) => ({
           timestamp: +eventDayData.timestamp * 1000,
-          totalAmountPaid: BigInt(eventDayData.dailyHMTPayoutAmount),
           totalCount: +eventDayData.dailyPayoutCount,
-          averageAmountPerWorker:
-            eventDayData.dailyWorkerCount === '0'
-              ? BigInt(0)
-              : BigInt(eventDayData.dailyHMTPayoutAmount) /
-                BigInt(eventDayData.dailyWorkerCount),
         })),
       };
     } catch (e: any) {
@@ -369,7 +357,7 @@ export class StatisticsUtils {
     options?: SubgraphOptions
   ): Promise<IHMTStatistics> {
     try {
-      const subgraphUrl = getSubgraphUrl(networkData);
+      const subgraphUrl = getHMTSubgraphUrl(networkData);
       const { hmtokenStatistics } = await customGqlFetch<{
         hmtokenStatistics: HMTStatisticsData;
       }>(subgraphUrl, GET_HMTOKEN_STATISTICS_QUERY, options);
@@ -412,7 +400,7 @@ export class StatisticsUtils {
     options?: SubgraphOptions
   ): Promise<IHMTHolder[]> {
     try {
-      const subgraphUrl = getSubgraphUrl(networkData);
+      const subgraphUrl = getHMTSubgraphUrl(networkData);
       const { address, orderDirection } = params;
       const query = GET_HOLDERS_QUERY(address);
 
@@ -490,17 +478,17 @@ export class StatisticsUtils {
     options?: SubgraphOptions
   ): Promise<IDailyHMT[]> {
     try {
-      const subgraphUrl = getSubgraphUrl(networkData);
+      const subgraphUrl = getHMTSubgraphUrl(networkData);
       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 customGqlFetch<{
-        eventDayDatas: EventDayData[];
+        eventDayDatas: HMTEventDayData[];
       }>(
         subgraphUrl,
-        GET_EVENT_DAY_DATA_QUERY(filter),
+        GET_HMT_EVENT_DAY_DATA_QUERY(filter),
         {
           from: filter.from ? getUnixTimestamp(filter.from) : undefined,
           to: filter.to ? getUnixTimestamp(filter.to) : undefined,

package/src/transaction/index.ts

@@ -0,0 +1 @@
+export { TransactionUtils } from './transaction_utils';

package/src/{transaction.ts → transaction/transaction_utils.ts}

@@ -1,23 +1,23 @@
 import { ethers } from 'ethers';
-import { NETWORKS } from './constants';
-import { ChainId, OrderDirection } from './enums';
+import { NETWORKS } from '../constants';
+import { ChainId, OrderDirection } from '../enums';
 import {
   ErrorCannotUseDateAndBlockSimultaneously,
   ErrorInvalidHashProvided,
   ErrorUnsupportedChainID,
-} from './error';
-import { TransactionData } from './graphql';
+} from '../error';
+import { TransactionData } from '../graphql';
 import {
   GET_TRANSACTION_QUERY,
   GET_TRANSACTIONS_QUERY,
-} from './graphql/queries/transaction';
+} from '../graphql/queries/transaction';
 import {
   InternalTransaction,
   ITransaction,
   ITransactionsFilter,
   SubgraphOptions,
-} from './interfaces';
-import { getSubgraphUrl, getUnixTimestamp, customGqlFetch } from './utils';
+} from '../interfaces';
+import { getSubgraphUrl, getUnixTimestamp, customGqlFetch } from '../utils';
 
 /**
  * Utility class for transaction-related queries.
@@ -129,8 +129,8 @@ export class TransactionUtils {
    *   token?: string; // (Optional) The token address to filter transactions.
    *   startDate?: Date; // (Optional) The start date to filter transactions (inclusive).
    *   endDate?: Date; // (Optional) The end date to filter transactions (inclusive).
-   *   startBlock?: number; // (Optional) The start block number to filter transactions (inclusive).
-   *   endBlock?: number; // (Optional) The end block number to filter transactions (inclusive).
+   *   startBlock?: bigint | number; // (Optional) The start block to filter transactions (inclusive).
+   *   endBlock?: bigint | number; // (Optional) The end block to filter transactions (inclusive).
    *   first?: number; // (Optional) Number of transactions per page. Default is 10.
    *   skip?: number; // (Optional) Number of transactions to skip. Default is 0.
    *   orderDirection?: OrderDirection; // (Optional) Order of the results. Default is DESC.
@@ -220,8 +220,8 @@ export class TransactionUtils {
           ? getUnixTimestamp(filter?.startDate)
           : undefined,
         endDate: filter.endDate ? getUnixTimestamp(filter.endDate) : undefined,
-        startBlock: filter.startBlock ? filter.startBlock : undefined,
-        endBlock: filter.endBlock ? filter.endBlock : undefined,
+        startBlock: filter.startBlock ? Number(filter.startBlock) : undefined,
+        endBlock: filter.endBlock ? Number(filter.endBlock) : undefined,
         method: filter.method ? filter.method : undefined,
         escrow: filter.escrow ? filter.escrow : undefined,
         token: filter.token ? filter.token : undefined,