EscrowClient

@human-protocol/sdk

---

@human-protocol/sdk / escrow / EscrowClient

Class: EscrowClient

Defined in: escrow.ts:148

Introduction

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.

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 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

npm install @human-protocol/sdk

yarn

yarn install @human-protocol/sdk

Code example

Signer

Using private key (backend)

import { EscrowClient } from '@human-protocol/sdk';
import { Wallet, providers } 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);

Using Wagmi (frontend)

import { useSigner, useChainId } from 'wagmi';
import { EscrowClient } from '@human-protocol/sdk';

const { data: signer } = useSigner();
const escrowClient = await EscrowClient.build(signer);

Provider

import { EscrowClient } from '@human-protocol/sdk';
import { providers } from 'ethers';

const rpcUrl = 'YOUR_RPC_URL';

const provider = new providers.JsonRpcProvider(rpcUrl);
const escrowClient = await EscrowClient.build(provider);

Extends

• BaseEthersClient

Constructors

Constructor

new EscrowClient(runner, networkData): EscrowClient

Defined in: escrow.ts:157

EscrowClient constructor

Parameters

runner

ContractRunner

The Runner object to interact with the Ethereum network

networkData

NetworkData

The network information required to connect to the Escrow contract

Returns

EscrowClient

Overrides

BaseEthersClient.constructor

Properties

networkData

networkData: NetworkData

Defined in: base.ts:12

Inherited from

BaseEthersClient.networkData

---

runner

protected runner: ContractRunner

Defined in: base.ts:11

Inherited from

BaseEthersClient.runner

Methods

bulkPayOut()

Call Signature

bulkPayOut(escrowAddress, recipients, amounts, finalResultsUrl, finalResultsHash, txId, forceComplete, txOptions?): Promise<void>

Defined in: escrow.ts:802

This function pays out the amounts specified to the workers and sets the URL of the final results file.

Parameters

escrowAddress

string

Escrow address to payout.

recipients

string[]

Array of recipient addresses.

amounts

bigint[]

Array of amounts the recipients will receive.

finalResultsUrl

string

Final results file URL.

finalResultsHash

string

Final results file hash.

txId

number

Transaction ID.

forceComplete

boolean

Indicates if remaining balance should be transferred to the escrow creator (optional, defaults to false).

txOptions?

Overrides

Additional transaction parameters (optional, defaults to an empty object).

Returns

Promise<void>

Returns void if successful. Throws error if any.

Code example

Only Reputation Oracle or admin can call it.

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;

await escrowClient.bulkPayOut('0x62dD51230A30401C455c8398d06F85e4EaB6309f', recipients, amounts, resultsUrl, resultsHash, txId, true);

Call Signature

bulkPayOut(escrowAddress, recipients, amounts, finalResultsUrl, finalResultsHash, payoutId, forceComplete, txOptions?): Promise<void>

Defined in: escrow.ts:852

This function pays out the amounts specified to the workers and sets the URL of the final results file.

Parameters

escrowAddress

string

Escrow address to payout.

recipients

string[]

Array of recipient addresses.

amounts

bigint[]

Array of amounts the recipients will receive.

finalResultsUrl

string

Final results file URL.

finalResultsHash

string

Final results file hash.

payoutId

string

Payout ID.

forceComplete

boolean

Indicates if remaining balance should be transferred to the escrow creator (optional, defaults to false).

txOptions?

Overrides

Additional transaction parameters (optional, defaults to an empty object).

Returns

Promise<void>

Returns void if successful. Throws error if any.

Code example

Only Reputation Oracle or admin can call it.

import { ethers, Wallet, providers } from 'ethers';
import { EscrowClient } from '@human-protocol/sdk';
import { v4 as uuidV4 } from 'uuid';

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 payoutId = uuidV4();

await escrowClient.bulkPayOut('0x62dD51230A30401C455c8398d06F85e4EaB6309f', recipients, amounts, resultsUrl, resultsHash, payoutId, true);

---

cancel()

cancel(escrowAddress, txOptions?): Promise<void>

Defined in: escrow.ts:951

This function cancels the specified escrow and sends the balance to the canceler.

Parameters

escrowAddress

string

Address of the escrow to cancel.

txOptions?

Overrides = {}

Additional transaction parameters (optional, defaults to an empty object).

