> For the complete documentation index, see [llms.txt](https://docs.trustlesswork.com/trustless-work/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.trustlesswork.com/trustless-work/v2-en/escrow-js-sdk/escrows.md).

# Escrows

REST operate methods — build unsigned XDR, sign with your wallet, then send.

Operate methods call Core **build** endpoints. Each returns an **unsigned** XDR. You sign it, then submit with `sendTransaction`.

Import from `@trustless-work/escrow-js` or `@trustless-work/escrow-js/rest`.

### Methods

| Method                        | Action                                                 |
| ----------------------------- | ------------------------------------------------------ |
| `deployEscrow`                | Create escrow (`unsignedXdr` + predicted `contractId`) |
| `fundEscrow`                  | Fund                                                   |
| `updateEscrow`                | Update properties                                      |
| `changeMilestoneStatus`       | Status / evidence (batch)                              |
| `approveMilestones`           | Approve (batch)                                        |
| `approveAndReleaseMilestones` | Approve + release (multi-release)                      |
| `manageMilestones`            | Add / edit milestones                                  |
| `releaseFunds`                | Release                                                |
| `startDispute`                | Start dispute                                          |
| `resolveDispute`              | Resolve dispute (distributions)                        |
| `withdrawRemainingFunds`      | Withdraw remaining                                     |

{% hint style="info" %}
Most operate methods take `(payload, type)` where `type` is `"single-release"` | `"multi-release"`. Multi-only helpers (`approveAndReleaseMilestones`, `releaseMilestones`, `disputeMilestones`) omit the type argument.
{% endhint %}

### Pattern

```ts
const { unsignedXdr } = await client.rest.fundEscrow(payload, "single-release");
const signedXdr = await signWithWallet(unsignedXdr);
const result = await client.rest.sendTransaction(signedXdr);
```

### Response types

| Step         | Type                                                           |
| ------------ | -------------------------------------------------------------- |
| Deploy build | `DeployEscrowResponse` → `{ unsignedXdr, txHash, contractId }` |
| Other builds | `BuildTransactionResponse` → `{ unsignedXdr, txHash }`         |
| Submit       | `SendTransactionResponse`                                      |

Error handling: Errors. Payload types: Types.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.trustlesswork.com/trustless-work/v2-en/escrow-js-sdk/escrows.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
