@human-protocol/sdk 1.1.17 → 1.1.18

package/dist/kvstore.js

@@ -12,9 +12,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.KVStoreClient = void 0;
 const typechain_types_1 = require("@human-protocol/core/typechain-types");
 const ethers_1 = require("ethers");
+const base_1 = require("./base");
 const constants_1 = require("./constants");
 const decorators_1 = require("./decorators");
 const error_1 = require("./error");
+const utils_1 = require("./utils");
 /**
  * ## Introduction
  *
@@ -84,26 +86,29 @@ const error_1 = require("./error");
  * const kvstoreClient = await KVStoreClient.build(signer);
  * ```
  */
-class KVStoreClient {
+class KVStoreClient extends base_1.BaseEthersClient {
     /**
      * **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, network) {
-        this.contract = typechain_types_1.KVStore__factory.connect(network.kvstoreAddress, signerOrProvider);
-        this.signerOrProvider = signerOrProvider;
+    constructor(signerOrProvider, networkData, gasPriceMultiplier) {
+        super(signerOrProvider, networkData, gasPriceMultiplier);
+        this.contract = typechain_types_1.KVStore__factory.connect(networkData.kvstoreAddress, signerOrProvider);
     }
     /**
      * 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 async build(signerOrProvider) {
+    static async build(signerOrProvider, gasPriceMultiplier) {
         let network;
         if (ethers_1.Signer.isSigner(signerOrProvider)) {
             if (!signerOrProvider.provider) {
@@ -119,7 +124,7 @@ class KVStoreClient {
         if (!networkData) {
             throw error_1.ErrorUnsupportedChainID;
         }
-        return new KVStoreClient(signerOrProvider, networkData);
+        return new KVStoreClient(signerOrProvider, networkData, gasPriceMultiplier);
     }
     /**
      * This function sets a key-value pair associated with the address that submits the transaction.
@@ -153,7 +158,9 @@ class KVStoreClient {
         if (key === '')
             throw error_1.ErrorKVStoreEmptyKey;
         try {
-            await this.contract?.set(key, value);
+            await this.contract?.set(key, value, {
+                ...(await this.gasPriceOptions()),
+            });
         }
         catch (e) {
             if (e instanceof Error)
@@ -196,13 +203,60 @@ class KVStoreClient {
         if (keys.includes(''))
             throw error_1.ErrorKVStoreEmptyKey;
         try {
-            await this.contract?.setBulk(keys, values);
+            await this.contract?.setBulk(keys, values, {
+                ...(await this.gasPriceOptions()),
+            });
         }
         catch (e) {
             if (e instanceof Error)
                 throw Error(`Failed to set bulk values: ${e.message}`);
         }
     }
+    /**
+     * 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);
+     * ```
+     */
+    async setURL(url, urlKey = 'url') {
+        if (!ethers_1.Signer.isSigner(this.signerOrProvider)) {
+            throw error_1.ErrorSigner;
+        }
+        if (!(0, utils_1.isValidUrl)(url)) {
+            throw error_1.ErrorInvalidUrl;
+        }
+        const content = await fetch(url).then((res) => res.text());
+        const contentHash = ethers_1.ethers.utils.keccak256(ethers_1.ethers.utils.toUtf8Bytes(content));
+        const hashKey = urlKey + 'Hash';
+        try {
+            await this.contract.setBulk([urlKey, hashKey], [url, contentHash], {
+                ...(await this.gasPriceOptions()),
+            });
+        }
+        catch (e) {
+            if (e instanceof Error)
+                throw Error(`Failed to set URL and hash: ${e.message}`);
+        }
+    }
     /**
      * This function returns the value for a specified key and address.
      *
@@ -242,6 +296,62 @@ class KVStoreClient {
             return e;
         }
     }
+    /**
+     * 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'
+     * );
+     * ```
+     */
+    async getURL(address, urlKey = 'url') {
+        if (!ethers_1.ethers.utils.isAddress(address))
+            throw error_1.ErrorInvalidAddress;
+        const hashKey = urlKey + 'Hash';
+        let url = '', hash = '';
+        try {
+            url = await this.contract?.get(address, urlKey);
+        }
+        catch (e) {
+            if (e instanceof Error)
+                throw Error(`Failed to get URL: ${e.message}`);
+        }
+        // Return empty string
+        if (!url?.length) {
+            return '';
+        }
+        try {
+            hash = await this.contract?.get(address, hashKey);
+        }
+        catch (e) {
+            if (e instanceof Error)
+                throw Error(`Failed to get Hash: ${e.message}`);
+        }
+        const content = await fetch(url).then((res) => res.text());
+        const contentHash = ethers_1.ethers.utils.keccak256(ethers_1.ethers.utils.toUtf8Bytes(content));
+        if (hash !== contentHash) {
+            throw error_1.ErrorInvalidHash;
+        }
+        return url;
+    }
 }
 __decorate([
     decorators_1.requiresSigner,
@@ -255,4 +365,10 @@ __decorate([
     __metadata("design:paramtypes", [Array, Array]),
     __metadata("design:returntype", Promise)
 ], KVStoreClient.prototype, "setBulk", null);
+__decorate([
+    decorators_1.requiresSigner,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object]),
+    __metadata("design:returntype", Promise)
+], KVStoreClient.prototype, "setURL", null);
 exports.KVStoreClient = KVStoreClient;

package/dist/staking.d.ts

@@ -1,6 +1,7 @@
 import { Provider } from '@ethersproject/abstract-provider';
-import { EscrowFactory, HMToken, Staking } from '@human-protocol/core/typechain-types';
+import { EscrowFactory, HMToken, RewardPool, Staking } from '@human-protocol/core/typechain-types';
 import { BigNumber, Signer } from 'ethers';
+import { BaseEthersClient } from './base';
 import { IAllocation, ILeader, ILeadersFilter, IReward } from './interfaces';
 import { NetworkData } from './types';
 /**
@@ -72,28 +73,36 @@ import { NetworkData } from './types';
  * const stakingClient = await StakingClient.build(provider);
  * ```
  */
-export declare class StakingClient {
-    signerOrProvider: Signer | Provider;
-    network: NetworkData;
+export declare class StakingClient extends BaseEthersClient {
     tokenContract: HMToken;
     stakingContract: Staking;
     escrowFactoryContract: EscrowFactory;
+    rewardPoolContract: RewardPool;
     /**
      * **StakingClient 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 Staking 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 StakingClient 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<StakingClient>} - An instance of StakingClient
      * @throws {ErrorProviderDoesNotExist} - Thrown if the provider does not exist for the provided Signer
      * @throws {ErrorUnsupportedChainID} - Thrown if the network's chainId is not supported
      */
-    static build(signerOrProvider: Signer | Provider): Promise<StakingClient>;
+    static build(signerOrProvider: Signer | Provider, gasPriceMultiplier?: number): Promise<StakingClient>;
+    /**
+     * Check if escrow exists
+     *
+     * @param escrowAddress Escrow address to check against
+     */
+    private checkValidEscrow;
     /**
      * This function approves the staking contract to transfer a specified amount of tokens when the user stakes. It increases the allowance for the staking contract.
      *
@@ -304,10 +313,10 @@ export declare class StakingClient {
      * const signer = new Wallet(privateKey, provider);
      * const stakingClient = await StakingClient.build(signer);
      *
-     * await stakingClient.distributeRewards('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * await stakingClient.distributeReward('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
      * ```
      */
-    distributeRewards(escrowAddress: string): Promise<void>;
+    distributeReward(escrowAddress: string): Promise<void>;
     /**
      * This function returns all the leader details of the protocol.
      *

package/dist/staking.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"staking.d.ts","sourceRoot":"","sources":["../src/staking.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAE5D,OAAO,EACL,aAAa,EAEb,OAAO,EAIP,OAAO,EAER,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AAenD,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC7E,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAMtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,aAAa;IACjB,gBAAgB,EAAE,MAAM,GAAG,QAAQ,CAAC;IACpC,OAAO,EAAE,WAAW,CAAC;IACrB,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,EAAE,OAAO,CAAC;IACzB,qBAAqB,EAAE,aAAa,CAAC;IAE5C;;;;;OAKG;gBACS,gBAAgB,EAAE,MAAM,GAAG,QAAQ,EAAE,OAAO,EAAE,WAAW;IAoBrE;;;;;;;OAOG;WACiB,KAAK,CAAC,gBAAgB,EAAE,MAAM,GAAG,QAAQ;IAsB7D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IAEU,YAAY,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB3D;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEU,KAAK,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBpD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEU,OAAO,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBtD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IAEU,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAStC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEU,KAAK,CAChB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,SAAS,GAChB,OAAO,CAAC,IAAI,CAAC;IAkChB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEU,QAAQ,CACnB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,SAAS,GAChB,OAAO,CAAC,IAAI,CAAC;IAyBhB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEU,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBlE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IAEU,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBpE;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAkBzD;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,UAAU,CAAC,MAAM,GAAE,cAAmB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAcxE;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAiBvE;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,UAAU,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;CAsBpE"}
+{"version":3,"file":"staking.d.ts","sourceRoot":"","sources":["../src/staking.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAE5D,OAAO,EACL,aAAa,EAEb,OAAO,EAEP,UAAU,EAEV,OAAO,EAER,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AAEnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAc1C,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC7E,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAMtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,aAAc,SAAQ,gBAAgB;IAC1C,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,EAAE,OAAO,CAAC;IACzB,qBAAqB,EAAE,aAAa,CAAC;IACrC,kBAAkB,EAAE,UAAU,CAAC;IAEtC;;;;;;OAMG;gBAED,gBAAgB,EAAE,MAAM,GAAG,QAAQ,EACnC,WAAW,EAAE,WAAW,EACxB,kBAAkB,CAAC,EAAE,MAAM;IAyB7B;;;;;;;;;OASG;WACiB,KAAK,CACvB,gBAAgB,EAAE,MAAM,GAAG,QAAQ,EACnC,kBAAkB,CAAC,EAAE,MAAM;IAuB7B;;;;OAIG;YACW,gBAAgB;IAU9B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IAEU,YAAY,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAmB3D;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEU,KAAK,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBpD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEU,OAAO,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBtD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IAEU,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAWtC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEU,KAAK,CAChB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,SAAS,GAChB,OAAO,CAAC,IAAI,CAAC;IA8BhB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEU,QAAQ,CACnB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,SAAS,GAChB,OAAO,CAAC,IAAI,CAAC;IAqBhB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEU,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAalE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IAEU,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAanE;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAkBzD;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,UAAU,CAAC,MAAM,GAAE,cAAmB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAcxE;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAWvE;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,UAAU,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;CAsBpE"}

package/dist/staking.js

@@ -16,6 +16,7 @@ exports.StakingClient = 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,29 +92,32 @@ const staking_1 = require("./graphql/queries/staking");
  * const stakingClient = await StakingClient.build(provider);
  * ```
  */
-class StakingClient {
+class StakingClient extends base_1.BaseEthersClient {
     /**
      * **StakingClient 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 Staking contract
+     * @param {number | undefined} gasPriceMultiplier - The multiplier to apply to the gas price
      */
-    constructor(signerOrProvider, network) {
-        this.stakingContract = typechain_types_1.Staking__factory.connect(network.stakingAddress, signerOrProvider);
-        this.escrowFactoryContract = typechain_types_1.EscrowFactory__factory.connect(network.factoryAddress, signerOrProvider);
-        this.tokenContract = typechain_types_1.HMToken__factory.connect(network.hmtAddress, signerOrProvider);
-        this.signerOrProvider = signerOrProvider;
-        this.network = network;
+    constructor(signerOrProvider, networkData, gasPriceMultiplier) {
+        super(signerOrProvider, networkData, gasPriceMultiplier);
+        this.stakingContract = typechain_types_1.Staking__factory.connect(networkData.stakingAddress, signerOrProvider);
+        this.escrowFactoryContract = typechain_types_1.EscrowFactory__factory.connect(networkData.factoryAddress, signerOrProvider);
+        this.tokenContract = typechain_types_1.HMToken__factory.connect(networkData.hmtAddress, signerOrProvider);
+        this.rewardPoolContract = typechain_types_1.RewardPool__factory.connect(networkData.rewardPoolAddress, this.signerOrProvider);
     }
     /**
      * Creates an instance of StakingClient 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<StakingClient>} - An instance of StakingClient
      * @throws {ErrorProviderDoesNotExist} - Thrown if the provider does not exist for the provided Signer
      * @throws {ErrorUnsupportedChainID} - Thrown if the network's chainId is not supported
      */
-    static async build(signerOrProvider) {
+    static async build(signerOrProvider, gasPriceMultiplier) {
         let network;
         if (ethers_1.Signer.isSigner(signerOrProvider)) {
             if (!signerOrProvider.provider) {
@@ -129,7 +133,20 @@ class StakingClient {
         if (!networkData) {
             throw error_1.ErrorUnsupportedChainID;
         }
-        return new StakingClient(signerOrProvider, networkData);
+        return new StakingClient(signerOrProvider, networkData, gasPriceMultiplier);
+    }
+    /**
+     * Check if escrow exists
+     *
+     * @param escrowAddress Escrow address to check against
+     */
+    async checkValidEscrow(escrowAddress) {
+        if (!ethers_1.ethers.utils.isAddress(escrowAddress)) {
+            throw error_1.ErrorInvalidEscrowAddressProvided;
+        }
+        if (!(await this.escrowFactoryContract.hasEscrow(escrowAddress))) {
+            throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
+        }
     }
     /**
      * This function approves the staking contract to transfer a specified amount of tokens when the user stakes. It increases the allowance for the staking contract.
@@ -163,7 +180,9 @@ class StakingClient {
             throw error_1.ErrorInvalidStakingValueSign;
         }
         try {
-            await this.tokenContract.approve(this.stakingContract.address, amount);
+            await this.tokenContract.approve(this.stakingContract.address, amount, {
+                ...(await this.gasPriceOptions()),
+            });
             return;
         }
         catch (e) {
@@ -205,7 +224,9 @@ class StakingClient {
             throw error_1.ErrorInvalidStakingValueSign;
         }
         try {
-            await this.stakingContract.stake(amount);
+            await this.stakingContract.stake(amount, {
+                ...(await this.gasPriceOptions()),
+            });
             return;
         }
         catch (e) {
@@ -246,7 +267,9 @@ class StakingClient {
             throw error_1.ErrorInvalidStakingValueSign;
         }
         try {
-            await this.stakingContract.unstake(amount);
+            await this.stakingContract.unstake(amount, {
+                ...(await this.gasPriceOptions()),
+            });
             return;
         }
         catch (e) {
@@ -279,7 +302,9 @@ class StakingClient {
      */
     async withdraw() {
         try {
-            await this.stakingContract.withdraw();
+            await this.stakingContract.withdraw({
+                ...(await this.gasPriceOptions()),
+            });
             return;
         }
         catch (e) {
@@ -326,14 +351,11 @@ class StakingClient {
         if (!ethers_1.ethers.utils.isAddress(staker)) {
             throw error_1.ErrorInvalidStakerAddressProvided;
         }
-        if (!ethers_1.ethers.utils.isAddress(escrowAddress)) {
-            throw error_1.ErrorInvalidEscrowAddressProvided;
-        }
-        if (!(await this.escrowFactoryContract.hasEscrow(escrowAddress))) {
-            throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
-        }
+        await this.checkValidEscrow(escrowAddress);
         try {
-            await this.stakingContract.slash(slasher, staker, escrowAddress, amount);
+            await this.stakingContract.slash(slasher, staker, escrowAddress, amount, {
+                ...(await this.gasPriceOptions()),
+            });
             return;
         }
         catch (e) {
@@ -374,14 +396,11 @@ class StakingClient {
         if (amount.isNegative()) {
             throw error_1.ErrorInvalidStakingValueSign;
         }
-        if (!ethers_1.ethers.utils.isAddress(escrowAddress)) {
-            throw error_1.ErrorInvalidEscrowAddressProvided;
-        }
-        if (!(await this.escrowFactoryContract.hasEscrow(escrowAddress))) {
-            throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
-        }
+        await this.checkValidEscrow(escrowAddress);
         try {
-            await this.stakingContract.allocate(escrowAddress, amount);
+            await this.stakingContract.allocate(escrowAddress, amount, {
+                ...(await this.gasPriceOptions()),
+            });
             return;
         }
         catch (e) {
@@ -415,14 +434,11 @@ class StakingClient {
      * ```
      */
     async closeAllocation(escrowAddress) {
-        if (!ethers_1.ethers.utils.isAddress(escrowAddress)) {
-            throw error_1.ErrorInvalidEscrowAddressProvided;
-        }
-        if (!(await this.escrowFactoryContract.hasEscrow(escrowAddress))) {
-            throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
-        }
+        await this.checkValidEscrow(escrowAddress);
         try {
-            await this.stakingContract.closeAllocation(escrowAddress);
+            await this.stakingContract.closeAllocation(escrowAddress, {
+                ...(await this.gasPriceOptions()),
+            });
             return;
         }
         catch (e) {
@@ -451,19 +467,15 @@ class StakingClient {
      * const signer = new Wallet(privateKey, provider);
      * const stakingClient = await StakingClient.build(signer);
      *
-     * await stakingClient.distributeRewards('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * await stakingClient.distributeReward('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
      * ```
      */
-    async distributeRewards(escrowAddress) {
-        if (!ethers_1.ethers.utils.isAddress(escrowAddress)) {
-            throw error_1.ErrorInvalidEscrowAddressProvided;
-        }
-        if (!(await this.escrowFactoryContract.hasEscrow(escrowAddress))) {
-            throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
-        }
+    async distributeReward(escrowAddress) {
+        await this.checkValidEscrow(escrowAddress);
         try {
-            const rewardPoolContract = typechain_types_1.RewardPool__factory.connect(await this.stakingContract.rewardPool(), this.signerOrProvider);
-            await rewardPoolContract.distributeReward(escrowAddress);
+            this.rewardPoolContract.distributeReward(escrowAddress, {
+                ...(await this.gasPriceOptions()),
+            });
             return;
         }
         catch (e) {
@@ -496,7 +508,7 @@ class StakingClient {
             throw error_1.ErrorInvalidStakerAddressProvided;
         }
         try {
-            const { leader } = await (0, graphql_request_1.default)(this.network.subgraphUrl, staking_1.GET_LEADER_QUERY, {
+            const { leader } = await (0, graphql_request_1.default)(this.networkData.subgraphUrl, staking_1.GET_LEADER_QUERY, {
                 address: address.toLowerCase(),
             });
             return leader;
@@ -528,7 +540,7 @@ class StakingClient {
      */
     async getLeaders(filter = {}) {
         try {
-            const { leaders } = await (0, graphql_request_1.default)(this.network.subgraphUrl, (0, staking_1.GET_LEADERS_QUERY)(filter), {
+            const { leaders } = await (0, graphql_request_1.default)(this.networkData.subgraphUrl, (0, staking_1.GET_LEADERS_QUERY)(filter), {
                 role: filter.role,
             });
             return leaders;
@@ -559,12 +571,7 @@ class StakingClient {
      * ```
      */
     async getAllocation(escrowAddress) {
-        if (!ethers_1.ethers.utils.isAddress(escrowAddress)) {
-            throw error_1.ErrorInvalidEscrowAddressProvided;
-        }
-        if (!(await this.escrowFactoryContract.hasEscrow(escrowAddress))) {
-            throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
-        }
+        await this.checkValidEscrow(escrowAddress);
         try {
             const result = await this.stakingContract.getAllocation(escrowAddress);
             return result;
@@ -599,7 +606,7 @@ class StakingClient {
             throw error_1.ErrorInvalidSlasherAddressProvided;
         }
         try {
-            const { rewardAddedEvents } = await (0, graphql_request_1.default)(this.network.subgraphUrl, reward_1.GET_REWARD_ADDED_EVENTS_QUERY, {
+            const { rewardAddedEvents } = await (0, graphql_request_1.default)(this.networkData.subgraphUrl, reward_1.GET_REWARD_ADDED_EVENTS_QUERY, {
                 slasherAddress: slasherAddress.toLowerCase(),
             });
             return rewardAddedEvents.map((reward) => {
@@ -661,5 +668,5 @@ __decorate([
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [String]),
     __metadata("design:returntype", Promise)
-], StakingClient.prototype, "distributeRewards", null);
+], StakingClient.prototype, "distributeReward", null);
 exports.StakingClient = StakingClient;

package/dist/statistics.d.ts

@@ -39,13 +39,13 @@ import { NetworkData } from './types';
  * ```
  */
 export declare class StatisticsClient {
-    network: NetworkData;
+    networkData: NetworkData;
     /**
      * **StatisticsClient constructor**
      *
-     * @param {NetworkData} network - The network information required to connect to the Statistics contract
+     * @param {NetworkData} networkData - The network information required to connect to the Statistics contract
      */
-    constructor(network: NetworkData);
+    constructor(networkData: NetworkData);
     /**
      * This function returns the statistical data of escrows.
      *

package/dist/statistics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"statistics.d.ts","sourceRoot":"","sources":["../src/statistics.ts"],"names":[],"mappings":"AAIA,OAAO,EAKL,gBAAgB,EAGhB,aAAa,EAEb,iBAAiB,EACjB,gBAAgB,EAEjB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,gBAAgB;IACpB,OAAO,EAAE,WAAW,CAAC;IAE5B;;;;OAIG;gBACS,OAAO,EAAE,WAAW;IAIhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACG,mBAAmB,CACvB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IA6B5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACG,mBAAmB,CACvB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAoB5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACG,oBAAoB,CACxB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IA2B7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgFG;IACG,gBAAgB,CACpB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,aAAa,CAAC;CAuC1B"}
+{"version":3,"file":"statistics.d.ts","sourceRoot":"","sources":["../src/statistics.ts"],"names":[],"mappings":"AAIA,OAAO,EAKL,gBAAgB,EAGhB,aAAa,EAEb,iBAAiB,EACjB,gBAAgB,EAEjB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,gBAAgB;IACpB,WAAW,EAAE,WAAW,CAAC;IAEhC;;;;OAIG;gBACS,WAAW,EAAE,WAAW;IAIpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACG,mBAAmB,CACvB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IA6B5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACG,mBAAmB,CACvB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAoB5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACG,oBAAoB,CACxB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IA2B7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgFG;IACG,gBAAgB,CACpB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,aAAa,CAAC;CAuC1B"}

package/dist/statistics.js

@@ -50,10 +50,10 @@ class StatisticsClient {
     /**
      * **StatisticsClient constructor**
      *
-     * @param {NetworkData} network - The network information required to connect to the Statistics contract
+     * @param {NetworkData} networkData - The network information required to connect to the Statistics contract
      */
-    constructor(network) {
-        this.network = network;
+    constructor(networkData) {
+        this.networkData = networkData;
     }
     /**
      * This function returns the statistical data of escrows.
@@ -106,8 +106,8 @@ class StatisticsClient {
      */
     async getEscrowStatistics(params = {}) {
         try {
-            const { escrowStatistics } = await (0, graphql_request_1.default)(this.network.subgraphUrl, graphql_1.GET_ESCROW_STATISTICS_QUERY);
-            const { eventDayDatas } = await (0, graphql_request_1.default)(this.network.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
+            const { escrowStatistics } = await (0, graphql_request_1.default)(this.networkData.subgraphUrl, graphql_1.GET_ESCROW_STATISTICS_QUERY);
+            const { eventDayDatas } = await (0, graphql_request_1.default)(this.networkData.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
                 from: params.from ? params.from.getTime() / 1000 : undefined,
                 to: params.to ? params.to.getTime() / 1000 : undefined,
             });
@@ -173,7 +173,7 @@ class StatisticsClient {
      */
     async getWorkerStatistics(params = {}) {
         try {
-            const { eventDayDatas } = await (0, graphql_request_1.default)(this.network.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
+            const { eventDayDatas } = await (0, graphql_request_1.default)(this.networkData.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
                 from: params.from ? params.from.getTime() / 1000 : undefined,
                 to: params.to ? params.to.getTime() / 1000 : undefined,
             });
@@ -257,7 +257,7 @@ class StatisticsClient {
      */
     async getPaymentStatistics(params = {}) {
         try {
-            const { eventDayDatas } = await (0, graphql_request_1.default)(this.network.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
+            const { eventDayDatas } = await (0, graphql_request_1.default)(this.networkData.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
                 from: params.from ? params.from.getTime() / 1000 : undefined,
                 to: params.to ? params.to.getTime() / 1000 : undefined,
             });
@@ -359,9 +359,9 @@ class StatisticsClient {
      */
     async getHMTStatistics(params = {}) {
         try {
-            const { hmtokenStatistics } = await (0, graphql_request_1.default)(this.network.subgraphUrl, graphql_1.GET_HMTOKEN_STATISTICS_QUERY);
-            const { holders } = await (0, graphql_request_1.default)(this.network.subgraphUrl, graphql_1.GET_HOLDERS_QUERY);
-            const { eventDayDatas } = await (0, graphql_request_1.default)(this.network.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
+            const { hmtokenStatistics } = await (0, graphql_request_1.default)(this.networkData.subgraphUrl, graphql_1.GET_HMTOKEN_STATISTICS_QUERY);
+            const { holders } = await (0, graphql_request_1.default)(this.networkData.subgraphUrl, graphql_1.GET_HOLDERS_QUERY);
+            const { eventDayDatas } = await (0, graphql_request_1.default)(this.networkData.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
                 from: params.from ? params.from.getTime() / 1000 : undefined,
                 to: params.to ? params.to.getTime() / 1000 : undefined,
             });

package/dist/storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAIxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,YAAY,CAAgB;IAEpC;;;;;OAKG;gBACS,MAAM,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,kBAAkB;IAcnE;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAoB1E;;;;;;;;;;;;;;OAcG;WACiB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAsBlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,WAAW,CACtB,KAAK,EAAE,GAAG,EAAE,EACZ,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,UAAU,EAAE,CAAC;IAkCxB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI3D;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAqB5D"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAIxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,YAAY,CAAgB;IAEpC;;;;;OAKG;gBACS,MAAM,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,kBAAkB;IAcnE;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAoB1E;;;;;;;;;;;;;;OAcG;WACiB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAsBlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,WAAW,CACtB,KAAK,EAAE,GAAG,EAAE,EACZ,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,UAAU,EAAE,CAAC;IAmCxB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI3D;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAqB5D"}

package/dist/storage.js

@@ -220,6 +220,7 @@ class StorageClient {
             try {
                 await this.client.putObject(bucket, key, content, {
                     'Content-Type': 'application/json',
+                    'Cache-Control': 'no-store',
                 });
                 return {
                     key,

package/dist/utils.d.ts

@@ -1,3 +1,5 @@
+import { Provider } from '@ethersproject/abstract-provider';
+import { BigNumber, Signer } from 'ethers';
 /**
  * **Get specific error text.*
  *
@@ -19,4 +21,10 @@ export declare const throwError: (e: any) => never;
  * @returns
  */
 export declare const isValidUrl: (url: string) => boolean;
+/**
+ * Increase/Decrease gas price
+ *
+ * @returns {Promise<BigNumber>} Returns the adjusted gas price
+ */
+export declare const gasPriceAdjusted: (signerOrProvider: Signer | Provider, gasPriceMultiplier: number) => Promise<BigNumber>;
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAeA;;;;;GAKG;AACH,eAAO,MAAM,eAAe,UAAW,GAAG,KAAG,MAO5C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,MAAO,GAAG,UAqBhC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,QAAS,MAAM,YAOrC,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AAenD;;;;;GAKG;AACH,eAAO,MAAM,eAAe,UAAW,GAAG,KAAG,MAO5C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,MAAO,GAAG,UAqBhC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,QAAS,MAAM,YAOrC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,qBACT,MAAM,GAAG,QAAQ,sBACf,MAAM,KACzB,QAAQ,SAAS,CAgBnB,CAAC"}