@human-protocol/sdk 5.2.0 → 6.1.0

package/dist/escrow.js

@@ -22,71 +22,52 @@ const graphql_1 = require("./graphql");
 const types_1 = require("./types");
 const utils_1 = require("./utils");
 /**
- * ## Introduction
- *
- * This client enables performing actions on Escrow contracts and obtaining information from both the contracts and subgraph.
+ * Client to perform actions on Escrow contracts and obtain information from the contracts.
  *
  * 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): Promise<EscrowClient>;
- * ```
+ * To use this client, it is recommended to initialize it using the static [`build`](/ts/classes/EscrowClient/#build) method.
  *
  * 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 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
- *
- * ### npm
- * ```bash
- * npm install @human-protocol/sdk
- * ```
- *
- * ### yarn
- * ```bash
- * yarn install @human-protocol/sdk
- * ```
+ * @example
  *
- * ## Code example
+ * ###Using Signer
  *
- * ### Signer
- *
- * **Using private key (backend)**
+ * ####Using private key (backend)
  *
  * ```ts
  * import { EscrowClient } from '@human-protocol/sdk';
- * import { Wallet, providers } from 'ethers';
+ * import { Wallet, JsonRpcProvider } from 'ethers';
  *
  * const rpcUrl = 'YOUR_RPC_URL';
  * const privateKey = 'YOUR_PRIVATE_KEY';
  *
- * const provider = new providers.JsonRpcProvider(rpcUrl);
+ * const provider = new JsonRpcProvider(rpcUrl);
  * const signer = new Wallet(privateKey, provider);
  * const escrowClient = await EscrowClient.build(signer);
  * ```
  *
- * **Using Wagmi (frontend)**
+ * ####Using Wagmi (frontend)
  *
  * ```ts
- * import { useSigner, useChainId } from 'wagmi';
+ * import { useSigner } from 'wagmi';
  * import { EscrowClient } from '@human-protocol/sdk';
  *
  * const { data: signer } = useSigner();
  * const escrowClient = await EscrowClient.build(signer);
  * ```
  *
- * ### Provider
+ * ###Using Provider
  *
  * ```ts
  * import { EscrowClient } from '@human-protocol/sdk';
- * import { providers } from 'ethers';
+ * import { JsonRpcProvider } from 'ethers';
  *
  * const rpcUrl = 'YOUR_RPC_URL';
- *
- * const provider = new providers.JsonRpcProvider(rpcUrl);
+ * const provider = new JsonRpcProvider(rpcUrl);
  * const escrowClient = await EscrowClient.build(provider);
  * ```
  */
@@ -94,8 +75,9 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * **EscrowClient constructor**
      *
