@human-protocol/sdk 3.0.8 → 4.0.0

package/dist/staking.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"staking.d.ts","sourceRoot":"","sources":["../src/staking.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EAEb,OAAO,EAEP,OAAO,EAER,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,SAAS,EAAU,MAAM,QAAQ,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAc1C,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,aAAc,SAAQ,gBAAgB;IAC1C,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,EAAE,OAAO,CAAC;IACzB,qBAAqB,EAAE,aAAa,CAAC;IAE5C;;;;;OAKG;gBACS,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW;IAmB5D;;;;;;;;OAQG;WACiB,KAAK,CAAC,MAAM,EAAE,cAAc;IAiBhD;;;;OAIG;YACW,gBAAgB;IAU9B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IAEU,YAAY,CACvB,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAuBhB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IAEU,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,GAAE,SAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB5E;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEU,OAAO,CAClB,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IAEU,QAAQ,CAAC,SAAS,GAAE,SAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAS/D;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IAEU,KAAK,CAChB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;CAmCjB"}
+{"version":3,"file":"staking.d.ts","sourceRoot":"","sources":["../src/staking.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EAEb,OAAO,EAEP,OAAO,EAER,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,SAAS,EAAU,MAAM,QAAQ,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAc1C,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,aAAc,SAAQ,gBAAgB;IAC1C,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,EAAE,OAAO,CAAC;IACzB,qBAAqB,EAAE,aAAa,CAAC;IAE5C;;;;;OAKG;gBACS,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW;IAmB5D;;;;;;;;OAQG;WACiB,KAAK,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IAiBzE;;;;OAIG;YACW,gBAAgB;IAU9B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IAEU,YAAY,CACvB,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAuBhB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEU,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,GAAE,SAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB5E;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEU,OAAO,CAClB,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IAEU,QAAQ,CAAC,SAAS,GAAE,SAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAS/D;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEU,KAAK,CAChB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAoChB;;;;;;;;;;;;;;;;;;;OAmBG;IACU,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;CAgCvE"}

package/dist/staking.js

@@ -20,19 +20,19 @@ const utils_1 = require("./utils");
 /**
  * ## Introduction
  *
- * This client enables to perform actions on staking contracts and obtain staking information from both the contracts and subgraph.
+ * This client enables performing actions on staking contracts and obtaining staking information from both the contracts and subgraph.
  *
  * Internally, the SDK will use one network or another according to the network ID of the `runner`.
  * To use this client, it is recommended to initialize it using the static `build` method.
  *
  * ```ts
- * static async build(runner: ContractRunner);
+ * static async build(runner: ContractRunner): Promise<StakingClient>;
  * ```
  *
  * A `Signer` or a `Provider` should be passed depending on the use case of this module:
  *
- * - **Signer**: when the user wants to use this model in order to send transactions caling the contract functions.
- * - **Provider**: when the user wants to use this model in order to get information from the contracts or subgraph.
+ * - **Signer**: when the user wants to use this model to send transactions calling the contract functions.
+ * - **Provider**: when the user wants to use this model to get information from the contracts or subgraph.
  *
  * ## Installation
  *
@@ -50,21 +50,21 @@ const utils_1 = require("./utils");
  *
  * ### Signer
  *
- * **Using private key(backend)**
+ * **Using private key (backend)**
  *
  * ```ts
  * import { StakingClient } from '@human-protocol/sdk';
  * import { Wallet, providers } from 'ethers';
  *
  * const rpcUrl = 'YOUR_RPC_URL';
- * const privateKey = 'YOUR_PRIVATE_KEY'
+ * const privateKey = 'YOUR_PRIVATE_KEY';
  *
  * const provider = new providers.JsonRpcProvider(rpcUrl);
  * const signer = new Wallet(privateKey, provider);
  * const stakingClient = await StakingClient.build(signer);
  * ```
  *
- * **Using Wagmi(frontend)**
+ * **Using Wagmi (frontend)**
  *
  * ```ts
  * import { useSigner, useChainId } from 'wagmi';
@@ -140,7 +140,6 @@ class StakingClient extends base_1.BaseEthersClient {
      * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
      * @returns Returns void if successful. Throws error if any.
      *
-     *
      * **Code example**
      *
      * ```ts
@@ -148,7 +147,7 @@ class StakingClient extends base_1.BaseEthersClient {
      * import { StakingClient } from '@human-protocol/sdk';
      *
      * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY'
+     * const privateKey = 'YOUR_PRIVATE_KEY';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const signer = new Wallet(privateKey, provider);
@@ -182,7 +181,6 @@ class StakingClient extends base_1.BaseEthersClient {
      * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
      * @returns Returns void if successful. Throws error if any.
      *
-     *
      * **Code example**
      *
      * ```ts
@@ -190,7 +188,7 @@ class StakingClient extends base_1.BaseEthersClient {
      * import { StakingClient } from '@human-protocol/sdk';
      *
      * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY'
+     * const privateKey = 'YOUR_PRIVATE_KEY';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const signer = new Wallet(privateKey, provider);
@@ -198,7 +196,7 @@ class StakingClient extends base_1.BaseEthersClient {
      *
      * const amount = ethers.parseUnits(5, 'ether'); //convert from ETH to WEI
      * await stakingClient.approveStake(amount); // if it was already approved before, this is not necessary
-     * await stakingClient.approveStake(amount);
+     * await stakingClient.stake(amount);
      * ```
      */
     async stake(amount, txOptions = {}) {
@@ -225,7 +223,6 @@ class StakingClient extends base_1.BaseEthersClient {
      * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
      * @returns Returns void if successful. Throws error if any.
      *
-     *
      * **Code example**
      *
      * ```ts
@@ -233,7 +230,7 @@ class StakingClient extends base_1.BaseEthersClient {
      * import { StakingClient } from '@human-protocol/sdk';
      *
      * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY'
+     * const privateKey = 'YOUR_PRIVATE_KEY';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const signer = new Wallet(privateKey, provider);
@@ -259,14 +256,13 @@ class StakingClient extends base_1.BaseEthersClient {
         }
     }
     /**
-     * This function withdraws unstaked and non locked tokens form staking contract to the user wallet.
+     * This function withdraws unstaked and non-locked tokens from staking contract to the user wallet.
      *
      * > Must have tokens available to withdraw
      *
      * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
      * @returns Returns void if successful. Throws error if any.
      *
-     *
      * **Code example**
      *
      * ```ts
@@ -274,7 +270,7 @@ class StakingClient extends base_1.BaseEthersClient {
      * import { StakingClient } from '@human-protocol/sdk';
      *
      * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY'
+     * const privateKey = 'YOUR_PRIVATE_KEY';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const signer = new Wallet(privateKey, provider);
@@ -293,16 +289,15 @@ class StakingClient extends base_1.BaseEthersClient {
         }
     }
     /**
-     * This function reduces the allocated amount by an staker in an escrow and transfers those tokens to the reward pool. This allows the slasher to claim them later.
+     * This function reduces the allocated amount by a staker in an escrow and transfers those tokens to the reward pool. This allows the slasher to claim them later.
      *
      * @param {string} slasher Wallet address from who requested the slash
      * @param {string} staker Wallet address from who is going to be slashed
      * @param {string} escrowAddress Address of the escrow that the slash is made
+     * @param {bigint} amount Amount in WEI of tokens to slash.
      * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
-     * @param {bigint} amount Amount in WEI of tokens to unstake.
      * @returns Returns void if successful. Throws error if any.
      *
-     *
      * **Code example**
      *
      * ```ts
@@ -310,7 +305,7 @@ class StakingClient extends base_1.BaseEthersClient {
      * import { StakingClient } from '@human-protocol/sdk';
      *
      * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY'
+     * const privateKey = 'YOUR_PRIVATE_KEY';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const signer = new Wallet(privateKey, provider);
@@ -342,6 +337,52 @@ class StakingClient extends base_1.BaseEthersClient {
             return (0, utils_1.throwError)(e);
         }
     }
+    /**
+     * Retrieves comprehensive staking information for a staker.
+     *
+     * @param {string} stakerAddress - The address of the staker.
+     * @returns {Promise<StakerInfo>}
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { StakingClient } from '@human-protocol/sdk';
+     *
+     * const rpcUrl = 'YOUR_RPC_URL';
+     *
+     * const provider = new providers.JsonRpcProvider(rpcUrl);
+     * const stakingClient = await StakingClient.build(provider);
+     *
+     * const stakingInfo = await stakingClient.getStakerInfo('0xYourStakerAddress');
+     * console.log(stakingInfo.tokensStaked);
+     * ```
+     */
+    async getStakerInfo(stakerAddress) {
+        if (!ethers_1.ethers.isAddress(stakerAddress)) {
+            throw error_1.ErrorInvalidStakerAddressProvided;
+        }
+        try {
+            const stakerInfo = await this.stakingContract.stakes(stakerAddress);
+            const currentBlock = await this.runner.provider.getBlockNumber();
+            const tokensWithdrawable = stakerInfo.tokensLockedUntil !== 0n &&
+                currentBlock >= stakerInfo.tokensLockedUntil
+                ? stakerInfo.tokensLocked
+                : 0n;
+            const adjustedLockedAmount = stakerInfo.tokensLockedUntil !== 0n &&
+                currentBlock >= stakerInfo.tokensLockedUntil
+                ? 0n
+                : stakerInfo.tokensLocked;
+            return {
+                stakedAmount: stakerInfo.tokensStaked,
+                lockedAmount: adjustedLockedAmount,
+                lockedUntil: adjustedLockedAmount === 0n ? 0n : stakerInfo.tokensLockedUntil,
+                withdrawableAmount: tokensWithdrawable,
+            };
+        }
+        catch (error) {
+            return (0, utils_1.throwError)(error);
+        }
+    }
 }
 exports.StakingClient = StakingClient;
 __decorate([

package/dist/statistics.d.ts

@@ -4,20 +4,15 @@ import { NetworkData } from './types';
 /**
  * ## Introduction
  *
- * This client enables to obtain statistical information from the subgraph.
+ * This client enables obtaining statistical information from the subgraph.
  *
- * Unlikely from the other SDK clients, `StatisticsClient` does not require `signer` or `provider` to be provided.
- * We just need to create client object using relevant network data.
+ * Unlike other SDK clients, `StatisticsClient` does not require `signer` or `provider` to be provided.
+ * We just need to create a client object using relevant network data.
  *
  * ```ts
  * constructor(network: NetworkData)
  * ```
  *
- * A `Signer` or a `Provider` should be passed depending on the use case of this module:
- *
- * - **Signer**: when the user wants to use this model in order to send transactions caling the contract functions.
- * - **Provider**: when the user wants to use this model in order to get information from the contracts or subgraph.
- *
  * ## Installation
  *
  * ### npm
@@ -50,7 +45,6 @@ export declare class StatisticsClient {
     /**
      * This function returns the statistical data of escrows.
      *
-     *
      * **Input parameters**
      *
      * ```ts
@@ -79,10 +73,8 @@ export declare class StatisticsClient {
      * };
      * ```
      *
-     *
      * @param {IStatisticsFilter} filter Statistics params with duration data
-     * @returns {EscrowStatistics} Escrow statistics data.
-     *
+     * @returns {Promise<EscrowStatistics>} Escrow statistics data.
      *
      * **Code example**
      *
@@ -102,7 +94,6 @@ export declare class StatisticsClient {
     /**
      * This function returns the statistical data of workers.
      *
-     *
      * **Input parameters**
      *
      * ```ts
@@ -126,10 +117,8 @@ export declare class StatisticsClient {
      * };
      * ```
      *
-     *
      * @param {IStatisticsFilter} filter Statistics params with duration data
-     * @returns {WorkerStatistics} Worker statistics data.
-     *
+     * @returns {Promise<WorkerStatistics>} Worker statistics data.
      *
      * **Code example**
      *
@@ -149,7 +138,6 @@ export declare class StatisticsClient {
     /**
      * This function returns the statistical data of payments.
      *
-     *
      * **Input parameters**
      *
      * ```ts
@@ -175,10 +163,8 @@ export declare class StatisticsClient {
      * };
      * ```
      *
-     *
      * @param {IStatisticsFilter} filter Statistics params with duration data
-     * @returns {PaymentStatistics} Payment statistics data.
-     *
+     * @returns {Promise<PaymentStatistics>} Payment statistics data.
      *
      * **Code example**
      *
@@ -219,7 +205,7 @@ export declare class StatisticsClient {
     /**
      * This function returns the statistical data of HMToken.
      *
-     *
+     * ```ts
      * type HMTStatistics = {
      *   totalTransferAmount: BigNumber;
      *   totalTransferCount: BigNumber;
@@ -227,9 +213,7 @@ export declare class StatisticsClient {
      * };
      * ```
      *
-     *
-     * @returns {HMTStatistics} HMToken statistics data.
-     *
+     * @returns {Promise<HMTStatistics>} HMToken statistics data.
      *
      * **Code example**
      *
@@ -253,7 +237,7 @@ export declare class StatisticsClient {
      * **Input parameters**
      *
      * @param {IHMTHoldersParams} params HMT Holders params with filters and ordering
-     * @returns {HMTHolder[]} List of HMToken holders.
+     * @returns {Promise<HMTHolder[]>} List of HMToken holders.
      *
      * **Code example**
      *
@@ -276,7 +260,6 @@ export declare class StatisticsClient {
     /**
      * This function returns the statistical data of HMToken day by day.
      *
-     *
      * **Input parameters**
      *
      * ```ts
@@ -299,10 +282,8 @@ export declare class StatisticsClient {
      * }
      * ```
      *
-     *
      * @param {IStatisticsFilter} filter Statistics params with duration data
-     * @returns {DailyHMTData[]} Daily HMToken statistics data.
-     *
+     * @returns {Promise<DailyHMTData[]>} Daily HMToken statistics data.
      *
      * **Code example**
      *

package/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,EAEhB,SAAS,EACT,YAAY,EACb,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAItC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,gBAAgB;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;gBACS,WAAW,EAAE,WAAW;IAKpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACG,mBAAmB,CACvB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAuC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,mBAAmB,CACvB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IA4B5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoEG;IACG,oBAAoB,CACxB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IAkC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,gBAAgB,IAAI,OAAO,CAAC,aAAa,CAAC;IAkBhD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,aAAa,CAAC,MAAM,GAAE,iBAAsB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAwBzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IACG,eAAe,CACnB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,YAAY,EAAE,CAAC;CA8B3B"}
+{"version":3,"file":"statistics.d.ts","sourceRoot":"","sources":["../src/statistics.ts"],"names":[],"mappings":"AAIA,OAAO,EAKL,gBAAgB,EAGhB,aAAa,EAEb,iBAAiB,EACjB,gBAAgB,EAEhB,SAAS,EACT,YAAY,EACb,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAItC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,gBAAgB;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;gBACS,WAAW,EAAE,WAAW;IAKpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACG,mBAAmB,CACvB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAuC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACG,mBAAmB,CACvB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IA4B5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiEG;IACG,oBAAoB,CACxB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IAkC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,gBAAgB,IAAI,OAAO,CAAC,aAAa,CAAC;IAkBhD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,aAAa,CAAC,MAAM,GAAE,iBAAsB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAwBzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,eAAe,CACnB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,YAAY,EAAE,CAAC;CA8B3B"}

package/dist/statistics.js

@@ -13,20 +13,15 @@ const enums_1 = require("./enums");
 /**
  * ## Introduction
  *
- * This client enables to obtain statistical information from the subgraph.
+ * This client enables obtaining statistical information from the subgraph.
  *
- * Unlikely from the other SDK clients, `StatisticsClient` does not require `signer` or `provider` to be provided.
- * We just need to create client object using relevant network data.
+ * Unlike other SDK clients, `StatisticsClient` does not require `signer` or `provider` to be provided.
+ * We just need to create a client object using relevant network data.
  *
  * ```ts
  * constructor(network: NetworkData)
  * ```
  *
- * A `Signer` or a `Provider` should be passed depending on the use case of this module:
- *
- * - **Signer**: when the user wants to use this model in order to send transactions caling the contract functions.
- * - **Provider**: when the user wants to use this model in order to get information from the contracts or subgraph.
- *
  * ## Installation
  *
  * ### npm
@@ -60,7 +55,6 @@ class StatisticsClient {
     /**
      * This function returns the statistical data of escrows.
      *
-     *
      * **Input parameters**
      *
      * ```ts
@@ -89,10 +83,8 @@ class StatisticsClient {
      * };
      * ```
      *
-     *
      * @param {IStatisticsFilter} filter Statistics params with duration data
-     * @returns {EscrowStatistics} Escrow statistics data.
-     *
+     * @returns {Promise<EscrowStatistics>} Escrow statistics data.
      *
      * **Code example**
      *
@@ -142,7 +134,6 @@ class StatisticsClient {
     /**
      * This function returns the statistical data of workers.
      *
-     *
      * **Input parameters**
      *
      * ```ts
@@ -166,10 +157,8 @@ class StatisticsClient {
      * };
      * ```
      *
-     *
      * @param {IStatisticsFilter} filter Statistics params with duration data
-     * @returns {WorkerStatistics} Worker statistics data.
-     *
+     * @returns {Promise<WorkerStatistics>} Worker statistics data.
      *
      * **Code example**
      *
@@ -211,7 +200,6 @@ class StatisticsClient {
     /**
      * This function returns the statistical data of payments.
      *
-     *
      * **Input parameters**
      *
      * ```ts
@@ -237,10 +225,8 @@ class StatisticsClient {
      * };
      * ```
      *
-     *
      * @param {IStatisticsFilter} filter Statistics params with duration data
-     * @returns {PaymentStatistics} Payment statistics data.
-     *
+     * @returns {Promise<PaymentStatistics>} Payment statistics data.
      *
      * **Code example**
      *
@@ -308,7 +294,7 @@ class StatisticsClient {
     /**
      * This function returns the statistical data of HMToken.
      *
-     *
+     * ```ts
      * type HMTStatistics = {
      *   totalTransferAmount: BigNumber;
      *   totalTransferCount: BigNumber;
@@ -316,9 +302,7 @@ class StatisticsClient {
      * };
      * ```
      *
-     *
-     * @returns {HMTStatistics} HMToken statistics data.
-     *
+     * @returns {Promise<HMTStatistics>} HMToken statistics data.
      *
      * **Code example**
      *
@@ -354,7 +338,7 @@ class StatisticsClient {
      * **Input parameters**
      *
      * @param {IHMTHoldersParams} params HMT Holders params with filters and ordering
-     * @returns {HMTHolder[]} List of HMToken holders.
+     * @returns {Promise<HMTHolder[]>} List of HMToken holders.
      *
      * **Code example**
      *
@@ -394,7 +378,6 @@ class StatisticsClient {
     /**
      * This function returns the statistical data of HMToken day by day.
      *
-     *
      * **Input parameters**
      *
      * ```ts
@@ -417,10 +400,8 @@ class StatisticsClient {
      * }
      * ```
      *
-     *
      * @param {IStatisticsFilter} filter Statistics params with duration data
-     * @returns {DailyHMTData[]} Daily HMToken statistics data.
-     *
+     * @returns {Promise<DailyHMTData[]>} Daily HMToken statistics data.
      *
      * **Code example**
      *

package/dist/storage.d.ts

@@ -5,7 +5,7 @@ import { UploadFile, StorageCredentials, StorageParams } from './types';
  *
  * ## Introduction
  *
- * This client enables to interact with S3 cloud storage services like Amazon S3 Bucket, Google Cloud Storage and others.
+ * This client enables interacting with S3 cloud storage services like Amazon S3 Bucket, Google Cloud Storage, and others.
  *
  * The instance creation of `StorageClient` should be made using its constructor:
  *
@@ -13,7 +13,7 @@ import { UploadFile, StorageCredentials, StorageParams } from './types';
  * constructor(params: StorageParams, credentials?: StorageCredentials)
  * ```
  *
- * > If credentials is not provided, it uses an anonymous access to the bucket for downloading files.
+ * > If credentials are not provided, it uses anonymous access to the bucket for downloading files.
  *
  * ## Installation
  *
@@ -53,7 +53,7 @@ export declare class StorageClient {
      * **Storage client constructor**
      *
      * @param {StorageParams} params - Cloud storage params
-     * @param {StorageCredentials} credentials - Optional. Cloud storage access data. If credentials is not provided - use an anonymous access to the bucket
+     * @param {StorageCredentials} credentials - Optional. Cloud storage access data. If credentials are not provided - use anonymous access to the bucket
      */
     constructor(params: StorageParams, credentials?: StorageCredentials);
     /**
@@ -61,8 +61,7 @@ export declare class StorageClient {
      *
      * @param {string[]} keys Array of filenames to download.
      * @param {string} bucket Bucket name.
-     * @returns {any[]} Returns an array of json files downloaded and parsed into objects.
-     *
+     * @returns {Promise<any[]>} Returns an array of JSON files downloaded and parsed into objects.
      *
      * **Code example**
      *
@@ -84,28 +83,26 @@ export declare class StorageClient {
      */
     downloadFiles(keys: string[], bucket: string): Promise<any[]>;
     /**
-     * This function downloads files from a Url.
-     *
-     * @param {string} url Url of the file to download.
-     * @returns {any} Returns the JSON file downloaded and parsed into object.
+     * This function downloads files from a URL.
      *
+     * @param {string} url URL of the file to download.
+     * @returns {Promise<any>} Returns the JSON file downloaded and parsed into an object.
      *
      * **Code example**
      *
      * ```ts
      * import { StorageClient } from '@human-protocol/sdk';
      *
-     * const file = await storageClient.downloadFileFromUrl('http://localhost/file.json');
+     * const file = await StorageClient.downloadFileFromUrl('http://localhost/file.json');
      * ```
      */
     static downloadFileFromUrl(url: string): Promise<any>;
     /**
      * This function uploads files to a bucket.
      *
-     * @param {any[]} files Array of objects to upload serialized into json.
+     * @param {any[]} files Array of objects to upload serialized into JSON.
      * @param {string} bucket Bucket name.
-     * @returns {UploadFile[]} Returns an array of json files downloaded and parsed into objects.
-     *
+     * @returns {Promise<UploadFile[]>} Returns an array of uploaded file metadata.
      *
      * **Code example**
      *
@@ -135,8 +132,7 @@ export declare class StorageClient {
      * This function checks if a bucket exists.
      *
      * @param {string} bucket Bucket name.
-     * @returns {boolean} Returns `true` if exists, `false` if it doesn't.
-     *
+     * @returns {Promise<boolean>} Returns `true` if exists, `false` if it doesn't.
      *
      * **Code example**
      *
@@ -160,11 +156,10 @@ export declare class StorageClient {
      */
     bucketExists(bucket: string): Promise<boolean>;
     /**
-     * This function list all file names contained in the bucket.
+     * This function lists all file names contained in the bucket.
      *
      * @param {string} bucket Bucket name.
-     * @returns {boolean} Returns the list of file names contained in the bucket.
-     *
+     * @returns {Promise<string[]>} Returns the list of file names contained in the bucket.
      *
      * **Code example**
      *

package/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;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"}
+{"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;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAoB1E;;;;;;;;;;;;;OAaG;WACiB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAsBlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACU,WAAW,CACtB,KAAK,EAAE,GAAG,EAAE,EACZ,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,UAAU,EAAE,CAAC;IAmCxB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI3D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAqB5D"}

package/dist/storage.js

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