@human-protocol/sdk 1.1.17 → 1.1.18

package/dist/base.d.ts

@@ -0,0 +1,29 @@
+import { Provider } from '@ethersproject/abstract-provider';
+import { Signer, ethers } from 'ethers';
+import { NetworkData } from './types';
+/**
+ * ## Introduction
+ *
+ * This class is used as a base class for other clients making on-chain calls.
+ *
+ */
+export declare abstract class BaseEthersClient {
+    protected signerOrProvider: Signer | Provider;
+    protected gasPriceMultiplier?: number;
+    networkData: NetworkData;
+    /**
+     * **BaseClient constructor**
+     *
+     * @param {Signer | Provider} signerOrProvider The Signer or Provider object to interact with the Ethereum network
+     * @param {NetworkData} networkData The network information required to connect to the contracts
+     * @param {number | undefined} gasPriceMultiplier The multiplier to apply to the gas price
+     */
+    constructor(signerOrProvider: Signer | Provider, networkData: NetworkData, gasPriceMultiplier?: number);
+    /**
+     * Adjust the gas price, and return as an option to be passed to a transaction
+     *
+     * @returns {Promise<{ gasPrice: BigNumber }>} Returns the gas price options
+     */
+    protected gasPriceOptions(): Promise<Partial<ethers.Overrides>>;
+}
+//# sourceMappingURL=base.d.ts.map

package/dist/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtC;;;;;GAKG;AACH,8BAAsB,gBAAgB;IACpC,SAAS,CAAC,gBAAgB,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC9C,SAAS,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC/B,WAAW,EAAE,WAAW,CAAC;IAEhC;;;;;;OAMG;gBAED,gBAAgB,EAAE,MAAM,GAAG,QAAQ,EACnC,WAAW,EAAE,WAAW,EACxB,kBAAkB,CAAC,EAAE,MAAM;IAO7B;;;;OAIG;cACa,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;CAUtE"}

package/dist/base.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseEthersClient = void 0;
+const utils_1 = require("./utils");
+/**
+ * ## Introduction
+ *
+ * This class is used as a base class for other clients making on-chain calls.
+ *
+ */
+class BaseEthersClient {
+    /**
+     * **BaseClient constructor**
+     *
+     * @param {Signer | Provider} signerOrProvider The Signer or Provider object to interact with the Ethereum network
+     * @param {NetworkData} networkData The network information required to connect to the contracts
+     * @param {number | undefined} gasPriceMultiplier The multiplier to apply to the gas price
+     */
+    constructor(signerOrProvider, networkData, gasPriceMultiplier) {
+        this.networkData = networkData;
+        this.signerOrProvider = signerOrProvider;
+        this.gasPriceMultiplier = gasPriceMultiplier;
+    }
+    /**
+     * Adjust the gas price, and return as an option to be passed to a transaction
+     *
+     * @returns {Promise<{ gasPrice: BigNumber }>} Returns the gas price options
+     */
+    async gasPriceOptions() {
+        return this.gasPriceMultiplier
+            ? {
+                gasPrice: await (0, utils_1.gasPriceAdjusted)(this.signerOrProvider, this.gasPriceMultiplier),
+            }
+            : {};
+    }
+}
+exports.BaseEthersClient = BaseEthersClient;

package/dist/error.d.ts

