Types

Types

All types below ship with @trustless-work/escrow. Import them from the package root or from @trustless-work/escrow/types.

import type {
  DeploySingleReleaseEscrowPayload,
  EscrowSummary,
  Roles,
} from "@trustless-work/escrow";

Three buckets

1. Entities — on-chain shapes (roles, milestones, escrow).

2. Payloads — what you send to operate hooks / REST (deploy, fund, release, …).

3. Reads & responses — what Core returns after build, submit, or GET.

Amounts

• Operate payloads use human numbers (amount: 1000).

• Read-model fields use decimal strings (balance: "1000", amount: "250").

There is no UUID id / escrowId. Always identify an escrow with contractId (C…).

Browse by topic

• Entities — Roles, milestones, SingleReleaseEscrow / MultiReleaseEscrow, trustline

• Payloads — Deploy, update, fund, release, dispute, manage milestones

• Reads & responses — EscrowSummary, snapshots, list params, build/send responses

• Errors — ApiProblemDetails and escrow error codes

Core values

type EscrowType = "single-release" | "multi-release";

type EscrowStatus = "active" | "released" | "disputed";

type EscrowNetwork = string; // network id from Core

type baseURL = string; // Core API base URL

Value	Meaning
single-release	One payout for the whole escrow after milestones are done
multi-release	Each milestone can be released on its own
active / released / disputed	Derived status on list/detail rows

Quick map

You want to…	Start with
Deploy an escrow	Payloads — DeploySingleReleaseEscrowPayload / DeployMultiReleaseEscrowPayload
Fund / release / dispute	Payloads
Show a list in the UI	Reads & responses — EscrowSummary
Show one escrow	Reads & responses — EscrowDetail
Sign & submit	BuildTransactionResponse → wallet → SendTransactionResponse
Handle failures	Errors