@human-protocol/sdk 3.0.8 → 4.0.0

package/dist/error.js

@@ -1,23 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NumericFault = exports.ReplacementUnderpriced = exports.InvalidArgumentError = exports.EthereumError = exports.ErrorHashIsEmptyString = exports.ErrorLaunchedEventIsNotEmitted = exports.ErrorRecipientAndAmountsMustBeSameLength = exports.ErrorAmountsCannotBeEmptyArray = exports.ErrorEscrowDoesNotHaveEnoughBalance = exports.ErrorAmountMustBeGreaterThanZero = exports.ErrorRecipientCannotBeEmptyArray = exports.ErrorTotalFeeMustBeLessThanHundred = exports.ErrorFeeMustBeBetweenZeroAndHundred = exports.ErrorNoURLprovided = exports.ErrorListOfHandlersCannotBeEmpty = exports.ErrorUrlIsEmptyString = exports.ErrorInvalidUrl = exports.ErrorStorageClientDoesNotExist = exports.ErrorManifestFileDoesNotExist = exports.ErrorTransferEventNotFoundInTransactionLogs = exports.ErrorEscrowAddressIsNotProvidedByFactory = exports.ErrorSigner = exports.ErrorUnsupportedChainID = exports.ErrorProviderDoesNotExist = exports.ErrorHMTokenAmountNotApproved = exports.ErrorFailedToCheckAllowance = exports.ErrorFailedToApproveStakingAmountSignerDoesNotExist = exports.ErrorStakingGetStakers = exports.ErrorInvalidEscrowAddressProvided = exports.ErrorCannotUseDateAndBlockSimultaneously = exports.ErrorInvalidHahsProvided = exports.ErrorInvalidStakerAddressProvided = exports.ErrorInvalidSlasherAddressProvided = exports.ErrorInvalidStakingValueSign = exports.ErrorInvalidStakingValueType = exports.ErrorStakingValueMustBePositive = exports.ErrorInvalidExchangeOracleAddressProvided = exports.ErrorInvalidReputationOracleAddressProvided = exports.ErrorInvalidRecordingOracleAddressProvided = exports.ErrorInvalidTokenAddress = exports.ErrorInvalidAddress = exports.ErrorKVStoreArrayLength = exports.ErrorKVStoreEmptyKey = exports.ErrorStorageFileNotUploaded = exports.ErrorStorageFileNotFound = exports.ErrorStorageBucketNotFound = exports.ErrorStorageCredentialsMissing = exports.ErrorStorageClientNotExists = exports.ErrorStorageClientNotInitialized = exports.ErrorStakingMissing = void 0;
-exports.InvalidKeyError = exports.WarnSubgraphApiKeyNotProvided = exports.ErrorUnsupportedStatus = exports.ErrorInvalidHash = exports.InvalidEthereumAddressError = exports.ContractExecutionError = exports.TransactionReplaced = exports.NonceExpired = void 0;
+exports.EthereumError = exports.WarnSubgraphApiKeyNotProvided = exports.ErrorUnsupportedStatus = exports.ErrorInvalidHash = exports.ErrorHashIsEmptyString = exports.ErrorLaunchedEventIsNotEmitted = exports.ErrorRecipientAndAmountsMustBeSameLength = exports.ErrorAmountsCannotBeEmptyArray = exports.ErrorEscrowDoesNotHaveEnoughBalance = exports.ErrorAmountMustBeGreaterThanZero = exports.ErrorTooManyRecipients = exports.ErrorRecipientCannotBeEmptyArray = exports.ErrorTotalFeeMustBeLessThanHundred = exports.ErrorFeeMustBeBetweenZeroAndHundred = exports.ErrorNoURLprovided = exports.ErrorListOfHandlersCannotBeEmpty = exports.ErrorUrlIsEmptyString = exports.ErrorInvalidUrl = exports.ErrorManifestFileDoesNotExist = exports.ErrorTransferEventNotFoundInTransactionLogs = exports.ErrorEscrowAddressIsNotProvidedByFactory = exports.ErrorSigner = exports.ErrorUnsupportedChainID = exports.ErrorProviderDoesNotExist = exports.ErrorHMTokenAmountNotApproved = exports.ErrorFailedToCheckAllowance = exports.ErrorFailedToApproveStakingAmountSignerDoesNotExist = exports.ErrorStakingGetStakers = exports.ErrorInvalidEscrowAddressProvided = exports.ErrorCannotUseDateAndBlockSimultaneously = exports.ErrorInvalidHashProvided = exports.ErrorInvalidStakerAddressProvided = exports.ErrorInvalidSlasherAddressProvided = exports.ErrorInvalidStakingValueSign = exports.ErrorInvalidStakingValueType = exports.ErrorStakingValueMustBePositive = exports.ErrorInvalidExchangeOracleAddressProvided = exports.ErrorInvalidReputationOracleAddressProvided = exports.ErrorInvalidRecordingOracleAddressProvided = exports.ErrorInvalidTokenAddress = exports.ErrorInvalidAddress = exports.ErrorKVStoreArrayLength = exports.ErrorKVStoreEmptyKey = exports.ErrorStorageFileNotUploaded = exports.ErrorStorageFileNotFound = exports.ErrorStorageBucketNotFound = exports.ErrorStorageCredentialsMissing = exports.ErrorStorageClientNotExists = exports.ErrorStorageClientNotInitialized = exports.ErrorStakingMissing = void 0;
+exports.InvalidKeyError = exports.InvalidEthereumAddressError = exports.ContractExecutionError = exports.TransactionReplaced = exports.NonceExpired = exports.NumericFault = exports.ReplacementUnderpriced = exports.InvalidArgumentError = void 0;
 /**
  * @constant {Error} - The Staking contract is missing.
  */
 exports.ErrorStakingMissing = new Error('Staking contract is missing');
 /**
- * @constant {Error} - The Storage client not initialised.
+ * @constant {Error} - The Storage client not initialized.
  */
 exports.ErrorStorageClientNotInitialized = new Error('Storage client not initialized');
 /**
- * @constant {Error} - The Storage does not exists.
+ * @constant {Error} - The Storage client does not exist.
  */