@@ -201,4 +201,12 @@ export declare class ContractExecutionError extends EthereumError {
 export declare class InvalidEthereumAddressError extends Error {
     constructor(address: string);
 }
+/**
+ * @constant {Error} - The Hash does not match
+ */
+export declare const ErrorInvalidHash: Error;
+/**
+ * @constant {Error} - The Hash does not match
+ */
+export declare const ErrorMissingGasPrice: Error;
 //# sourceMappingURL=error.d.ts.map

package/dist/error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,mBAAmB,OAA2C,CAAC;AAE5E;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,OAEvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,0BAA0B,OAAgC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,wBAAwB,OAA8B,CAAC;AAEpE;;GAEG;AACH,eAAO,MAAM,2BAA2B,OAAiC,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,oBAAoB,OAAoC,CAAC;AAEtE;;GAEG;AACH,eAAO,MAAM,uBAAuB,OAEnC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,OAA+B,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,wBAAwB,OAAqC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,0CAA0C,OAEtD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2CAA2C,OAEvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,yCAAyC,OAErD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,+BAA+B,OAE3C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,OAExC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,OAExC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC,OAE9C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC,OAE7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC,OAE7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,OAA0C,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,mDAAmD,OAE/D,CAAC;AAEF,eAAO,MAAM,2BAA2B,OAEvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,OAAmC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,yBAAyB,OAAuC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,uBAAuB,OAAoC,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,WAAW,OAA+B,CAAC;AAExD;;GAEG;AACH,eAAO,MAAM,wCAAwC,OAEpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2CAA2C,OAEvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,OAEzC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,OAAkC,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,qBAAqB,OAAsC,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB,OAA+B,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,mCAAmC,OAE/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC,OAE9C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mCAAmC,OAE/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wCAAwC,OAEpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,OAAuC,CAAC;AAE3E,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,oBAAqB,SAAQ,aAAa;gBACzC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,aAAc,SAAQ,aAAa;gBAClC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,qBAAsB,SAAQ,aAAa;gBAC1C,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,sBAAuB,SAAQ,aAAa;gBAC3C,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,YAAa,SAAQ,aAAa;gBACjC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,YAAa,SAAQ,aAAa;gBACjC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,mBAAoB,SAAQ,aAAa;gBACxC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,sBAAuB,SAAQ,aAAa;gBAC3C,MAAM,EAAE,MAAM;CAG3B;AAED,qBAAa,2BAA4B,SAAQ,KAAK;gBACxC,OAAO,EAAE,MAAM;CAG5B"}
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,mBAAmB,OAA2C,CAAC;AAE5E;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,OAEvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,0BAA0B,OAAgC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,wBAAwB,OAA8B,CAAC;AAEpE;;GAEG;AACH,eAAO,MAAM,2BAA2B,OAAiC,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,oBAAoB,OAAoC,CAAC;AAEtE;;GAEG;AACH,eAAO,MAAM,uBAAuB,OAEnC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,OAA+B,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,wBAAwB,OAAqC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,0CAA0C,OAEtD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2CAA2C,OAEvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,yCAAyC,OAErD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,+BAA+B,OAE3C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,OAExC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,OAExC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC,OAE9C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC,OAE7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC,OAE7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,OAA0C,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,mDAAmD,OAE/D,CAAC;AAEF,eAAO,MAAM,2BAA2B,OAEvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,OAAmC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,yBAAyB,OAAuC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,uBAAuB,OAAoC,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,WAAW,OAA+B,CAAC;AAExD;;GAEG;AACH,eAAO,MAAM,wCAAwC,OAEpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2CAA2C,OAEvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,OAEzC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,OAAkC,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,qBAAqB,OAAsC,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB,OAA+B,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,mCAAmC,OAE/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC,OAE9C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mCAAmC,OAE/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wCAAwC,OAEpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,OAAuC,CAAC;AAE3E,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,oBAAqB,SAAQ,aAAa;gBACzC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,aAAc,SAAQ,aAAa;gBAClC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,qBAAsB,SAAQ,aAAa;gBAC1C,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,sBAAuB,SAAQ,aAAa;gBAC3C,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,YAAa,SAAQ,aAAa;gBACjC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,YAAa,SAAQ,aAAa;gBACjC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,mBAAoB,SAAQ,aAAa;gBACxC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,sBAAuB,SAAQ,aAAa;gBAC3C,MAAM,EAAE,MAAM;CAG3B;AAED,qBAAa,2BAA4B,SAAQ,KAAK;gBACxC,OAAO,EAAE,MAAM;CAG5B;AACD;;GAEG;AACH,eAAO,MAAM,gBAAgB,OAA4B,CAAC;AAE1D;;GAEG;AACH,eAAO,MAAM,oBAAoB,OAAiC,CAAC"}

package/dist/error.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NumericFault = exports.ReplacementUnderpriced = exports.UnpredictableGasLimit = exports.OutOfGasError = exports.InvalidArgumentError = exports.EthereumError = exports.ErrorHashIsEmptyString = exports.ErrorLaunchedEventIsNotEmitted = exports.ErrorRecipientAndAmountsMustBeSameLength = exports.ErrorAmountsCannotBeEmptyArray = exports.ErrorEscrowDoesNotHaveEnoughBalance = exports.ErrorAmountMustBeGreaterThanZero = exports.ErrorRecipientCannotBeEmptyArray = exports.ErrorTotalFeeMustBeLessThanHundred = exports.ErrorFeeMustBeBetweenZeroAndHundred = exports.ErrorNoURLprovided = exports.ErrorListOfHandlersCannotBeEmpty = exports.ErrorUrlIsEmptyString = exports.ErrorInvalidUrl = exports.ErrorStorageClientDoesNotExist = exports.ErrorManifestFileDoesNotExist = exports.ErrorTransferEventNotFoundInTransactionLogs = exports.ErrorEscrowAddressIsNotProvidedByFactory = exports.ErrorSigner = exports.ErrorUnsupportedChainID = exports.ErrorProviderDoesNotExist = exports.ErrorHMTokenAmountNotApproved = exports.ErrorFailedToCheckAllowance = exports.ErrorFailedToApproveStakingAmountSignerDoesNotExist = exports.ErrorStakingGetStakers = exports.ErrorInvalidEscrowAddressProvided = exports.ErrorInvalidStakerAddressProvided = exports.ErrorInvalidSlasherAddressProvided = exports.ErrorInvalidStakingValueSign = exports.ErrorInvalidStakingValueType = exports.ErrorStakingValueMustBePositive = exports.ErrorInvalidExchangeOracleAddressProvided = exports.ErrorInvalidReputationOracleAddressProvided = exports.ErrorInvalidRecordingOracleAddressProvided = exports.ErrorInvalidTokenAddress = exports.ErrorInvalidAddress = exports.ErrorKVStoreArrayLength = exports.ErrorKVStoreEmptyKey = exports.ErrorStorageFileNotUploaded = exports.ErrorStorageFileNotFound = exports.ErrorStorageBucketNotFound = exports.ErrorStorageCredentialsMissing = exports.ErrorStorageClientNotExists = exports.ErrorStorageClientNotInitialized = exports.ErrorStakingMissing = void 0;
-exports.InvalidEthereumAddressError = exports.ContractExecutionError = exports.TransactionReplaced = exports.NonceExpired = void 0;
+exports.ErrorMissingGasPrice = exports.ErrorInvalidHash = exports.InvalidEthereumAddressError = exports.ContractExecutionError = exports.TransactionReplaced = exports.NonceExpired = void 0;
 /**
  * @constant {Error} - The Staking contract is missing.
  */
@@ -235,3 +235,11 @@ class InvalidEthereumAddressError extends Error {
     }
 }
 exports.InvalidEthereumAddressError = InvalidEthereumAddressError;
