@human-protocol/sdk 3.0.7 → 4.0.0

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';
@@ -91,20 +91,18 @@ class StakingClient extends base_1.BaseEthersClient {
      * **StakingClient constructor**
      *
      * @param {ContractRunner} runner - The Runner object to interact with the Ethereum network
-     * @param {NetworkData} network - The network information required to connect to the Staking contract
+     * @param {NetworkData} networkData - The network information required to connect to the Staking contract
      */
     constructor(runner, networkData) {
         super(runner, networkData);
         this.stakingContract = typechain_types_1.Staking__factory.connect(networkData.stakingAddress, runner);
         this.escrowFactoryContract = typechain_types_1.EscrowFactory__factory.connect(networkData.factoryAddress, runner);
         this.tokenContract = typechain_types_1.HMToken__factory.connect(networkData.hmtAddress, runner);
-        this.rewardPoolContract = typechain_types_1.RewardPool__factory.connect(networkData.rewardPoolAddress, this.runner);
     }
     /**
      * Creates an instance of StakingClient from a Runner.
      *
      * @param {ContractRunner} runner - The Runner 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
@@ -142,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
@@ -150,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);
@@ -184,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
@@ -192,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);
@@ -200,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 = {}) {
@@ -227,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
@@ -235,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);
@@ -261,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
@@ -276,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);
@@ -295,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 which allocation will 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
@@ -312,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);
@@ -345,151 +338,49 @@ class StakingClient extends base_1.BaseEthersClient {
         }
     }
     /**
-     * This function allocates a portion of the staked tokens to a specific escrow.
-     *
-     * > Must have tokens staked
-     *
-     * @param {string} escrowAddress Address of the escrow contract to allocate in.
-     * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
-     * @param {bigint} amount Amount in WEI of tokens to allocate.
-     * @returns Returns void if successful. Throws error if any.
-     *
-     *
-     * **Code example**
-     *
-     * ```ts
-     * import { ethers, Wallet, providers } from 'ethers';
-     * import { StakingClient } 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 stakingClient = await StakingClient.build(signer);
-     *
-     * const amount = ethers.parseUnits(5, 'ether'); //convert from ETH to WEI
-     * await stakingClient.allocate('0x62dD51230A30401C455c8398d06F85e4EaB6309f', amount);
-     * ```
-     */
-    async allocate(escrowAddress, amount, txOptions = {}) {
-        if (typeof amount !== 'bigint') {
-            throw error_1.ErrorInvalidStakingValueType;
-        }
-        if (amount < 0n) {
-            throw error_1.ErrorInvalidStakingValueSign;
-        }
-        await this.checkValidEscrow(escrowAddress);
-        try {
-            await (await this.stakingContract.allocate(escrowAddress, amount, txOptions)).wait();
-            return;
-        }
-        catch (e) {
-            return (0, utils_1.throwError)(e);
-        }
-    }
-    /**
-     * This function drops the allocation from a specific escrow.
-     *
-     * > The escrow must have allocation
-     * > The escrow must be cancelled or completed.
-     *
-     * @param {string} escrowAddress Address of the escrow contract to close allocation from.
-     * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
-     * @returns Returns void if successful. Throws error if any.
-     *
-     *
-     * **Code example**
-     *
-     * ```ts
-     * import { Wallet, providers } from 'ethers';
-     * import { StakingClient } 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 stakingClient = await StakingClient.build(signer);
-     *
-     * await stakingClient.closeAllocation('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
-     * ```
-     */
-    async closeAllocation(escrowAddress, txOptions = {}) {
-        await this.checkValidEscrow(escrowAddress);
-        try {
-            await (await this.stakingContract.closeAllocation(escrowAddress, txOptions)).wait();
-            return;
-        }
-        catch (e) {
-            return (0, utils_1.throwError)(e);
-        }
-    }
-    /**
-     * This function drops the allocation from a specific escrow.
-     *
-     * > The escrow must have rewards added
-     *
-     * @param {string} escrowAddress Escrow address from which rewards are distributed.
-     * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
-     * @returns Returns void if successful. Throws error if any.
-     *
-     *
-     * **Code example**
-     *
-     * ```ts
-     * import { Wallet, providers } from 'ethers';
-     * import { StakingClient } 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 stakingClient = await StakingClient.build(signer);
-     *
-     * await stakingClient.distributeReward('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
-     * ```
-     */
-    async distributeReward(escrowAddress, txOptions = {}) {
-        await this.checkValidEscrow(escrowAddress);
-        try {
-            (await this.rewardPoolContract.distributeReward(escrowAddress, txOptions)).wait();
-            return;
-        }
-        catch (e) {
-            return (0, utils_1.throwError)(e);
-        }
-    }
-    /**
-     * This function returns information about the allocation of the specified escrow.
-     *
-     * @param {string} escrowAddress Escrow address from which we want to get allocation information.
-     * @returns {IAllocation} Returns allocation info if exists.
+     * 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';
-     * import { providers } from 'ethers';
      *
      * const rpcUrl = 'YOUR_RPC_URL';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const stakingClient = await StakingClient.build(provider);
      *
-     * const allocationInfo = await stakingClient.getAllocation('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * const stakingInfo = await stakingClient.getStakerInfo('0xYourStakerAddress');
+     * console.log(stakingInfo.tokensStaked);
      * ```
      */
-    async getAllocation(escrowAddress) {
-        await this.checkValidEscrow(escrowAddress);
-        try {
-            const result = await this.stakingContract.getAllocation(escrowAddress);
-            return result;
+    async getStakerInfo(stakerAddress) {
+        if (!ethers_1.ethers.isAddress(stakerAddress)) {
+            throw error_1.ErrorInvalidStakerAddressProvided;
         }
-        catch (e) {
-            return (0, utils_1.throwError)(e);
+        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);
         }
     }
 }
@@ -524,21 +415,3 @@ __decorate([
     __metadata("design:paramtypes", [String, String, String, BigInt, Object]),
     __metadata("design:returntype", Promise)
 ], StakingClient.prototype, "slash", null);
-__decorate([
-    decorators_1.requiresSigner,
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [String, BigInt, Object]),
-    __metadata("design:returntype", Promise)
-], StakingClient.prototype, "allocate", null);
-__decorate([
-    decorators_1.requiresSigner,
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [String, Object]),
-    __metadata("design:returntype", Promise)
-], StakingClient.prototype, "closeAllocation", null);
-__decorate([
-    decorators_1.requiresSigner,
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [String, Object]),
-    __metadata("design:returntype", Promise)
-], StakingClient.prototype, "distributeReward", null);

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;IAqC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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**
      *