-exports.ErrorStorageClientNotExists = new Error('Storage client does not exists');
+exports.ErrorStorageClientNotExists = new Error('Storage client does not exist');
 /**
- * @constant {Error} - The Storage credentials is missing.
+ * @constant {Error} - The Storage credentials are missing.
  */
-exports.ErrorStorageCredentialsMissing = new Error('Storage credentials is missing');
+exports.ErrorStorageCredentialsMissing = new Error('Storage credentials are missing');
 /**
  * @constant {Error} - The Storage bucket not found.
  */
@@ -31,19 +31,19 @@ exports.ErrorStorageFileNotFound = new Error('File not found');
  */
 exports.ErrorStorageFileNotUploaded = new Error('File not uploaded');
 /**
- * @constant {Error} - The KVStore key can not be empty.
+ * @constant {Error} - The KVStore key cannot be empty.
  */
-exports.ErrorKVStoreEmptyKey = new Error('Key can not be empty');
+exports.ErrorKVStoreEmptyKey = new Error('Key cannot be empty');
 /**
  * @constant {Error} - The KVStore arrays must have the same length.
  */
 exports.ErrorKVStoreArrayLength = new Error('Arrays must have the same length');
 /**
- * @constant {Error} - The Address sent is invalid.
+ * @constant {Error} - The address provided is invalid.
  */
 exports.ErrorInvalidAddress = new Error('Invalid address');
 /**
- * @constant {Error} - The token address sent is invalid.
+ * @constant {Error} - The token address provided is invalid.
  */
 exports.ErrorInvalidTokenAddress = new Error('Invalid token address');
 /**
@@ -55,11 +55,11 @@ exports.ErrorInvalidRecordingOracleAddressProvided = new Error('Invalid recordin
  */
 exports.ErrorInvalidReputationOracleAddressProvided = new Error('Invalid reputation oracle address provided');
 /**
- * @constant {Error} - Invalid reputation oracle address provided.
+ * @constant {Error} - Invalid exchange oracle address provided.
  */
 exports.ErrorInvalidExchangeOracleAddressProvided = new Error('Invalid exchange oracle address provided');
 /**
- * @constant {Error} - The Staking value must be positive.
+ * @constant {Error} - The staking value must be positive.
  */
 exports.ErrorStakingValueMustBePositive = new Error('Value must be positive');
 /**
@@ -81,7 +81,7 @@ exports.ErrorInvalidStakerAddressProvided = new Error('Invalid staker address pr
 /**
  * @constant {Error} - Invalid hash provided.
  */