+/**
+ * @constant {Error} - The Hash does not match
+ */
+exports.ErrorInvalidHash = new Error('Invalid hash');
+/**
+ * @constant {Error} - The Hash does not match
+ */
+exports.ErrorMissingGasPrice = new Error('Missing gas price');

package/dist/escrow.d.ts

@@ -1,5 +1,6 @@
 import { Provider } from '@ethersproject/abstract-provider';
 import { BigNumber, Signer } from 'ethers';
+import { BaseEthersClient } from './base';
 import { ChainId } from './enums';
 import { IEscrowConfig, IEscrowsFilter } from './interfaces';
 import { EscrowCancel, EscrowStatus, NetworkData } from './types';
@@ -73,27 +74,33 @@ import { EscrowData } from './graphql';
  * const escrowClient = await EscrowClient.build(provider);
  * ```
  */
-export declare class EscrowClient {
+export declare class EscrowClient extends BaseEthersClient {
     private escrowFactoryContract;
-    private escrowContract?;
-    private signerOrProvider;
-    network: NetworkData;
     /**
      * **EscrowClient constructor**
      *
      * @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, network: NetworkData);
+    constructor(signerOrProvider: Signer | Provider, networkData: NetworkData, gasPriceMultiplier?: number);
     /**
      * 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
      */
-    static build(signerOrProvider: Signer | Provider): Promise<EscrowClient>;
+    static build(signerOrProvider: Signer | Provider, gasPriceMultiplier?: number): Promise<EscrowClient>;
+    /**
+     * Connects to the escrow contract
+     *
+     * @param escrowAddress Escrow address to connect to
+     */
+    private getEscrowContract;
     /**
      * This function creates an escrow contract that uses the token passed to pay oracle fees and reward workers.
      *

package/dist/escrow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"escrow.d.ts","sourceRoot":"","sources":["../src/escrow.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAU5D,OAAO,EAAE,SAAS,EAAmB,MAAM,EAAU,MAAM,QAAQ,CAAC;AAIpE,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAyBlC,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAElE,OAAO,EACL,UAAU,EAGX,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,qBAAqB,CAAgB;IAC7C,OAAO,CAAC,cAAc,CAAC,CAAS;IAChC,OAAO,CAAC,gBAAgB,CAAoB;IACrC,OAAO,EAAE,WAAW,CAAC;IAE5B;;;;;OAKG;gBACS,gBAAgB,EAAE,MAAM,GAAG,QAAQ,EAAE,OAAO,EAAE,WAAW;IASrE;;;;;;;OAOG;WACiB,KAAK,CAAC,gBAAgB,EAAE,MAAM,GAAG,QAAQ;IAsB7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IAEU,YAAY,CACvB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EAAE,EACzB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,MAAM,CAAC;IAkClB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IAEG,KAAK,CACT,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,aAAa,GAC1B,OAAO,CAAC,IAAI,CAAC;IAgFhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IAEG,oBAAoB,CACxB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EAAE,EACzB,cAAc,EAAE,MAAM,EACtB,YAAY,EAAE,aAAa,GAC1B,OAAO,CAAC,MAAM,CAAC;IAgBlB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IAEG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAkCnE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEG,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,CAAC;IAkChB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IAEG,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IAEG,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAAE,EACpB,OAAO,EAAE,SAAS,EAAE,EACpB,eAAe,EAAE,MAAM,EACvB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAqEhB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IAEG,MAAM,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAoD1D;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IAEG,KAAK,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBjD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEG,kBAAkB,CACtB,aAAa,EAAE,MAAM,EACrB,eAAe,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,IAAI,CAAC;IA+BhB;;;;;;;;;;;;;;;;;;;OAmBG;IACG,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAoB3D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoB5D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoB3D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBvE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,SAAS,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAoB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBvE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,qBAAqB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBnE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,0BAA0B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBxE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,wBAAwB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBtE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAmBhE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,WAAW;IACtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgGG;WACiB,UAAU,CAC5B,MAAM,EAAE,cAAc,GACrB,OAAO,CAAC,UAAU,EAAE,CAAC;IAmExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmEG;WACiB,SAAS,CAC3B,OAAO,EAAE,OAAO,EAChB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,UAAU,CAAC;CAuBvB"}
+{"version":3,"file":"escrow.d.ts","sourceRoot":"","sources":["../src/escrow.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAU5D,OAAO,EAAE,SAAS,EAAmB,MAAM,EAAU,MAAM,QAAQ,CAAC;AAEpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAG1C,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAyBlC,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAElE,OAAO,EACL,UAAU,EAGX,MAAM,WAAW,CAAC;AAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;IAChD,OAAO,CAAC,qBAAqB,CAAgB;IAE7C;;;;;;OAMG;gBAED,gBAAgB,EAAE,MAAM,GAAG,QAAQ,EACnC,WAAW,EAAE,WAAW,EACxB,kBAAkB,CAAC,EAAE,MAAM;IAU7B;;;;;;;;;OASG;WACiB,KAAK,CACvB,gBAAgB,EAAE,MAAM,GAAG,QAAQ,EACnC,kBAAkB,CAAC,EAAE,MAAM;IAuB7B;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAQzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IAEU,YAAY,CACvB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EAAE,EACzB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,MAAM,CAAC;IAqClB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IAEG,KAAK,CACT,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,aAAa,GAC1B,OAAO,CAAC,IAAI,CAAC;IAiFhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IAEG,oBAAoB,CACxB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EAAE,EACzB,cAAc,EAAE,MAAM,EACtB,YAAY,EAAE,aAAa,GAC1B,OAAO,CAAC,MAAM,CAAC;IAgBlB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IAEG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAiCnE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEG,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,CAAC;IAkChB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IAEG,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IAEG,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAAE,EACpB,OAAO,EAAE,SAAS,EAAE,EACpB,eAAe,EAAE,MAAM,EACvB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAsEhB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IAEG,MAAM,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAoD1D;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IAEG,KAAK,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBjD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEG,kBAAkB,CACtB,aAAa,EAAE,MAAM,EACrB,eAAe,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,IAAI,CAAC;IA+BhB;;;;;;;;;;;;;;;;;;;OAmBG;IACG,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAkB3D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB5D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB3D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBvE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,SAAS,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAkB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBvE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,qBAAqB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBnE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,0BAA0B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBxE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,wBAAwB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBtE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAiBhE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,WAAW;IACtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgGG;WACiB,UAAU,CAC5B,MAAM,EAAE,cAAc,GACrB,OAAO,CAAC,UAAU,EAAE,CAAC;IAmExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmEG;WACiB,SAAS,CAC3B,OAAO,EAAE,OAAO,EAChB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,UAAU,CAAC;CAuBvB"}

package/dist/escrow.js

@@ -16,6 +16,7 @@ exports.EscrowUtils = exports.EscrowClient = void 0;
 const typechain_types_1 = require("@human-protocol/core/typechain-types");
 const ethers_1 = require("ethers");
 const graphql_request_1 = __importDefault(require("graphql-request"));
+const base_1 = require("./base");
 const constants_1 = require("./constants");
 const decorators_1 = require("./decorators");
 const error_1 = require("./error");
@@ -91,27 +92,29 @@ const graphql_1 = require("./graphql");
  * const escrowClient = await EscrowClient.build(provider);
  * ```
  */
