EscrowUtils

@human-protocol/sdk

---

@human-protocol/sdk / escrow / EscrowUtils

Class: EscrowUtils

Defined in: escrow.ts:1842

Introduction

Utility class for escrow-related operations.

Installation

npm

npm install @human-protocol/sdk

yarn

yarn install @human-protocol/sdk

Code example

Signer

Using private key(backend)

import { ChainId, EscrowUtils } from '@human-protocol/sdk';

const escrowAddresses = new EscrowUtils.getEscrows({
  chainId: ChainId.POLYGON_AMOY
});

Constructors

Constructor

new EscrowUtils(): EscrowUtils

Returns

EscrowUtils

Methods

getCancellationRefund()

static getCancellationRefund(chainId, escrowAddress, options?): Promise<ICancellationRefund | null>

Defined in: escrow.ts:2434

This function returns the cancellation refund for a given escrow address.

This uses Subgraph

Input parameters

enum ChainId {
 ALL = -1,
 MAINNET = 1,
 SEPOLIA = 11155111,
 BSC_MAINNET = 56,
 BSC_TESTNET = 97,
 POLYGON = 137,
 POLYGON_AMOY = 80002,
 LOCALHOST = 1338,
}

interface ICancellationRefund {
  id: string;
  escrowAddress: string;
  receiver: string;
  amount: bigint;
  block: number;
  timestamp: number;
  txHash: string;
};

Parameters

chainId

ChainId

Network in which the escrow has been deployed

escrowAddress

string

Address of the escrow

options?

SubgraphOptions

Optional configuration for subgraph requests.

Returns

Promise<ICancellationRefund | null>

Cancellation refund data

Code example

import { ChainId, EscrowUtils } from '@human-protocol/sdk';

const cancellationRefund = await EscrowUtils.getCancellationRefund(ChainId.POLYGON_AMOY, "0x1234567890123456789012345678901234567890");

---

getCancellationRefunds()

static getCancellationRefunds(filter, options?): Promise<ICancellationRefund[]>

Defined in: escrow.ts:2338

This function returns the cancellation refunds for a given set of networks.

This uses Subgraph

Input parameters

enum ChainId {
 ALL = -1,
 MAINNET = 1,
 SEPOLIA = 11155111,
 BSC_MAINNET = 56,
 BSC_TESTNET = 97,
 POLYGON = 137,
 POLYGON_AMOY = 80002,
 LOCALHOST = 1338,
}

interface ICancellationRefund {
  id: string;
  escrowAddress: string;
  receiver: string;
  amount: bigint;
  block: number;
  timestamp: number;
  txHash: string;
};

Parameters

filter

ICancellationRefundFilter

Filter parameters.

options?

SubgraphOptions

Optional configuration for subgraph requests.

Returns

Promise<ICancellationRefund[]>

List of cancellation refunds matching the filters.

Code example

import { ChainId, EscrowUtils } from '@human-protocol/sdk';

const cancellationRefunds = await EscrowUtils.getCancellationRefunds({
   chainId: ChainId.POLYGON_AMOY,
   escrowAddress: '0x1234567890123456789012345678901234567890',
});
console.log(cancellationRefunds);

---

getEscrow()

static getEscrow(chainId, escrowAddress, options?): Promise<IEscrow | null>

Defined in: escrow.ts:2067

This function returns the escrow data for a given address.

This uses Subgraph

Input parameters

enum ChainId {
  ALL = -1,
  MAINNET = 1,
  SEPOLIA = 11155111,
  BSC_MAINNET = 56,
  BSC_TESTNET = 97,
  POLYGON = 137,
  POLYGON_AMOY = 80002,
  LOCALHOST = 1338,
}

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

Parameters

chainId

ChainId

Network in which the escrow has been deployed

escrowAddress

string

Address of the escrow

options?

SubgraphOptions

Optional configuration for subgraph requests.

Returns

Promise<IEscrow | null>

• Escrow data or null if not found.

Code example

import { ChainId, EscrowUtils } from '@human-protocol/sdk';

const escrow = new EscrowUtils.getEscrow(ChainId.POLYGON_AMOY, "0x1234567890123456789012345678901234567890");

---

getEscrows()

static getEscrows(filter, options?): Promise<IEscrow[]>

Defined in: escrow.ts:1946

This function returns an array of escrows based on the specified filter parameters.

Input parameters

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

enum ChainId {
  ALL = -1,
  MAINNET = 1,
  SEPOLIA = 11155111,
  BSC_MAINNET = 56,
  BSC_TESTNET = 97,
  POLYGON = 137,
  POLYGON_AMOY=80002,
  LOCALHOST = 1338,
}

enum OrderDirection {
  ASC = 'asc',
  DESC = 'desc',
}

enum EscrowStatus {
  Launched,
  Pending,
  Partial,
  Paid,
  Complete,
  Cancelled,
}

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

Parameters

filter

IEscrowsFilter

Filter parameters.

options?

SubgraphOptions

Optional configuration for subgraph requests.

Returns

Promise<IEscrow[]>

List of escrows that match the filter.

Code example

import { ChainId, EscrowUtils, EscrowStatus } from '@human-protocol/sdk';

const filters: IEscrowsFilter = {
  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);

---

getPayouts()

static getPayouts(filter, options?): Promise<IPayout[]>

Defined in: escrow.ts:2242

This function returns the payouts for a given set of networks.

This uses Subgraph

Input parameters Fetch payouts from the subgraph.

Parameters

filter

IPayoutFilter

Filter parameters.

options?

SubgraphOptions

Optional configuration for subgraph requests.

Returns

Promise<IPayout[]>

List of payouts matching the filters.

Code example

import { ChainId, EscrowUtils } from '@human-protocol/sdk';

const payouts = await EscrowUtils.getPayouts({
  chainId: ChainId.POLYGON,
  escrowAddress: '0x1234567890123456789012345678901234567890',
  recipient: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcdef',
  from: new Date('2023-01-01'),
  to: new Date('2023-12-31')
});
console.log(payouts);

---

getStatusEvents()

static getStatusEvents(filter, options?): Promise<IStatusEvent[]>

Defined in: escrow.ts:2150

This function returns the status events for a given set of networks within an optional date range.

This uses Subgraph

Input parameters

enum ChainId {
  ALL = -1,
  MAINNET = 1,
  SEPOLIA = 11155111,
  BSC_MAINNET = 56,
  BSC_TESTNET = 97,
  POLYGON = 137,
  POLYGON_AMOY = 80002,
  LOCALHOST = 1338,
}

enum OrderDirection {
  ASC = 'asc',
  DESC = 'desc',
}

type Status = {
  escrowAddress: string;
  timestamp: string;
  status: string;
};

Parameters

filter

IStatusEventFilter

Filter parameters.

options?

SubgraphOptions

Optional configuration for subgraph requests.

Returns

Promise<IStatusEvent[]>

• Array of status events with their corresponding statuses.

Code example

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