-exports.ErrorInvalidHahsProvided = new Error('Invalid hash provided');
+exports.ErrorInvalidHashProvided = new Error('Invalid hash provided');
 /**
  * @constant {Error} - Cannot use both date and block filters simultaneously.
  */
@@ -98,17 +98,20 @@ exports.ErrorStakingGetStakers = new Error('Error getting stakers data');
  * @constant {Error} - Failed to approve staking amount: signerOrProvider is not a Signer instance.
  */
 exports.ErrorFailedToApproveStakingAmountSignerDoesNotExist = new Error('Failed to approve staking amount: signerOrProvider is not a Signer instance');
+/**
+ * @constant {Error} - Failed to check allowance.
+ */
 exports.ErrorFailedToCheckAllowance = new Error('Failed to check allowance');
 /**
  * @constant {Error} - The HMToken amount not approved.
  */
 exports.ErrorHMTokenAmountNotApproved = new Error('Amount not approved');
 /**
- * @constant {Error} - Init provider does not exists.
+ * @constant {Error} - Provider does not exist.
  */
 exports.ErrorProviderDoesNotExist = new Error('Provider does not exist');
 /**
- * @constant {Error} - Init with unsupported chain ID.
+ * @constant {Error} - Unsupported chain ID.
  */
 exports.ErrorUnsupportedChainID = new Error('Unsupported chain ID');
 /**
@@ -127,10 +130,6 @@ exports.ErrorTransferEventNotFoundInTransactionLogs = new Error('Transfer event
  * @constant {Error} - Manifest file does not exist.
  */
 exports.ErrorManifestFileDoesNotExist = new Error('Manifest file does not exist');
-/**
- * @constant {Error} - Storage client does not exist.
- */
-exports.ErrorStorageClientDoesNotExist = new Error('Storage client does not exist');
 /**
  * @constant {Error} - Invalid URL string.
  */