Code example

Only Job Launcher or admin can call it.

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');

Returns

Promise<void>

---

complete()

complete(escrowAddress, txOptions?): Promise<void>

Defined in: escrow.ts:742

This function sets the status of an escrow to completed.

Parameters

escrowAddress

string

Address of the escrow.

txOptions?

Overrides = {}

Additional transaction parameters (optional, defaults to an empty object).

Returns

Promise<void>

Returns void if successful. Throws error if any.

Code example

Only Recording Oracle or admin can call it.

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');

---

createBulkPayoutTransaction()

createBulkPayoutTransaction(escrowAddress, recipients, amounts, finalResultsUrl, finalResultsHash, payoutId, forceComplete, txOptions?): Promise<TransactionLikeWithNonce>

Defined in: escrow.ts:1149

Creates a prepared transaction for bulk payout without immediately sending it.

Parameters

escrowAddress

string

Escrow address to payout.

recipients

string[]

Array of recipient addresses.

amounts

bigint[]

Array of amounts the recipients will receive.

finalResultsUrl

string

Final results file URL.

finalResultsHash

string

Final results file hash.

payoutId

string

Payout ID to identify the payout.

forceComplete

boolean = false

Indicates if remaining balance should be transferred to the escrow creator (optional, defaults to false).

txOptions?

Overrides = {}

Additional transaction parameters (optional, defaults to an empty object).

Returns

Promise<TransactionLikeWithNonce>

Returns object with raw transaction and signed transaction hash

Code example

Only Reputation Oracle or admin can call it.

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 payoutId = '372f6916-fe34-4711-b6e3-274f682047de';

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();

***

### createEscrow()

> **createEscrow**(`tokenAddress`, `jobRequesterId`, `txOptions?`): `Promise`\<`string`\>