@@ -122,7 +114,9 @@ class StatisticsClient {
                 skip: skip,
             });
             return {
-                totalEscrows: +escrowStatistics.totalEscrowCount,
+                totalEscrows: escrowStatistics?.totalEscrowCount
+                    ? +escrowStatistics.totalEscrowCount
+                    : 0,
                 dailyEscrowsData: eventDayDatas.map((eventDayData) => ({
                     timestamp: new Date(+eventDayData.timestamp * 1000),
                     escrowsTotal: +eventDayData.dailyEscrowCount,
@@ -140,7 +134,6 @@ class StatisticsClient {
     /**
      * This function returns the statistical data of workers.
      *
-     *
      * **Input parameters**
      *
      * ```ts
@@ -164,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**
      *
@@ -209,7 +200,6 @@ class StatisticsClient {
     /**
      * This function returns the statistical data of payments.
      *
-     *
      * **Input parameters**
      *
      * ```ts
@@ -235,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**
      *
@@ -306,7 +294,7 @@ class StatisticsClient {
     /**
      * This function returns the statistical data of HMToken.
      *
-     *
+     * ```ts
      * type HMTStatistics = {
      *   totalTransferAmount: BigNumber;
      *   totalTransferCount: BigNumber;
@@ -314,9 +302,7 @@ class StatisticsClient {
      * };
      * ```
      *
-     *
-     * @returns {HMTStatistics} HMToken statistics data.
-     *
+     * @returns {Promise<HMTStatistics>} HMToken statistics data.
      *
      * **Code example**
      *
@@ -352,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**
      *
@@ -392,7 +378,6 @@ class StatisticsClient {
     /**
      * This function returns the statistical data of HMToken day by day.
      *
-     *
      * **Input parameters**
      *
      * ```ts
@@ -415,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**
      *