-     * @param {ContractRunner} runner The Runner object to interact with the Ethereum network
-     * @param {NetworkData} networkData The network information required to connect to the Escrow contract
+     * @param runner - The Runner object to interact with the Ethereum network
+     * @param networkData - The network information required to connect to the Escrow contract
+     * @returns An instance of EscrowClient
      */
     constructor(runner, networkData) {
         super(runner, networkData);
@@ -104,11 +86,10 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * Creates an instance of EscrowClient from a Runner.
      *
-     * @param {ContractRunner} runner The Runner object to interact with the Ethereum network
-     *
-     * @returns {Promise<EscrowClient>} An instance of EscrowClient
-     * @throws {ErrorProviderDoesNotExist} Thrown if the provider does not exist for the provided Signer
-     * @throws {ErrorUnsupportedChainID} Thrown if the network's chainId is not supported
+     * @param runner - The Runner object to interact with the Ethereum network
+     * @returns An instance of EscrowClient
+     * @throws ErrorProviderDoesNotExist If the provider does not exist for the provided Signer
+     * @throws ErrorUnsupportedChainID If the network's chainId is not supported
      */
     static async build(runner) {
         if (!runner.provider) {
@@ -137,28 +118,17 @@ class EscrowClient extends base_1.BaseEthersClient {
     }
     /**
      * This function creates an escrow contract that uses the token passed to pay oracle fees and reward workers.
+     * @remarks Need to have available stake.
+     * @param tokenAddress - The address of the token to use for escrow funding.
+     * @param jobRequesterId - Identifier for the job requester.
+     * @param txOptions - Additional transaction parameters (optional, defaults to an empty object).
+     * @returns Returns the address of the escrow created.
+     * @throws ErrorInvalidTokenAddress If the token address is invalid
+     * @throws ErrorLaunchedEventIsNotEmitted If the LaunchedV2 event is not emitted
      *
-     * @param {string} tokenAddress - The address of the token to use for escrow funding.
-     * @param {string} jobRequesterId - Identifier for the job requester.
-     * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
-     * @returns {Promise<string>} Returns the address of the escrow created.
-     *
-     *
-     * **Code example**
-     *
-     * > Need to have available stake.
+     * @example
      *
      * ```ts
-     * import { Wallet, providers } from 'ethers';
-     * import { EscrowClient } 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 escrowClient = await EscrowClient.build(signer);
-     *
      * const tokenAddress = '0x0376D26246Eb35FF4F9924cF13E6C05fd0bD7Fb4';
      * const jobRequesterId = "job-requester-id";
      * const escrowAddress = await escrowClient.createEscrow(tokenAddress, jobRequesterId);
@@ -169,7 +139,7 @@ class EscrowClient extends base_1.BaseEthersClient {
             throw error_1.ErrorInvalidTokenAddress;
         }
         try {
-            const result = await (await this.escrowFactoryContract.createEscrow(tokenAddress, jobRequesterId, txOptions)).wait();
+            const result = await this.sendTxAndWait((overrides) => this.escrowFactoryContract.createEscrow(tokenAddress, jobRequesterId, overrides), txOptions);
             const event = result?.logs?.find(({ topics }) => topics.includes(ethers_1.ethers.id('LaunchedV2(address,address,string)')))?.args;
             if (!event) {
                 throw error_1.ErrorLaunchedEventIsNotEmitted;
@@ -210,50 +180,45 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * Creates, funds, and sets up a new escrow contract in a single transaction.
      *
-     * @param {string} tokenAddress - The ERC-20 token address used to fund the escrow.
-     * @param {bigint} amount - The token amount to fund the escrow with.
-     * @param {string} jobRequesterId - An off-chain identifier for the job requester.
-     * @param {IEscrowConfig} escrowConfig - Configuration parameters for escrow setup:
-     *   - `recordingOracle`: Address of the recording oracle.
-     *   - `reputationOracle`: Address of the reputation oracle.
-     *   - `exchangeOracle`: Address of the exchange oracle.
-     *   - `recordingOracleFee`: Fee (in basis points or percentage * 100) for the recording oracle.
-     *   - `reputationOracleFee`: Fee for the reputation oracle.
-     *   - `exchangeOracleFee`: Fee for the exchange oracle.
-     *   - `manifest`: URL to the manifest file.
-     *   - `manifestHash`: Hash of the manifest content.
-     * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
-     *
-     * @returns {Promise<string>} Returns the address of the escrow created.
+     * @remarks Need to have available stake and approve allowance in the token contract before calling this method.
+     * @param tokenAddress - The ERC-20 token address used to fund the escrow.
+     * @param amount - The token amount to fund the escrow with.
+     * @param jobRequesterId - An off-chain identifier for the job requester.
+     * @param escrowConfig - Configuration parameters for escrow setup.
+     * @param txOptions - Additional transaction parameters (optional, defaults to an empty object).
+     * @returns Returns the address of the escrow created.
+     * @throws ErrorInvalidTokenAddress If the token address is invalid
+     * @throws ErrorInvalidRecordingOracleAddressProvided If the recording oracle address is invalid
+     * @throws ErrorInvalidReputationOracleAddressProvided If the reputation oracle address is invalid
+     * @throws ErrorInvalidExchangeOracleAddressProvided If the exchange oracle address is invalid
+     * @throws ErrorAmountMustBeGreaterThanZero If any oracle fee is less than or equal to zero
+     * @throws ErrorTotalFeeMustBeLessThanHundred If the total oracle fees exceed 100
+     * @throws ErrorInvalidManifest If the manifest is not a valid URL or JSON string
+     * @throws ErrorHashIsEmptyString If the manifest hash is empty
+     * @throws ErrorLaunchedEventIsNotEmitted If the LaunchedV2 event is not emitted
      *
      * @example
-     * import { Wallet, ethers } from 'ethers';
-     * import { EscrowClient, IERC20__factory } from '@human-protocol/sdk';
-     *
-     * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY';
-     * const provider = new ethers.JsonRpcProvider(rpcUrl);
-     * const signer = new Wallet(privateKey, provider);
-     *
-     * const escrowClient = await EscrowClient.build(signer);
+     * ```ts
+     * import { ethers } from 'ethers';
+     * import { ERC20__factory } from '@human-protocol/sdk';
      *
-     * const tokenAddress = '0xTokenAddress';
+     * const tokenAddress = '0x0376D26246Eb35FF4F9924cF13E6C05fd0bD7Fb4';
      * const amount = ethers.parseUnits('1000', 18);
      * const jobRequesterId = 'requester-123';
      *
-     * const token = IERC20__factory.connect(tokenAddress, signer);
+     * const token = ERC20__factory.connect(tokenAddress, signer);
      * await token.approve(escrowClient.escrowFactoryContract.target, amount);
      *
      * const escrowConfig = {
-     *   recordingOracle: '0xRecordingOracle',
-     *   reputationOracle: '0xReputationOracle',
-     *   exchangeOracle: '0xExchangeOracle',
+     *   recordingOracle: '0xRecordingOracleAddress',
+     *   reputationOracle: '0xReputationOracleAddress',
+     *   exchangeOracle: '0xExchangeOracleAddress',
      *   recordingOracleFee: 5n,
      *   reputationOracleFee: 5n,
      *   exchangeOracleFee: 5n,
      *   manifest: 'https://example.com/manifest.json',
      *   manifestHash: 'manifestHash-123',
-     * } satisfies IEscrowConfig;
+     * };
      *
      * const escrowAddress = await escrowClient.createFundAndSetupEscrow(
      *   tokenAddress,
@@ -261,8 +226,8 @@ class EscrowClient extends base_1.BaseEthersClient {
      *   jobRequesterId,
      *   escrowConfig
      * );
-     *
      * console.log('Escrow created at:', escrowAddress);
+     * ```
      */
     async createFundAndSetupEscrow(tokenAddress, amount, jobRequesterId, escrowConfig, txOptions = {}) {
         if (!ethers_1.ethers.isAddress(tokenAddress)) {
@@ -271,7 +236,7 @@ class EscrowClient extends base_1.BaseEthersClient {
         this.verifySetupParameters(escrowConfig);
         const { recordingOracle, reputationOracle, exchangeOracle, recordingOracleFee, reputationOracleFee, exchangeOracleFee, manifest, manifestHash, } = escrowConfig;
         try {
-            const result = await (await this.escrowFactoryContract.createFundAndSetupEscrow(tokenAddress, amount, jobRequesterId, reputationOracle, recordingOracle, exchangeOracle, reputationOracleFee, recordingOracleFee, exchangeOracleFee, manifest, manifestHash, txOptions)).wait();
+            const result = await this.sendTxAndWait((overrides) => this.escrowFactoryContract.createFundAndSetupEscrow(tokenAddress, amount, jobRequesterId, reputationOracle, recordingOracle, exchangeOracle, reputationOracleFee, recordingOracleFee, exchangeOracleFee, manifest, manifestHash, overrides), txOptions);
             const event = result?.logs?.find(({ topics }) => topics.includes(ethers_1.ethers.id('LaunchedV2(address,address,string)')))?.args;
             if (!event) {
                 throw error_1.ErrorLaunchedEventIsNotEmitted;
@@ -285,35 +250,33 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * This function sets up the parameters of the escrow.
      *
-     * @param {string} escrowAddress Address of the escrow to set up.
-     * @param {IEscrowConfig} escrowConfig Escrow configuration parameters.
-     * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
-     * @returns Returns void if successful. Throws error if any.
-     *
-     *
-     * **Code example**
+     * @remarks Only Job Launcher or admin can call it.
+     *
+     * @param escrowAddress - Address of the escrow to set up.
+     * @param escrowConfig - Escrow configuration parameters.
+     * @param txOptions - Additional transaction parameters (optional, defaults to an empty object).
+     * @returns -
+     * @throws ErrorInvalidRecordingOracleAddressProvided If the recording oracle address is invalid
+     * @throws ErrorInvalidReputationOracleAddressProvided If the reputation oracle address is invalid
+     * @throws ErrorInvalidExchangeOracleAddressProvided If the exchange oracle address is invalid
+     * @throws ErrorAmountMustBeGreaterThanZero If any oracle fee is less than or equal to zero
+     * @throws ErrorTotalFeeMustBeLessThanHundred If the total oracle fees exceed 100
+     * @throws ErrorInvalidManifest If the manifest is not a valid URL or JSON string
+     * @throws ErrorHashIsEmptyString If the manifest hash is empty
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
-     * > Only Job Launcher or admin can call it.
+     * @example
      *
      * ```ts
-     * import { Wallet, providers } from 'ethers';
-     * import { EscrowClient } 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 escrowClient = await EscrowClient.build(signer);
-     *
      * const escrowAddress = '0x62dD51230A30401C455c8398d06F85e4EaB6309f';
      * const escrowConfig = {
      *    recordingOracle: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
      *    reputationOracle: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
      *    exchangeOracle: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
-     *    recordingOracleFee: BigInt('10'),
-     *    reputationOracleFee: BigInt('10'),
-     *    exchangeOracleFee: BigInt('10'),
+     *    recordingOracleFee: 10n,
+     *    reputationOracleFee: 10n,
+     *    exchangeOracleFee: 10n,
      *    manifest: 'http://localhost/manifest.json',
      *    manifestHash: 'b5dad76bf6772c0f07fd5e048f6e75a5f86ee079',
      * };
@@ -331,7 +294,7 @@ class EscrowClient extends base_1.BaseEthersClient {
         }
         try {
             const escrowContract = this.getEscrowContract(escrowAddress);
-            await (await escrowContract.setup(reputationOracle, recordingOracle, exchangeOracle, reputationOracleFee, recordingOracleFee, exchangeOracleFee, manifest, manifestHash, txOptions)).wait();
+            await this.sendTxAndWait((overrides) => escrowContract.setup(reputationOracle, recordingOracle, exchangeOracle, reputationOracleFee, recordingOracleFee, exchangeOracleFee, manifest, manifestHash, overrides), txOptions);
             return;
         }
         catch (e) {
@@ -341,26 +304,19 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * This function adds funds of the chosen token to the escrow.
      *
-     * @param {string} escrowAddress Address of the escrow to fund.
-     * @param {bigint} amount Amount to be added as funds.
-     * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
-     * @returns Returns void if successful. Throws error if any.
-     *
-     *
-     * **Code example**
+     * @param escrowAddress - Address of the escrow to fund.
+     * @param amount - Amount to be added as funds.
+     * @param txOptions - Additional transaction parameters (optional, defaults to an empty object).
+     * @returns -
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorAmountMustBeGreaterThanZero If the amount is less than or equal to zero
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
+     * @example
      * ```ts
-     * import { ethers, Wallet, providers } from 'ethers';
-     * import { EscrowClient } from '@human-protocol/sdk';
+     * import { ethers } from 'ethers';
      *
-     * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY';
-     *
-     * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const signer = new Wallet(privateKey, provider);
-     * const escrowClient = await EscrowClient.build(signer);
-     *
-     * const amount = ethers.parseUnits(5, 'ether'); //convert from ETH to WEI
+     * const amount = ethers.parseUnits('5', 'ether');
      * await escrowClient.fund('0x62dD51230A30401C455c8398d06F85e4EaB6309f', amount);
      * ```
      */
@@ -378,7 +334,7 @@ class EscrowClient extends base_1.BaseEthersClient {
             const escrowContract = this.getEscrowContract(escrowAddress);
             const tokenAddress = await escrowContract.token();
             const tokenContract = typechain_types_1.HMToken__factory.connect(tokenAddress, this.runner);
-            await (await tokenContract.transfer(escrowAddress, amount, txOptions)).wait();
+            await this.sendTxAndWait((overrides) => tokenContract.transfer(escrowAddress, amount, overrides), txOptions);
             return;
         }
         catch (e) {
@@ -389,7 +345,7 @@ class EscrowClient extends base_1.BaseEthersClient {
         const escrowContract = this.getEscrowContract(escrowAddress);
         const hasFundsToReserveParam = typeof a === 'bigint';
         const fundsToReserve = hasFundsToReserveParam ? a : null;
-        const txOptions = (hasFundsToReserveParam ? b : a) || {};
+        const txOptions = (hasFundsToReserveParam ? b : a);
         // When fundsToReserve is provided and is 0, allow empty URL.
         // In this situation not solutions might have been provided so the escrow can be straight cancelled.
         const allowEmptyUrl = hasFundsToReserveParam && fundsToReserve === 0n;
@@ -406,12 +362,10 @@ class EscrowClient extends base_1.BaseEthersClient {
             throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
         }
         try {
-            if (fundsToReserve !== null) {
-                await (await escrowContract['storeResults(string,string,uint256)'](url, hash, fundsToReserve, txOptions)).wait();
-            }
-            else {
-                await (await escrowContract['storeResults(string,string)'](url, hash, txOptions)).wait();
-            }
+            const txFactory = (overrides) => fundsToReserve !== null
+                ? escrowContract['storeResults(string,string,uint256)'](url, hash, fundsToReserve, overrides)
+                : escrowContract['storeResults(string,string)'](url, hash, overrides);
+            await this.sendTxAndWait(txFactory, txOptions);
         }
         catch (e) {
             if (!hasFundsToReserveParam && e.reason === 'DEPRECATED_SIGNATURE') {
@@ -424,27 +378,15 @@ class EscrowClient extends base_1.BaseEthersClient {
     }
     /**
      * This function sets the status of an escrow to completed.
+     * @remarks Only Recording Oracle or admin can call it.
+     * @param escrowAddress - Address of the escrow.
+     * @param txOptions - Additional transaction parameters (optional, defaults to an empty object).
+     * @returns -
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid.
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory.
      *
-     * @param {string} escrowAddress Address of the escrow.
-     * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
-     * @returns Returns void if successful. Throws error if any.
-     *
-     *
-     * **Code example**
-     *
-     * > Only Recording Oracle or admin can call it.
-     *
+     * @example
      * ```ts
-     * import { Wallet, providers } from 'ethers';
-     * import { EscrowClient } 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 escrowClient = await EscrowClient.build(signer);
-     *
      * await escrowClient.complete('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
      * ```
      */
@@ -457,7 +399,7 @@ class EscrowClient extends base_1.BaseEthersClient {
         }
         try {
             const escrowContract = this.getEscrowContract(escrowAddress);
-            await (await escrowContract.complete(txOptions)).wait();
+            await this.sendTxAndWait((overrides) => escrowContract.complete(overrides), txOptions);
             return;
         }
         catch (e) {
@@ -469,12 +411,10 @@ class EscrowClient extends base_1.BaseEthersClient {
         const escrowContract = this.getEscrowContract(escrowAddress);
         const idIsString = typeof id === 'string';
         try {
-            if (idIsString) {
-                await (await escrowContract['bulkPayOut(address[],uint256[],string,string,string,bool)'](recipients, amounts, finalResultsUrl, finalResultsHash, id, forceComplete, txOptions)).wait();
-            }
-            else {
-                await (await escrowContract['bulkPayOut(address[],uint256[],string,string,uint256,bool)'](recipients, amounts, finalResultsUrl, finalResultsHash, id, forceComplete, txOptions)).wait();
-            }
+            const txFactory = (overrides) => idIsString
+                ? escrowContract['bulkPayOut(address[],uint256[],string,string,string,bool)'](recipients, amounts, finalResultsUrl, finalResultsHash, id, forceComplete, overrides)
+                : escrowContract['bulkPayOut(address[],uint256[],string,string,uint256,bool)'](recipients, amounts, finalResultsUrl, finalResultsHash, id, forceComplete, overrides);
+            await this.sendTxAndWait(txFactory, txOptions);
         }
         catch (e) {
             if (!idIsString && e.reason === 'DEPRECATED_SIGNATURE') {
@@ -487,26 +427,16 @@ class EscrowClient extends base_1.BaseEthersClient {
     }
     /**
      * This function cancels the specified escrow and sends the balance to the canceler.
+     * @remarks Only Job Launcher or admin can call it.
+     * @param escrowAddress - Address of the escrow to cancel.
+     * @param txOptions - Additional transaction parameters (optional, defaults to an empty object).
+     * @returns -
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
-     * @param {string} escrowAddress Address of the escrow to cancel.
-     * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
-     *
-     *
-     * **Code example**
-     *
-     * > Only Job Launcher or admin can call it.
+     * @example
      *
      * ```ts
-     * import { ethers, Wallet, providers } from 'ethers';
-     * import { EscrowClient } 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 escrowClient = await EscrowClient.build(signer);
-     *
      * await escrowClient.cancel('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
      * ```
      */
@@ -519,7 +449,7 @@ class EscrowClient extends base_1.BaseEthersClient {
         }
         try {
             const escrowContract = this.getEscrowContract(escrowAddress);
-            await (await escrowContract.cancel(txOptions)).wait();
+            await this.sendTxAndWait((overrides) => escrowContract.cancel(overrides), txOptions);
         }
         catch (e) {
             return (0, utils_1.throwError)(e);
@@ -527,26 +457,16 @@ class EscrowClient extends base_1.BaseEthersClient {
     }
     /**
      * This function requests the cancellation of the specified escrow (moves status to ToCancel or finalizes if expired).
+     * @remarks Only Job Launcher or admin can call it.
+     * @param escrowAddress - Address of the escrow to request cancellation.
+     * @param txOptions - Additional transaction parameters (optional, defaults to an empty object).
+     * @returns -
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
-     * @param {string} escrowAddress Address of the escrow to request cancellation.
-     * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
-     * @returns Returns void if successful. Throws error if any.
-     *
-     * **Code example**
-     *
-     * > Only Job Launcher or admin can call it.
+     * @example
      *
      * ```ts
-     * import { Wallet, providers } from 'ethers';
-     * import { EscrowClient } 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 escrowClient = await EscrowClient.build(signer);
-     *
      * await escrowClient.requestCancellation('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
      * ```
      */
@@ -559,7 +479,7 @@ class EscrowClient extends base_1.BaseEthersClient {
         }
         try {
             const escrowContract = this.getEscrowContract(escrowAddress);
-            await (await escrowContract.requestCancellation(txOptions)).wait();
+            await this.sendTxAndWait((overrides) => escrowContract.requestCancellation(overrides), txOptions);
         }
         catch (e) {
             return (0, utils_1.throwError)(e);
@@ -567,32 +487,25 @@ class EscrowClient extends base_1.BaseEthersClient {
     }
     /**
      * This function withdraws additional tokens in the escrow to the canceler.
+     * @remarks Only Job Launcher or admin can call it.
      *
-     * @param {string} escrowAddress Address of the escrow to withdraw.
-     * @param {string} tokenAddress Address of the token to withdraw.
-     * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
-     * @returns {IEscrowWithdraw} Returns the escrow withdrawal data including transaction hash and withdrawal amount. Throws error if any.
-     *
+     * @param escrowAddress - Address of the escrow to withdraw.
+     * @param tokenAddress - Address of the token to withdraw.
+     * @param txOptions - Additional transaction parameters (optional, defaults to an empty object).
+     * @returns Returns the escrow withdrawal data including transaction hash and withdrawal amount.
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorInvalidTokenAddress If the token address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
+     * @throws ErrorTransferEventNotFoundInTransactionLogs If the Transfer event is not found in transaction logs
      *
-     * **Code example**
-     *
-     * > Only Job Launcher or admin can call it.
+     * @example
      *
      * ```ts
-     * import { ethers, Wallet, providers } from 'ethers';
-     * import { EscrowClient } 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 escrowClient = await EscrowClient.build(signer);
-     *
-     * await escrowClient.withdraw(
+     * const withdrawData = await escrowClient.withdraw(
      *  '0x62dD51230A30401C455c8398d06F85e4EaB6309f',
      *  '0x0376D26246Eb35FF4F9924cF13E6C05fd0bD7Fb4'
      * );
+     * console.log('Withdrawn amount:', withdrawData.withdrawnAmount);
      * ```
      */
     async withdraw(escrowAddress, tokenAddress, txOptions = {}) {
@@ -607,7 +520,7 @@ class EscrowClient extends base_1.BaseEthersClient {
         }
         try {
             const escrowContract = this.getEscrowContract(escrowAddress);
-            const transactionReceipt = await (await escrowContract.withdraw(tokenAddress, txOptions)).wait();
+            const transactionReceipt = await this.sendTxAndWait((overrides) => escrowContract.withdraw(tokenAddress, overrides), txOptions);
             let amountTransferred = undefined;
             const tokenContract = typechain_types_1.ERC20__factory.connect(tokenAddress, this.runner);
             if (transactionReceipt)
@@ -639,43 +552,54 @@ class EscrowClient extends base_1.BaseEthersClient {
     }
     /**
      * Creates a prepared transaction for bulk payout without immediately sending it.
-     * @param {string} escrowAddress Escrow address to payout.
-     * @param {string[]} recipients Array of recipient addresses.
-     * @param {bigint[]} amounts Array of amounts the recipients will receive.
-     * @param {string} finalResultsUrl Final results file URL.
-     * @param {string} finalResultsHash Final results file hash.
-     * @param {string} payoutId Payout ID to identify the payout.
-     * @param {boolean} forceComplete Indicates if remaining balance should be transferred to the escrow creator (optional, defaults to false).
-     * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
-     * @returns Returns object with raw transaction and signed transaction hash
-     *
-     * **Code example**
+     * @remarks Only Reputation Oracle or admin can call it.
+     *
+     * @param escrowAddress - Escrow address to payout.
+     * @param recipients - Array of recipient addresses.
+     * @param amounts - Array of amounts the recipients will receive.
+     * @param finalResultsUrl - Final results file URL.
+     * @param finalResultsHash - Final results file hash.
+     * @param payoutId - Payout ID to identify the payout.
+     * @param forceComplete - Indicates if remaining balance should be transferred to the escrow creator (optional, defaults to false).
+     * @param txOptions - Additional transaction parameters (optional, defaults to an empty object).
+     * @returns Returns object with raw transaction and nonce
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorRecipientCannotBeEmptyArray If the recipients array is empty
+     * @throws ErrorTooManyRecipients If there are too many recipients
+     * @throws ErrorAmountsCannotBeEmptyArray If the amounts array is empty
+     * @throws ErrorRecipientAndAmountsMustBeSameLength If recipients and amounts arrays have different lengths
+     * @throws InvalidEthereumAddressError If any recipient address is invalid
+     * @throws ErrorInvalidUrl If the final results URL is invalid
+     * @throws ErrorHashIsEmptyString If the final results hash is empty
+     * @throws ErrorEscrowDoesNotHaveEnoughBalance If the escrow doesn't have enough balance
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
-     * > Only Reputation Oracle or admin can call it.
+     * @example
      *
      * ```ts
-     * import { ethers, Wallet, providers } from 'ethers';
-     * import { EscrowClient } from '@human-protocol/sdk';
-     *
-     * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY'
+     * import { ethers } from 'ethers';
+     * import { v4 as uuidV4 } from 'uuid';
      *
-     * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const signer = new Wallet(privateKey, provider);
-     * const escrowClient = await EscrowClient.build(signer);
-     *
-     * const recipients = ['0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'];
-     * const amounts = [ethers.parseUnits(5, 'ether'), ethers.parseUnits(10, 'ether')];
+     * const recipients = ['0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', '0x70997970C51812dc3A010C7d01b50e0d17dc79C8'];
+     * const amounts = [ethers.parseUnits('5', 'ether'), ethers.parseUnits('10', 'ether')];
      * const resultsUrl = 'http://localhost/results.json';
      * const resultsHash = 'b5dad76bf6772c0f07fd5e048f6e75a5f86ee079';
-     * const payoutId = '372f6916-fe34-4711-b6e3-274f682047de';
-     *
-     * const rawTransaction = await escrowClient.createBulkPayoutTransaction('0x62dD51230A30401C455c8398d06F85e4EaB6309f', recipients, amounts, resultsUrl, resultsHash, txId);
+     * const payoutId = uuidV4();
+     *
+     * const rawTransaction = await escrowClient.createBulkPayoutTransaction(
+     *   '0x62dD51230A30401C455c8398d06F85e4EaB6309f',
+     *   recipients,
+     *   amounts,
+     *   resultsUrl,
+     *   resultsHash,
+     *   payoutId
+     * );
      * console.log('Raw transaction:', rawTransaction);
      *
      * const signedTransaction = await signer.signTransaction(rawTransaction);
      * console.log('Tx hash:', ethers.keccak256(signedTransaction));
-     * (await signer.sendTransaction(rawTransaction)).wait();
+     * await signer.sendTransaction(rawTransaction);
+     * ```
      */
     async createBulkPayoutTransaction(escrowAddress, recipients, amounts, finalResultsUrl, finalResultsHash, payoutId, forceComplete = false, txOptions = {}) {
         await this.ensureCorrectBulkPayoutInput(escrowAddress, recipients, amounts, finalResultsUrl, finalResultsHash);
@@ -757,21 +681,15 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * This function returns the balance for a specified escrow address.
      *
-     * @param {string} escrowAddress Address of the escrow.
-     * @returns {Promise<bigint>} Balance of the escrow in the token used to fund it.
-     *
-     * **Code example**
+     * @param escrowAddress - Address of the escrow.
+     * @returns Balance of the escrow in the token used to fund it.
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
+     * @example
      * ```ts
-     * import { providers } from 'ethers';
-     * import { EscrowClient } from '@human-protocol/sdk';
-     *
-     * const rpcUrl = 'YOUR_RPC_URL';
-     *
-     * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(provider);
-     *
      * const balance = await escrowClient.getBalance('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * console.log('Balance:', balance);
      * ```
      */
     async getBalance(escrowAddress) {
@@ -798,21 +716,15 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * This function returns the reserved funds for a specified escrow address.
      *
-     * @param {string} escrowAddress Address of the escrow.
-     * @returns {Promise<bigint>} Reserved funds of the escrow in the token used to fund it.
-     *
-     * **Code example**
+     * @param escrowAddress - Address of the escrow.
+     * @returns Reserved funds of the escrow in the token used to fund it.
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
+     * @example
      * ```ts
-     * import { providers } from 'ethers';
-     * import { EscrowClient } from '@human-protocol/sdk';
-     *
-     * const rpcUrl = 'YOUR_RPC_URL';
-     *
-     * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(provider);
-     *
      * const reservedFunds = await escrowClient.getReservedFunds('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * console.log('Reserved funds:', reservedFunds);
      * ```
      */
     async getReservedFunds(escrowAddress) {
@@ -833,21 +745,15 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * This function returns the manifest file hash.
      *
-     * @param {string} escrowAddress Address of the escrow.
-     * @returns {Promise<string>} Hash of the manifest file content.
-     *
-     * **Code example**
+     * @param escrowAddress - Address of the escrow.
+     * @returns Hash of the manifest file content.
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
+     * @example
      * ```ts
-     * import { providers } from 'ethers';
-     * import { EscrowClient } from '@human-protocol/sdk';
-     *
-     * const rpcUrl = 'YOUR_RPC_URL';
-     *
-     * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(provider);
-     *
      * const manifestHash = await escrowClient.getManifestHash('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * console.log('Manifest hash:', manifestHash);
      * ```
      */
     async getManifestHash(escrowAddress) {
@@ -868,21 +774,15 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * This function returns the manifest. Could be a URL or a JSON string.
      *
-     * @param {string} escrowAddress Address of the escrow.
-     * @returns {Promise<string>} Url of the manifest.
-     *
-     * **Code example**
+     * @param escrowAddress - Address of the escrow.
+     * @returns Manifest URL or JSON string.
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
+     * @example
      * ```ts
-     * import { providers } from 'ethers';
-     * import { EscrowClient } from '@human-protocol/sdk';
-     *
-     * const rpcUrl = 'YOUR_RPC_URL';
-     *
-     * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(provider);
-     *
      * const manifest = await escrowClient.getManifest('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * console.log('Manifest:', manifest);
      * ```
      */
     async getManifest(escrowAddress) {
@@ -903,21 +803,15 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * This function returns the results file URL.
      *
-     * @param {string} escrowAddress Address of the escrow.
-     * @returns {Promise<string>} Results file url.
-     *
-     * **Code example**
+     * @param escrowAddress - Address of the escrow.
+     * @returns Results file URL.
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
+     * @example
      * ```ts
-     * import { providers } from 'ethers';
-     * import { EscrowClient } from '@human-protocol/sdk';
-     *
-     * const rpcUrl = 'YOUR_RPC_URL';
-     *
-     * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(provider);
-     *
      * const resultsUrl = await escrowClient.getResultsUrl('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * console.log('Results URL:', resultsUrl);
      * ```
      */
     async getResultsUrl(escrowAddress) {
@@ -938,21 +832,15 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * This function returns the intermediate results file URL.
      *
-     * @param {string} escrowAddress Address of the escrow.
-     * @returns {Promise<string>} Url of the file that store results from Recording Oracle.
-     *
-     * **Code example**
+     * @param escrowAddress - Address of the escrow.
+     * @returns URL of the file that stores results from Recording Oracle.
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
+     * @example
      * ```ts
-     * import { providers } from 'ethers';
-     * import { EscrowClient } from '@human-protocol/sdk';
-     *
-     * const rpcUrl = 'YOUR_RPC_URL';
-     *
-     * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(provider);
-     *
      * const intermediateResultsUrl = await escrowClient.getIntermediateResultsUrl('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * console.log('Intermediate results URL:', intermediateResultsUrl);
      * ```
      */
     async getIntermediateResultsUrl(escrowAddress) {
@@ -973,21 +861,15 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * This function returns the intermediate results hash.
      *
-     * @param {string} escrowAddress Address of the escrow.
-     * @returns {Promise<string>} Hash of the intermediate results file content.
-     *
-     * **Code example**
+     * @param escrowAddress - Address of the escrow.
+     * @returns Hash of the intermediate results file content.
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
+     * @example
      * ```ts
-     * import { providers } from 'ethers';
-     * import { EscrowClient } from '@human-protocol/sdk';
-     *
-     * const rpcUrl = 'YOUR_RPC_URL';
-     *
-     * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(provider);
-     *
      * const intermediateResultsHash = await escrowClient.getIntermediateResultsHash('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * console.log('Intermediate results hash:', intermediateResultsHash);
      * ```
      */
     async getIntermediateResultsHash(escrowAddress) {
@@ -1008,21 +890,15 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * This function returns the token address used for funding the escrow.
      *
-     * @param {string} escrowAddress Address of the escrow.
-     * @returns {Promise<string>} Address of the token used to fund the escrow.
-     *
-     * **Code example**
+     * @param escrowAddress - Address of the escrow.
+     * @returns Address of the token used to fund the escrow.
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
+     * @example
      * ```ts
-     * import { providers } from 'ethers';
-     * import { EscrowClient } from '@human-protocol/sdk';
-     *
-     * const rpcUrl = 'YOUR_RPC_URL';
-     *
-     * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(provider);
-     *
      * const tokenAddress = await escrowClient.getTokenAddress('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * console.log('Token address:', tokenAddress);
      * ```
      */
     async getTokenAddress(escrowAddress) {
@@ -1043,21 +919,17 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * This function returns the current status of the escrow.
      *
-     * @param {string} escrowAddress Address of the escrow.
-     * @returns {Promise<EscrowStatus>} Current status of the escrow.
-     *
-     * **Code example**
+     * @param escrowAddress - Address of the escrow.
+     * @returns Current status of the escrow.
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
+     * @example
      * ```ts
-     * import { providers } from 'ethers';
-     * import { EscrowClient } from '@human-protocol/sdk';
-     *
-     * const rpcUrl = 'YOUR_RPC_URL';
-     *
-     * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(provider);
+     * import { EscrowStatus } from '@human-protocol/sdk';
      *
      * const status = await escrowClient.getStatus('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * console.log('Status:', EscrowStatus[status]);
      * ```
      */
     async getStatus(escrowAddress) {
@@ -1078,21 +950,15 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * This function returns the recording oracle address for a given escrow.
      *
-     * @param {string} escrowAddress Address of the escrow.
-     * @returns {Promise<string>} Address of the Recording Oracle.
-     *
-     * **Code example**
+     * @param escrowAddress - Address of the escrow.
+     * @returns Address of the Recording Oracle.
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
+     * @example
      * ```ts
-     * import { providers } from 'ethers';
-     * import { EscrowClient } from '@human-protocol/sdk';
-     *
-     * const rpcUrl = 'YOUR_RPC_URL';
-     *
-     * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(provider);
-     *
      * const oracleAddress = await escrowClient.getRecordingOracleAddress('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * console.log('Recording Oracle address:', oracleAddress);
      * ```
      */
     async getRecordingOracleAddress(escrowAddress) {
@@ -1113,21 +979,15 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * This function returns the job launcher address for a given escrow.
      *
-     * @param {string} escrowAddress Address of the escrow.
-     * @returns {Promise<string>} Address of the Job Launcher.
-     *
-     * **Code example**
+     * @param escrowAddress - Address of the escrow.
+     * @returns Address of the Job Launcher.
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
+     * @example
      * ```ts
-     * import { providers } from 'ethers';
-     * import { EscrowClient } from '@human-protocol/sdk';
-     *
-     * const rpcUrl = 'YOUR_RPC_URL';
-     *
-     * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(provider);
-     *
      * const jobLauncherAddress = await escrowClient.getJobLauncherAddress('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * console.log('Job Launcher address:', jobLauncherAddress);
      * ```
      */
     async getJobLauncherAddress(escrowAddress) {
@@ -1148,21 +1008,15 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * This function returns the reputation oracle address for a given escrow.
      *
-     * @param {string} escrowAddress Address of the escrow.
-     * @returns {Promise<string>} Address of the Reputation Oracle.
-     *
-     * **Code example**
+     * @param escrowAddress - Address of the escrow.
+     * @returns Address of the Reputation Oracle.
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
+     * @example
      * ```ts
-     * import { providers } from 'ethers';
-     * import { EscrowClient } from '@human-protocol/sdk';
-     *
-     * const rpcUrl = 'YOUR_RPC_URL';
-     *
-     * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(provider);
-     *
      * const oracleAddress = await escrowClient.getReputationOracleAddress('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * console.log('Reputation Oracle address:', oracleAddress);
      * ```
      */
     async getReputationOracleAddress(escrowAddress) {
@@ -1183,21 +1037,15 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * This function returns the exchange oracle address for a given escrow.
      *
-     * @param {string} escrowAddress Address of the escrow.
-     * @returns {Promise<string>} Address of the Exchange Oracle.
-     *
-     * **Code example**
+     * @param escrowAddress - Address of the escrow.
+     * @returns Address of the Exchange Oracle.
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
+     * @example
      * ```ts
-     * import { providers } from 'ethers';
-     * import { EscrowClient } from '@human-protocol/sdk';
-     *
-     * const rpcUrl = 'YOUR_RPC_URL';
-     *
-     * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(provider);
-     *
      * const oracleAddress = await escrowClient.getExchangeOracleAddress('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * console.log('Exchange Oracle address:', oracleAddress);
      * ```
      */
     async getExchangeOracleAddress(escrowAddress) {
@@ -1218,21 +1066,15 @@ class EscrowClient extends base_1.BaseEthersClient {
     /**
      * This function returns the escrow factory address for a given escrow.
      *
-     * @param {string} escrowAddress Address of the escrow.
-     * @returns {Promise<string>} Address of the escrow factory.
-     *
-     * **Code example**
+     * @param escrowAddress - Address of the escrow.
+     * @returns Address of the escrow factory.
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorEscrowAddressIsNotProvidedByFactory If the escrow is not provided by the factory
      *
+     * @example
      * ```ts
-     * import { providers } from 'ethers';
-     * import { EscrowClient } from '@human-protocol/sdk';
-     *
-     * const rpcUrl = 'YOUR_RPC_URL';
-     *
-     * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(provider);
-     *
      * const factoryAddress = await escrowClient.getFactoryAddress('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * console.log('Factory address:', factoryAddress);
      * ```
      */
     async getFactoryAddress(escrowAddress) {
@@ -1319,138 +1161,40 @@ __decorate([
     __metadata("design:returntype", Promise)
 ], EscrowClient.prototype, "createBulkPayoutTransaction", null);
 /**
- * ## Introduction
- *
- * Utility class for escrow-related operations.
- *
- * ## Installation
- *
- * ### npm
- * ```bash
- * npm install @human-protocol/sdk
- * ```
- *
- * ### yarn
- * ```bash
- * yarn install @human-protocol/sdk
- * ```
- *
- * ## Code example
- *
- * ### Signer
- *
- * **Using private key(backend)**
+ * Utility helpers for escrow-related queries.
  *
+ * @example
  * ```ts
  * import { ChainId, EscrowUtils } from '@human-protocol/sdk';
  *
- * const escrowAddresses = new EscrowUtils.getEscrows({
+ * const escrows = await EscrowUtils.getEscrows({
  *   chainId: ChainId.POLYGON_AMOY
  * });
+ * console.log('Escrows:', escrows);
  * ```
  */
 class EscrowUtils {
     /**
      * This function returns an array of escrows based on the specified filter parameters.
      *
+     * @param filter - Filter parameters.
+     * @param options - Optional configuration for subgraph requests.
+     * @returns List of escrows that match the filter.
+     * @throws ErrorInvalidAddress If any filter address is invalid
+     * @throws ErrorUnsupportedChainID If the chain ID is not supported
      *
-     * **Input parameters**
-     *
-     * ```ts
-     * interface IEscrowsFilter {
-     *   chainId: ChainId;
-     *   launcher?: string;
-     *   reputationOracle?: string;
-     *   recordingOracle?: string;
-     *   exchangeOracle?: string;
-     *   jobRequesterId?: string;
-     *   status?: EscrowStatus;
-     *   from?: Date;
-     *   to?: Date;
-     *   first?: number;
-     *   skip?: number;
-     *   orderDirection?: OrderDirection;
-     * }
-     * ```
-     *
-     * ```ts
-     * enum ChainId {
-     *   ALL = -1,
-     *   MAINNET = 1,
-     *   SEPOLIA = 11155111,
-     *   BSC_MAINNET = 56,
-     *   BSC_TESTNET = 97,
-     *   POLYGON = 137,
-     *   POLYGON_AMOY=80002,
-     *   LOCALHOST = 1338,
-     * }
-     * ```
-     *
-     * ```ts
-     * enum OrderDirection {
-     *   ASC = 'asc',
-     *   DESC = 'desc',
-     * }
-     * ```
-     *
-     * ```ts
-     * enum EscrowStatus {
-     *   Launched,
-     *   Pending,
-     *   Partial,
-     *   Paid,
-     *   Complete,
-     *   Cancelled,
-     * }
-     * ```
-     *
-     * ```ts
-     * interface IEscrow {
-     *   id: string;
-     *   address: string;
-     *   amountPaid: bigint;
-     *   balance: bigint;
-     *   count: bigint;
-     *   factoryAddress: string;
-     *   finalResultsUrl: string | null;
-     *   finalResultsHash: string | null;
-     *   intermediateResultsUrl: string | null;
-     *   intermediateResultsHash: string | null;
-     *   launcher: string;
-     *   jobRequesterId: string | null;
-     *   manifestHash: string | null;
-     *   manifest: string | null;
-     *   recordingOracle: string | null;
-     *   reputationOracle: string | null;
-     *   exchangeOracle: string | null;
-     *   recordingOracleFee: number | null;
-     *   reputationOracleFee: number | null;
-     *   exchangeOracleFee: number | null;
-     *   status: string;
-     *   token: string;
-     *   totalFundedAmount: bigint;
-     *   createdAt: number;
-     *   chainId: number;
-     * };
-     * ```
-     *
-     *
-     * @param {IEscrowsFilter} filter Filter parameters.
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {IEscrow[]} List of escrows that match the filter.
-     *
-     * **Code example**
-     *
+     * @example
      * ```ts
-     * import { ChainId, EscrowUtils, EscrowStatus } from '@human-protocol/sdk';
+     * import { ChainId, EscrowStatus } from '@human-protocol/sdk';
      *
-     * const filters: IEscrowsFilter = {
+     * const filters = {
      *   status: EscrowStatus.Pending,
      *   from: new Date(2023, 4, 8),
      *   to: new Date(2023, 5, 8),
      *   chainId: ChainId.POLYGON_AMOY
      * };
      * const escrows = await EscrowUtils.getEscrows(filters);
+     * console.log('Found escrows:', escrows.length);
      * ```
      */
     static async getEscrows(filter, options) {
@@ -1498,63 +1242,24 @@ class EscrowUtils {
      *
      * > This uses Subgraph
      *
-     * **Input parameters**
-     *
-     * ```ts
-     * enum ChainId {
-     *   ALL = -1,
-     *   MAINNET = 1,
-     *   SEPOLIA = 11155111,
-     *   BSC_MAINNET = 56,
-     *   BSC_TESTNET = 97,
-     *   POLYGON = 137,
-     *   POLYGON_AMOY = 80002,
-     *   LOCALHOST = 1338,
-     * }
-     * ```
-     *
-     * ```ts
-     * interface IEscrow {
-     *   id: string;
-     *   address: string;
-     *   amountPaid: bigint;
-     *   balance: bigint;
-     *   count: bigint;
-     *   factoryAddress: string;
-     *   finalResultsUrl: string | null;
-     *   finalResultsHash: string | null;
-     *   intermediateResultsUrl: string | null;
-     *   intermediateResultsHash: string | null;
-     *   launcher: string;
-     *   jobRequesterId: string | null;
-     *   manifestHash: string | null;
-     *   manifest: string | null;
-     *   recordingOracle: string | null;
-     *   reputationOracle: string | null;
-     *   exchangeOracle: string | null;
-     *   recordingOracleFee: number | null;
-     *   reputationOracleFee: number | null;
-     *   exchangeOracleFee: number | null;
-     *   status: string;
-     *   token: string;
-     *   totalFundedAmount: bigint;
-     *   createdAt: number;
-     *   chainId: number;
-     * };
-     * ```
-     *
-     *
-     * @param {ChainId} chainId Network in which the escrow has been deployed
-     * @param {string} escrowAddress Address of the escrow
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IEscrow | null>} - Escrow data or null if not found.
-     *
-     * **Code example**
+     * @param chainId - Network in which the escrow has been deployed
+     * @param escrowAddress - Address of the escrow
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Escrow data or null if not found.
+     * @throws ErrorUnsupportedChainID If the chain ID is not supported
+     * @throws ErrorInvalidAddress If the escrow address is invalid
      *
+     * @example
      * ```ts
-     * import { ChainId, EscrowUtils } from '@human-protocol/sdk';
+     * import { ChainId } from '@human-protocol/sdk';
      *
-     * const escrow = new EscrowUtils.getEscrow(ChainId.POLYGON_AMOY, "0x1234567890123456789012345678901234567890");
+     * const escrow = await EscrowUtils.getEscrow(
+     *   ChainId.POLYGON_AMOY,
+     *   "0x1234567890123456789012345678901234567890"
+     * );
+     * if (escrow) {
+     *   console.log('Escrow status:', escrow.status);
+     * }
      * ```
      */
     static async getEscrow(chainId, escrowAddress, options) {
@@ -1575,56 +1280,25 @@ class EscrowUtils {
      *
      * > This uses Subgraph
      *
-     * **Input parameters**
-     *
-     * ```ts
-     * enum ChainId {
-     *   ALL = -1,
-     *   MAINNET = 1,
-     *   SEPOLIA = 11155111,
-     *   BSC_MAINNET = 56,
-     *   BSC_TESTNET = 97,
-     *   POLYGON = 137,
-     *   POLYGON_AMOY = 80002,
-     *   LOCALHOST = 1338,
-     * }
-     * ```
-     *
-     * ```ts
-     * enum OrderDirection {
-     *   ASC = 'asc',
-     *   DESC = 'desc',
-     * }
-     * ```
+     * @param filter - Filter parameters.
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Array of status events with their corresponding statuses.
+     * @throws ErrorInvalidAddress If the launcher address is invalid
+     * @throws ErrorUnsupportedChainID If the chain ID is not supported
      *
+     * @example
      * ```ts
-     * type Status = {
-     *   escrowAddress: string;
-     *   timestamp: string;
-     *   status: string;
-     * };
-     * ```
-     *
-     * @param {IStatusEventFilter} filter Filter parameters.
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<StatusEvent[]>} - Array of status events with their corresponding statuses.
+     * import { ChainId, EscrowStatus } from '@human-protocol/sdk';
      *
-     * **Code example**
-     *
-     * ```ts
-     * import { ChainId, EscrowUtils, EscrowStatus } from '@human-protocol/sdk';
-     *
-     * (async () => {
-     *   const fromDate = new Date('2023-01-01');
-     *   const toDate = new Date('2023-12-31');
-     *   const statusEvents = await EscrowUtils.getStatusEvents({
-     *     chainId: ChainId.POLYGON,
-     *     statuses: [EscrowStatus.Pending, EscrowStatus.Complete],
-     *     from: fromDate,
-     *     to: toDate
-     *   });
-     *   console.log(statusEvents);
-     * })();
+     * const fromDate = new Date('2023-01-01');
+     * const toDate = new Date('2023-12-31');
+     * const statusEvents = await EscrowUtils.getStatusEvents({
+     *   chainId: ChainId.POLYGON,
+     *   statuses: [EscrowStatus.Pending, EscrowStatus.Complete],
+     *   from: fromDate,
+     *   to: toDate
+     * });
+     * console.log('Status events:', statusEvents.length);
      * ```
      */
     static async getStatusEvents(filter, options) {
@@ -1670,17 +1344,15 @@ class EscrowUtils {
      *
      * > This uses Subgraph
      *
-     * **Input parameters**
-     * Fetch payouts from the subgraph.
-     *
-     * @param {IPayoutFilter} filter Filter parameters.
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IPayout[]>} List of payouts matching the filters.
-     *
-     * **Code example**
+     * @param filter - Filter parameters.
+     * @param options - Optional configuration for subgraph requests.
+     * @returns List of payouts matching the filters.
+     * @throws ErrorUnsupportedChainID If the chain ID is not supported
+     * @throws ErrorInvalidAddress If any filter address is invalid
      *
+     * @example
      * ```ts
-     * import { ChainId, EscrowUtils } from '@human-protocol/sdk';
+     * import { ChainId } from '@human-protocol/sdk';
      *
      * const payouts = await EscrowUtils.getPayouts({
      *   chainId: ChainId.POLYGON,
@@ -1689,7 +1361,7 @@ class EscrowUtils {
      *   from: new Date('2023-01-01'),
      *   to: new Date('2023-12-31')
      * });
-     * console.log(payouts);
+     * console.log('Payouts:', payouts.length);
      * ```
      */
     static async getPayouts(filter, options) {
@@ -1731,48 +1403,22 @@ class EscrowUtils {
      *
      * > This uses Subgraph
      *
-     * **Input parameters**
-     *
-     * ```ts
-     * enum ChainId {
-     *  ALL = -1,
-     *  MAINNET = 1,
-     *  SEPOLIA = 11155111,
-     *  BSC_MAINNET = 56,
-     *  BSC_TESTNET = 97,
-     *  POLYGON = 137,
-     *  POLYGON_AMOY = 80002,
-     *  LOCALHOST = 1338,
-     * }
-     * ```
-     *
-     * ```ts
-     * interface ICancellationRefund {
-     *   id: string;
-     *   escrowAddress: string;
-     *   receiver: string;
-     *   amount: bigint;
-     *   block: number;
-     *   timestamp: number;
-     *   txHash: string;
-     * };
-     * ```
-     *
-     *
-     * @param {Object} filter Filter parameters.
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<ICancellationRefund[]>} List of cancellation refunds matching the filters.
-     *
-     * **Code example**
+     * @param filter - Filter parameters.
+     * @param options - Optional configuration for subgraph requests.
+     * @returns List of cancellation refunds matching the filters.
+     * @throws ErrorUnsupportedChainID If the chain ID is not supported
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
+     * @throws ErrorInvalidAddress If the receiver address is invalid
      *
+     * @example
      * ```ts
-     * import { ChainId, EscrowUtils } from '@human-protocol/sdk';
+     * import { ChainId } from '@human-protocol/sdk';
      *
      * const cancellationRefunds = await EscrowUtils.getCancellationRefunds({
      *    chainId: ChainId.POLYGON_AMOY,
      *    escrowAddress: '0x1234567890123456789012345678901234567890',
      * });
-     * console.log(cancellationRefunds);
+     * console.log('Cancellation refunds:', cancellationRefunds.length);
      * ```
      */
     static async getCancellationRefunds(filter, options) {
@@ -1815,45 +1461,25 @@ class EscrowUtils {
      *
      * > This uses Subgraph
      *
-     * **Input parameters**
-     *
-     * ```ts
-     * enum ChainId {
-     *  ALL = -1,
-     *  MAINNET = 1,
-     *  SEPOLIA = 11155111,
-     *  BSC_MAINNET = 56,
-     *  BSC_TESTNET = 97,
-     *  POLYGON = 137,
-     *  POLYGON_AMOY = 80002,
-     *  LOCALHOST = 1338,
-     * }
-     * ```
+     * @param chainId - Network in which the escrow has been deployed
+     * @param escrowAddress - Address of the escrow
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Cancellation refund data or null if not found.
+     * @throws ErrorUnsupportedChainID If the chain ID is not supported
+     * @throws ErrorInvalidEscrowAddressProvided If the escrow address is invalid
      *
+     * @example
      * ```ts
-     * interface ICancellationRefund {
-     *   id: string;
-     *   escrowAddress: string;
-     *   receiver: string;
-     *   amount: bigint;
-     *   block: number;
-     *   timestamp: number;
-     *   txHash: string;
-     * };
-     * ```
-     *
+     * import { ChainId } from '@human-protocol/sdk';
      *
-     * @param {ChainId} chainId Network in which the escrow has been deployed
-     * @param {string} escrowAddress Address of the escrow
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<ICancellationRefund>} Cancellation refund data
      *
-     * **Code example**
-     *
-     * ```ts
-     * import { ChainId, EscrowUtils } from '@human-protocol/sdk';
-     *
-     * const cancellationRefund = await EscrowUtils.getCancellationRefund(ChainId.POLYGON_AMOY, "0x1234567890123456789012345678901234567890");
+     * const cancellationRefund = await EscrowUtils.getCancellationRefund(
+     *   ChainId.POLYGON_AMOY,
+     *   "0x1234567890123456789012345678901234567890"
+     * );
+     * if (cancellationRefund) {
+     *   console.log('Refund amount:', cancellationRefund.amount);
+     * }
      * ```
      */
     static async getCancellationRefund(chainId, escrowAddress, options) {