Defined in: [escrow.ts:235](https://github.com/humanprotocol/human-protocol/blob/61aec7f941934ccbea233e5338eb9fedacd0b20e/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L235)

This function creates an escrow contract that uses the token passed to pay oracle fees and reward workers.

#### Parameters

##### tokenAddress

`string`

The address of the token to use for escrow funding.

##### jobRequesterId

`string`

Identifier for the job requester.

##### txOptions?

`Overrides` = `{}`

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.

```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);

---

createFundAndSetupEscrow()

createFundAndSetupEscrow(tokenAddress, amount, jobRequesterId, escrowConfig, txOptions?): Promise<string>

Defined in: escrow.ts:372

Creates, funds, and sets up a new escrow contract in a single transaction.

Parameters

tokenAddress

string

The ERC-20 token address used to fund the escrow.

amount

bigint

The token amount to fund the escrow with.

jobRequesterId

string

An off-chain identifier for the job requester.

escrowConfig

IEscrowConfig

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.

txOptions?

Overrides = {}

Additional transaction parameters (optional, defaults to an empty object).

Returns

Promise<string>

Returns the address of the escrow created.

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);

const tokenAddress = '0xTokenAddress';
const amount = ethers.parseUnits('1000', 18);
const jobRequesterId = 'requester-123';

const token = IERC20__factory.connect(tokenAddress, signer);
await token.approve(escrowClient.escrowFactoryContract.target, amount);

const escrowConfig = {
  recordingOracle: '0xRecordingOracle',
  reputationOracle: '0xReputationOracle',
  exchangeOracle: '0xExchangeOracle',
  recordingOracleFee: 5n,
  reputationOracleFee: 5n,
  exchangeOracleFee: 5n,
  manifest: 'https://example.com/manifest.json',
  manifestHash: 'manifestHash-123',
} satisfies IEscrowConfig;

const escrowAddress = await escrowClient.createFundAndSetupEscrow(
  tokenAddress,
  amount,
  jobRequesterId,
  escrowConfig
);

console.log('Escrow created at:', escrowAddress);

---

fund()

fund(escrowAddress, amount, txOptions?): Promise<void>

Defined in: escrow.ts:545

This function adds funds of the chosen token to the escrow.

Parameters

escrowAddress

string

Address of the escrow to fund.

amount

bigint

Amount to be added as funds.

txOptions?

Overrides = {}

Additional transaction parameters (optional, defaults to an empty object).

Returns

Promise<void>

Returns void if successful. Throws error if any.

Code example

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 amount = ethers.parseUnits(5, 'ether'); //convert from ETH to WEI
await escrowClient.fund('0x62dD51230A30401C455c8398d06F85e4EaB6309f', amount);

---

getBalance()

getBalance(escrowAddress): Promise<bigint>

Defined in: escrow.ts:1294

This function returns the balance for a specified escrow address.

Parameters

escrowAddress

string

Address of the escrow.

Returns

Promise<bigint>

Balance of the escrow in the token used to fund it.

Code example

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');

---

getExchangeOracleAddress()

getExchangeOracleAddress(escrowAddress): Promise<string>

Defined in: escrow.ts:1755

This function returns the exchange oracle address for a given escrow.

Parameters

escrowAddress

string

Address of the escrow.

Returns

Promise<string>

Address of the Exchange Oracle.

Code example

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');

---

getFactoryAddress()

getFactoryAddress(escrowAddress): Promise<string>

Defined in: escrow.ts:1793

This function returns the escrow factory address for a given escrow.

Parameters

escrowAddress

string

Address of the escrow.

Returns

Promise<string>

Address of the escrow factory.

Code example

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');

---

getIntermediateResultsHash()

getIntermediateResultsHash(escrowAddress): Promise<string>

Defined in: escrow.ts:1527

This function returns the intermediate results hash.

Parameters

escrowAddress

string

Address of the escrow.

Returns

Promise<string>

Hash of the intermediate results file content.

Code example

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');

---

getIntermediateResultsUrl()

getIntermediateResultsUrl(escrowAddress): Promise<string>

Defined in: escrow.ts:1489

This function returns the intermediate results file URL.

Parameters

escrowAddress

string

Address of the escrow.

Returns

Promise<string>

Url of the file that store results from Recording Oracle.

Code example

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');

---

getJobLauncherAddress()

getJobLauncherAddress(escrowAddress): Promise<string>

Defined in: escrow.ts:1679

This function returns the job launcher address for a given escrow.

Parameters

escrowAddress

string

Address of the escrow.

Returns

Promise<string>

Address of the Job Launcher.

Code example

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');

---

getManifest()

getManifest(escrowAddress): Promise<string>

Defined in: escrow.ts:1413

This function returns the manifest. Could be a URL or a JSON string.

Parameters

escrowAddress

string

Address of the escrow.

Returns

Promise<string>

Url of the manifest.

Code example

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');

---

getManifestHash()

getManifestHash(escrowAddress): Promise<string>

Defined in: escrow.ts:1375

This function returns the manifest file hash.

Parameters

escrowAddress

string

Address of the escrow.

Returns

Promise<string>

Hash of the manifest file content.

Code example

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');

---

getRecordingOracleAddress()

getRecordingOracleAddress(escrowAddress): Promise<string>

Defined in: escrow.ts:1641

This function returns the recording oracle address for a given escrow.

Parameters

escrowAddress

string

Address of the escrow.

Returns

Promise<string>

Address of the Recording Oracle.

Code example

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');

---

getReputationOracleAddress()

getReputationOracleAddress(escrowAddress): Promise<string>

Defined in: escrow.ts:1717

This function returns the reputation oracle address for a given escrow.

Parameters

escrowAddress

string

Address of the escrow.

Returns

Promise<string>

Address of the Reputation Oracle.

Code example

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');

---

getReservedFunds()

getReservedFunds(escrowAddress): Promise<bigint>

Defined in: escrow.ts:1338

This function returns the reserved funds for a specified escrow address.

Parameters

escrowAddress

string

Address of the escrow.

Returns

Promise<bigint>

Reserved funds of the escrow in the token used to fund it.

Code example

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');

---

getResultsUrl()

getResultsUrl(escrowAddress): Promise<string>

Defined in: escrow.ts:1451

This function returns the results file URL.

Parameters

escrowAddress

string

Address of the escrow.

Returns

Promise<string>

Results file url.

Code example

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');

---

getStatus()

getStatus(escrowAddress): Promise<EscrowStatus>

Defined in: escrow.ts:1603

This function returns the current status of the escrow.

Parameters

escrowAddress

string

Address of the escrow.

Returns

Promise<EscrowStatus>

Current status of the escrow.

Code example

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 status = await escrowClient.getStatus('0x62dD51230A30401C455c8398d06F85e4EaB6309f');

---

getTokenAddress()

getTokenAddress(escrowAddress): Promise<string>

Defined in: escrow.ts:1565

This function returns the token address used for funding the escrow.

Parameters

escrowAddress

string

Address of the escrow.

Returns

Promise<string>

Address of the token used to fund the escrow.

Code example

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');

---

requestCancellation()

requestCancellation(escrowAddress, txOptions?): Promise<void>

Defined in: escrow.ts:997

This function requests the cancellation of the specified escrow (moves status to ToCancel or finalizes if expired).

Parameters

escrowAddress

string

Address of the escrow to request cancellation.

txOptions?

Overrides = {}

Additional transaction parameters (optional, defaults to an empty object).

Returns

Promise<void>

Returns void if successful. Throws error if any.

Code example

Only Job Launcher or admin can call it.

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');

---

setup()

setup(escrowAddress, escrowConfig, txOptions?): Promise<void>

Defined in: escrow.ts:469

This function sets up the parameters of the escrow.

Parameters

escrowAddress

string

Address of the escrow to set up.

escrowConfig

IEscrowConfig

Escrow configuration parameters.

txOptions?

Overrides = {}

Additional transaction parameters (optional, defaults to an empty object).

Returns

Promise<void>

Returns void if successful. Throws error if any.

Code example

Only Job Launcher or admin can call it.

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'),
   manifest: 'http://localhost/manifest.json',
   manifestHash: 'b5dad76bf6772c0f07fd5e048f6e75a5f86ee079',
};
await escrowClient.setup(escrowAddress, escrowConfig);

---

storeResults()

Call Signature

storeResults(escrowAddress, url, hash, fundsToReserve, txOptions?): Promise<void>

Defined in: escrow.ts:611

This function stores the results URL and hash.

Parameters

escrowAddress

string

Address of the escrow.

url

string

Results file URL.

hash

string

Results file hash.

fundsToReserve

bigint

Funds to reserve for payouts

txOptions?

Overrides

Additional transaction parameters (optional, defaults to an empty object).

Returns

Promise<void>

Returns void if successful. Throws error if any.

Code example

Only Recording Oracle or admin can call it.

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.storeResults('0x62dD51230A30401C455c8398d06F85e4EaB6309f', 'http://localhost/results.json', 'b5dad76bf6772c0f07fd5e048f6e75a5f86ee079', ethers.parseEther('10'));

Call Signature

storeResults(escrowAddress, url, hash, txOptions?): Promise<void>

Defined in: escrow.ts:647

This function stores the results URL and hash.

Parameters

escrowAddress

string

Address of the escrow.

url

string

Results file URL.

hash

string

Results file hash.

txOptions?

Overrides

Additional transaction parameters (optional, defaults to an empty object).

Returns

Promise<void>

Returns void if successful. Throws error if any.

Code example

Only Recording Oracle or admin can call it.

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.storeResults('0x62dD51230A30401C455c8398d06F85e4EaB6309f', 'http://localhost/results.json', 'b5dad76bf6772c0f07fd5e048f6e75a5f86ee079');

---

withdraw()

withdraw(escrowAddress, tokenAddress, txOptions?): Promise<IEscrowWithdraw>

Defined in: escrow.ts:1048

This function withdraws additional tokens in the escrow to the canceler.

Parameters

escrowAddress

string

Address of the escrow to withdraw.

tokenAddress

string

Address of the token to withdraw.

txOptions?

Overrides = {}

Additional transaction parameters (optional, defaults to an empty object).

Returns

Promise<IEscrowWithdraw>

Returns the escrow withdrawal data including transaction hash and withdrawal amount. Throws error if any.

Code example

Only Job Launcher or admin can call it.

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(
 '0x62dD51230A30401C455c8398d06F85e4EaB6309f',
 '0x0376D26246Eb35FF4F9924cF13E6C05fd0bD7Fb4'
);

---

build()

static build(runner): Promise<EscrowClient>

Defined in: escrow.ts:175

Creates an instance of EscrowClient from a Runner.

Parameters

runner

ContractRunner

The Runner object to interact with the Ethereum network

Returns

Promise<EscrowClient>

An instance of EscrowClient

Throws

Thrown if the provider does not exist for the provided Signer

Throws

Thrown if the network's chainId is not supported