@human-protocol/sdk 1.1.18 → 2.0.0

package/src/staking.ts

@@ -1,6 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { Provider } from '@ethersproject/abstract-provider';
-import { Network } from '@ethersproject/networks';
 import {
   EscrowFactory,
   EscrowFactory__factory,
@@ -11,8 +8,7 @@ import {
   Staking,
   Staking__factory,
 } from '@human-protocol/core/typechain-types';
-import { BigNumber, Signer, ethers } from 'ethers';
-import gqlFetch from 'graphql-request';
+import { ContractRunner, Overrides, ethers } from 'ethers';
 import { BaseEthersClient } from './base';
 import { NETWORKS } from './constants';
 import { requiresSigner } from './decorators';
@@ -27,23 +23,20 @@ import {
   ErrorProviderDoesNotExist,
   ErrorUnsupportedChainID,
 } from './error';
-import { IAllocation, ILeader, ILeadersFilter, IReward } from './interfaces';
+import { IAllocation } from './interfaces';
 import { NetworkData } from './types';
 import { throwError } from './utils';
-import { GET_REWARD_ADDED_EVENTS_QUERY } from './graphql/queries/reward';
-import { RewardAddedEventData } from './graphql';
-import { GET_LEADER_QUERY, GET_LEADERS_QUERY } from './graphql/queries/staking';
 
 /**
  * ## Introduction
  *
  * This client enables to perform actions on staking contracts and obtain staking information from both the contracts and subgraph.
  *
- * Internally, the SDK will use one network or another according to the network ID of the `signerOrProvider`.
+ * 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(signerOrProvider: Signer | Provider);
+ * static async build(runner: ContractRunner);
  * ```
  *
  * A `Signer` or a `Provider` should be passed depending on the use case of this module:
@@ -112,71 +105,58 @@ export class StakingClient extends BaseEthersClient {
   /**
    * **StakingClient constructor**
    *
-   * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+   * @param {ContractRunner} runner - The Runner object to interact with the Ethereum network
    * @param {NetworkData} network - The network information required to connect to the Staking contract
-   * @param {number | undefined} gasPriceMultiplier - The multiplier to apply to the gas price
    */
-  constructor(
-    signerOrProvider: Signer | Provider,
-    networkData: NetworkData,
-    gasPriceMultiplier?: number
-  ) {
-    super(signerOrProvider, networkData, gasPriceMultiplier);
+  constructor(runner: ContractRunner, networkData: NetworkData) {
+    super(runner, networkData);
 
     this.stakingContract = Staking__factory.connect(
       networkData.stakingAddress,
-      signerOrProvider
+      runner
     );
 
     this.escrowFactoryContract = EscrowFactory__factory.connect(
       networkData.factoryAddress,
-      signerOrProvider
+      runner
     );
 
     this.tokenContract = HMToken__factory.connect(
       networkData.hmtAddress,
-      signerOrProvider
+      runner
     );
 
     this.rewardPoolContract = RewardPool__factory.connect(
       networkData.rewardPoolAddress,
-      this.signerOrProvider
+      this.runner
     );
   }
 
   /**
-   * Creates an instance of StakingClient from a Signer or Provider.
+   * Creates an instance of StakingClient from a Runner.
    *
-   * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+   * @param {ContractRunner} runner - The Runner object to interact with the Ethereum network
    * @param {number | undefined} gasPriceMultiplier - The multiplier to apply to the gas price
    *
    * @returns {Promise<StakingClient>} - An instance of StakingClient
    * @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(
-    signerOrProvider: Signer | Provider,
-    gasPriceMultiplier?: number
-  ) {
-    let network: Network;
-    if (Signer.isSigner(signerOrProvider)) {
-      if (!signerOrProvider.provider) {
-        throw ErrorProviderDoesNotExist;
-      }
-
-      network = await signerOrProvider.provider.getNetwork();
-    } else {
-      network = await signerOrProvider.getNetwork();
+  public static async build(runner: ContractRunner) {
+    if (!runner.provider) {
+      throw ErrorProviderDoesNotExist;
     }
 
-    const chainId: ChainId = network.chainId;
+    const network = await runner.provider?.getNetwork();
+
+    const chainId: ChainId = Number(network?.chainId);
     const networkData = NETWORKS[chainId];
 
     if (!networkData) {
       throw ErrorUnsupportedChainID;
     }
 
-    return new StakingClient(signerOrProvider, networkData, gasPriceMultiplier);
+    return new StakingClient(runner, networkData);
   }
 
   /**
@@ -185,7 +165,7 @@ export class StakingClient extends BaseEthersClient {
    * @param escrowAddress Escrow address to check against
    */
   private async checkValidEscrow(escrowAddress: string) {
-    if (!ethers.utils.isAddress(escrowAddress)) {
+    if (!ethers.isAddress(escrowAddress)) {
       throw ErrorInvalidEscrowAddressProvided;
     }
 
@@ -197,7 +177,8 @@ export class StakingClient extends BaseEthersClient {
   /**
    * This function approves the staking contract to transfer a specified amount of tokens when the user stakes. It increases the allowance for the staking contract.
    *
-   * @param {BigNumber} amount Amount in WEI of tokens to approve for stake.
+   * @param {bigint} amount Amount in WEI of tokens to approve for stake.
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -214,24 +195,31 @@ export class StakingClient extends BaseEthersClient {
    * const signer = new Wallet(privateKey, provider);
    * const stakingClient = await StakingClient.build(signer);
    *
-   * const amount = ethers.utils.parseUnits(5, 'ether'); //convert from ETH to WEI
+   * const amount = ethers.parseUnits(5, 'ether'); //convert from ETH to WEI
    * await stakingClient.approveStake(amount);
    * ```
    */
   @requiresSigner
-  public async approveStake(amount: BigNumber): Promise<void> {
-    if (!BigNumber.isBigNumber(amount)) {
+  public async approveStake(
+    amount: bigint,
+    txOptions: Overrides = {}
+  ): Promise<void> {
+    if (typeof amount !== 'bigint') {
       throw ErrorInvalidStakingValueType;
     }
 
-    if (amount.isNegative()) {
+    if (amount < 0n) {
       throw ErrorInvalidStakingValueSign;
     }
 
     try {
-      await this.tokenContract.approve(this.stakingContract.address, amount, {
-        ...(await this.gasPriceOptions()),
-      });
+      await (
+        await this.tokenContract.approve(
+          await this.stakingContract.getAddress(),
+          amount,
+          txOptions
+        )
+      ).wait();
       return;
     } catch (e) {
       return throwError(e);
@@ -243,7 +231,8 @@ export class StakingClient extends BaseEthersClient {
    *
    * > `approveStake` must be called before
    *
-   * @param {BigNumber} amount Amount in WEI of tokens to stake.
+   * @param {bigint} amount Amount in WEI of tokens to stake.
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -260,25 +249,23 @@ export class StakingClient extends BaseEthersClient {
    * const signer = new Wallet(privateKey, provider);
    * const stakingClient = await StakingClient.build(signer);
    *
-   * const amount = ethers.utils.parseUnits(5, 'ether'); //convert from ETH to WEI
+   * const amount = ethers.parseUnits(5, 'ether'); //convert from ETH to WEI
    * await stakingClient.approveStake(amount); // if it was already approved before, this is not necessary
    * await stakingClient.approveStake(amount);
    * ```
    */
   @requiresSigner
-  public async stake(amount: BigNumber): Promise<void> {
-    if (!BigNumber.isBigNumber(amount)) {
+  public async stake(amount: bigint, txOptions: Overrides = {}): Promise<void> {
+    if (typeof amount !== 'bigint') {
       throw ErrorInvalidStakingValueType;
     }
 
-    if (amount.isNegative()) {
+    if (amount < 0n) {
       throw ErrorInvalidStakingValueSign;
     }
 
     try {
-      await this.stakingContract.stake(amount, {
-        ...(await this.gasPriceOptions()),
-      });
+      await (await this.stakingContract.stake(amount, txOptions)).wait();
       return;
     } catch (e) {
       return throwError(e);
@@ -290,7 +277,8 @@ export class StakingClient extends BaseEthersClient {
    *
    * > Must have tokens available to unstake
    *
-   * @param {BigNumber} amount Amount in WEI of tokens to unstake.
+   * @param {bigint} amount Amount in WEI of tokens to unstake.
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -307,24 +295,25 @@ export class StakingClient extends BaseEthersClient {
    * const signer = new Wallet(privateKey, provider);
    * const stakingClient = await StakingClient.build(signer);
    *
-   * const amount = ethers.utils.parseUnits(5, 'ether'); //convert from ETH to WEI
+   * const amount = ethers.parseUnits(5, 'ether'); //convert from ETH to WEI
    * await stakingClient.unstake(amount);
    * ```
    */
   @requiresSigner
-  public async unstake(amount: BigNumber): Promise<void> {
-    if (!BigNumber.isBigNumber(amount)) {
+  public async unstake(
+    amount: bigint,
+    txOptions: Overrides = {}
+  ): Promise<void> {
+    if (typeof amount !== 'bigint') {
       throw ErrorInvalidStakingValueType;
     }
 
-    if (amount.isNegative()) {
+    if (amount < 0n) {
       throw ErrorInvalidStakingValueSign;
     }
 
     try {
-      await this.stakingContract.unstake(amount, {
-        ...(await this.gasPriceOptions()),
-      });
+      await (await this.stakingContract.unstake(amount, txOptions)).wait();
       return;
     } catch (e) {
       return throwError(e);
@@ -336,6 +325,7 @@ export class StakingClient extends BaseEthersClient {
    *
    * > Must have tokens available to withdraw
    *
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -356,11 +346,9 @@ export class StakingClient extends BaseEthersClient {
    * ```
    */
   @requiresSigner
-  public async withdraw(): Promise<void> {
+  public async withdraw(txOptions: Overrides = {}): Promise<void> {
     try {
-      await this.stakingContract.withdraw({
-        ...(await this.gasPriceOptions()),
-      });
+      await (await this.stakingContract.withdraw(txOptions)).wait();
       return;
     } catch (e) {
       return throwError(e);
@@ -373,7 +361,8 @@ export class StakingClient extends BaseEthersClient {
    * @param {string} slasher Wallet address from who requested the slash
    * @param {string} staker Wallet address from who is going to be slashed
    * @param {string} escrowAddress Address of the escrow which allocation will be slashed
-   * @param {BigNumber} amount Amount in WEI of tokens to unstake.
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
+   * @param {bigint} amount Amount in WEI of tokens to unstake.
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -390,7 +379,7 @@ export class StakingClient extends BaseEthersClient {
    * const signer = new Wallet(privateKey, provider);
    * const stakingClient = await StakingClient.build(signer);
    *
-   * const amount = ethers.utils.parseUnits(5, 'ether'); //convert from ETH to WEI
+   * const amount = ethers.parseUnits(5, 'ether'); //convert from ETH to WEI
    * await stakingClient.slash('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', '0x62dD51230A30401C455c8398d06F85e4EaB6309f', amount);
    * ```
    */
@@ -399,30 +388,37 @@ export class StakingClient extends BaseEthersClient {
     slasher: string,
     staker: string,
     escrowAddress: string,
-    amount: BigNumber
+    amount: bigint,
+    txOptions: Overrides = {}
   ): Promise<void> {
-    if (!BigNumber.isBigNumber(amount)) {
+    if (typeof amount !== 'bigint') {
       throw ErrorInvalidStakingValueType;
     }
 
-    if (amount.isNegative()) {
+    if (amount < 0n) {
       throw ErrorInvalidStakingValueSign;
     }
 
-    if (!ethers.utils.isAddress(slasher)) {
+    if (!ethers.isAddress(slasher)) {
       throw ErrorInvalidSlasherAddressProvided;
     }
 
-    if (!ethers.utils.isAddress(staker)) {
+    if (!ethers.isAddress(staker)) {
       throw ErrorInvalidStakerAddressProvided;
     }
 
     await this.checkValidEscrow(escrowAddress);
 
     try {
-      await this.stakingContract.slash(slasher, staker, escrowAddress, amount, {
-        ...(await this.gasPriceOptions()),
-      });
+      await (
+        await this.stakingContract.slash(
+          slasher,
+          staker,
+          escrowAddress,
+          amount,
+          txOptions
+        )
+      ).wait();
 
       return;
     } catch (e) {
@@ -436,7 +432,8 @@ export class StakingClient extends BaseEthersClient {
    * > Must have tokens staked
    *
    * @param {string} escrowAddress Address of the escrow contract to allocate in.
-   * @param {BigNumber} amount Amount in WEI of tokens to allocate.
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
+   * @param {bigint} amount Amount in WEI of tokens to allocate.
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -453,29 +450,30 @@ export class StakingClient extends BaseEthersClient {
    * const signer = new Wallet(privateKey, provider);
    * const stakingClient = await StakingClient.build(signer);
    *
-   * const amount = ethers.utils.parseUnits(5, 'ether'); //convert from ETH to WEI
+   * const amount = ethers.parseUnits(5, 'ether'); //convert from ETH to WEI
    * await stakingClient.allocate('0x62dD51230A30401C455c8398d06F85e4EaB6309f', amount);
    * ```
    */
   @requiresSigner
   public async allocate(
     escrowAddress: string,
-    amount: BigNumber
+    amount: bigint,
+    txOptions: Overrides = {}
   ): Promise<void> {
-    if (!BigNumber.isBigNumber(amount)) {
+    if (typeof amount !== 'bigint') {
       throw ErrorInvalidStakingValueType;
     }
 
-    if (amount.isNegative()) {
+    if (amount < 0n) {
       throw ErrorInvalidStakingValueSign;
     }
 
     await this.checkValidEscrow(escrowAddress);
 
     try {
-      await this.stakingContract.allocate(escrowAddress, amount, {
-        ...(await this.gasPriceOptions()),
-      });
+      await (
+        await this.stakingContract.allocate(escrowAddress, amount, txOptions)
+      ).wait();
       return;
     } catch (e) {
       return throwError(e);
@@ -489,6 +487,7 @@ export class StakingClient extends BaseEthersClient {
    * > The escrow must be cancelled or completed.
    *
    * @param {string} escrowAddress Address of the escrow contract to close allocation from.
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -509,13 +508,16 @@ export class StakingClient extends BaseEthersClient {
    * ```
    */
   @requiresSigner
-  public async closeAllocation(escrowAddress: string): Promise<void> {
+  public async closeAllocation(
+    escrowAddress: string,
+    txOptions: Overrides = {}
+  ): Promise<void> {
     await this.checkValidEscrow(escrowAddress);
 
     try {
-      await this.stakingContract.closeAllocation(escrowAddress, {
-        ...(await this.gasPriceOptions()),
-      });
+      await (
+        await this.stakingContract.closeAllocation(escrowAddress, txOptions)
+      ).wait();
       return;
     } catch (e) {
       return throwError(e);
@@ -528,6 +530,7 @@ export class StakingClient extends BaseEthersClient {
    * > The escrow must have rewards added
    *
    * @param {string} escrowAddress Escrow address from which rewards are distributed.
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -548,93 +551,22 @@ export class StakingClient extends BaseEthersClient {
    * ```
    */
   @requiresSigner
-  public async distributeReward(escrowAddress: string): Promise<void> {
+  public async distributeReward(
+    escrowAddress: string,
+    txOptions: Overrides = {}
+  ): Promise<void> {
     await this.checkValidEscrow(escrowAddress);
 
     try {
-      this.rewardPoolContract.distributeReward(escrowAddress, {
-        ...(await this.gasPriceOptions()),
-      });
+      (
+        await this.rewardPoolContract.distributeReward(escrowAddress, txOptions)
+      ).wait();
       return;
     } catch (e) {
       return throwError(e);
     }
   }
 
-  /**
-   * 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.
-   *
-   *
-   * **Code example**
-   *
-   * ```ts
-   * import { StakingClient } from '@human-protocol/sdk';
-   * import { providers } from 'ethers';
-   *
-   * const rpcUrl = 'YOUR_RPC_URL';
-   *
-   * const provider = new providers.JsonRpcProvider(rpcUrl);
-   * const stakingClient = await StakingClient.build(provider);
-   *
-   * const leaders = await stakingClient.getLeaders();
-   * ```
-   */
-  public async getLeader(address: string): Promise<ILeader> {
-    if (!ethers.utils.isAddress(address)) {
-      throw ErrorInvalidStakerAddressProvided;
-    }
-
-    try {
-      const { leader } = await gqlFetch<{
-        leader: ILeader;
-      }>(this.networkData.subgraphUrl, GET_LEADER_QUERY, {
-        address: address.toLowerCase(),
-      });
-
-      return leader;
-    } catch (e) {
-      return throwError(e);
-    }
-  }
-
-  /**
-   * This function returns the leader data for the given address.
-   *
-   * @param {string} address Leader address.
-   * @returns {ILeader} Returns the leader details.
-   *
-   *
-   * **Code example**
-   *
-   * ```ts
-   * import { StakingClient } from '@human-protocol/sdk';
-   * import { providers } from 'ethers';
-   *
-   * const rpcUrl = 'YOUR_RPC_URL';
-   *
-   * const provider = new providers.JsonRpcProvider(rpcUrl);
-   * const stakingClient = await StakingClient.build(provider);
-   *
-   * const leader = await stakingClient.getLeader('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
-   * ```
-   */
-  public async getLeaders(filter: ILeadersFilter = {}): Promise<ILeader[]> {
-    try {
-      const { leaders } = await gqlFetch<{
-        leaders: ILeader[];
-      }>(this.networkData.subgraphUrl, GET_LEADERS_QUERY(filter), {
-        role: filter.role,
-      });
-
-      return leaders;
-    } catch (e) {
-      return throwError(e);
-    }
-  }
-
   /**
    * This function returns information about the allocation of the specified escrow.
    *
@@ -666,48 +598,4 @@ export class StakingClient extends BaseEthersClient {
       return throwError(e);
     }
   }
-
-  /**
-   * This function returns information about the rewards for a given slasher address.
-   *
-   * @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.
-   *
-   *
-   * **Code example**
-   *
-   * ```ts
-   * import { StakingClient } from '@human-protocol/sdk';
-   * import { providers } from 'ethers';
-   *
-   * const rpcUrl = 'YOUR_RPC_URL';
-   *
-   * const provider = new providers.JsonRpcProvider(rpcUrl);
-   * const stakingClient = await StakingClient.build(provider);
-   *
-   * const rewards = await stakingClient.getRewards('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
-   * ```
-   */
-  public async getRewards(slasherAddress: string): Promise<IReward[]> {
-    if (!ethers.utils.isAddress(slasherAddress)) {
-      throw ErrorInvalidSlasherAddressProvided;
-    }
-
-    try {
-      const { rewardAddedEvents } = await gqlFetch<{
-        rewardAddedEvents: RewardAddedEventData[];
-      }>(this.networkData.subgraphUrl, GET_REWARD_ADDED_EVENTS_QUERY, {
-        slasherAddress: slasherAddress.toLowerCase(),
-      });
-
-      return rewardAddedEvents.map((reward: any) => {
-        return {
-          escrowAddress: reward.escrow,
-          amount: reward.amount,
-        };
-      });
-    } catch (e) {
-      return throwError(e);
-    }
-  }
 }

package/src/statistics.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import { BigNumber } from 'ethers';
+import { ethers } from 'ethers';
 import gqlFetch from 'graphql-request';
 
 import {
@@ -296,14 +296,13 @@ export class StatisticsClient {
       return {
         dailyPaymentsData: eventDayDatas.map((eventDayData) => ({
           timestamp: new Date(+eventDayData.timestamp * 1000),
-          totalAmountPaid: BigNumber.from(eventDayData.dailyPayoutAmount),
+          totalAmountPaid: ethers.toBigInt(eventDayData.dailyPayoutAmount),
           totalCount: +eventDayData.dailyPayoutCount,
           averageAmountPerWorker:
             eventDayData.dailyWorkerCount === '0'
-              ? BigNumber.from(0)
-              : BigNumber.from(eventDayData.dailyPayoutAmount).div(
-                  eventDayData.dailyWorkerCount
-                ),
+              ? ethers.toBigInt(0)
+              : ethers.toBigInt(eventDayData.dailyPayoutAmount) /
+                ethers.toBigInt(eventDayData.dailyWorkerCount),
         })),
       };
     } catch (e: any) {
@@ -412,18 +411,18 @@ export class StatisticsClient {
       });
 
       return {
-        totalTransferAmount: BigNumber.from(
+        totalTransferAmount: ethers.toBigInt(
           hmtokenStatistics.totalValueTransfered
         ),
         totalTransferCount: Number(hmtokenStatistics.totalTransferEventCount),
         totalHolders: +hmtokenStatistics.holders,
         holders: holders.map((holder) => ({
           address: holder.address,
-          balance: BigNumber.from(holder.balance),
+          balance: ethers.toBigInt(holder.balance),
         })),
         dailyHMTData: eventDayDatas.map((eventDayData) => ({
           timestamp: new Date(+eventDayData.timestamp * 1000),
-          totalTransactionAmount: BigNumber.from(
+          totalTransactionAmount: ethers.toBigInt(
             eventDayData.dailyHMTTransferAmount
           ),
           totalTransactionCount: +eventDayData.dailyHMTTransferCount,

package/src/types.ts

@@ -1,5 +1,3 @@
-import { BigNumber } from 'ethers';
-
 /**
  * Enum for escrow statuses.
  * @readonly
@@ -150,5 +148,5 @@ export type EscrowCancel = {
   /**
    * The amount refunded in the escrow cancellation.
    */
-  amountRefunded: BigNumber;
+  amountRefunded: bigint;
 };