-class EscrowClient {
+class EscrowClient extends base_1.BaseEthersClient {
     /**
      * **EscrowClient constructor**
      *
      * @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, network) {
-        this.escrowFactoryContract = typechain_types_1.EscrowFactory__factory.connect(network.factoryAddress, signerOrProvider);
-        this.network = network;
-        this.signerOrProvider = signerOrProvider;
+    constructor(signerOrProvider, networkData, gasPriceMultiplier) {
+        super(signerOrProvider, networkData, gasPriceMultiplier);
+        this.escrowFactoryContract = typechain_types_1.EscrowFactory__factory.connect(networkData.factoryAddress, signerOrProvider);
     }
     /**
      * 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
      */
-    static async build(signerOrProvider) {
+    static async build(signerOrProvider, gasPriceMultiplier) {
         let network;
         if (ethers_1.Signer.isSigner(signerOrProvider)) {
             if (!signerOrProvider.provider) {
@@ -127,7 +130,20 @@ class EscrowClient {
         if (!networkData) {
             throw error_1.ErrorUnsupportedChainID;
         }
-        return new EscrowClient(signerOrProvider, networkData);
+        return new EscrowClient(signerOrProvider, networkData, gasPriceMultiplier);
+    }
+    /**
+     * Connects to the escrow contract
+     *
+     * @param escrowAddress Escrow address to connect to
+     */
+    getEscrowContract(escrowAddress) {
+        try {
+            return typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
+        }
+        catch (e) {
+            return (0, utils_1.throwError)(e);
+        }
     }
     /**
      * This function creates an escrow contract that uses the token passed to pay oracle fees and reward workers.
@@ -169,7 +185,9 @@ class EscrowClient {
             }
         });
         try {
-            const result = await (await this.escrowFactoryContract.createEscrow(tokenAddress, trustedHandlers, jobRequesterId)).wait();
+            const result = await (await this.escrowFactoryContract.createEscrow(tokenAddress, trustedHandlers, jobRequesterId, {
+                ...(await this.gasPriceOptions()),
+            })).wait();
             const event = result.events?.find(({ topics }) => topics.includes(ethers_1.ethers.utils.id('LaunchedV2(address,address,string)')))?.args;
             if (!event) {
                 throw error_1.ErrorLaunchedEventIsNotEmitted;
@@ -252,8 +270,10 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            await this.escrowContract.setup(reputationOracle, recordingOracle, exchangeOracle, reputationOracleFee, recordingOracleFee, exchangeOracleFee, manifestUrl, manifestHash);
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            await escrowContract.setup(reputationOracle, recordingOracle, exchangeOracle, reputationOracleFee, recordingOracleFee, exchangeOracleFee, manifestUrl, manifestHash, {
+                ...(await this.gasPriceOptions()),
+            });
             return;
         }
         catch (e) {
@@ -347,10 +367,12 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            const tokenAddress = await this.escrowContract.token();
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            const tokenAddress = await escrowContract.token();
             const tokenContract = typechain_types_1.HMToken__factory.connect(tokenAddress, this.signerOrProvider);
-            await tokenContract.transfer(escrowAddress, amount);
+            await tokenContract.transfer(escrowAddress, amount, {
+                ...(await this.gasPriceOptions()),
+            });
             return;
         }
         catch (e) {
@@ -401,8 +423,10 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            await this.escrowContract.storeResults(url, hash);
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            await escrowContract.storeResults(url, hash, {
+                ...(await this.gasPriceOptions()),
+            });
             return;
         }
         catch (e) {
@@ -442,8 +466,10 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            await this.escrowContract.complete();
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            await escrowContract.complete({
+                ...(await this.gasPriceOptions()),
+            });
             return;
         }
         catch (e) {
@@ -523,8 +549,10 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            await this.escrowContract.bulkPayOut(recipients, amounts, finalResultsUrl, finalResultsHash, constants_1.DEFAULT_TX_ID);
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            await escrowContract.bulkPayOut(recipients, amounts, finalResultsUrl, finalResultsHash, constants_1.DEFAULT_TX_ID, {
+                ...(await this.gasPriceOptions()),
+            });
             return;
         }
         catch (e) {
@@ -564,11 +592,13 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            const tx = await this.escrowContract.cancel();
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            const tx = await escrowContract.cancel({
+                ...(await this.gasPriceOptions()),
+            });
             const transactionReceipt = await tx.wait();
             let amountTransferred = undefined;
-            const tokenAddress = await this.escrowContract.token();
+            const tokenAddress = await escrowContract.token();
             const tokenContract = typechain_types_1.HMToken__factory.connect(tokenAddress, this.signerOrProvider);
             for (const log of transactionReceipt.logs) {
                 if (log.address === tokenAddress) {
@@ -626,8 +656,10 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            await this.escrowContract.abort();
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            await escrowContract.abort({
+                ...(await this.gasPriceOptions()),
+            });
             return;
         }
         catch (e) {
@@ -677,8 +709,10 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            await this.escrowContract.addTrustedHandlers(trustedHandlers);
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            await escrowContract.addTrustedHandlers(trustedHandlers, {
+                ...(await this.gasPriceOptions()),
+            });
             return;
         }
         catch (e) {
@@ -713,8 +747,8 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            return this.escrowContract.getBalance();
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            return escrowContract.getBalance();
         }
         catch (e) {
             return (0, utils_1.throwError)(e);
@@ -748,8 +782,8 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            return this.escrowContract.manifestHash();
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            return escrowContract.manifestHash();
         }
         catch (e) {
             return (0, utils_1.throwError)(e);
@@ -783,8 +817,8 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            return this.escrowContract.manifestUrl();
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            return escrowContract.manifestUrl();
         }
         catch (e) {
             return (0, utils_1.throwError)(e);
@@ -818,8 +852,8 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            return this.escrowContract.finalResultsUrl();
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            return escrowContract.finalResultsUrl();
         }
         catch (e) {
             return (0, utils_1.throwError)(e);
@@ -853,8 +887,8 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            return this.escrowContract.intermediateResultsUrl();
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            return escrowContract.intermediateResultsUrl();
         }
         catch (e) {
             return (0, utils_1.throwError)(e);
@@ -888,8 +922,8 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            return this.escrowContract.token();
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            return escrowContract.token();
         }
         catch (e) {
             return (0, utils_1.throwError)(e);
@@ -923,8 +957,8 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            return this.escrowContract.status();
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            return escrowContract.status();
         }
         catch (e) {
             return (0, utils_1.throwError)(e);
@@ -958,8 +992,8 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            return this.escrowContract.recordingOracle();
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            return escrowContract.recordingOracle();
         }
         catch (e) {
             return (0, utils_1.throwError)(e);
@@ -993,8 +1027,8 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            return this.escrowContract.launcher();
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            return escrowContract.launcher();
         }
         catch (e) {
             return (0, utils_1.throwError)(e);
@@ -1028,8 +1062,8 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            return this.escrowContract.reputationOracle();
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            return escrowContract.reputationOracle();
         }
         catch (e) {
             return (0, utils_1.throwError)(e);
@@ -1063,8 +1097,8 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            return this.escrowContract.exchangeOracle();
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            return escrowContract.exchangeOracle();
         }
         catch (e) {
             return (0, utils_1.throwError)(e);
@@ -1098,8 +1132,8 @@ class EscrowClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            return this.escrowContract.escrowFactory();
+            const escrowContract = this.getEscrowContract(escrowAddress);
+            return escrowContract.escrowFactory();
         }
         catch (e) {
             return (0, utils_1.throwError)(e);

package/dist/kvstore.d.ts

@@ -1,5 +1,6 @@
 import { Provider } from '@ethersproject/abstract-provider';
 import { Signer } from 'ethers';
+import { BaseEthersClient } from './base';
 import { NetworkData } from './types';
 /**
  * ## Introduction
@@ -70,25 +71,27 @@ import { NetworkData } from './types';
  * const kvstoreClient = await KVStoreClient.build(signer);
  * ```
  */
-export declare class KVStoreClient {
+export declare class KVStoreClient extends BaseEthersClient {
     private contract;
-    private signerOrProvider;
     /**
      * **KVStoreClient constructor**
      *
      * @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, network: NetworkData);
+    constructor(signerOrProvider: Signer | Provider, networkData: NetworkData, gasPriceMultiplier?: number);
     /**
      * 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
      */
-    static build(signerOrProvider: Signer | Provider): Promise<KVStoreClient>;
+    static build(signerOrProvider: Signer | Provider, gasPriceMultiplier?: number): Promise<KVStoreClient>;
     /**
      * This function sets a key-value pair associated with the address that submits the transaction.
      *
@@ -145,6 +148,32 @@ export declare class KVStoreClient {
      * ```
      */
     setBulk(keys: string[], values: string[]): Promise<void>;
+    /**
+     * This function sets a URL value for the address that submits the transaction.
+     *
+     * @param {string} url URL to set
+     * @param {string | undefined} urlKey Configurable URL key. `url` by default.
+     * @returns Returns void if successful. Throws error if any.
+     *
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { Wallet, providers } from 'ethers';
+     * import { KVStoreClient } 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 kvstoreClient = await KVStoreClient.build(signer);
+     *
+     * await kvstoreClient.setURL('example.com');
+     * await kvstoreClient.setURL('linkedin.com/example', 'linkedinUrl);
+     * ```
+     */
+    setURL(url: string, urlKey?: string): Promise<void>;
     /**
      * This function returns the value for a specified key and address.
      *
@@ -170,5 +199,32 @@ export declare class KVStoreClient {
      * ```
      */
     get(address: string, key: string): Promise<string>;
+    /**
+     * This function returns the URL value for the given entity.
+     *
+     * @param {string} address Address from which to get the URL value.
+     * @param {string} urlKey  Configurable URL key. `url` by default.
+     * @returns {string} URL value for the given address if exists, and the content is valid
+     *
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { providers } from 'ethers';
+     * import { KVStoreClient } from '@human-protocol/sdk';
+     *
+     * const rpcUrl = 'YOUR_RPC_URL';
+     *
+     * const provider = new providers.JsonRpcProvider(rpcUrl);
+     * const kvstoreClient = await KVStoreClient.build(provider);
+     *
+     * const url = await kvstoreClient.getURL('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266');
+     * const linkedinUrl = await kvstoreClient.getURL(
+     *    '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
+     *    'linkedinUrl'
+     * );
+     * ```
+     */
+    getURL(address: string, urlKey?: string): Promise<string>;
 }
 //# sourceMappingURL=kvstore.d.ts.map

package/dist/kvstore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kvstore.d.ts","sourceRoot":"","sources":["../src/kvstore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAM5D,OAAO,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AAYxC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAU;IAC1B,OAAO,CAAC,gBAAgB,CAAoB;IAE5C;;;;;OAKG;gBACS,gBAAgB,EAAE,MAAM,GAAG,QAAQ,EAAE,OAAO,EAAE,WAAW;IAQrE;;;;;;;OAOG;WACiB,KAAK,CAAC,gBAAgB,EAAE,MAAM,GAAG,QAAQ;IAsB7D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEU,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU3D;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IAEU,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAarE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAYhE"}
+{"version":3,"file":"kvstore.d.ts","sourceRoot":"","sources":["../src/kvstore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAM5D,OAAO,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAc1C,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,aAAc,SAAQ,gBAAgB;IACjD,OAAO,CAAC,QAAQ,CAAU;IAE1B;;;;;;OAMG;gBAED,gBAAgB,EAAE,MAAM,GAAG,QAAQ,EACnC,WAAW,EAAE,WAAW,EACxB,kBAAkB,CAAC,EAAE,MAAM;IAU7B;;;;;;;;;OASG;WACiB,KAAK,CACvB,gBAAgB,EAAE,MAAM,GAAG,QAAQ,EACnC,kBAAkB,CAAC,EAAE,MAAM;IAuB7B;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEU,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAY3D;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IAEU,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAerE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IAEU,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,SAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IA0B/D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAa/D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;CAmCtE"}