@human-protocol/sdk 1.1.18 → 1.1.19

package/src/constants.ts

@@ -59,7 +59,7 @@ export const NETWORKS: {
     hmtAddress: '0xd1ba9BAC957322D6e8c07a160a3A8dA11A0d2867',
     stakingAddress: '0x05398211bA2046E296fBc9a9D3EB49e3F15C3123',
     rewardPoolAddress: '0x4A5963Dd6792692e9147EdC7659936b96251917a',
-    kvstoreAddress: '0x70671167176C4934204B1C7e97F5e86695857ef2',
+    kvstoreAddress: '0xB6d36B1CDaD50302BCB3DB43bAb0D349458e1b8D',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/mainnet-v2',
     oldSubgraphUrl: '',
@@ -86,7 +86,7 @@ export const NETWORKS: {
     hmtAddress: '0xd3A31D57FDD790725d0F6B78095F62E8CD4ab317',
     stakingAddress: '0xf46B45Df3d956369726d8Bd93Ba33963Ab692920',
     rewardPoolAddress: '0x0376D26246Eb35FF4F9924cF13E6C05fd0bD7Fb4',
-    kvstoreAddress: '0xc9Fe39c4b6e1d7A2991355Af159956982DADf842',
+    kvstoreAddress: '0x19Fc3e859C1813ac9427a7a78BeB9ae102CE96d3',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/goerli-v2',
     oldSubgraphUrl:
@@ -101,7 +101,7 @@ export const NETWORKS: {
     hmtAddress: '0x711Fd6ab6d65A98904522d4e3586F492B989c527',
     stakingAddress: '0xdFbB79dC35a3A53741be54a2C9b587d6BafAbd1C',
     rewardPoolAddress: '0xf376443BCc6d4d4D63eeC086bc4A9E4a83878e0e',
-    kvstoreAddress: '0x2B95bEcb6EBC4589f64CB000dFCF716b4aeF8aA6',
+    kvstoreAddress: '0x21A0C4CED7aE447fCf87D9FE3A29FA9B3AB20Ff1',
     subgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/bsc-v2',
     oldSubgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/bsc',
     oldFactoryAddress: '0xc88bC422cAAb2ac8812de03176402dbcA09533f4',
@@ -114,7 +114,7 @@ export const NETWORKS: {
     hmtAddress: '0xE3D74BBFa45B4bCa69FF28891fBE392f4B4d4e4d',
     stakingAddress: '0x5517fE916Fe9F8dB15B0DDc76ebDf0BdDCd4ed18',
     rewardPoolAddress: '0xB0A0500103eCEc431b73F6BAd923F0a2774E6e29',
-    kvstoreAddress: '0x3aD4B091E054f192a822D1406f4535eAd38580e4',
+    kvstoreAddress: '0x32e27177BA6Ea91cf28dfd91a0Da9822A4b74EcF',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/bsctest-v2',
     oldSubgraphUrl:
@@ -129,7 +129,7 @@ export const NETWORKS: {
     hmtAddress: '0xc748B2A084F8eFc47E086ccdDD9b7e67aEb571BF',
     stakingAddress: '0xcbAd56bE3f504E98bd70875823d3CC0242B7bB29',
     rewardPoolAddress: '0xa8e32d777a3839440cc7c24D591A64B9481753B3',
-    kvstoreAddress: '0x35Cf4beBD58F9C8D75B9eA2599479b6C173d406F',
+    kvstoreAddress: '0xbcB28672F826a50B03EE91B28145EAbddA73B2eD',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/polygon-v2',
     oldSubgraphUrl:
@@ -144,7 +144,7 @@ export const NETWORKS: {
     hmtAddress: '0x0376D26246Eb35FF4F9924cF13E6C05fd0bD7Fb4',
     stakingAddress: '0x7Fd3dF914E7b6Bd96B4c744Df32183b51368Bfac',
     rewardPoolAddress: '0xf0145eD99AC3c4f877aDa7dA4D1E059ec9116BAE',
-    kvstoreAddress: '0xD7F61E812e139a5a02eDae9Dfec146E1b8eA3807',
+    kvstoreAddress: '0xD96158c7267Ea658a4688F4aEf1c85659851625d',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/mumbai-v2',
     oldSubgraphUrl:
@@ -159,7 +159,7 @@ export const NETWORKS: {
     hmtAddress: '0x3b25BC1dC591D24d60560d0135D6750A561D4764',
     stakingAddress: '0x05398211bA2046E296fBc9a9D3EB49e3F15C3123',
     rewardPoolAddress: '0x4A5963Dd6792692e9147EdC7659936b96251917a',
-    kvstoreAddress: '0x70671167176C4934204B1C7e97F5e86695857ef2',
+    kvstoreAddress: '0x2B95bEcb6EBC4589f64CB000dFCF716b4aeF8aA6',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/moonbeam-v2',
     oldSubgraphUrl:
@@ -174,7 +174,7 @@ export const NETWORKS: {
     hmtAddress: '0x2dd72db2bBA65cE663e476bA8b84A1aAF802A8e3',
     stakingAddress: '0xBFC7009F3371F93F3B54DdC8caCd02914a37495c',
     rewardPoolAddress: '0xf46B45Df3d956369726d8Bd93Ba33963Ab692920',
-    kvstoreAddress: '0xE3D74BBFa45B4bCa69FF28891fBE392f4B4d4e4d',
+    kvstoreAddress: '0xcC561f4482f4Ff051D2Dcc65c2cE1A0f291bbA46',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/moonbase-alpha-v2',
     oldSubgraphUrl: '',
@@ -188,7 +188,7 @@ export const NETWORKS: {
     hmtAddress: '0x9406d5c635AD22b0d76c75E52De57A2177919ca3',
     stakingAddress: '0x9890473B0b93E24d6D1a8Dfb739D577C6f25FFd3',
     rewardPoolAddress: '0x5517fE916Fe9F8dB15B0DDc76ebDf0BdDCd4ed18',
-    kvstoreAddress: '0x707fb5A5d36BC15275Af3f73262bf9a1D8C470EB',
+    kvstoreAddress: '0x3aD4B091E054f192a822D1406f4535eAd38580e4',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/fuji-v2',
     oldSubgraphUrl:
@@ -203,7 +203,7 @@ export const NETWORKS: {
     hmtAddress: '0x12365293cb6477d4fc2686e46BB97E3Fb64f1550',
     stakingAddress: '0x05398211bA2046E296fBc9a9D3EB49e3F15C3123',
     rewardPoolAddress: '0x4A5963Dd6792692e9147EdC7659936b96251917a',
-    kvstoreAddress: '0x70671167176C4934204B1C7e97F5e86695857ef2',
+    kvstoreAddress: '0x9Bc7bff35B2Be2413708d48c3B0aEF5c43646728',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/avalanche-v2',
     oldSubgraphUrl:
@@ -273,3 +273,11 @@ export const KVStoreKeys = {
   webhookUrl: 'webhookUrl',
   url: 'url',
 };
+
+export const Role = {
+  Validator: 'Validator',
+  JobLauncher: 'Job Launcher',
+  ExchangeOracle: 'Exchange Oracle',
+  ReputationOracle: 'Reputation Oracle',
+  RecordingOracle: 'Recording Oracle',
+};

package/src/encryption.ts

@@ -437,4 +437,44 @@ export class EncryptionUtils {
 
     return encrypted as string;
   }
+
+  /**
+   * Verifies if a message appears to be encrypted with OpenPGP.
+   *
+   * @param {string} message Message to verify.
+   * @returns {Promise<boolean>} `true` if the message appears to be encrypted, `false` if not.
+   *
+   * **Code example:**
+   *
+   * ```ts
+   * const message = `-----BEGIN PGP MESSAGE-----
+   *
+   * wV4DqdeRpqH+jaISAQdAsvBFxikvjxRqC7ZlDe98cLd7/aeCEI/AcL8PpVKK
+   * mC0wKlwxNg/ADi55z9jcYFuMC4kKE+C/teM+JqiI8DO9AwassQUvKFtULnpx
+   * h2jaOjC/0sAQASjUsIFK8zbuDgk/P8T9Npn6px+GlJPg9K90iwtPWiIp0eyW
+   * 4zXamJZT51k2DyaUX/Rsc6P4PYhQRKjt0yxtH0jHPmKkLC/9eBeFf4GP0zlZ
+   * 18xMZ8uCpQCma708Gz0sJYxEz3u/eZdHD7Mc7tWQKyJG8MsTwM1P+fdK1X75
+   * L9UryJG2AY+6kKZhG4dqjNxiO4fWluiB2u7iMF+iLEyE3SQCEYorWMC+NDWi
+   * QIJZ7oQ2w7BaPo1a991gvTOSNm5v2x44KfqPI1uj859BjsQTCA==
+   * =tsmI
+   * -----END PGP MESSAGE-----`;
+   *
+   * const isEncrypted = await EncriptionUtils.isEncrypted(message);
+   *
+   * if (isEncrypted) {
+   *   console.log('The message is encrypted with OpenPGP.');
+   * } else {
+   *   console.log('The message is not encrypted with OpenPGP.');
+   * }
+   * ```
+   */
+  public static isEncrypted(message: string): boolean {
+    const startMarker = '-----BEGIN PGP MESSAGE-----';
+    const endMarker = '-----END PGP MESSAGE-----';
+
+    const hasStartMarker = message.includes(startMarker);
+    const hasEndMarker = message.includes(endMarker);
+
+    return hasStartMarker && hasEndMarker;
+  }
 }

package/src/error.ts

@@ -334,8 +334,3 @@ export class InvalidEthereumAddressError extends Error {
  * @constant {Error} - The Hash does not match
  */
 export const ErrorInvalidHash = new Error('Invalid hash');
-
-/**
- * @constant {Error} - The Hash does not match
- */
-export const ErrorMissingGasPrice = new Error('Missing gas price');

package/src/escrow.ts

@@ -9,7 +9,7 @@ import {
   HMToken,
   HMToken__factory,
 } from '@human-protocol/core/typechain-types';
-import { BigNumber, ContractReceipt, Signer, ethers } from 'ethers';
+import { BigNumber, ContractReceipt, Overrides, Signer, ethers } from 'ethers';
 import gqlFetch from 'graphql-request';
 import { BaseEthersClient } from './base';
 import { DEFAULT_TX_ID, NETWORKS } from './constants';
@@ -125,14 +125,9 @@ export class EscrowClient extends BaseEthersClient {
    *
    * @param {Signer | Provider} signerOrProvider The Signer or Provider object to interact with the Ethereum network
    * @param {NetworkData} network The network information required to connect to the Escrow 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(signerOrProvider: Signer | Provider, networkData: NetworkData) {
+    super(signerOrProvider, networkData);
 
     this.escrowFactoryContract = EscrowFactory__factory.connect(
       networkData.factoryAddress,
@@ -144,16 +139,12 @@ export class EscrowClient extends BaseEthersClient {
    * Creates an instance of EscrowClient from a Signer or Provider.
    *
    * @param {Signer | Provider} signerOrProvider The Signer or Provider object to interact with the Ethereum network
-   * @param {number | undefined} gasPriceMultiplier The multiplier to apply to the gas price
    *
    * @returns {Promise<EscrowClient>} An instance of EscrowClient
    * @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
-  ) {
+  public static async build(signerOrProvider: Signer | Provider) {
     let network: Network;
     if (Signer.isSigner(signerOrProvider)) {
       if (!signerOrProvider.provider) {
@@ -172,7 +163,7 @@ export class EscrowClient extends BaseEthersClient {
       throw ErrorUnsupportedChainID;
     }
 
-    return new EscrowClient(signerOrProvider, networkData, gasPriceMultiplier);
+    return new EscrowClient(signerOrProvider, networkData);
   }
 
   /**
@@ -194,6 +185,7 @@ export class EscrowClient extends BaseEthersClient {
    * @param {string} tokenAddress Token address to use for pay outs.
    * @param {string[]} trustedHandlers Array of addresses that can perform actions on the contract.
    * @param {string} jobRequesterId Job Requester Id
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns {Promise<string>} Return the address of the escrow created.
    *
    *
@@ -222,7 +214,8 @@ export class EscrowClient extends BaseEthersClient {
   public async createEscrow(
     tokenAddress: string,
     trustedHandlers: string[],
-    jobRequesterId: string
+    jobRequesterId: string,
+    txOptions: Overrides = {}
   ): Promise<string> {
     if (!ethers.utils.isAddress(tokenAddress)) {
       throw ErrorInvalidTokenAddress;
@@ -240,9 +233,7 @@ export class EscrowClient extends BaseEthersClient {
           tokenAddress,
           trustedHandlers,
           jobRequesterId,
-          {
-            ...(await this.gasPriceOptions()),
-          }
+          txOptions
         )
       ).wait();
 
@@ -265,6 +256,7 @@ export class EscrowClient extends BaseEthersClient {
    *
    * @param {string} escrowAddress Address of the escrow to set up.
    * @param {IEscrowConfig} escrowConfig Escrow configuration parameters.
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -300,7 +292,8 @@ export class EscrowClient extends BaseEthersClient {
   @requiresSigner
   async setup(
     escrowAddress: string,
-    escrowConfig: IEscrowConfig
+    escrowConfig: IEscrowConfig,
+    txOptions: Overrides = {}
   ): Promise<void> {
     const {
       recordingOracle,
@@ -362,19 +355,19 @@ export class EscrowClient extends BaseEthersClient {
     try {
       const escrowContract = this.getEscrowContract(escrowAddress);
 
-      await escrowContract.setup(
-        reputationOracle,
-        recordingOracle,
-        exchangeOracle,
-        reputationOracleFee,
-        recordingOracleFee,
-        exchangeOracleFee,
-        manifestUrl,
-        manifestHash,
-        {
-          ...(await this.gasPriceOptions()),
-        }
-      );
+      await (
+        await escrowContract.setup(
+          reputationOracle,
+          recordingOracle,
+          exchangeOracle,
+          reputationOracleFee,
+          recordingOracleFee,
+          exchangeOracleFee,
+          manifestUrl,
+          manifestHash,
+          txOptions
+        )
+      ).wait();
 
       return;
     } catch (e) {
@@ -450,6 +443,7 @@ export class EscrowClient extends BaseEthersClient {
    *
    * @param {string} escrowAddress Address of the escrow to fund.
    * @param {BigNumber} amount Amount to be added as funds.
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -471,7 +465,11 @@ export class EscrowClient extends BaseEthersClient {
    * ```
    */
   @requiresSigner
-  async fund(escrowAddress: string, amount: BigNumber): Promise<void> {
+  async fund(
+    escrowAddress: string,
+    amount: BigNumber,
+    txOptions: Overrides = {}
+  ): Promise<void> {
     if (!ethers.utils.isAddress(escrowAddress)) {
       throw ErrorInvalidEscrowAddressProvided;
     }
@@ -493,10 +491,9 @@ export class EscrowClient extends BaseEthersClient {
         tokenAddress,
         this.signerOrProvider
       );
-
-      await tokenContract.transfer(escrowAddress, amount, {
-        ...(await this.gasPriceOptions()),
-      });
+      await (
+        await tokenContract.transfer(escrowAddress, amount, txOptions)
+      ).wait;
 
       return;
     } catch (e) {
@@ -510,6 +507,7 @@ export class EscrowClient extends BaseEthersClient {
    * @param {string} escrowAddress Address of the escrow.
    * @param {string} url Results file url.
    * @param {string} hash Results file hash.
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -535,7 +533,8 @@ export class EscrowClient extends BaseEthersClient {
   async storeResults(
     escrowAddress: string,
     url: string,
-    hash: string
+    hash: string,
+    txOptions: Overrides = {}
   ): Promise<void> {
     if (!ethers.utils.isAddress(escrowAddress)) {
       throw ErrorInvalidEscrowAddressProvided;
@@ -560,9 +559,7 @@ export class EscrowClient extends BaseEthersClient {
     try {
       const escrowContract = this.getEscrowContract(escrowAddress);
 
-      await escrowContract.storeResults(url, hash, {
-        ...(await this.gasPriceOptions()),
-      });
+      await (await escrowContract.storeResults(url, hash, txOptions)).wait();
 
       return;
     } catch (e) {
@@ -574,6 +571,7 @@ export class EscrowClient extends BaseEthersClient {
    * This function sets the status of an escrow to completed.
    *
    * @param {string} escrowAddress Address of the escrow.
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -596,7 +594,10 @@ export class EscrowClient extends BaseEthersClient {
    * ```
    */
   @requiresSigner
-  async complete(escrowAddress: string): Promise<void> {
+  async complete(
+    escrowAddress: string,
+    txOptions: Overrides = {}
+  ): Promise<void> {
     if (!ethers.utils.isAddress(escrowAddress)) {
       throw ErrorInvalidEscrowAddressProvided;
     }
@@ -608,9 +609,7 @@ export class EscrowClient extends BaseEthersClient {
     try {
       const escrowContract = this.getEscrowContract(escrowAddress);
 
-      await escrowContract.complete({
-        ...(await this.gasPriceOptions()),
-      });
+      await (await escrowContract.complete(txOptions)).wait();
       return;
     } catch (e) {
       return throwError(e);
@@ -625,6 +624,7 @@ export class EscrowClient extends BaseEthersClient {
    * @param {BigNumber[]} amounts Array of amounts the recipients will receive.
    * @param {string} finalResultsUrl Final results file url.
    * @param {string} finalResultsHash Final results file hash.
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -657,7 +657,8 @@ export class EscrowClient extends BaseEthersClient {
     recipients: string[],
     amounts: BigNumber[],
     finalResultsUrl: string,
-    finalResultsHash: string
+    finalResultsHash: string,
+    txOptions: Overrides = {}
   ): Promise<void> {
     if (!ethers.utils.isAddress(escrowAddress)) {
       throw ErrorInvalidEscrowAddressProvided;
@@ -711,17 +712,16 @@ export class EscrowClient extends BaseEthersClient {
     try {
       const escrowContract = this.getEscrowContract(escrowAddress);
 
-      await escrowContract.bulkPayOut(
-        recipients,
-        amounts,
-        finalResultsUrl,
-        finalResultsHash,
-        DEFAULT_TX_ID,
-
-        {
-          ...(await this.gasPriceOptions()),
-        }
-      );
+      await (
+        await escrowContract.bulkPayOut(
+          recipients,
+          amounts,
+          finalResultsUrl,
+          finalResultsHash,
+          DEFAULT_TX_ID,
+          txOptions
+        )
+      ).wait();
       return;
     } catch (e) {
       return throwError(e);
@@ -732,6 +732,7 @@ export class EscrowClient extends BaseEthersClient {
    * This function cancels the specified escrow and sends the balance to the canceler.
    *
    * @param {string} escrowAddress Address of the escrow to cancel.
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns {EscrowCancel} Returns the escrow cancellation data including transaction hash and refunded amount. Throws error if any.
    *
    *
@@ -754,7 +755,10 @@ export class EscrowClient extends BaseEthersClient {
    * ```
    */
   @requiresSigner
-  async cancel(escrowAddress: string): Promise<EscrowCancel> {
+  async cancel(
+    escrowAddress: string,
+    txOptions: Overrides = {}
+  ): Promise<EscrowCancel> {
     if (!ethers.utils.isAddress(escrowAddress)) {
       throw ErrorInvalidEscrowAddressProvided;
     }
@@ -766,10 +770,9 @@ export class EscrowClient extends BaseEthersClient {
     try {
       const escrowContract = this.getEscrowContract(escrowAddress);
 
-      const tx = await escrowContract.cancel({
-        ...(await this.gasPriceOptions()),
-      });
-      const transactionReceipt = await tx.wait();
+      const transactionReceipt = await (
+        await escrowContract.cancel(txOptions)
+      ).wait();
 
       let amountTransferred: BigNumber | undefined = undefined;
       const tokenAddress = await escrowContract.token();
@@ -810,6 +813,7 @@ export class EscrowClient extends BaseEthersClient {
    * This function cancels the specified escrow, sends the balance to the canceler and selfdestructs the escrow contract.
    *
    * @param {string} escrowAddress Address of the escrow.
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -832,7 +836,7 @@ export class EscrowClient extends BaseEthersClient {
    * ```
    */
   @requiresSigner
-  async abort(escrowAddress: string): Promise<void> {
+  async abort(escrowAddress: string, txOptions: Overrides = {}): Promise<void> {
     if (!ethers.utils.isAddress(escrowAddress)) {
       throw ErrorInvalidEscrowAddressProvided;
     }
@@ -844,9 +848,7 @@ export class EscrowClient extends BaseEthersClient {
     try {
       const escrowContract = this.getEscrowContract(escrowAddress);
 
-      await escrowContract.abort({
-        ...(await this.gasPriceOptions()),
-      });
+      await (await escrowContract.abort(txOptions)).wait();
       return;
     } catch (e) {
       return throwError(e);
@@ -858,6 +860,7 @@ export class EscrowClient extends BaseEthersClient {
    *
    * @param {string} escrowAddress Address of the escrow.
    * @param {string[]} trustedHandlers Array of addresses of trusted handlers to add.
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -883,7 +886,8 @@ export class EscrowClient extends BaseEthersClient {
   @requiresSigner
   async addTrustedHandlers(
     escrowAddress: string,
-    trustedHandlers: string[]
+    trustedHandlers: string[],
+    txOptions: Overrides = {}
   ): Promise<void> {
     if (!ethers.utils.isAddress(escrowAddress)) {
       throw ErrorInvalidEscrowAddressProvided;
@@ -906,9 +910,9 @@ export class EscrowClient extends BaseEthersClient {
     try {
       const escrowContract = this.getEscrowContract(escrowAddress);
 
-      await escrowContract.addTrustedHandlers(trustedHandlers, {
-        ...(await this.gasPriceOptions()),
-      });
+      await (
+        await escrowContract.addTrustedHandlers(trustedHandlers, txOptions)
+      ).wait();
       return;
     } catch (e) {
       return throwError(e);

package/src/kvstore.ts

@@ -4,7 +4,7 @@ import {
   KVStore,
   KVStore__factory,
 } from '@human-protocol/core/typechain-types';
-import { Signer, ethers } from 'ethers';
+import { Overrides, Signer, ethers } from 'ethers';
 import { BaseEthersClient } from './base';
 import { NETWORKS } from './constants';
 import { requiresSigner } from './decorators';
@@ -99,14 +99,9 @@ export class KVStoreClient extends BaseEthersClient {
    *
    * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
    * @param {NetworkData} network - The network information required to connect to the KVStore 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(signerOrProvider: Signer | Provider, networkData: NetworkData) {
+    super(signerOrProvider, networkData);
 
     this.contract = KVStore__factory.connect(
       networkData.kvstoreAddress,
@@ -118,16 +113,12 @@ export class KVStoreClient extends BaseEthersClient {
    * Creates an instance of KVStoreClient from a Signer or Provider.
    *
    * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
-   * @param {number | undefined} gasPriceMultiplier - The multiplier to apply to the gas price
    *
    * @returns {Promise<KVStoreClient>} - An instance of KVStoreClient
    * @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
-  ) {
+  public static async build(signerOrProvider: Signer | Provider) {
     let network: Network;
     if (Signer.isSigner(signerOrProvider)) {
       if (!signerOrProvider.provider) {
@@ -146,7 +137,7 @@ export class KVStoreClient extends BaseEthersClient {
       throw ErrorUnsupportedChainID;
     }
 
-    return new KVStoreClient(signerOrProvider, networkData, gasPriceMultiplier);
+    return new KVStoreClient(signerOrProvider, networkData);
   }
 
   /**
@@ -154,6 +145,7 @@ export class KVStoreClient extends BaseEthersClient {
    *
    * @param {string} key Key of the key-value pair
    * @param {string} value Value of the key-value pair
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -176,13 +168,15 @@ export class KVStoreClient extends BaseEthersClient {
    * ```
    */
   @requiresSigner
-  public async set(key: string, value: string): Promise<void> {
+  public async set(
+    key: string,
+    value: string,
+    txOptions: Overrides = {}
+  ): Promise<void> {
     if (!Signer.isSigner(this.signerOrProvider)) throw ErrorSigner;
     if (key === '') throw ErrorKVStoreEmptyKey;
     try {
-      await this.contract?.set(key, value, {
-        ...(await this.gasPriceOptions()),
-      });
+      await (await this.contract.set(key, value, txOptions)).wait();
     } catch (e) {
       if (e instanceof Error) throw Error(`Failed to set value: ${e.message}`);
     }
@@ -193,6 +187,7 @@ export class KVStoreClient extends BaseEthersClient {
    *
    * @param {string[]} keys Array of keys (keys and value must have the same order)
    * @param {string[]} values Array of values
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -217,15 +212,17 @@ export class KVStoreClient extends BaseEthersClient {
    * ```
    */
   @requiresSigner
-  public async setBulk(keys: string[], values: string[]): Promise<void> {
+  public async setBulk(
+    keys: string[],
+    values: string[],
+    txOptions: Overrides = {}
+  ): Promise<void> {
     if (!Signer.isSigner(this.signerOrProvider)) throw ErrorSigner;
     if (keys.length !== values.length) throw ErrorKVStoreArrayLength;
     if (keys.includes('')) throw ErrorKVStoreEmptyKey;
 
     try {
-      await this.contract?.setBulk(keys, values, {
-        ...(await this.gasPriceOptions()),
-      });
+      await (await this.contract.setBulk(keys, values, txOptions)).wait();
     } catch (e) {
       if (e instanceof Error)
         throw Error(`Failed to set bulk values: ${e.message}`);
@@ -237,6 +234,7 @@ export class KVStoreClient extends BaseEthersClient {
    *
    * @param {string} url URL to set
    * @param {string | undefined} urlKey Configurable URL key. `url` by default.
+   * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
    * @returns Returns void if successful. Throws error if any.
    *
    *
@@ -258,7 +256,11 @@ export class KVStoreClient extends BaseEthersClient {
    * ```
    */
   @requiresSigner
-  public async setURL(url: string, urlKey = 'url'): Promise<void> {
+  public async setURL(
+    url: string,
+    urlKey = 'url',
+    txOptions: Overrides = {}
+  ): Promise<void> {
     if (!Signer.isSigner(this.signerOrProvider)) {
       throw ErrorSigner;
     }
@@ -275,9 +277,13 @@ export class KVStoreClient extends BaseEthersClient {
     const hashKey = urlKey + 'Hash';
 
     try {
-      await this.contract.setBulk([urlKey, hashKey], [url, contentHash], {
-        ...(await this.gasPriceOptions()),
-      });
+      await (
+        await this.contract.setBulk(
+          [urlKey, hashKey],
+          [url, contentHash],
+          txOptions
+        )
+      ).wait();
     } catch (e) {
       if (e instanceof Error)
         throw Error(`Failed to set URL and hash: ${e.message}`);