@human-protocol/sdk 6.0.0 → 6.1.0

package/src/escrow.ts

@@ -66,7 +66,12 @@ import {
   IEscrowWithdraw,
   SubgraphOptions,
 } from './interfaces';
-import { EscrowStatus, NetworkData, TransactionLikeWithNonce } from './types';
+import {
+  EscrowStatus,
+  NetworkData,
+  TransactionLikeWithNonce,
+  TransactionOverrides,
+} from './types';
 import {
   getSubgraphUrl,
   getUnixTimestamp,
@@ -205,20 +210,22 @@ export class EscrowClient extends BaseEthersClient {
   public async createEscrow(
     tokenAddress: string,
     jobRequesterId: string,
-    txOptions: Overrides = {}
+    txOptions: TransactionOverrides = {}
   ): Promise<string> {
     if (!ethers.isAddress(tokenAddress)) {
       throw ErrorInvalidTokenAddress;
     }
 
     try {
-      const result = await (
-        await this.escrowFactoryContract.createEscrow(
-          tokenAddress,
-          jobRequesterId,
-          txOptions
-        )
-      ).wait();
+      const result = await this.sendTxAndWait(
+        (overrides) =>
+          this.escrowFactoryContract.createEscrow(
+            tokenAddress,
+            jobRequesterId,
+            overrides
+          ),
+        txOptions
+      );
 
       const event = (
         result?.logs?.find(({ topics }) =>
@@ -340,7 +347,7 @@ export class EscrowClient extends BaseEthersClient {
     amount: bigint,
     jobRequesterId: string,
     escrowConfig: IEscrowConfig,
-    txOptions: Overrides = {}
+    txOptions: TransactionOverrides = {}
   ): Promise<string> {
     if (!ethers.isAddress(tokenAddress)) {
       throw ErrorInvalidTokenAddress;
@@ -360,22 +367,24 @@ export class EscrowClient extends BaseEthersClient {
     } = escrowConfig;
 
     try {
-      const result = await (
-        await this.escrowFactoryContract.createFundAndSetupEscrow(
-          tokenAddress,
-          amount,
-          jobRequesterId,
-          reputationOracle,
-          recordingOracle,
-          exchangeOracle,
-          reputationOracleFee,
-          recordingOracleFee,
-          exchangeOracleFee,
-          manifest,
-          manifestHash,
-          txOptions
-        )
-      ).wait();
+      const result = await this.sendTxAndWait(
+        (overrides) =>
+          this.escrowFactoryContract.createFundAndSetupEscrow(
+            tokenAddress,
+            amount,
+            jobRequesterId,
+            reputationOracle,
+            recordingOracle,
+            exchangeOracle,
+            reputationOracleFee,
+            recordingOracleFee,
+            exchangeOracleFee,
+            manifest,
+            manifestHash,
+            overrides
+          ),
+        txOptions
+      );
 
       const event = (
         result?.logs?.find(({ topics }) =>
@@ -433,7 +442,7 @@ export class EscrowClient extends BaseEthersClient {
   async setup(
     escrowAddress: string,
     escrowConfig: IEscrowConfig,
-    txOptions: Overrides = {}
+    txOptions: TransactionOverrides = {}
   ): Promise<void> {
     const {
       recordingOracle,
@@ -459,19 +468,21 @@ export class EscrowClient extends BaseEthersClient {
     try {
       const escrowContract = this.getEscrowContract(escrowAddress);
 
-      await (
-        await escrowContract.setup(
-          reputationOracle,
-          recordingOracle,
-          exchangeOracle,
-          reputationOracleFee,
-          recordingOracleFee,
-          exchangeOracleFee,
-          manifest,
-          manifestHash,
-          txOptions
-        )
-      ).wait();
+      await this.sendTxAndWait(
+        (overrides) =>
+          escrowContract.setup(
+            reputationOracle,
+            recordingOracle,
+            exchangeOracle,
+            reputationOracleFee,
+            recordingOracleFee,
+            exchangeOracleFee,
+            manifest,
+            manifestHash,
+            overrides
+          ),
+        txOptions
+      );
 
       return;
     } catch (e) {
@@ -502,7 +513,7 @@ export class EscrowClient extends BaseEthersClient {
   async fund(
     escrowAddress: string,
     amount: bigint,
-    txOptions: Overrides = {}
+    txOptions: TransactionOverrides = {}
   ): Promise<void> {
     if (!ethers.isAddress(escrowAddress)) {
       throw ErrorInvalidEscrowAddressProvided;
@@ -525,9 +536,10 @@ export class EscrowClient extends BaseEthersClient {
         tokenAddress,
         this.runner
       );
-      await (
-        await tokenContract.transfer(escrowAddress, amount, txOptions)
-      ).wait();
+      await this.sendTxAndWait(
+        (overrides) => tokenContract.transfer(escrowAddress, amount, overrides),
+        txOptions
+      );
 
       return;
     } catch (e) {
@@ -564,7 +576,7 @@ export class EscrowClient extends BaseEthersClient {
     escrowAddress: string,
     url: string,
     hash: string,
-    txOptions?: Overrides
+    txOptions?: TransactionOverrides
   ): Promise<void>;
 
   /**
@@ -604,7 +616,7 @@ export class EscrowClient extends BaseEthersClient {
     url: string,
     hash: string,
     fundsToReserve: bigint,
-    txOptions?: Overrides
+    txOptions?: TransactionOverrides
   ): Promise<void>;
 
   @requiresSigner
@@ -612,14 +624,16 @@ export class EscrowClient extends BaseEthersClient {
     escrowAddress: string,
     url: string,
     hash: string,
-    a?: bigint | Overrides,
-    b?: Overrides
+    a?: bigint | TransactionOverrides,
+    b?: TransactionOverrides
   ): Promise<void> {
     const escrowContract = this.getEscrowContract(escrowAddress);
 
     const hasFundsToReserveParam = typeof a === 'bigint';
     const fundsToReserve = hasFundsToReserveParam ? (a as bigint) : null;
-    const txOptions = (hasFundsToReserveParam ? b : a) || {};
+    const txOptions = (hasFundsToReserveParam ? b : a) as
+      | TransactionOverrides
+      | undefined;
     // When fundsToReserve is provided and is 0, allow empty URL.
     // In this situation not solutions might have been provided so the escrow can be straight cancelled.
     const allowEmptyUrl = hasFundsToReserveParam && fundsToReserve === 0n;
@@ -640,24 +654,17 @@ export class EscrowClient extends BaseEthersClient {
     }
 
     try {
-      if (fundsToReserve !== null) {
-        await (
-          await escrowContract['storeResults(string,string,uint256)'](
-            url,
-            hash,
-            fundsToReserve,
-            txOptions
-          )
-        ).wait();
-      } else {
-        await (
-          await escrowContract['storeResults(string,string)'](
-            url,
-            hash,
-            txOptions
-          )
-        ).wait();
-      }
+      const txFactory = (overrides: Overrides) =>
+        fundsToReserve !== null
+          ? escrowContract['storeResults(string,string,uint256)'](
+              url,
+              hash,
+              fundsToReserve,
+              overrides
+            )
+          : escrowContract['storeResults(string,string)'](url, hash, overrides);
+
+      await this.sendTxAndWait(txFactory, txOptions);
     } catch (e) {
       if (!hasFundsToReserveParam && e.reason === 'DEPRECATED_SIGNATURE') {
         throw ErrorStoreResultsVersion;
@@ -685,7 +692,7 @@ export class EscrowClient extends BaseEthersClient {
   @requiresSigner
   async complete(
     escrowAddress: string,
-    txOptions: Overrides = {}
+    txOptions: TransactionOverrides = {}
   ): Promise<void> {
     if (!ethers.isAddress(escrowAddress)) {
       throw ErrorInvalidEscrowAddressProvided;
@@ -697,8 +704,10 @@ export class EscrowClient extends BaseEthersClient {
 
     try {
       const escrowContract = this.getEscrowContract(escrowAddress);
-
-      await (await escrowContract.complete(txOptions)).wait();
+      await this.sendTxAndWait(
+        (overrides) => escrowContract.complete(overrides),
+        txOptions
+      );
       return;
     } catch (e) {
       return throwError(e);
@@ -759,7 +768,7 @@ export class EscrowClient extends BaseEthersClient {
     finalResultsHash: string,
     txId: number,
     forceComplete: boolean,
-    txOptions: Overrides
+    txOptions: TransactionOverrides
   ): Promise<void>;
 
   /**
@@ -817,7 +826,7 @@ export class EscrowClient extends BaseEthersClient {
     finalResultsHash: string,
     payoutId: string,
     forceComplete: boolean,
-    txOptions: Overrides
+    txOptions: TransactionOverrides
   ): Promise<void>;
 
   @requiresSigner
@@ -829,7 +838,7 @@ export class EscrowClient extends BaseEthersClient {
     finalResultsHash: string,
     id: number | string,
     forceComplete: boolean,
-    txOptions: Overrides = {}
+    txOptions: TransactionOverrides = {}
   ): Promise<void> {
     await this.ensureCorrectBulkPayoutInput(
       escrowAddress,
@@ -843,35 +852,32 @@ export class EscrowClient extends BaseEthersClient {
     const idIsString = typeof id === 'string';
 
     try {
-      if (idIsString) {
-        await (
-          await escrowContract[
-            'bulkPayOut(address[],uint256[],string,string,string,bool)'
-          ](
-            recipients,
-            amounts,
-            finalResultsUrl,
-            finalResultsHash,
-            id,
-            forceComplete,
-            txOptions
-          )
-        ).wait();
-      } else {
-        await (
-          await escrowContract[
-            'bulkPayOut(address[],uint256[],string,string,uint256,bool)'
-          ](
-            recipients,
-            amounts,
-            finalResultsUrl,
-            finalResultsHash,
-            id,
-            forceComplete,
-            txOptions
-          )
-        ).wait();
-      }
+      const txFactory = (overrides: Overrides) =>
+        idIsString
+          ? escrowContract[
+              'bulkPayOut(address[],uint256[],string,string,string,bool)'
+            ](
+              recipients,
+              amounts,
+              finalResultsUrl,
+              finalResultsHash,
+              id,
+              forceComplete,
+              overrides
+            )
+          : escrowContract[
+              'bulkPayOut(address[],uint256[],string,string,uint256,bool)'
+            ](
+              recipients,
+              amounts,
+              finalResultsUrl,
+              finalResultsHash,
+              id,
+              forceComplete,
+              overrides
+            );
+
+      await this.sendTxAndWait(txFactory, txOptions);
     } catch (e) {
       if (!idIsString && e.reason === 'DEPRECATED_SIGNATURE') {
         throw ErrorBulkPayOutVersion;
@@ -900,7 +906,7 @@ export class EscrowClient extends BaseEthersClient {
   @requiresSigner
   async cancel(
     escrowAddress: string,
-    txOptions: Overrides = {}
+    txOptions: TransactionOverrides = {}
   ): Promise<void> {
     if (!ethers.isAddress(escrowAddress)) {
       throw ErrorInvalidEscrowAddressProvided;
@@ -912,7 +918,10 @@ export class EscrowClient extends BaseEthersClient {
 
     try {
       const escrowContract = this.getEscrowContract(escrowAddress);
-      await (await escrowContract.cancel(txOptions)).wait();
+      await this.sendTxAndWait(
+        (overrides) => escrowContract.cancel(overrides),
+        txOptions
+      );
     } catch (e) {
       return throwError(e);
     }
@@ -936,7 +945,7 @@ export class EscrowClient extends BaseEthersClient {
   @requiresSigner
   async requestCancellation(
     escrowAddress: string,
-    txOptions: Overrides = {}
+    txOptions: TransactionOverrides = {}
   ): Promise<void> {
     if (!ethers.isAddress(escrowAddress)) {
       throw ErrorInvalidEscrowAddressProvided;
@@ -948,7 +957,10 @@ export class EscrowClient extends BaseEthersClient {
 
     try {
       const escrowContract = this.getEscrowContract(escrowAddress);
-      await (await escrowContract.requestCancellation(txOptions)).wait();
+      await this.sendTxAndWait(
+        (overrides) => escrowContract.requestCancellation(overrides),
+        txOptions
+      );
     } catch (e) {
       return throwError(e);
     }
@@ -981,7 +993,7 @@ export class EscrowClient extends BaseEthersClient {
   async withdraw(
     escrowAddress: string,
     tokenAddress: string,
-    txOptions: Overrides = {}
+    txOptions: TransactionOverrides = {}
   ): Promise<IEscrowWithdraw> {
     if (!ethers.isAddress(escrowAddress)) {
       throw ErrorInvalidEscrowAddressProvided;
@@ -997,10 +1009,10 @@ export class EscrowClient extends BaseEthersClient {
 
     try {
       const escrowContract = this.getEscrowContract(escrowAddress);
-
-      const transactionReceipt = await (
-        await escrowContract.withdraw(tokenAddress, txOptions)
-      ).wait();
+      const transactionReceipt = await this.sendTxAndWait(
+        (overrides) => escrowContract.withdraw(tokenAddress, overrides),
+        txOptions
+      );
 
       let amountTransferred: bigint | undefined = undefined;
 

package/src/interfaces.ts

@@ -149,8 +149,8 @@ export interface ITransaction {
 
 export interface ITransactionsFilter extends IPagination {
   chainId: ChainId;
-  startBlock?: number;
-  endBlock?: number;
+  startBlock?: number | bigint;
+  endBlock?: number | bigint;
   startDate?: Date;
   endDate?: Date;
   fromAddress?: string;

package/src/kvstore.ts

@@ -2,7 +2,7 @@ import {
   KVStore,
   KVStore__factory,
 } from '@human-protocol/core/typechain-types';
-import { ContractRunner, Overrides, ethers } from 'ethers';
+import { ContractRunner, ethers } from 'ethers';
 import { BaseEthersClient } from './base';
 import { KVStoreKeys, NETWORKS } from './constants';
 import { requiresSigner } from './decorators';
@@ -17,7 +17,7 @@ import {
   ErrorUnsupportedChainID,
   InvalidKeyError,
 } from './error';
-import { NetworkData } from './types';
+import { NetworkData, TransactionOverrides } from './types';
 import { getSubgraphUrl, customGqlFetch, isValidUrl } from './utils';
 import {
   GET_KVSTORE_BY_ADDRESS_AND_KEY_QUERY,
@@ -156,11 +156,14 @@ export class KVStoreClient extends BaseEthersClient {
   public async set(
     key: string,
     value: string,
-    txOptions: Overrides = {}
+    txOptions: TransactionOverrides = {}
   ): Promise<void> {
     if (key === '') throw ErrorKVStoreEmptyKey;
     try {
-      await (await this.contract.set(key, value, txOptions)).wait();
+      await this.sendTxAndWait(
+        (overrides) => this.contract.set(key, value, overrides),
+        txOptions
+      );
     } catch (e) {
       if (e instanceof Error) throw Error(`Failed to set value: ${e.message}`);
     }
@@ -188,13 +191,16 @@ export class KVStoreClient extends BaseEthersClient {
   public async setBulk(
     keys: string[],
     values: string[],
-    txOptions: Overrides = {}
+    txOptions: TransactionOverrides = {}
   ): Promise<void> {
     if (keys.length !== values.length) throw ErrorKVStoreArrayLength;
     if (keys.includes('')) throw ErrorKVStoreEmptyKey;
 
     try {
-      await (await this.contract.setBulk(keys, values, txOptions)).wait();
+      await this.sendTxAndWait(
+        (overrides) => this.contract.setBulk(keys, values, overrides),
+        txOptions
+      );
     } catch (e) {
       if (e instanceof Error)
         throw Error(`Failed to set bulk values: ${e.message}`);
@@ -221,7 +227,7 @@ export class KVStoreClient extends BaseEthersClient {
   public async setFileUrlAndHash(
     url: string,
     urlKey = 'url',
-    txOptions: Overrides = {}
+    txOptions: TransactionOverrides = {}
   ): Promise<void> {
     if (!isValidUrl(url)) {
       throw ErrorInvalidUrl;
@@ -233,13 +239,15 @@ export class KVStoreClient extends BaseEthersClient {
     const hashKey = urlKey + '_hash';
 
     try {
-      await (
-        await this.contract.setBulk(
-          [urlKey, hashKey],
-          [url, contentHash],
-          txOptions
-        )
-      ).wait();
+      await this.sendTxAndWait(
+        (overrides) =>
+          this.contract.setBulk(
+            [urlKey, hashKey],
+            [url, contentHash],
+            overrides
+          ),
+        txOptions
+      );
     } catch (e) {
       if (e instanceof Error)
         throw Error(`Failed to set URL and hash: ${e.message}`);

package/src/staking.ts

@@ -6,7 +6,7 @@ import {
   Staking,
   Staking__factory,
 } from '@human-protocol/core/typechain-types';
-import { ContractRunner, Overrides, ethers } from 'ethers';
+import { ContractRunner, ethers } from 'ethers';
 import { BaseEthersClient } from './base';
 import { NETWORKS } from './constants';
 import { requiresSigner } from './decorators';
@@ -29,7 +29,7 @@ import {
   SubgraphOptions,
 } from './interfaces';
 import { StakerData } from './graphql';
-import { NetworkData } from './types';
+import { NetworkData, TransactionOverrides } from './types';
 import { getSubgraphUrl, customGqlFetch, throwError } from './utils';
 import {
   GET_STAKER_BY_ADDRESS_QUERY,
@@ -194,7 +194,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 +205,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 +242,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 +255,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 +288,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 +299,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 +323,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 +370,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 +391,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) {

package/src/transaction.ts

@@ -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,