@@ -160,7 +159,11 @@ exports.ErrorTotalFeeMustBeLessThanHundred = new Error('Total fee must be less t
  */
 exports.ErrorRecipientCannotBeEmptyArray = new Error('Recipient cannot be an empty array');
 /**
- * @constant {Error} - Amount must be greater than zero..
+ * @constant {Error} - Too many recipients.
+ */
+exports.ErrorTooManyRecipients = new Error('Too many recipients');
+/**
+ * @constant {Error} - Amount must be greater than zero.
  */
 exports.ErrorAmountMustBeGreaterThanZero = new Error('Amount must be greater than zero');
 /**
@@ -183,6 +186,18 @@ exports.ErrorLaunchedEventIsNotEmitted = new Error('Launched event is not emitte
  * @constant {Error} - Hash is an empty string.
  */
 exports.ErrorHashIsEmptyString = new Error('Hash is an empty string');
+/**
+ * @constant {Error} - The hash does not match.
+ */
+exports.ErrorInvalidHash = new Error('Invalid hash');
+/**
+ * @constant {Error} - The status is not supported.
+ */
+exports.ErrorUnsupportedStatus = new Error('Unsupported status for query');
+/**
+ * @constant {Warning} - The SUBGRAPH_API_KEY is not being provided.
+ */
+exports.WarnSubgraphApiKeyNotProvided = '"SUBGRAPH_API_KEY" is not being provided. It might cause issues with the subgraph.';
 class EthereumError extends Error {
     constructor(message) {
         super(`An error occurred while interacting with Ethereum: ${message}`);
@@ -231,18 +246,6 @@ class InvalidEthereumAddressError extends Error {
     }
 }
 exports.InvalidEthereumAddressError = InvalidEthereumAddressError;
-/**
- * @constant {Error} - The Hash does not match
- */
-exports.ErrorInvalidHash = new Error('Invalid hash');
-/**
- * @constant {Error} - The Status is not supported
- */
-exports.ErrorUnsupportedStatus = new Error('Unsupported status for query');
-/**
- * @constant {Error} - The SUBGRAPH_API_KEY is not being provided
- */
-exports.WarnSubgraphApiKeyNotProvided = '"SUBGRAPH_API_KEY" is not being provided. It might cause issues with the subgraph.';
 class InvalidKeyError extends Error {
     constructor(key, address) {
         super(`Key "${key}" not found for address ${address}`);

package/dist/escrow.d.ts

@@ -3,23 +3,23 @@ import { BaseEthersClient } from './base';
 import { ChainId, OrderDirection } from './enums';
 import { EscrowData, StatusEvent } from './graphql';
 import { IEscrowConfig, IEscrowsFilter } from './interfaces';
-import { EscrowCancel, EscrowStatus, EscrowWithdraw, NetworkData } from './types';
+import { EscrowCancel, EscrowStatus, EscrowWithdraw, NetworkData, TransactionLikeWithNonce } from './types';
 /**
  * ## Introduction
  *
- * This client enables to perform actions on Escrow contracts and obtain information from both the contracts and subgraph.
+ * This client enables performing actions on Escrow contracts and obtaining 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<EscrowClient>;
  * ```
  *
  * 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
  *
@@ -37,21 +37,21 @@ import { EscrowCancel, EscrowStatus, EscrowWithdraw, NetworkData } from './types
  *
  * ### Signer
  *
- * **Using private key(backend)**
+ * **Using private key (backend)**
  *
  * ```ts
  * import { EscrowClient } 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 escrowClient = await EscrowClient.build(signer);
  * ```
  *
- * **Using Wagmi(frontend)**
+ * **Using Wagmi (frontend)**
  *
  * ```ts
  * import { useSigner, useChainId } from 'wagmi';
@@ -101,11 +101,11 @@ export declare class EscrowClient extends BaseEthersClient {
     /**
      * This function creates an escrow contract that uses the token passed to pay oracle fees and reward workers.
      *
-     * @param {string} tokenAddress Token address to use for pay outs.
+     * @param {string} tokenAddress Token address to use for payouts.
      * @param {string[]} trustedHandlers Array of addresses that can perform actions on the contract.
      * @param {string} jobRequesterId Job Requester Id
      * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
-     * @returns {Promise<string>} Return the address of the escrow created.
+     * @returns {Promise<string>} Returns the address of the escrow created.
      *
      *
      * **Code example**
@@ -117,7 +117,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * import { EscrowClient } 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);
@@ -148,7 +148,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * import { EscrowClient } 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);
@@ -159,10 +159,10 @@ export declare class EscrowClient extends BaseEthersClient {
      *    recordingOracle: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
      *    reputationOracle: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
      *    exchangeOracle: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
-     *    recordingOracleFee: bigint.from('10'),
-     *    reputationOracleFee: bigint.from('10'),
-     *    exchangeOracleFee: bigint.from('10'),
-     *    manifestUrl: 'htttp://localhost/manifest.json',
+     *    recordingOracleFee: BigInt('10'),
+     *    reputationOracleFee: BigInt('10'),
+     *    exchangeOracleFee: BigInt('10'),
+     *    manifestUrl: 'http://localhost/manifest.json',
      *    manifestHash: 'b5dad76bf6772c0f07fd5e048f6e75a5f86ee079',
      * };
      * await escrowClient.setup(escrowAddress, escrowConfig);
@@ -185,7 +185,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * import { EscrowClient } 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);
@@ -197,10 +197,10 @@ export declare class EscrowClient extends BaseEthersClient {
      */
     fund(escrowAddress: string, amount: bigint, txOptions?: Overrides): Promise<void>;
     /**
-     * This function stores the results url and hash.
+     * This function stores the results URL and hash.
      *
      * @param {string} escrowAddress Address of the escrow.
-     * @param {string} url Results file url.
+     * @param {string} url Results file URL.
      * @param {string} hash Results file hash.
      * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
      * @returns Returns void if successful. Throws error if any.
@@ -215,13 +215,13 @@ export declare class EscrowClient extends BaseEthersClient {
      * import { EscrowClient } 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);
      * const escrowClient = await EscrowClient.build(signer);
      *
-     * await storeResults.storeResults('0x62dD51230A30401C455c8398d06F85e4EaB6309f', 'http://localhost/results.json', 'b5dad76bf6772c0f07fd5e048f6e75a5f86ee079');
+     * await escrowClient.storeResults('0x62dD51230A30401C455c8398d06F85e4EaB6309f', 'http://localhost/results.json', 'b5dad76bf6772c0f07fd5e048f6e75a5f86ee079');
      * ```
      */
     storeResults(escrowAddress: string, url: string, hash: string, txOptions?: Overrides): Promise<void>;
@@ -242,7 +242,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * import { EscrowClient } 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);
@@ -258,9 +258,10 @@ export declare class EscrowClient extends BaseEthersClient {
      * @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} finalResultsUrl Final results file URL.
      * @param {string} finalResultsHash Final results file hash.
-     * @param {string} forceComplete Indicates if remaining balance should be transferred to the escrow creator (optional, defaults to false).
+     * @param {number} txId Transaction ID.
+     * @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 void if successful. Throws error if any.
      *
@@ -274,7 +275,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * import { EscrowClient } 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);
@@ -283,12 +284,13 @@ export declare class EscrowClient extends BaseEthersClient {
      * const recipients = ['0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'];
      * const amounts = [ethers.parseUnits(5, 'ether'), ethers.parseUnits(10, 'ether')];
      * const resultsUrl = 'http://localhost/results.json';
-     * const resultsHash'b5dad76bf6772c0f07fd5e048f6e75a5f86ee079';
+     * const resultsHash = 'b5dad76bf6772c0f07fd5e048f6e75a5f86ee079';
+     * const txId = 1;
      *
-     * await escrowClient.bulkPayOut('0x62dD51230A30401C455c8398d06F85e4EaB6309f', recipients, amounts, resultsUrl, resultsHash);
+     * await escrowClient.bulkPayOut('0x62dD51230A30401C455c8398d06F85e4EaB6309f', recipients, amounts, resultsUrl, resultsHash, txId);
      * ```
      */
-    bulkPayOut(escrowAddress: string, recipients: string[], amounts: bigint[], finalResultsUrl: string, finalResultsHash: string, forceComplete?: boolean, txOptions?: Overrides): Promise<void>;
+    bulkPayOut(escrowAddress: string, recipients: string[], amounts: bigint[], finalResultsUrl: string, finalResultsHash: string, txId: number, forceComplete?: boolean, txOptions?: Overrides): Promise<void>;
     /**
      * This function cancels the specified escrow and sends the balance to the canceler.
      *
@@ -306,7 +308,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * import { EscrowClient } 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);
@@ -334,13 +336,13 @@ export declare class EscrowClient extends BaseEthersClient {
      * import { EscrowClient } 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);
      * const escrowClient = await EscrowClient.build(signer);
      *
-     * const trustedHandlers = ['0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266']
+     * const trustedHandlers = ['0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'];
      * await escrowClient.addTrustedHandlers('0x62dD51230A30401C455c8398d06F85e4EaB6309f', trustedHandlers);
      * ```
      */
@@ -363,7 +365,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * import { EscrowClient } 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);
@@ -376,11 +378,53 @@ export declare class EscrowClient extends BaseEthersClient {
      * ```
      */
     withdraw(escrowAddress: string, tokenAddress: string, txOptions?: Overrides): Promise<EscrowWithdraw>;
+    /**
+     * 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 {number} txId Transaction ID.
+     * @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**
+     *
+     * > Only Reputation Oracle or a trusted handler can call it.
+     *
+     * ```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);
+     *
+     * const recipients = ['0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'];
+     * const amounts = [ethers.parseUnits(5, 'ether'), ethers.parseUnits(10, 'ether')];
+     * const resultsUrl = 'http://localhost/results.json';
+     * const resultsHash = 'b5dad76bf6772c0f07fd5e048f6e75a5f86ee079';
+     * const txId = 1;
+     *
+     * const rawTransaction = await escrowClient.createBulkPayoutTransaction('0x62dD51230A30401C455c8398d06F85e4EaB6309f', recipients, amounts, resultsUrl, resultsHash, txId);
+     * console.log('Raw transaction:', rawTransaction);
+     *
+     * const signedTransaction = await signer.signTransaction(rawTransaction);
+     * console.log('Tx hash:', ethers.keccak256(signedTransaction));
+     * (await signer.sendTransaction(rawTransaction)).wait();
+     */
+    createBulkPayoutTransaction(escrowAddress: string, recipients: string[], amounts: bigint[], finalResultsUrl: string, finalResultsHash: string, txId: number, forceComplete?: boolean, txOptions?: Overrides): Promise<TransactionLikeWithNonce>;
+    private ensureCorrectBulkPayoutInput;
     /**
      * This function returns the balance for a specified escrow address.
      *
      * @param {string} escrowAddress Address of the escrow.
-     * @returns {bigint} Balance of the escrow in the token used to fund it.
+     * @returns {Promise<bigint>} Balance of the escrow in the token used to fund it.
      *
      * **Code example**
      *
@@ -391,7 +435,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * const rpcUrl = 'YOUR_RPC_URL';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(signer);
+     * const escrowClient = await EscrowClient.build(provider);
      *
      * const balance = await escrowClient.getBalance('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
      * ```
@@ -401,7 +445,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * This function returns the manifest file hash.
      *
      * @param {string} escrowAddress Address of the escrow.
-     * @returns {string} Hash of the manifest file content.
+     * @returns {Promise<string>} Hash of the manifest file content.
      *
      * **Code example**
      *
@@ -412,7 +456,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * const rpcUrl = 'YOUR_RPC_URL';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(signer);
+     * const escrowClient = await EscrowClient.build(provider);
      *
      * const manifestHash = await escrowClient.getManifestHash('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
      * ```
@@ -422,7 +466,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * This function returns the manifest file URL.
      *
      * @param {string} escrowAddress Address of the escrow.
-     * @returns {string} Url of the manifest.
+     * @returns {Promise<string>} Url of the manifest.
      *
      * **Code example**
      *
@@ -433,7 +477,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * const rpcUrl = 'YOUR_RPC_URL';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(signer);
+     * const escrowClient = await EscrowClient.build(provider);
      *
      * const manifestUrl = await escrowClient.getManifestUrl('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
      * ```
@@ -443,7 +487,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * This function returns the results file URL.
      *
      * @param {string} escrowAddress Address of the escrow.
-     * @returns {string} Results file url.
+     * @returns {Promise<string>} Results file url.
      *
      * **Code example**
      *
@@ -454,7 +498,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * const rpcUrl = 'YOUR_RPC_URL';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(signer);
+     * const escrowClient = await EscrowClient.build(provider);
      *
      * const resultsUrl = await escrowClient.getResultsUrl('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
      * ```
@@ -464,7 +508,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * This function returns the intermediate results file URL.
      *
      * @param {string} escrowAddress Address of the escrow.
-     * @returns {string} Url of the file that store results from Recording Oracle.
+     * @returns {Promise<string>} Url of the file that store results from Recording Oracle.
      *
      * **Code example**
      *
@@ -475,9 +519,9 @@ export declare class EscrowClient extends BaseEthersClient {
      * const rpcUrl = 'YOUR_RPC_URL';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(signer);
+     * const escrowClient = await EscrowClient.build(provider);
      *
-     * const intemediateResultsUrl = await escrowClient.getIntermediateResultsUrl('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * const intermediateResultsUrl = await escrowClient.getIntermediateResultsUrl('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
      * ```
      */
     getIntermediateResultsUrl(escrowAddress: string): Promise<string>;
@@ -485,7 +529,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * This function returns the token address used for funding the escrow.
      *
      * @param {string} escrowAddress Address of the escrow.
-     * @returns {string} Address of the token used to fund the escrow.
+     * @returns {Promise<string>} Address of the token used to fund the escrow.
      *
      * **Code example**
      *
@@ -496,7 +540,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * const rpcUrl = 'YOUR_RPC_URL';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(signer);
+     * const escrowClient = await EscrowClient.build(provider);
      *
      * const tokenAddress = await escrowClient.getTokenAddress('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
      * ```
@@ -506,7 +550,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * This function returns the current status of the escrow.
      *
      * @param {string} escrowAddress Address of the escrow.
-     * @returns {EscrowStatus} Current status of the escrow.
+     * @returns {Promise<EscrowStatus>} Current status of the escrow.
      *
      * **Code example**
      *
@@ -517,7 +561,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * const rpcUrl = 'YOUR_RPC_URL';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(signer);
+     * const escrowClient = await EscrowClient.build(provider);
      *
      * const status = await escrowClient.getStatus('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
      * ```
@@ -527,7 +571,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * This function returns the recording oracle address for a given escrow.
      *
      * @param {string} escrowAddress Address of the escrow.
-     * @returns {string} Address of the Recording Oracle.
+     * @returns {Promise<string>} Address of the Recording Oracle.
      *
      * **Code example**
      *
@@ -538,7 +582,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * const rpcUrl = 'YOUR_RPC_URL';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(signer);
+     * const escrowClient = await EscrowClient.build(provider);
      *
      * const oracleAddress = await escrowClient.getRecordingOracleAddress('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
      * ```
@@ -548,7 +592,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * This function returns the job launcher address for a given escrow.
      *
      * @param {string} escrowAddress Address of the escrow.
-     * @returns {string} Address of the Job Launcher.
+     * @returns {Promise<string>} Address of the Job Launcher.
      *
      * **Code example**
      *
@@ -559,7 +603,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * const rpcUrl = 'YOUR_RPC_URL';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(signer);
+     * const escrowClient = await EscrowClient.build(provider);
      *
      * const jobLauncherAddress = await escrowClient.getJobLauncherAddress('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
      * ```
@@ -569,7 +613,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * This function returns the reputation oracle address for a given escrow.
      *
      * @param {string} escrowAddress Address of the escrow.
-     * @returns {EscrowStatus} Address of the Reputation Oracle.
+     * @returns {Promise<string>} Address of the Reputation Oracle.
      *
      * **Code example**
      *
@@ -580,7 +624,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * const rpcUrl = 'YOUR_RPC_URL';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(signer);
+     * const escrowClient = await EscrowClient.build(provider);
      *
      * const oracleAddress = await escrowClient.getReputationOracleAddress('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
      * ```
@@ -590,7 +634,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * This function returns the exchange oracle address for a given escrow.
      *
      * @param {string} escrowAddress Address of the escrow.
-     * @returns {EscrowStatus} Address of the Exchange Oracle.
+     * @returns {Promise<string>} Address of the Exchange Oracle.
      *
      * **Code example**
      *
@@ -601,7 +645,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * const rpcUrl = 'YOUR_RPC_URL';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(signer);
+     * const escrowClient = await EscrowClient.build(provider);
      *
      * const oracleAddress = await escrowClient.getExchangeOracleAddress('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
      * ```
@@ -611,7 +655,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * This function returns the escrow factory address for a given escrow.
      *
      * @param {string} escrowAddress Address of the escrow.
-     * @returns {EscrowStatus} Address of the escrow factory.
+     * @returns {Promise<string>} Address of the escrow factory.
      *
      * **Code example**
      *
@@ -622,7 +666,7 @@ export declare class EscrowClient extends BaseEthersClient {
      * const rpcUrl = 'YOUR_RPC_URL';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
-     * const escrowClient = await EscrowClient.build(signer);
+     * const escrowClient = await EscrowClient.build(provider);
      *
      * const factoryAddress = await escrowClient.getFactoryAddress('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
      * ```
@@ -656,7 +700,7 @@ export declare class EscrowClient extends BaseEthersClient {
  * import { ChainId, EscrowUtils } from '@human-protocol/sdk';
  *
  * const escrowAddresses = new EscrowUtils.getEscrows({
- *   network: ChainId.POLYGON_AMOY
+ *   chainId: ChainId.POLYGON_AMOY
  * });
  * ```
  */
@@ -701,7 +745,6 @@ export declare class EscrowUtils {
      *   AVALANCHE_TESTNET = 43113,
      *   CELO = 42220,
      *   CELO_ALFAJORES = 44787,
-     *    = 1273227453,
      *   LOCALHOST = 1338,
      * }
      * ```