> 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/architecture.md).

# Architecture

Entry points, client layers, and the build → sign → send flow.

### Package entry points

| Import                              | Contains                                        |
| ----------------------------------- | ----------------------------------------------- |
| `@trustless-work/escrow-js`         | Client, config helpers, services, types, errors |
| `@trustless-work/escrow-js/rest`    | `EscrowRestService`                             |
| `@trustless-work/escrow-js/graphql` | GraphQL service, documents, GraphQL types       |
| `@trustless-work/escrow-js/types`   | Payloads, responses, read-model, entities       |

```ts
import { TrustlessWorkClient } from "@trustless-work/escrow-js";
import { EscrowRestService } from "@trustless-work/escrow-js/rest";
import { EscrowGraphqlService } from "@trustless-work/escrow-js/graphql";

const client = new TrustlessWorkClient({ baseURL, apiKey });
const rest = client.rest;       // operate + GET /escrows*
const graphql = client.graphql; // POST /graphql
```

### Layers

```
TrustlessWorkClient
  ├─ HttpTransport (native fetch + auth + Problem Details)
  ├─ EscrowRestService    (operate builds + REST reads)
  └─ EscrowGraphqlService (POST /graphql)
```

Optional module-level helpers (`configureTrustlessWork` / `escrowRest` / `escrowGraphql`) wrap a default `TrustlessWorkClient` — the vanilla counterpart to React’s `TrustlessWorkConfig`.

### Build → sign → send

Every mutate method returns an **unsigned** transaction. You sign with the wallet, then submit via `sendTransaction`.

```ts
import {
  TrustlessWorkClient,
  development,
  toTrustlessWorkError,
  TrustlessWorkApiError,
  formatApiErrorMessage,
} from "@trustless-work/escrow-js";
import type { DeploySingleReleaseEscrowPayload } from "@trustless-work/escrow-js/types";

const client = new TrustlessWorkClient({
  baseURL: development,
  apiKey: process.env.API_KEY,
});

const onSubmit = async (payload: DeploySingleReleaseEscrowPayload) => {
  try {
    const { unsignedXdr, contractId } = await client.rest.deployEscrow(
      payload,
      "single-release",
      // optional: { platformId, subjectId }
    );

    const signedXdr = await signWithWallet(unsignedXdr);
    const result = await client.rest.sendTransaction(signedXdr);

    if (result.code === "STELLAR_TX_SUBMITTED_INDEXER_LAGGING") {
      // Tx is on-chain; poll GET /escrows/:contractId until the indexer catches up
    }
  } catch (error: unknown) {
    const normalized = toTrustlessWorkError(error);
    if (normalized instanceof TrustlessWorkApiError) {
      console.error(formatApiErrorMessage(normalized), normalized.code);
    }
    throw error;
  }
};
```

### Operate response shapes

| Step         | Type                       | Shape                                                       |
| ------------ | -------------------------- | ----------------------------------------------------------- |
| Deploy build | `DeployEscrowResponse`     | `{ unsignedXdr, txHash, contractId }`                       |
| Other builds | `BuildTransactionResponse` | `{ unsignedXdr, txHash }`                                   |
| Submit       | `SendTransactionResponse`  | `{ txHash, ledger, contractId?, escrow?, code?, message? }` |

`code` may be `STELLAR_TX_SUBMITTED` or `STELLAR_TX_SUBMITTED_INDEXER_LAGGING`.

### Identity & amounts

* Escrow identity is **`contractId` only** (no UUID `id` / `escrowId`).
* Deploy trustline: `{ contractId, symbol }` (Soroban SAC `C…` + asset code).
* Read amounts are **decimal strings**; operate payloads use **numbers**.

See Types and Errors for the full catalog.


---

# 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/architecture.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.