@human-protocol/sdk 3.0.7 → 4.0.0

package/src/staking.ts

@@ -3,8 +3,6 @@ import {
   EscrowFactory__factory,
   HMToken,
   HMToken__factory,
-  RewardPool,
-  RewardPool__factory,
   Staking,
   Staking__factory,
 } from '@human-protocol/core/typechain-types';
@@ -23,26 +21,26 @@ import {
   ErrorProviderDoesNotExist,
   ErrorUnsupportedChainID,
 } from './error';
-import { IAllocation } from './interfaces';
 import { NetworkData } from './types';
 import { throwError } from './utils';
+import { StakerInfo } from './interfaces';
 
 /**
  * ## Introduction
  *
- * This client enables to perform actions on staking contracts and obtain staking information from both the contracts and subgraph.
+ * This client enables performing actions on staking contracts and obtaining staking 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<StakingClient>;
  * ```
  *
  * 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
  *
@@ -60,21 +58,21 @@ import { throwError } from './utils';
  *
  * ### Signer
  *
- * **Using private key(backend)**
+ * **Using private key (backend)**
  *
  * ```ts
  * import { StakingClient } 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 stakingClient = await StakingClient.build(signer);
  * ```
  *
- * **Using Wagmi(frontend)**
+ * **Using Wagmi (frontend)**
  *
  * ```ts
  * import { useSigner, useChainId } from 'wagmi';
@@ -100,13 +98,12 @@ export class StakingClient extends BaseEthersClient {
   public tokenContract: HMToken;
   public stakingContract: Staking;
   public escrowFactoryContract: EscrowFactory;
-  public rewardPoolContract: RewardPool;
 
   /**
    * **StakingClient constructor**
    *
    * @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 {NetworkData} networkData - The network information required to connect to the Staking contract
    */
   constructor(runner: ContractRunner, networkData: NetworkData) {
     super(runner, networkData);
@@ -125,24 +122,18 @@ export class StakingClient extends BaseEthersClient {
       networkData.hmtAddress,
       runner
     );
-
-    this.rewardPoolContract = RewardPool__factory.connect(
-      networkData.rewardPoolAddress,
-      this.runner
-    );
   }
 
   /**
    * Creates an instance of StakingClient from a Runner.
    *
    * @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(runner: ContractRunner) {
+  public static async build(runner: ContractRunner): Promise<StakingClient> {
     if (!runner.provider) {
       throw ErrorProviderDoesNotExist;
     }
@@ -181,7 +172,6 @@ export class StakingClient extends BaseEthersClient {
    * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
-   *
    * **Code example**
    *
    * ```ts
@@ -189,7 +179,7 @@ export class StakingClient extends BaseEthersClient {
    * import { StakingClient } 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);
@@ -235,7 +225,6 @@ export class StakingClient extends BaseEthersClient {
    * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
-   *
    * **Code example**
    *
    * ```ts
@@ -243,7 +232,7 @@ export class StakingClient extends BaseEthersClient {
    * import { StakingClient } 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);
@@ -251,7 +240,7 @@ export class StakingClient extends BaseEthersClient {
    *
    * 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);
+   * await stakingClient.stake(amount);
    * ```
    */
   @requiresSigner
