For the complete documentation index, see llms.txt. This page is also available as Markdown.

Escrows

Operate

Operate hooks call Core build endpoints. Each returns an unsigned XDR. You sign it, then submit with useSendTransaction.

Import from @trustless-work/escrow, @trustless-work/escrow/hooks, or @trustless-work/escrow/hooks/rest.

Hooks

Hook
Action

useDeployEscrow

Create escrow (unsignedXdr + predicted contractId)

useFundEscrow

Fund

useUpdateEscrow

Update properties

useChangeMilestoneStatus

Status / evidence (batch)

useApproveMilestones

Approve (batch)

useApproveAndReleaseMilestones

Approve + release (multi-release)

useManageMilestones

Add / edit milestones

useReleaseFunds

Release

useStartDispute

Start dispute

useResolveDispute

Resolve dispute (distributions)

useWithdrawRemainingFunds

Withdraw remaining

Most operate methods take (payload, type) where type is "single-release" | "multi-release". Multi-only helpers (approveAndReleaseMilestones, releaseMilestones, disputeMilestones) omit the type argument.

Pattern

Response types

Step
Type

Deploy build

DeployEscrowResponse{ unsignedXdr, txHash, contractId }

Other builds

BuildTransactionResponse{ unsignedXdr, txHash }

Submit

SendTransactionResponse

Error handling: Errors. Payload types: Types.