@@ -281,7 +270,6 @@ export class StakingClient extends BaseEthersClient {
    * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
-   *
    * **Code example**
    *
    * ```ts
@@ -289,7 +277,7 @@ export class StakingClient extends BaseEthersClient {
    * import { StakingClient } 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);
@@ -321,14 +309,13 @@ export class StakingClient extends BaseEthersClient {
   }
 
   /**
-   * This function withdraws unstaked and non locked tokens form staking contract to the user wallet.
+   * This function withdraws unstaked and non-locked tokens from staking contract to the user wallet.
    *
    * > 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.
    *
-   *
    * **Code example**
    *
    * ```ts
@@ -336,7 +323,7 @@ export class StakingClient extends BaseEthersClient {
    * import { StakingClient } 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);
@@ -356,16 +343,15 @@ export class StakingClient extends BaseEthersClient {
   }
 
   /**
-   * This function reduces the allocated amount by an staker in an escrow and transfers those tokens to the reward pool. This allows the slasher to claim them later.
+   * This function reduces the allocated amount by a staker in an escrow and transfers those tokens to the reward pool. This allows the slasher to claim them later.
    *
    * @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 {string} escrowAddress Address of the escrow that the slash is made
+   * @param {bigint} amount Amount in WEI of tokens to slash.
    * @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.
    *
-   *
    * **Code example**
    *
    * ```ts
@@ -373,7 +359,7 @@ export class StakingClient extends BaseEthersClient {
    * import { StakingClient } 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);
@@ -427,175 +413,55 @@ export class StakingClient extends BaseEthersClient {
   }
 
   /**
-   * This function allocates a portion of the staked tokens to a specific escrow.
-   *
-   * > Must have tokens staked
-   *
-   * @param {string} escrowAddress Address of the escrow contract to allocate in.
-   * @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.
-   *
-   *
-   * **Code example**
-   *
-   * ```ts
-   * import { ethers, Wallet, providers } from 'ethers';
-   * import { StakingClient } from '@human-protocol/sdk';
-   *
-   * const rpcUrl = 'YOUR_RPC_URL';
-   * const privateKey = 'YOUR_PRIVATE_KEY'
-   *
-   * const provider = new providers.JsonRpcProvider(rpcUrl);
-   * const signer = new Wallet(privateKey, provider);
-   * const stakingClient = await StakingClient.build(signer);
-   *
-   * const amount = ethers.parseUnits(5, 'ether'); //convert from ETH to WEI
-   * await stakingClient.allocate('0x62dD51230A30401C455c8398d06F85e4EaB6309f', amount);
-   * ```
-   */
-  @requiresSigner
-  public async allocate(
-    escrowAddress: string,
-    amount: bigint,
-    txOptions: Overrides = {}
-  ): Promise<void> {
-    if (typeof amount !== 'bigint') {
-      throw ErrorInvalidStakingValueType;
-    }
-
-    if (amount < 0n) {
-      throw ErrorInvalidStakingValueSign;
-    }
-
-    await this.checkValidEscrow(escrowAddress);
-
-    try {
-      await (
-        await this.stakingContract.allocate(escrowAddress, amount, txOptions)
-      ).wait();
-      return;
-    } catch (e) {
-      return throwError(e);
-    }
-  }
-
-  /**
-   * This function drops the allocation from a specific escrow.
-   *
-   * > The escrow must have allocation
-   * > 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.
-   *
-   *
-   * **Code example**
-   *
-   * ```ts
-   * import { Wallet, providers } from 'ethers';
-   * import { StakingClient } from '@human-protocol/sdk';
-   *
-   * const rpcUrl = 'YOUR_RPC_URL';
-   * const privateKey = 'YOUR_PRIVATE_KEY'
-   *
-   * const provider = new providers.JsonRpcProvider(rpcUrl);
-   * const signer = new Wallet(privateKey, provider);
-   * const stakingClient = await StakingClient.build(signer);
-   *
-   * await stakingClient.closeAllocation('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
-   * ```
-   */
-  @requiresSigner
-  public async closeAllocation(
-    escrowAddress: string,
-    txOptions: Overrides = {}
-  ): Promise<void> {
-    await this.checkValidEscrow(escrowAddress);
-
-    try {
-      await (
-        await this.stakingContract.closeAllocation(escrowAddress, txOptions)
-      ).wait();
-      return;
-    } catch (e) {
-      return throwError(e);
-    }
-  }
-
-  /**
-   * This function drops the allocation from a specific escrow.
-   *
-   * > 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.
-   *
-   *
-   * **Code example**
-   *
-   * ```ts
-   * import { Wallet, providers } from 'ethers';
-   * import { StakingClient } from '@human-protocol/sdk';
-   *
-   * const rpcUrl = 'YOUR_RPC_URL';
-   * const privateKey = 'YOUR_PRIVATE_KEY'
-   *
-   * const provider = new providers.JsonRpcProvider(rpcUrl);
-   * const signer = new Wallet(privateKey, provider);
-   * const stakingClient = await StakingClient.build(signer);
-   *
-   * await stakingClient.distributeReward('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
-   * ```
-   */
-  @requiresSigner
-  public async distributeReward(
-    escrowAddress: string,
-    txOptions: Overrides = {}
-  ): Promise<void> {
-    await this.checkValidEscrow(escrowAddress);
-
-    try {
-      (
-        await this.rewardPoolContract.distributeReward(escrowAddress, txOptions)
-      ).wait();
-      return;
-    } catch (e) {
-      return throwError(e);
-    }
-  }
-
-  /**
-   * This function returns information about the allocation of the specified escrow.
-   *
-   * @param {string} escrowAddress Escrow address from which we want to get allocation information.
-   * @returns {IAllocation} Returns allocation info if exists.
+   * Retrieves comprehensive staking information for a staker.
    *
+   * @param {string} stakerAddress - The address of the staker.
+   * @returns {Promise<StakerInfo>}
    *
    * **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 allocationInfo = await stakingClient.getAllocation('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+   * const stakingInfo = await stakingClient.getStakerInfo('0xYourStakerAddress');
+   * console.log(stakingInfo.tokensStaked);
    * ```
    */
-  public async getAllocation(escrowAddress: string): Promise<IAllocation> {
-    await this.checkValidEscrow(escrowAddress);
+  public async getStakerInfo(stakerAddress: string): Promise<StakerInfo> {
+    if (!ethers.isAddress(stakerAddress)) {
+      throw ErrorInvalidStakerAddressProvided;
+    }
 
     try {
-      const result = await this.stakingContract.getAllocation(escrowAddress);
-      return result;
-    } catch (e) {
-      return throwError(e);
+      const stakerInfo = await this.stakingContract.stakes(stakerAddress);
+      const currentBlock = await this.runner.provider!.getBlockNumber();
+
+      const tokensWithdrawable =
+        stakerInfo.tokensLockedUntil !== 0n &&
+        currentBlock >= stakerInfo.tokensLockedUntil
+          ? stakerInfo.tokensLocked
+          : 0n;
+
+      const adjustedLockedAmount =
+        stakerInfo.tokensLockedUntil !== 0n &&
+        currentBlock >= stakerInfo.tokensLockedUntil
+          ? 0n
+          : stakerInfo.tokensLocked;
+
+      return {
+        stakedAmount: stakerInfo.tokensStaked,
+        lockedAmount: adjustedLockedAmount,
+        lockedUntil:
+          adjustedLockedAmount === 0n ? 0n : stakerInfo.tokensLockedUntil,
+        withdrawableAmount: tokensWithdrawable,
+      };
+    } catch (error) {
+      return throwError(error);
     }
   }
 }

package/src/statistics.ts

@@ -26,20 +26,15 @@ import { OrderDirection } from './enums';
 /**
  * ## Introduction
  *
- * This client enables to obtain statistical information from the subgraph.
+ * This client enables obtaining statistical information from the subgraph.
  *
- * Unlikely from the other SDK clients, `StatisticsClient` does not require `signer` or `provider` to be provided.
- * We just need to create client object using relevant network data.
+ * Unlike other SDK clients, `StatisticsClient` does not require `signer` or `provider` to be provided.
+ * We just need to create a client object using relevant network data.
  *
  * ```ts
  * constructor(network: NetworkData)
  * ```
  *
- * 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.
- *
  * ## Installation
  *
  * ### npm
@@ -77,7 +72,6 @@ export class StatisticsClient {
   /**
    * This function returns the statistical data of escrows.
    *
-   *
    * **Input parameters**
    *
    * ```ts
@@ -106,10 +100,8 @@ export class StatisticsClient {
    * };
    * ```
    *
-   *
    * @param {IStatisticsFilter} filter Statistics params with duration data
-   * @returns {EscrowStatistics} Escrow statistics data.
-   *
+   * @returns {Promise<EscrowStatistics>} Escrow statistics data.
    *
    * **Code example**
    *
@@ -149,7 +141,9 @@ export class StatisticsClient {
       });
 
       return {
-        totalEscrows: +escrowStatistics.totalEscrowCount,
+        totalEscrows: escrowStatistics?.totalEscrowCount
+          ? +escrowStatistics.totalEscrowCount
+          : 0,
         dailyEscrowsData: eventDayDatas.map((eventDayData) => ({
           timestamp: new Date(+eventDayData.timestamp * 1000),
           escrowsTotal: +eventDayData.dailyEscrowCount,
@@ -167,7 +161,6 @@ export class StatisticsClient {
   /**
    * This function returns the statistical data of workers.
    *
-   *
    * **Input parameters**
    *
    * ```ts
@@ -191,10 +184,8 @@ export class StatisticsClient {
    * };
    * ```
    *
-   *
    * @param {IStatisticsFilter} filter Statistics params with duration data
-   * @returns {WorkerStatistics} Worker statistics data.
-   *
+   * @returns {Promise<WorkerStatistics>} Worker statistics data.
    *
    * **Code example**
    *
@@ -243,7 +234,6 @@ export class StatisticsClient {
   /**
    * This function returns the statistical data of payments.
    *
-   *
    * **Input parameters**
    *
    * ```ts
@@ -269,10 +259,8 @@ export class StatisticsClient {
    * };
    * ```
    *
-   *
    * @param {IStatisticsFilter} filter Statistics params with duration data
-   * @returns {PaymentStatistics} Payment statistics data.
-   *
+   * @returns {Promise<PaymentStatistics>} Payment statistics data.
    *
    * **Code example**
    *
@@ -348,7 +336,7 @@ export class StatisticsClient {
   /**
    * This function returns the statistical data of HMToken.
    *
-   *
+   * ```ts
    * type HMTStatistics = {
    *   totalTransferAmount: BigNumber;
    *   totalTransferCount: BigNumber;
@@ -356,9 +344,7 @@ export class StatisticsClient {
    * };
    * ```
    *
-   *
-   * @returns {HMTStatistics} HMToken statistics data.
-   *
+   * @returns {Promise<HMTStatistics>} HMToken statistics data.
    *
    * **Code example**
    *
@@ -399,7 +385,7 @@ export class StatisticsClient {
    * **Input parameters**
    *
    * @param {IHMTHoldersParams} params HMT Holders params with filters and ordering
-   * @returns {HMTHolder[]} List of HMToken holders.
+   * @returns {Promise<HMTHolder[]>} List of HMToken holders.
    *
    * **Code example**
    *
@@ -445,7 +431,6 @@ export class StatisticsClient {
   /**
    * This function returns the statistical data of HMToken day by day.
    *
-   *
    * **Input parameters**
    *
    * ```ts
@@ -468,10 +453,8 @@ export class StatisticsClient {
    * }
    * ```
    *
-   *
    * @param {IStatisticsFilter} filter Statistics params with duration data
-   * @returns {DailyHMTData[]} Daily HMToken statistics data.
-   *
+   * @returns {Promise<DailyHMTData[]>} Daily HMToken statistics data.
    *
    * **Code example**
    *

package/src/storage.ts

@@ -19,7 +19,7 @@ import { HttpStatus } from './constants';
  *
  * ## Introduction
  *
- * This client enables to interact with S3 cloud storage services like Amazon S3 Bucket, Google Cloud Storage and others.
+ * This client enables interacting with S3 cloud storage services like Amazon S3 Bucket, Google Cloud Storage, and others.
  *
  * The instance creation of `StorageClient` should be made using its constructor:
  *
@@ -27,7 +27,7 @@ import { HttpStatus } from './constants';
  * constructor(params: StorageParams, credentials?: StorageCredentials)
  * ```
  *
- * > If credentials is not provided, it uses an anonymous access to the bucket for downloading files.
+ * > If credentials are not provided, it uses anonymous access to the bucket for downloading files.
  *
  * ## Installation
  *
@@ -68,7 +68,7 @@ export class StorageClient {
    * **Storage client constructor**
    *
    * @param {StorageParams} params - Cloud storage params
-   * @param {StorageCredentials} credentials - Optional. Cloud storage access data. If credentials is not provided - use an anonymous access to the bucket
+   * @param {StorageCredentials} credentials - Optional. Cloud storage access data. If credentials are not provided - use anonymous access to the bucket
    */
   constructor(params: StorageParams, credentials?: StorageCredentials) {
     try {
@@ -89,8 +89,7 @@ export class StorageClient {
    *
    * @param {string[]} keys Array of filenames to download.
    * @param {string} bucket Bucket name.
-   * @returns {any[]} Returns an array of json files downloaded and parsed into objects.
-   *
+   * @returns {Promise<any[]>} Returns an array of JSON files downloaded and parsed into objects.
    *
    * **Code example**
    *
@@ -131,18 +130,17 @@ export class StorageClient {
   }
 
   /**
-   * This function downloads files from a Url.
-   *
-   * @param {string} url Url of the file to download.
-   * @returns {any} Returns the JSON file downloaded and parsed into object.
+   * This function downloads files from a URL.
    *
+   * @param {string} url URL of the file to download.
+   * @returns {Promise<any>} Returns the JSON file downloaded and parsed into an object.
    *
    * **Code example**
    *
    * ```ts
    * import { StorageClient } from '@human-protocol/sdk';
    *
-   * const file = await storageClient.downloadFileFromUrl('http://localhost/file.json');
+   * const file = await StorageClient.downloadFileFromUrl('http://localhost/file.json');
    * ```
    */
   public static async downloadFileFromUrl(url: string): Promise<any> {
@@ -170,10 +168,9 @@ export class StorageClient {
   /**
    * This function uploads files to a bucket.
    *
-   * @param {any[]} files Array of objects to upload serialized into json.
+   * @param {any[]} files Array of objects to upload serialized into JSON.
    * @param {string} bucket Bucket name.
-   * @returns {UploadFile[]} Returns an array of json files downloaded and parsed into objects.
-   *
+   * @returns {Promise<UploadFile[]>} Returns an array of uploaded file metadata.
    *
    * **Code example**
    *
@@ -240,8 +237,7 @@ export class StorageClient {
    * This function checks if a bucket exists.
    *
    * @param {string} bucket Bucket name.
-   * @returns {boolean} Returns `true` if exists, `false` if it doesn't.
-   *
+   * @returns {Promise<boolean>} Returns `true` if exists, `false` if it doesn't.
    *
    * **Code example**
    *
@@ -268,11 +264,10 @@ export class StorageClient {
   }
 
   /**
-   * This function list all file names contained in the bucket.
+   * This function lists all file names contained in the bucket.
    *
    * @param {string} bucket Bucket name.
-   * @returns {boolean} Returns the list of file names contained in the bucket.
-   *
+   * @returns {Promise<string[]>} Returns the list of file names contained in the bucket.
    *
    * **Code example**
    *

package/src/transaction.ts

@@ -5,7 +5,7 @@ import { NETWORKS } from './constants';
 import { ChainId, OrderDirection } from './enums';
 import {
   ErrorCannotUseDateAndBlockSimultaneously,
-  ErrorInvalidHahsProvided,
+  ErrorInvalidHashProvided,
   ErrorUnsupportedChainID,
 } from './error';
 import {
@@ -36,7 +36,7 @@ export class TransactionUtils {
     hash: string
   ): Promise<ITransaction> {
     if (!ethers.isHexString(hash)) {
-      throw ErrorInvalidHahsProvided;
+      throw ErrorInvalidHashProvided;
     }
     const networkData = NETWORKS[chainId];