https://api.trustlesswork.comLoading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Trustless Work docs are written for humans and for machines.
Humans get clarity, precision, and examples. Agents get structure, consistency, and predictable semantics.
The next generation of builders won’t just code. They’ll prompt, automate, and delegate work to agents.
An AI-ready doc set lets you:
Export content for training and internal copilots.
Feed pages into your LLM memory or RAG pipeline.
Let agents reason through flows and generate SDK/API calls.
You can export any section of the docs as PDF or Markdown.

PDF for onboarding manuals and reference packs.
Markdown (.md) for ingestion and context injection.
Prompt blocks for pasting into GPT, Cursor, or v0.dev.
Check the SDK pages for prompt-first workflows that generate and debug escrow flows.
Search is optimized for natural language. Use intent-focused prompts, not just keywords.
Example prompts:
Escrow is a neutral way to hold funds until conditions are met. It’s the simplest primitive for “trust, but verify”.
Most people first think of real estate. That’s correct. Escrow is common in high-value transactions.

Escrow also shows up in marketplaces (Upwork, eBay, etc.).

Big platforms can afford escrow infrastructure. Many others can’t.
eBay leans on legacy providers (often 3%–8% fees). Upwork invested heavily in escrow operations.
Platforms that could greatly benefit from the use of escrows don't use them because of the technical complexity and cost of building an escrow infrastructure.

Fiat escrow is expensive and slow. It typically requires bank rails and settlement workflows.
It’s operationally heavy. Real estate, M&A, and cross-border trade use escrow because they can justify the overhead.
Some teams spend months to a year building escrow infrastructure.
Blockchain makes escrow programmable and auditable. But building production-grade contracts and flows still takes specialized time. Most teams don’t want to hire a full smart contract team for v1.
Chargebacks and fraud in marketplaces
Late or withheld payments for freelancers
Unclear fund control in grants, bounties, or pre-orders
No dispute path in P2P or milestone deals
Payments release only when work is approved.
Funds sit in secure, neutral smart contracts.
Approval flows can be signed by users, platforms, or agents.
Works globally with USDC and Stellar settlement.
Get started: Developer Quickstart
Trustless Work is built for developers, platforms, and agents who want more control and automation over when funds are released.
Examples:
Gig and freelance platforms (milestone payouts)
B2B tools using USDC for global settlement
Rental and booking platforms (security deposits)
Why it fits:
Reduce fraud
Automate releases and disbursements
Lower operational cost
Examples:
Solo devs or small teams prototyping dApps
DAO tooling, donation platforms, on-chain marketplaces
Why it fits:
Plug-and-play escrow logic
Start on testnet, then go live without re-architecting
Examples:
Platforms with escrow-like flows but no escrow infrastructure
Teams replacing costly custodial services with on-chain escrow
Why it fits:
Less legal and operational risk than custody
Programmable, auditable escrow behavior
Build your first flow: Developer Quickstart
An escrow is just structured data — a JSON body that defines how funds are held, released, and tracked. Each property tells the contract who does what, when funds move, and under which conditions.
TLDR:
Single-Release → all milestones must be approved for one payout.
Multi-Release → each milestone unlocks its own payout.
Below we break down the core properties of every escrow, and then highlight the differences between Single-Release and Multi-Release.

Escrow ID The on-chain identifier of the contract (also the deposit address). This is where funds are actually sent and locked.
Engagement ID & Title Configurable strings that help you identify the escrow in your own system — for example, linking it to an invoice, project ID, or marketplace order.
Description Human-readable explanation of the escrow’s purpose. Useful for context in dashboards, audits, or dispute resolution.
Roles Every escrow defines who can act on it:
Approver → validates milestone completion
Service Provider → delivers the work
Platform Address → the platform itself, able to take fees or adjust config before funding
Release Signer → executes the release of funds
Dispute Resolver → arbitrates conflicts, can re-route funds
Receiver → final destination of the funds 👉 See Roles for full detail.
Amount & Platform Fee
Single-Release: the total amount to be paid once conditions are met, plus an optional platformFee percentage sent to the platform.
Multi-Release: the total amount is distributed across milestones (each milestone defines its own amount). The platform fee still applies globally.
Trustline Defines the token being used. This is how Stellar escrows know which asset to accept. Typically USDC, but any Stellar-issued token is supported.
Flags Internal state markers that describe what’s happening:
disputed → a party raised a dispute
released → funds have already been released
resolved → a dispute has been settled
approved (Multi-Release only) → milestone has been approved by approver
Milestones define what must be completed to unlock funds.
Single-Release Escrow
You can define one or many milestones, but the release is all-or-nothing.
Funds are only released once all milestones are approved.
Each milestone tracks:
description → what’s being delivered
status → any type of status
approve → true or false
evidence (optional) → proof of delivery
Multi-Release Escrow
Each milestone has the same properties as the single release, plus its own amount and flags.
When a milestone is approved, its funds can be released without waiting for others.
Milestones include:
amount → how much is unlocked upon approval
description → what’s being delivered
status → any type of status
flags → released, disputed, resolved and approve
receiver → final destination of the funds
This structure allows a project to fund and release in phases, not all at once.

Single-Release = one payout, triggered when all milestones are approved. Amount + release & dispute flags live at the top level of the escrow.
Multi-Release = multiple payouts, each milestone has its own amount and flags. The total escrowed amount is distributed across milestones.
Both share the same core structure — IDs, roles, description, trustline, and platform fee. The difference is:
Single-Release → milestones are “checkpoints” for one big release.
Multi-Release → milestones are “tranches,” each tied to its own release.
Choose Escrow Type
Assign Roles
Follow Lifecycle Phases
Test configs in deploy in dApp

Once an escrow is deployed, it becomes fundable — meaning any authorized wallet can deposit assets into it. This is where trust becomes tangible: the logic you set in the Initiation Phase now holds real value.
The Funding Phase signals the start of the agreement in motion. It turns the escrow from an empty container of logic into a live, capital-backed contract.
Every escrow has an Escrow ID (also called Contract ID). Both terms refer to the same on-chain address — where funds are actually held.
You can fund an escrow in two main ways:
Direct Deposit — Send funds manually to the escrow’s ID using any Stellar wallet.
This method is simple and works universally.
However, deposits made this way may not automatically trigger indexation events, so if you’re building analytics or dashboards, you’ll need to handle those deposits separately.
Using the “Fund Escrow” Endpoint — via the Trustless Work API or dApp.
This option generates and signs the transaction from your connected wallet (e.g., Freighter).
It also emits a Deposit Event on-chain, making it easier for our indexer (and your platform) to track and verify deposits automatically.
This is the method we recommend — it’s what powers the “Fund” buttons in our Backoffice and Demo dApps.
⚡ In short:
Direct deposits work for any wallet or integration.
The API endpoint tracks them better for dashboards, automation, and future reconciliations.
When you deployed your escrow, you defined a target amount — that’s your goal. It’s used to calculate whether the escrow is:
Fully Funded – the on-chain balance matches the target amount
Partially Funded – the balance is lower than expected
Overfunded – extra deposits were made
What you see on-chain is the balance, which is dynamic:
It increases when deposits are made.
It decreases when funds are released.
It always reflects the escrow’s current real-time state.
💡 The target
amountis static — it represents intent. Thebalanceis live — it represents reality.
Funds can come from any wallet that supports the trustline you defined during initiation. The most common setup is USDC on Stellar, but any asset with a valid trustline works.
We recommend using non-custodial wallets for deposits — especially Freighter, our default integration.
⚠️ Important note: Some custodial exchanges (like Binance) don’t yet support sending directly to contract addresses. Withdrawals may fail or get flagged as invalid. Always test deposits from a non-custodial wallet first.
If you’re building a product where funds flow in from external users or payment processors — like a marketplace or investment pool — you can integrate on-ramp services directly with the escrow.
We’ve tested integrations where on-ramps send USDC straight to an escrow contract, creating a seamless deposit experience. Each successful deposit triggers an event that platforms can listen to for real-time funding status updates.
💬 Builders who want to explore advanced integrations can check out our open-source examples and dApp code on GitHub. We’re continuously experimenting with new funding patterns and wallets to improve this experience.
By the end of this phase:
Your escrow now holds real assets.
Its balance reflects the amount deposited.
Events are recorded on-chain for transparency.
All participants can independently verify the deposit.
You can confirm the escrow’s funded state on:
🌐 Escrow Viewer — for a clear visual of deposits and status
🔍 Stellar Expert — for blockchain-level transaction details
💡 Use the Viewer for clarity, Expert for raw transparency.

Once the escrow is funded, the work begins. This phase is where the Service Provider (or Milestone Marker) communicates progress to everyone else — by signing an update that changes the milestone’s status.
It’s how the escrow “breathes.” Each update becomes a traceable, on-chain proof of what’s happening off-chain.
Every milestone in an escrow has two types of information:
Structural data — defined at deployment (title, receiver, amount).
Dynamic status — updated as work evolves.
The Change Milestone Status action updates that dynamic state. It’s not limited to pre-set words like pending or done — your platform defines the vocabulary.
A milestone could move through any flow you design:
“Design Started” → “Ready for Review” → “Approved”
“Product Packed” → “In Transit” → “Delivered”
“Pull Request Opened” → “Code Merged” → “Deployed”
💬 Trustless Work doesn’t impose statuses. It only ensures that the update comes from the correct role — the Service Provider — and that every change is signed and recorded.
Only the Service Provider (Milestone Marker) can sign milestone status updates. This preserves accountability: progress always originates from the party doing the work.
Once signed, the update is broadcast on-chain, and the contract records:
The new status label (a text string defined by your platform)
An optional evidence field
Other participants — Approver, Release Signer, Platform — can view the update but cannot alter it.
Each update can include an evidence input, typically a URL or reference pointing to external proof of progress.
This could be:
A link to a code repository, pull request, or merge commit
A delivery receipt, tracking page, or signed document
A file stored on decentralized storage like IPFS, Filecoin, or Arweave
📎 Note: Trustless Work doesn’t store media or documents. It only stores the reference — keeping the escrow lightweight and privacy-respectful. Platforms decide where evidence lives, and how much they want to display publicly.
Platforms can build their own workflows on top of this mechanism:
Display a real-time progress feed on dashboards
Require specific evidence types before allowing “Approve” actions
Automate milestone transitions based on external data (e.g., an API confirming delivery)
Each status update becomes part of the escrow’s event history — a transparent, auditable record of progress.
Every signed update triggers:
A Milestone Status Event, visible on Stellar explorers and in the Escrow Viewer
A refreshed view of the milestone’s metadata (status, evidence, and timestamp)
It doesn’t release funds — it just advances the state. The Approval Phase that follows decides whether payment moves forward or the milestone is disputed.
By the end of this phase:
The Service Provider has submitted a new, verifiable progress update.
The escrow now reflects the most recent milestone status and evidence.
All participants can see the change on-chain and in the Escrow Viewer.
This phase transforms subjective progress into verifiable data — one signed update at a time.
From idea to escrow in one day.
Designing an escrow is only half the battle. The real question is: How do you go from schema to a working product without burning months on contracts, audits, and ops flows?
That’s why Trustless Work offers a modular product suite — tools you can combine like building blocks to launch escrow-powered workflows today.
Escrow API – The programmable core. Create, fund, update, approve, and release escrows. Maximum control, minimal friction.
Next.js SDK – React-friendly wrapper for interacting with escrows directly from your frontend.
Escrow Blocks – Pre-built React UI components. The fastest way to launch a user-facing escrow flow.
Back Office dApp (Open Source) – Ops-friendly control panel for deploying and managing escrows. Ideal for dispute resolution, MVP pilots, and non-technical teams. Use it, clone it.
Demo Lab dApp – Developer sandbox to test flows before pushing to production.
Escrow Viewer (Open Source) – Public, read-only explorer of escrow configs, milestones, and balances. Essential for transparency and compliance.
Think of these as playbooks for how to mix & match the suite:
Full API/SDK Integration → For teams with dev capacity and UX control needs. Your UI + our escrow logic.
Escrow Blocks: → Import template UI components to launch faster, with minimal custom frontend work.
Hybrid Back Office → Your users stay in your UI, but ops/disputes handled in the Back Office.
Back Office First → Launch this week. Manage flows directly in our Back Office while validating.
Template Fork → Clone one of our open-source dApps, rebrand, extend. Perfect for hackathons.
Escrows need rails. Trustless Work runs on Stellar, a blockchain optimized for stablecoins, payments, and smart contracts.
Trustless Work contracts run on Stellar. Smart contract logic runs on Soroban.
Wallets sign the transactions. Trustlines define which assets accounts can hold.
Fast finality. Most transactions confirm in ~5 seconds.
Low fees. Transaction fees are typically fractions of a cent.
Built for payments. Wallets, exchanges, and on/off-ramps already support Stellar.
Stablecoin-ready. USDC is widely used on Stellar, plus any issued asset.
Soroban is Stellar’s smart contract engine.
It powers programmable escrows. You can encode roles, milestones, approvals, disputes, and release logic on-chain.
If you’re building locally, start with Testnet Tokens and Trustlines first.
On Stellar, accounts must explicitly opt in to hold and use assets. This opt-in is called a trustline.
Trustlines are how Stellar accounts opt in to issued assets.
If an account has no trustline, it cannot hold that asset.
A trustline links an account to an asset issuer.
It allows the account to receive, hold, and send that asset.
It includes a limit (max balance you accept).
It tracks balance and liabilities (like open offers).
Trustless Work escrows can use any Stellar-issued asset.
Every participant must be able to hold that asset.
If a signer can’t hold the escrow asset, their step may fail. Set trustlines before testing any escrow flow.
Use these issuer addresses when you configure the escrow trustline.
A Comprehensive Developer's Guide to Stellar Wallet Integrations
Stellar wallets are essential tools for interacting with the Stellar blockchain, enabling developers and users to securely manage, send, and receive digital assets. This section covers the setup and integration of popular Stellar wallets:
Albedo Wallet
xBull Wallet
Rabet Wallet
Lobstr Wallet
Hana Wallet
Public Key: Your Stellar address, used to receive assets. This can be shared publicly.
Private Key: Your secret key used to authorize transactions. This must be kept secure and never shared.
Never share your private key with anyone
Stellar accounts need to establish trustlines to receive custom assets. Trustlines represent a relationship between two accounts, where one account trusts the other to issue a specific asset. This allows the receiving account to accept and hold that asset.
Trustlines are crucial in Stellar for:
Establishing trust with asset issuers
Enabling receipt of custom tokens
Requiring a small minimum balance to create
Stellar accounts require a minimum balance (currently 0.5 XLM)
Each trustline adds to the minimum balance requirement
Helps prevent spam and ensures network stability
Use hardware wallets when possible
Enable two-factor authentication
Store private keys offline
Use secure, updated browsers
Regularly update wallet software
Be cautious of phishing sites
In order to get registered, you have to connect with a Stellar wallet. If you do not yet have one, or have never used one, there is more information in the following section:
Stellar WalletsTo authenticate you will need to login to our Dapp with a Stellar Wallet and Request an API key. Here are the steps to achieve that:
Request API KeyComing: We are figuring out how this can work with passkeys and send to addresses with Memo. WE do this in the open, so feel free to crontribute.
Step-by-step instructions to help you connect your product with Trustless Work smoothly and efficiently.
The purpose of this document is to provide a comprehensive guide on implementing best practices within the development team. It covers essential methodologies, tools, and strategies that can enhance productivity and ensure high-quality outcomes.
Most common flow in the dApps.

Flow that must always be executed at each Endpoint except Get Balances & Get Escrow

The document describes the essential execution flow for service endpoints, with exceptions for Get Balances and Get Escrow, ensuring uniformity in implementation.
All the entities that you'll need.
In this document, we explore the structure and functionality of key escrow-related types and interfaces used in the system, including the Escrow and Escrow Response entities. These entities are crucial for handling escrow operations such as initializing, updating, and responding to requests regarding escrow contracts.
Our React library includes all these types. Simply import them.
/**
* The base URL for the Trustless Work API
*/
export type baseURL =
| "https://api.trustlesswork.com"
| "https://dev.api.trustlesswork.com";
/**
* Escrow Type
*/
export type EscrowType = "single-release" | "multi-release";
/**
* Http Method
*/
export type HttpMethod = "get" | "post" | "put" | "delete";
/**
* Unique possible statuses for a Trustless Work request
*/
export type Status = "SUCCESS" | "FAILED";
/**
* Date
*/
export type Date = {
_seconds: number;
_nanoseconds: number;
};
/**
* Fund Escrow Payload, this can be a single-release or multi-release
*/
export type FundEscrowPayload = {
/**
* Amount to be transferred upon completion of escrow milestones
*/
amount: number;
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Address of the user signing the contract transaction
*/
signer: string;
};/**
* Approve Milestone Payload, this can be a single-release or multi-release
*/
export type ApproveMilestonePayload = {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Index of the milestone to be updated
*/
milestoneIndex: string;
/**
* New evidence of work performed by the service provider.
*/
newEvidence?: string;
/**
* Address of the entity requiring the service.
*/
approver: string;
};/**
* Change Milestone Status Payload, this can be a single-release or multi-release
*/
export type ChangeMilestoneStatusPayload = {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Index of the milestone to be updated
*/
milestoneIndex: string;
/**
* New status of the milestone
*/
newStatus: string;
/**
* New evidence of work performed by the service provider.
*/
newEvidence?: string;
/**
* Address of the entity providing the service.
*/
serviceProvider: string;
};/**
* Single Release Release Funds Payload
*/
export type SingleReleaseReleaseFundsPayload = {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Address of the user in charge of releasing the escrow funds to the service provider.
*/
releaseSigner: string;
};/**
* Single Release Start Dispute Payload. This starts a dispute for the entire escrow.
*/
export type SingleReleaseStartDisputePayload = {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Address of the user signing the contract transaction
*/
signer: string;
};/**
* Resolve Dispute Payload
*/
export type SingleReleaseResolveDisputePayload = {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Address in charge of resolving disputes within the escrow.
*/
disputeResolver: string;
/**
* Distributions of the escrow amount to the receivers.
*/
distributions: [
{
/**
* Address of the receiver
*/
address: string;
/**
* Amount to be transferred to the receiver. All the amount must be equal to the total amount of the escrow.
*/
amount: number;
},
];
};/**
* Withdraw remaining funds
*/
export type WithdrawRemainingFundsPayload = {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Address in charge of resolving disputes within the escrow.
*/
disputeResolver: string;
/**
* Distributions of the escrow amount to the receivers.
*/
distributions: [
{
/**
* Address of the receiver
*/
address: string;
/**
* Amount to be transferred to the receiver. All the amount must be equal to the total amount of the escrow.
*/
amount: number;
},
];
};
/**
* Get Escrow From Indexer By Contract Ids Params
*/
export type GetEscrowFromIndexerByContractIdsParams = {
/**
* IDs (addresses) that identifies the escrow contracts.
*/
contractIds: string[];
/**
* If true, the escrows will be validated on the blockchain to ensure data consistency.
* This performs an additional verification step to confirm that the escrow data
* returned from the indexer matches the current state on the blockchain.
* Use this when you need to ensure the most up-to-date and accurate escrow information.
* If you active this param, your request will take longer to complete.
*/
validateOnChain?: boolean;
};import { ApiErrorTypes } from "@/errors/enums/error.enum";
/**
* Types for Error response
*/
export type ErrorResponse = {
message: string;
code: number;
type: ApiErrorTypes;
};
/**
* Types for TW errors
*/
export type ApiError = Pick<ErrorResponse, "message" | "code">;
/**
* Types for Wallet errors
*/
export type WalletError = Pick<ErrorResponse, "message" | "code">;
/**
* Types for Request errors
*/
export type RequestError = ApiError | Error | WalletError;
Single-Release Escrow is a type in which all your funds are released only once, either with the resolution of a dispute or by completing all the milestones defined for it.
The Deploy endpoints allow users to deploy escrows efficiently. These endpoints provide the way to initialize escrows in the Stellar's Blockchain.
Key Components
Initial Fund Lockup: Upon contract initiation, the escrow amoun plus the platform fee (“platformFee”) is deposited into an escrow account.
Flags: The escrow status is interpreted by means of these flags: (approved, dispute, released, resolved).
Primary Roles:
Service Provider: Delivers the deliverable corresponding to each milestone.
Approver: Verifies and approves a milestone before authorizing the release of funds.
Dispute Resolver: Intervenes in case of disagreement and decides whether to release or refund the locked amount.
Receiver: The final recipient of the funds if different from the Service Provider.
Brief Workflow
An escrow is initialized by defining all the necessary escrow properties.
The Service Provider completes a milestone and requests approval.
The approver reviews the deliverable; if approved, signs a transaction that releases the amount allocated as escrow reward (minus the platform and Trustless Work fee).
The Stellar network executes the transaction and transfers the payment to the Service Provider or the configured Receiver.
If a dispute arises, the Dispute Resolver evaluates the evidence and, upon signing their decision, marks the escrow as resolved to release or refund the corresponding funds.
This model protects all parties: the client knows that funds are available but cannot be released without validation, and the service provider receives payment upon completion of all milestones and the milestones themselves being approved by the approver, leveraging Stellar's transparency and immutability.
A Multi-Release Contract is an escrow agreement on the Stellar blockchain that divides the total payment of a project into multiple deliveries (“milestones”). Each milestone is released only upon verification of its completion, ensuring that funds remain secure until the associated work is validated.
Key Components
Initial Fund Lockup: Upon contract initiation, the total of all milestone amounts plus the platform fee (“platformFee”) is deposited into an escrow account.
Milestones: Each stage includes a description, a specific amount, and status flags (approved, dispute, released, resolved).
Primary Roles:
Service Provider: Delivers the deliverable corresponding to each milestone.
Approver: Verifies and approves a milestone before authorizing the release of funds.
Dispute Resolver: Intervenes in case of disagreement and decides whether to release or refund the locked amount.
Receiver: The final recipient of the funds if different from the Service Provider.
Brief Workflow
The Service Provider completes a milestone and requests approval.
The Approver reviews the deliverable; if approved, they sign a transaction that releases only the amount allocated to that milestone (minus the platform and Trustless Work fee).
The Stellar network executes the transaction and transfers the payment to the Service Provider or the configured Receiver.
If a dispute arises, the Dispute Resolver evaluates the evidence and, upon signing their decision, marks the milestone as resolved to release or refund the corresponding funds.
This model protects all parties: the client knows that funds are available but cannot be released without validation, and the Service Provider receives payment for each verified delivery—leveraging Stellar’s transparency and immutability.
These endpoints provide a way to receive tokens through Trustline and send any transactions to the Stellar Blockchain.
Helper endpoints are designed to provide additional functionalities that complement the main features of an API. They often include utility functions that streamline common requests, simplify data manipulation, or enhance overall user experience.
Helper endpoints offer several benefits that enhance both development efficiency and user satisfaction.
Set Trustline: Allows the user to interact with some tokens.
Send Transaction: Send the transaction to Stellar Network with the signed hash.
Get Multiple Escrow Balance: This endpoint allows users to retrieve the balances of multiple escrow accounts simultaneously.
These endpoints ensure secure transactions by leveraging Stellar's infrastructure, guaranteeing transparency and reliability.
This endpoint facilitates the recovery and proper storage in Firebase of escrow-related information submitted to the Stellar Blockchain via external applications, bypassing the standard application.
External Transaction: This endpoint handles cases where the XDR generated by any endpoint of our REST API is signed and sent directly by external applications.
Internal Queue: Information initially generated by the application is stored in an internal queue, awaiting association with a specific transaction identified by its hash (txHash).
Firebase Storage: Once retrieved from the internal queue, the information is permanently stored in Firebase.
External Application: Signs and sends the XDR without using the standard endpoint (helper/send-transaction).
Indexer: Responsible for retrieving information from the internal queue and storing it in Firebase upon receiving the transaction hash (txHash).
The XDR is obtained from any transaction (not signed) generated with any of the endpoints of our REST API.
The generated XDR is signed and sent externally (without using helper/send-transaction).
The external application provides the corresponding txHash.
The txHash is sent to indexer/update-from-txHash.
The endpoint retrieves information stored in the internal queue and saves it in Firebase.
Request:
Response:
The information associated with the provided txHash is successfully stored in Firebase, ensuring the integrity of the generated escrow.
Enables external integrations while maintaining information consistency.
Prevents data loss when bypassing the standard workflow.
Ensures secure and accurate storage in Firebase using the transaction hash.
This endpoint enhances the system's flexibility and robustness, ensuring all transactions, regardless of the method used, are adequately recorded in Firebase.

Wallet provider, validators and a connect button powered by Stellar Wallets Kit.
Execute this command to add the code component.
npx trustless-work add wallet-kitHow does it look like?


This block is required for all escrow blocks. It is used to provide the wallet provider, validators and a connect button powered by Stellar Wallets Kit. @Credit-Tech
When you already added the block to your project, you should add the USDC trustline to your Wallet. Otherwise, the escrow interaction will not work.
If you don't want to use the escrowProvider context, you'll need to provide the payload through an alternative method.
Table and Cards layout to explore escrows by signer with sorting and filtering. This component contains a detailed view of the escrow, including the signer, status, and actions.
Table and Cards layout to explore escrows by role with sorting and filtering. This component contains a detailed view of the escrow, including the signer, status, and actions.
Component to initialize an escrow with different variants and types.
Execute this command to add the code component.
npx trustless-work add escrows/single-release/initialize-escrow/form
// or
npx trustless-work add escrows/single-release/initialize-escrow/dialogExecute this command to add the code component.
npx trustless-work add escrows/multi-release/initialize-escrow/form
// or
npx trustless-work add escrows/multi-release/initialize-escrow/dialogComponent to fund an escrow using form, button and dialog variants.
Execute this command to add the code component.
npx trustless-work add escrows/single-multi-release/fund-escrow/form
// or
npx trustless-work add escrows/single-multi-release/fund-escrow/button
// or
npx trustless-work add escrows/single-multi-release/fund-escrow/dialogComponent to approve a milestone with form, button and dialog variants.
Execute this command to add the code component.
npx trustless-work add escrows/single-multi-release/approve-milestone/form
// or
npx trustless-work add escrows/single-multi-release/approve-milestone/button
// or
npx trustless-work add escrows/single-multi-release/approve-milestone/dialogComponent to change milestone status with form, button and dialog variants.
Execute this command to add the code component.
npx trustless-work add escrows/single-multi-release/change-milestone-status/form
// or
npx trustless-work add escrows/single-multi-release/change-milestone-status/button
// or
npx trustless-work add escrows/single-multi-release/change-milestone-status/dialogAction to release escrow funds.
Action to raise a dispute in the escrow or milestone.
Component to resolve disputes with form, button and dialog variants.
Execute this command to add the code component.
npx trustless-work add escrows/single-release/resolve-dispute/form
// or
npx trustless-work add escrows/single-release/resolve-dispute/button
// or
npx trustless-work add escrows/single-release/resolve-dispute/dialogExecute this command to add the code component.
npx trustless-work add escrows/multi-release/resolve-dispute/form
// or
npx trustless-work add escrows/multi-release/resolve-dispute/button
// or
npx trustless-work add escrows/multi-release/resolve-dispute/dialogComponent to update escrow configuration with form and dialog variants.
Execute this command to add the code component.
npx trustless-work add escrows/single-release/update-escrow/form
// or
npx trustless-work add escrows/single-release/update-escrow/dialogExecute this command to add the code component.
npx trustless-work add escrows/multi-release/update-escrow/form
// or
npx trustless-work add escrows/multi-release/update-escrow/dialogComponent to withdraw remaining funds with form, button and dialog variants.
Execute this command to add the code component.
npx trustless-work add escrows/multi-release/withdraw-remaining-funds/form
// or
npx trustless-work add escrows/multi-release/withdraw-remaining-funds/button
// or
npx trustless-work add escrows/multi-release/withdraw-remaining-funds/dialogfund a multi-release escrow with testnet USDC
create an SDK snippet to mark milestone as done
explain the difference between approver and release signer
After the Service Provider updates a milestone’s status, the Approver steps in. This is the phase where intent meets validation — the moment a platform or client officially confirms that progress is satisfactory.
Approval is the green light that tells the escrow:
“This milestone has met the conditions. It can now move toward payment.”
Approving a milestone doesn’t move funds yet — it simply updates the milestone’s internal flag:
approved: true
That single flag transforms the milestone from in progress to ready for release.
It’s a lightweight change in data but a heavy one in meaning — because once approved, the milestone is permanently recorded as validated. There’s no “unapprove” function. The decision becomes part of the escrow’s history.
Only the Approver — the wallet assigned to that role — can sign the approval. This address is often:
The buyer in a freelance contract,
The sponsor in a grant,
Or the platform logic in automated or multi-party flows.
The Approver’s signature confirms that:
The milestone has been delivered satisfactorily, and
The platform can now safely move toward release.
All milestones must be approved before any funds can move.
Once every milestone carries the approved: true flag, the escrow becomes “ready for release.”
The Release Signer can then execute the payout in one transaction.
Each milestone has its own approval and release logic.
Approving one milestone makes that milestone’s funds eligible for release, regardless of others.
This allows multiple, independent approval-release cycles within the same escrow.
🧩 In short:
Single-Release → approval is collective (all or nothing).
Multi-Release → approval is modular (one milestone at a time).
Approvals can happen at any moment, regardless of the milestone’s current “status” text.
Even if the Service Provider used a custom status like “Under Review” or “In Transit”, the Approver can sign approval immediately if they’re satisfied.
That flexibility allows each platform to define its own logic — maybe auto-approving after a timer, or requiring manual review before payment.
Once approved:
The milestone’s approved flag turns true,
The escrow recognizes that milestone as complete,
And it remains approved for the rest of its lifecycle.
Approval is also what separates smooth transactions from disputes. If the Approver signs, the flow advances to Release. If they refuse or challenge, the same milestone can instead move into Dispute Resolution.
🧭 Approval is the fork in the road — One path leads to payment, the other to mediation.
By the end of this phase:
The milestone’s approved flag is set to true.
The escrow recognizes that milestone as ready for release.
The approval event is permanently logged on-chain.
Participants can view the approval in real time through the Escrow Viewer.
💡 Approval doesn’t release funds — it unlocks the ability to. It’s the signal that work is accepted, and the escrow can now fulfill its purpose.
Goal: Go from idea to live escrows in under 1 week.
Time Estimate: 4–8 hours of implementation (plus testing).
Prerequisites:
Basic Web3 knowledge
A Stellar wallet (Freighter, Albedo)
Access to stablecoins (USDC/EURC on testnet or mainnet)
1. Understand Your Use Case
2. Choose the Correct Escrow Type
3. Define Roles
Assign the parties' Stellar addresses to each role in your escrow:📄 Roles in Trustless Work
4. Define Escrow Properties
5. Get Access
6. Install SDK / Tools Getting Started
7. Configure Your Escrow
8. Deploy on Testnet
9. Simulate Edge Cases
10. Run Compliance & UX Review
11. Migrate to Mainnet
12. Monitor & Optimize

The Initiation Phase is where the escrow takes shape.
You’re not moving money yet — you’re defining the logic that will govern how it moves later.
Think of this as the architecture of trust: setting the rules, actors, and conditions before anything hits the chain.
Participants and Roles
In the initiation phase key roles are assigned to specific parties. These roles determine responsibilities and actions throughout the transaction.
Every escrow is role-based — meaning only specific addresses can perform specific actions.
You can read more about roles here → Roles in Trustless Work.
During initiation, you assign which addresses will act as:
Milestone Marker (Service Provider) — delivers work and marks milestones as done
Approver — validates each milestone and can raise disputes
Release Signer — triggers the release of funds once conditions are met
Dispute Resolver — resolves conflicts and reallocates funds
Receiver — the final destination of funds
Platform Address — the address of the platform itself (receives a percentage fee and can adjust configuration before funding)
🔑 Roles are permissions, not identities.
The same wallet can hold more than one role, depending on your workflow.
This is where you define what gets paid, and when.
For a Single-Release escrow, you’ll have one total amount and one receiver.
The payment only happens once, after all milestones are approved.
Example: a one-off design project or security deposit.
For a Multi-Release escrow, you’ll define multiple milestones, each with:
Its own amount
Its own receiver
Its own flags and status
This structure allows you to fund once and pay multiple parties or stages over time.
💡 You can even add milestones later — turning one escrow into an ongoing contract.
On Stellar, every token (like USDC) is identified by its issuer address.
To hold that token, your wallet must explicitly “trust” that issuer — this is called a Trustline.
When you create an escrow, you must define which trustline (asset) it will hold.
Example: GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5 = USDC.
All participating addresses (Approver, Marker, Release Signer, etc.) must have that trustline enabled in their wallet.
Otherwise, they won’t be able to receive or send that asset.
⚠️ Without the trustline set, the transaction will fail — so ensure every role wallet is ready before deployment.
Every escrow includes an Engagement ID, which acts like your external reference number.
It’s a human-readable tag that connects the on-chain escrow to your off-chain logic.
Examples:
ORDER_2025_00234
INVOICE_98B-13
DAO_GRANT_ROUND2
The Engagement ID is optional for blockchain logic, but essential for indexing and analytics.
It lets platforms query, group, and monitor escrows easily through the API or the viewer.
Platforms can earn a Platform Fee on each escrow.
This fee is taken at release, alongside the protocol’s 0.3% Trustless Work fee.
Example:
Platform Fee = 1%
Trustless Fee = 0.3%
Total deduction = 1.3% (automatically split between platform and protocol)
The platform fee is sent to the Platform Address defined in the roles.
💡 For marketplaces and SaaS platforms, this is a native monetization layer built into the escrow logic — no separate billing flow required.
At the end of Initiation, you have:
A complete schema defining every role, milestone, fee, and asset
A trustline selected and validated for all participants
An engagement ID linking your escrow to external records
A clear understanding of what needs to happen before any money moves
This is the blueprint.
Once finalized, it’s deployed to the blockchain as an immutable contract.
From here on, every signature, approval, or release event happens on-chain.
Also, you should be able to view the escrow and it’s configuration on the escrow viewer or on Stellar expert.

Freighter is a browser extension wallet for Stellar. It is a non-custodial wallet extension for your browser.
How to install and set up Freighter Wallet.
How to connect Freighter Wallet to Trustless Work.
Useful resources, security tips, and FAQs.
Open the official Freighter Wallet website.
Click on "Add to Browser" for your preferred browser (e.g., Chrome, Brave, or Firefox).
Ensure you download only from the official website to avoid scams.
Follow the browser prompts to install the extension.
After installation, pin the Freighter extension for easy access.

Open the Freighter extension by clicking on its icon in your browser.
Click on "Create New Wallet".
Set a secure password (store this password securely).
Freighter will generate a Recovery Phrase (also called a Seed Phrase).
Write it down and store it in a safe place. Do not share it with anyone.


You need a funded Testnet account to submit transactions and pay fees.
Open the Freighter extension.
Switch the network to Testnet.

Click Fund with Friendbot.

Wait for the balance to appear.
Your account is now active on Stellar Testnet.
Open the Freighter extension.
Click on "Import Wallet".
Enter your existing Seed Phrase and set a password.

Navigate to the Trustless Work platform.
Example link: Trustless Work.
Click "Connect Wallet" in the top-right corner of the page.
Select "Freighter Wallet" from the list of options.
A pop-up will appear from Freighter asking for confirmation.
Approve the connection in the wallet extension.


Ensure Freighter is set to the correct network (Testnet or Mainnet) based on your environment. You can toggle the network in the Freighter settings.
Backup Your Seed Phrase: Store it in a secure, offline location.
Use Testnet for Development: When testing or experimenting, always switch to the Testnet to avoid losing real funds.
Enable Browser Security Features: Avoid installing unknown browser extensions that could compromise your wallet.
Official Website: Freighter Wallet
Documentation: Freighter GitHub Repo
Testnet Tokens: How to Get Testnet Tokens
Troubleshooting: Troubleshooting & FAQs
Your recovery phrase is the only way to restore your wallet. If it’s lost, your funds cannot be recovered.
Open the Freighter extension.
Click on the settings icon.
Toggle between Testnet and Mainnet in the dropdown.
/**
* Multi Release Release Funds Payload
*/
export type MultiReleaseReleaseFundsPayload = {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Address of the user in charge of releasing the escrow funds to the service provider.
*/
releaseSigner: string;
/**
* Index of the milestone to be released
*/
milestoneIndex: string;
};/**
* Multi Release Start Dispute Payload. This starts a dispute for a specific milestone.
*/
export type MultiReleaseStartDisputePayload = {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Address of the user signing the contract transaction
*/
signer: string;
/**
* Index of the milestone to be disputed
*/
milestoneIndex: string;
};/**
* Multi Release Resolve Dispute Payload
*/
export type MultiReleaseResolveDisputePayload = {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Address in charge of resolving disputes within the escrow.
*/
disputeResolver: string;
/**
* Distributions of the escrow amount to the receivers.
*/
distributions: [
{
/**
* Address of the receiver
*/
address: string;
/**
* Amount to be transferred to the receiver. All the amount must be equal to the total amount of the escrow.
*/
amount: number;
},
];
/**
* Index of the milestone to be resolved
*/
milestoneIndex: string;
};/**
* Get Escrows From Indexer By Signer Params
*/
export type GetEscrowsFromIndexerBySignerParams = {
/**
* Page number. Pagination
*/
page?: number;
/**
* Sorting direction. Sorting
*/
orderDirection?: "asc" | "desc";
/**
* Order by property. Sorting
*/
orderBy?: "createdAt" | "updatedAt" | "amount";
/**
* Created at = start date. Filtering
*/
startDate?: string;
/**
* Created at = end date. Filtering
*/
endDate?: string;
/**
* Max amount. Filtering
*/
maxAmount?: number;
/**
* Min amount. Filtering
*/
minAmount?: number;
/**
* Is active. Filtering
*/
isActive?: boolean;
/**
* Escrow that you are looking for. Filtering
*/
title?: string;
/**
* Engagement ID. Filtering
*/
engagementId?: string;
/**
* Status of the single-release escrow. Filtering
*/
status?: SingleReleaseEscrowStatus;
/**
* Type of the escrow. Filtering
*/
type?: "single-release" | "multi-release";
/**
* If true, the escrows will be validated on the blockchain to ensure data consistency.
* This performs an additional verification step to confirm that the escrow data
* returned from the indexer matches the current state on the blockchain.
* Use this when you need to ensure the most up-to-date and accurate escrow information.
* If you active this param, your request will take longer to complete.
*/
validateOnChain?: boolean;
/**
* Address of the user signing the contract transaction.
*/
signer: string;
};/**
* Get Escrows From Indexer By Role Params
*/
export type GetEscrowsFromIndexerByRoleParams = {
/**
* Page number. Pagination
*/
page?: number;
/**
* Sorting direction. Sorting
*/
orderDirection?: "asc" | "desc";
/**
* Order by property. Sorting
*/
orderBy?: "createdAt" | "updatedAt" | "amount";
/**
* Created at = start date. Filtering
*/
startDate?: string;
/**
* Created at = end date. Filtering
*/
endDate?: string;
/**
* Max amount. Filtering
*/
maxAmount?: number;
/**
* Min amount. Filtering
*/
minAmount?: number;
/**
* Is active. Filtering
*/
isActive?: boolean;
/**
* Escrow that you are looking for. Filtering
*/
title?: string;
/**
* Engagement ID. Filtering
*/
engagementId?: string;
/**
* Status of the single-release escrow. Filtering
*/
status?: SingleReleaseEscrowStatus;
/**
* Type of the escrow. Filtering
*/
type?: EscrowType;
/**
* If true, the escrows will be validated on the blockchain to ensure data consistency.
* This performs an additional verification step to confirm that the escrow data
* returned from the indexer matches the current state on the blockchain.
* Use this when you need to ensure the most up-to-date and accurate escrow information.
* If you active this param, your request will take longer to complete.
*/
validateOnChain?: boolean;
/**
* Role of the user. Required
*/
role: Role;
/**
* Address of the owner of the escrows. If you want to get all escrows from a specific role, you can use this parameter. But with this parameter, you can't use the signer parameter.
*/
roleAddress: string;
};
import { Date, EscrowType, Status } from "./types";
import {
Flags,
MultiReleaseEscrow,
MultiReleaseMilestone,
Roles,
SingleReleaseEscrow,
SingleReleaseMilestone,
Trustline,
} from "./types.entity";
/**
* Escrow's Response like fund, release, change, etc ...
*/
export type EscrowRequestResponse = {
/**
* Status of the request
*/
status: Status;
/**
* Unsigned transaction
*/
unsignedTransaction?: string;
};
/**
* Send Transaction Response
*/
export type SendTransactionResponse = {
/**
* Status of the request
*/
status: Status;
/**
* Message of the request
*/
message: string;
};
/**
* Initialize Escrow Response
*/
export type InitializeSingleReleaseEscrowResponse = EscrowRequestResponse & {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Escrow data
*/
escrow: SingleReleaseEscrow;
/**
* Message of the request
*/
message: string;
};
/**
* Initialize Multi Release Escrow Response
*/
export type InitializeMultiReleaseEscrowResponse =
InitializeSingleReleaseEscrowResponse & {
/**
* Escrow data
*/
escrow: MultiReleaseEscrow;
};
/**
* Update Escrow Response
*/
export type UpdateSingleReleaseEscrowResponse =
InitializeSingleReleaseEscrowResponse;
/**
* Update Multi Release Escrow Response
*/
export type UpdateMultiReleaseEscrowResponse =
InitializeMultiReleaseEscrowResponse;
/**
* Get Balances Response
*/
export type GetEscrowBalancesResponse = {
/**
* Address of the escrow
*/
address: string;
/**
* Balance of the escrow
*/
balance: number;
};
/**
* Get Escrows From Indexer Response
*/
export type GetEscrowsFromIndexerResponse = {
signer?: string;
contractId?: string;
engagementId: string;
title: string;
roles: Roles;
description: string;
amount: number;
platformFee: number;
balance?: number;
milestones:
| SingleReleaseMilestone[]
| (MultiReleaseMilestone[] & { disputeStartedBy: Roles });
flags?: Flags;
trustline: Trustline & { name: string };
receiverMemo?: number;
disputeStartedBy?: string;
fundedBy?: string;
isActive?: boolean;
approverFunds?: string;
receiverFunds?: string;
user: string;
createdAt: Date;
updatedAt: Date;
type: EscrowType;
};
/**
* Response for updating escrow from transaction hash
*/
export type UpdateFromTxHashResponse = {
/**
* Status of the request
*/
status: "SUCCESS" | "FAILED";
/**
* Message describing the result
*/
message: string;
};{
"txHash": "your-txHash-value"
}/**
* Single Release Initialize Escrow Payload
*/
export type InitializeSingleReleaseEscrowPayload = {
/**
* Address of the user signing the contract transaction
*/
signer: string;
/**
* Unique identifier for the escrow
*/
engagementId: string;
/**
* Name of the escrow
*/
title: string;
/**
* Roles that make up the escrow structure
*/
roles: {
/**
* Address of the entity requiring the service.
*/
approver: string;
/**
* Address of the entity providing the service.
*/
serviceProvider: string;
/**
* Address of the entity that owns the escrow
*/
platformAddress: string;
/**
* Address of the user in charge of releasing the escrow funds to the service provider.
*/
releaseSigner: string;
/**
* Address in charge of resolving disputes within the escrow.
*/
disputeResolver: string;
/**
* Address where escrow proceeds will be sent to
*/
receiver: string;
};
/**
* Text describing the function of the escrow
*/
description: string;
/**
* Amount to be transferred upon completion of escrow milestones
*/
amount: number;
/**
* Commission that the platform will receive when the escrow is completed
*/
platformFee: number;
/**
* Flags validating certain escrow life states
*/
flags?: {
/**
* Flag indicating that an escrow is in dispute.
*/
disputed?: boolean;
/**
* Flag indicating that escrow funds have already been released.
*/
released?: boolean;
/**
* Flag indicating that a disputed escrow has already been resolved.
*/
resolved?: boolean;
/**
* Flag indicating whether a milestone has been approved by the approver.
*/
approved?: boolean;
};
/**
* Information on the trustline that will manage the movement of funds in escrow
*/
trustline: {
/**
* Public address establishing permission to accept and use a specific token.
*/
address: string;
/**
* Official abbreviation representing the token in wallets, exchanges, and documentation.
*/
symbol: string;
};
/**
* Objectives to be completed to define the escrow as completed
*/
milestones: {
/**
* Text describing the function of the milestone
*/
description: string;
}[];
};/**
* Multi Release Initialize Escrow Payload
*/
export type InitializeMultiReleaseEscrowPayload = {
/**
* Address of the user signing the contract transaction
*/
signer: string;
/**
* Unique identifier for the escrow
*/
engagementId: string;
/**
* Name of the escrow
*/
title: string;
/**
* Roles that make up the escrow structure (without receiver, as each milestone has its own receiver)
*/
roles: {
/**
* Address of the entity requiring the service.
*/
approver: string;
/**
* Address of the entity providing the service.
*/
serviceProvider: string;
/**
* Address of the entity that owns the escrow
*/
platformAddress: string;
/**
* Address of the user in charge of releasing the escrow funds to the service provider.
*/
releaseSigner: string;
/**
* Address in charge of resolving disputes within the escrow.
*/
disputeResolver: string;
};
/**
* Text describing the function of the escrow
*/
description: string;
/**
* Commission that the platform will receive when the escrow is completed
*/
platformFee: number;
/**
* Information on the trustline that will manage the movement of funds in escrow
*/
trustline: {
/**
* Public address establishing permission to accept and use a specific token.
*/
address: string;
/**
* Official abbreviation representing the token in wallets, exchanges, and documentation.
*/
symbol: string;
};
/**
* Objectives to be completed to define the escrow as completed
*/
milestones: {
/**
* Text describing the function of the milestone
*/
description: string;
/**
* Amount to be transferred upon completion of this milestone
*/
amount: number;
/**
* Address where milestone proceeds will be sent to
*/
receiver: string;
}[];
};/**
* Single Release Escrow
*/
export type SingleReleaseEscrow = {
/**
* Address of the user signing the contract transaction
*/
signer: string;
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Unique identifier for the escrow
*/
engagementId: string;
/**
* Name of the escrow
*/
title: string;
/**
* Roles that make up the escrow structure
*/
roles: Roles;
/**
* Text describing the function of the escrow
*/
description: string;
/**
* Amount to be transferred upon completion of escrow milestones
*/
amount: number;
/**
* Commission that the platform will receive when the escrow is completed
*/
platformFee: number;
/**
* Amount of the token (XLM, USDC, EURC, etc) in the smart contract.
*/
balance: number;
/**
* Objectives to be completed to define the escrow as completed
*/
milestones: SingleReleaseMilestone[];
/**
* Flags validating certain escrow life states
*/
flags?: Flags;
/**
* Information on the trustline that will manage the movement of funds in escrow
*/
trustline: Trustline;
};
/**
* Multi Release Escrow
*/
export type MultiReleaseEscrow = Omit<
SingleReleaseEscrow,
"milestones" | "flags" | "amount" | "roles"
> & {
milestones: MultiReleaseMilestone[];
roles: Omit<Roles, "receiver">;
};/**
* Milestone
*/
type BaseMilestone = {
/**
* Text describing the function of the milestone.
*/
description: string;
/**
* Milestone status. Ex: Approved, In dispute, etc...
*/
status?: string;
/**
* Evidence of work performed by the service provider.
*/
evidence?: string;
};
/**
* Single Release Milestone
*/
export type SingleReleaseMilestone = BaseMilestone & {
/**
* Approved flag, only if the escrow is single-release
*/
approved?: boolean;
};
/**
* Multi Release Milestone
*/
export type MultiReleaseMilestone = BaseMilestone & {
/**
* Amount to be transferred upon completion of this milestone
*/
amount: number;
/**
* Address where milestone proceeds will be sent to
*/
receiver: string;
/**
* Flags validating certain milestone life states, only if the escrow is multi-release
*/
flags?: Flags;
};/**
* Trustline
*/
export type Trustline = {
/**
* Symbol of the token, example: USDC, EURC, etc...
*/
symbol: string;
/**
* Public address establishing permission to accept and use a specific token.
*/
address: string;
};/**
* Flags
*/
export type Flags = {
/**
* Flag indicating that an escrow is in dispute.
*/
disputed?: boolean;
/**
* Flag indicating that escrow funds have already been released.
*/
released?: boolean;
/**
* Flag indicating that a disputed escrow has already been resolved.
*/
resolved?: boolean;
/**
* Flag indicating whether a milestone has been approved by the approver.
*/
approved?: boolean;
};
/**
* Roles
*/
export type Roles = {
/**
* Address of the entity requiring the service.
*/
approver: string;
/**
* Address of the entity providing the service.
*/
serviceProvider: string;
/**
* Address of the entity that owns the escrow
*/
platformAddress: string;
/**
* Address of the user in charge of releasing the escrow funds to the service provider.
*/
releaseSigner: string;
/**
* Address in charge of resolving disputes within the escrow.
*/
disputeResolver: string;
/**
* Address where escrow proceeds will be sent to (In the “Multi-Release” version,
this role is at the milestone level.)
*/
receiver: string;
};
/**
* Role
*/
export type Role =
| "approver"
| "serviceProvider"
| "platformAddress"
| "releaseSigner"
| "disputeResolver"
| "receiver"
| "signer";This is the developer documentation for Trustless Work.
Trustless Work is Escrow-as-a-Service (EaaS) for stablecoin escrow. Build non-custodial flows with milestones, approvals, and disputes. Contracts run on Stellar (Soroban). Your app drives them via API or SDK.
Hold funds in escrow using non-custodial smart contracts.
Add programmable release logic to your app or marketplace.
Support milestones, approvals, partial releases, and disputes.
Configure roles and permissions per signer.
Launch faster without writing escrow contracts from scratch.
Marketplace escrow for e-commerce and services.
Freelance and contract escrow with milestone payouts.
Security deposits for rentals and reservations.
Crowdfunding and pre-orders with conditional payouts.
Grants and programmatic disbursements.
Trustless Work supports multiple escrow types, each tailored for different workflows. Whether you're building a marketplace, a grant platform, or a gig app, choosing the right escrow logic helps you balance simplicity, flexibility, and trust.
A Single-Release Escrow holds funds until all milestones (verifiable checkpoints, like "design done" or "code deployed") are completed and approved. Only then is the entire amount released in one go. It’s built for projects where trust builds across multiple steps but payout happens once.
Build it like this:
Deposit: Funds are locked upfront by any party (e.g., a client) via a Stellar wallet.
Milestone Completion: The Service Provider (e.g., a freelancer) marks each milestone complete (e.g., "Logo delivered," "Site live").
Approval & Release: The Approver (e.g., the client) verifies all milestones. Once all are signed off, the Release Signer (e.g., the platform) releases the full amount to the Receiver, minus any Platform fee.
Example: A freelancer on a marketplace delivers a website (milestones: wireframe, design, launch). The buyer (Approver) confirms all are done, and the platform (Release Signer) releases the full payment.
A Multi-Release Escrow releases funds incrementally as each milestone is completed and approved. It’s designed for staged projects where trust and payments build step-by-step, reducing risk.
Build it like this:
Deposit: Funds are deposited upfront or in parts via Stellar wallets.
Milestone Completion & Review: The Service Provider (e.g., a DAO contributor) marks each milestone complete (e.g., "Prototype built"). The Approver (e.g., DAO voters) reviews each.
Incremental Release: For each approved milestone, the Release Signer (e.g., the platform) releases that milestone’s portion of funds to the Receiver. Dispute Resolvers handle conflicts, adjusting amounts or canceling if needed. (Note: Per-milestone payouts are coming, per doc.)
Example: A DAO funds a developer for a project (milestones: code v1, v2, v3). Each milestone’s approval releases a portion of stablecoins, with a Dispute Resolver stepping in if voters contest progress.
Why use it?
✅ Flexible: Pay per milestone, not all at once.
Aspect
Single-Release
Multi-Release
Payouts
All at once, post all milestones
Per milestone
Use Case
Freelance with staged checks
Use Single-Release to get started fast.
Use Multi-Release when you need milestone-based control.
All escrows are non-custodial, programmable, and stablecoin-native.
Here are two minimal JSON snippets that highlight the structural difference between Single-Release and Multi-Release escrows. These aren’t full schemas, just the essentials so a builder can “see it” at a glance.
{
"contractId": "C...ESCROWADDRESS",
"engagementId": "order-123",
"title": "Website Development",
"description": "Build and deliver a marketing website",
"roles": {
"approver": "G...CLIENT",
"serviceProvider": "G...FREELANCER",
"releaseSigner": "G...SIGNER",
"platformAddress": "G...PLATFORM",
"disputeResolver": "G...RESOLVER",
"receiver": "G...FREELANCER"
},
"amount": 1000,
"platformFee": 0.5,
"milestones": [
{
"description": "Deliver homepage design",
"status": "Approved",
"approved": true
},
{
"description": "Deploy full website",
"status": "Pending",
"approved": false
}
],
"flags": {
"disputed": false,
"released": false,
"resolved": false
},
"trustline": {
"address": "G...USDCISSUER",
}
}👉 Even with multiple milestones, all must be approved before the single payout of 1000 USDC is released.
{
"contractId": "C...ESCROWADDRESS",
"engagementId": "grant-456",
"title": "Research Grant",
"description": "Funding project in two phases",
"roles": {
"approver": "G...FUNDER",
"serviceProvider": "G...RESEARCHER",
"releaseSigner": "G...SIGNER",
"platformAddress": "G...PLATFORM",
"disputeResolver": "G...RESOLVER",
},
"platformFee": 0.5,
"milestones": [
{
"description": "Submit interim report",
"amount": 500,
"status": "Approved",
"flags": { "approved": true, "released": true, "disputed": false, "resolved": false },
"receiver": "G...RESEARCHER"
},
{
"description": "Publish final report",
"amount": 500,
"status": "Pending",
"flags": { "approved": false, "released": false, "disputed": false, "resolved": false },
"receiver": "G...RESEARCHER"
}
],
"trustline": {
"address": "G...USDCISSUER",
}
}👉 Here, each milestone has its own amount and flags. Funds are released milestone-by-milestone (500 + 500).
The escrow lifecycle is the structured flow of actions and responsibilities that secure a transaction. At Trustless Work, we break this into clear phases, ensuring transparency, adaptability, and cons
The foundation of the escrow:
Roles and responsibilities are defined
Transaction terms (amount, milestones, fees, trustline) are set
The escrow contract is created on-chain
Anyone can deposit funds
Once funded, the escrow is live and ready for milestone tracking
Marked as completed
Optional evidence or proof can be added
Provides visibility for review
Milestones are reviewed by the Approver.
Can approve if conditions are met
Can raise a dispute if unsatisfied
Approval moves the escrow closer to payout.
The Release Signer authorizes payout.
Single-Release → all milestones must be approved before one payout
Multi-Release → funds are released milestone by milestone
Funds are transferred to the Receiver, minus any platform fee.
If any party raises a dispute, the lifecycle takes a detour:
Dispute Resolver steps in to resolve the conflict
Can redirect funds, adjust milestones, or cancel the escrow
Outcomes can be:
Full refund to client
Partial refund
No refund (funds go to provider)

The Release Phase is where everything comes together — approvals turn into payouts, and logic turns into money movement. This is the only phase that actually moves funds out of the escrow and into the hands of the receivers.
It’s also the most restricted phase:
Only the Release Signer can execute the release.
Every escrow designates one address as the Release Signer. That wallet — and only that wallet — can authorize the transfer of funds out of the escrow contract.
Depending on your workflow, this role can be configured in two main ways:
As a “push” model — the platform or a neutral signer triggers the release to the receiver.
As a “claim” model — the receiver is also the release signer, meaning they can claim their own funds once approved.
Both options are valid, and each suits a different kind of use case:
Freelance marketplaces
Push
Platform acts as release signer, paying out after approval
Escrow-based payouts or grants
Claim
The escrow enforces strict verification before funds can move.
All milestones must have their approved flag set to true.
No milestone can be in dispute.
Once verified, the contract releases the entire escrowed amount (minus fees) to the receiver.
Only the milestone(s) being released need to be approved.
Each milestone can be released independently.
The contract disburses only the approved milestone’s amount to its corresponding receiver.
🧩 In essence:
Single-Release: “Release everything.”
Multi-Release: “Release just this part.”
When the Release Signer executes the transaction:
The contract verifies all conditions.
It calculates deductions:
Platform Fee (set during initiation, e.g., 1%)
Trustless Work Fee (protocol fee, fixed at 0.3%)
It transfers the remaining balance to the receiver’s address.
It updates the milestone (or entire escrow) with:
released: true
A release transaction hash (visible on-chain).
This event becomes a permanent, auditable record of payout completion.
The Release Signer (platform or operator) sends funds out proactively.
Ideal for platforms that handle fund flow on behalf of users.
Provides an extra layer of control and compliance.
The Receiver is also the Release Signer.
They simply “claim” their approved funds directly from escrow.
Ideal for trust-minimized environments, grants, or bounty-style setups.
🧠 Both flows coexist within Trustless Work. The release logic doesn’t care who presses the button — only that the signer has permission.
Every release emits a Release Event — a blockchain record containing:
The escrow ID (contract address)
The milestone(s) released
The receiver address
Amount sent
Platform and protocol fees deducted
You can view these transparently through:
Escrow Viewer — human-readable milestone and release records
Stellar Expert — raw transaction details for verification and audit trails
By the end of this phase:
The approved milestones (or full escrow) have been paid out.
Platform and Trustless Work fees have been distributed.
The escrow contract updates its flags (released: true) accordingly.
A complete payout record is available both on-chain and in the Viewer.
💡 The Release Phase is where trust becomes settlement — money leaves the neutral zone and reaches its rightful destination.

No matter how well-designed a process is, disagreements happen. That’s why every Trustless Work escrow includes a final safeguard: Dispute Resolution.
This phase ensures that when parties disagree on delivery or results, funds don’t vanish into uncertainty. They stay locked in the escrow until a Dispute Resolver decides where they should go.
The Dispute Resolver is the only address authorized to intervene once a dispute is raised. This role represents a neutral authority — it can be:
A platform’s customer support team mediating between users
A DAO-based arbitration module
A trusted third party or auditor
Or, in advanced setups, a decentralized dispute resolution DAO
The resolver’s job is to review both sides, look at the evidence, and decide how the locked funds will be distributed.
Disputes can be triggered by either:
The Service Provider (e.g., claiming they delivered as promised), or
The Approver (e.g., claiming the work was unsatisfactory).
Once raised:
The milestone or escrow’s disputed flag is set to true.
The contract enters a locked state — meaning no further releases can happen until it’s resolved.
All updates and evidence remain visible on-chain for transparency.
The Dispute Resolver signs a resolution transaction that includes:
A list of addresses and amounts to re-route the funds to.
Optional evidence or reasoning (usually an off-chain link or case reference).
💡 This flexible format replaces the older binary system (refund or payout). It allows more nuanced outcomes — partial refunds, multi-party settlements, or even new allocations in special cases (like shared credit lines or pooled contributions).
Every resolution is publicly verifiable and immutable:
The contract emits a Resolution Event containing all the distributions.
These amounts become part of the escrow’s historical record.
Anyone can inspect who received what, when, and why.
This creates transparent, tamper-proof accountability — essential for platforms that need audit trails, regulatory compliance, or internal oversight.
You can verify resolution details directly in:
Escrow Viewer — structured breakdown of resolution outcomes
Stellar Expert — raw transaction data and event logs
Depending on the ecosystem, the Dispute Resolver can be implemented in different ways:
Marketplace or SaaS Platform
Platform’s customer support team
Upwork, Fiverr-style review desk
Grants or DAOs
Governance contract or arbitration module
🧩 The role is flexible — the key is that the resolver’s actions are traceable, transparent, and signed.
Resolvers can attach evidence to their decisions — for example:
Case reports
Proof of refund agreements
Links to decentralized storage (IPFS, Arweave, Filecoin)
Trustless Work stores only the reference (the URL or hash), not the file itself. This keeps the on-chain data light while preserving a full trail of proof.
By the end of this phase:
The Dispute Resolver has signed and submitted a resolution transaction.
Funds have been re-routed according to the distribution list.
The escrow’s resolved flag is set to true.
All movements are publicly visible and auditable.
💡 The Dispute Phase proves that even in disagreement, trust can remain programmable. No hidden decisions — every outcome is on-chain, traceable, and final.
Most platforms don’t need to “go fully on-chain.” What they need is programmable trust—a neutral, verifiable layer that handles what matters most: custody, release logic, and auditability.
That’s what Trustless Work provides. We let you decide how decentralized you want to go — from a quick no-code back office setup to a fully automated, API-driven architecture.
Traditional escrows live in someone else’s infrastructure — you trust the platform or a third-party agent to hold and release funds. In Trustless Work, the escrow itself is the infrastructure. Each one is an independent smart contract that holds logic, roles, and balances directly on the Stellar blockchain.
This design gives you:
Transparency — anyone can verify the escrow in real time.
Composability — you can plug this logic into your own stack.
Control — you decide how much you abstract or automate.
1. Smart Contract Layer
Soroban Escrow Contract
Core logic for milestones, roles, and fund releases.
Everyone — the foundation
Each tool works independently, but connects seamlessly through the same escrow contracts and API logic.
Not every company will deploy the entire stack. That’s why Trustless Work is hybrid by design — you can start manual, add automation later, or plug in your own UI at any time.
1. Back Office–First
Launch without writing code. Use the Back Office to deploy escrows, define roles, and manage releases. Then embed escrow status widgets or Viewer links on your own landing pages.
→ Best for pilots, MVPs, or early marketplaces.
2. Hybrid API + Back Office
Create escrows through the API (from your app), but handle approvals or disputes in the Back Office. Combine your UX with our governance layer.
→ Best for platforms that want control, without managing every on-chain flow.
3. Transparency Add-On
Keep your existing payment flow, but connect your users to the Escrow Viewer for proof-of-funds and progress tracking.
→ Best for compliance-heavy or high-trust environments.
4. Template Fork
Fork the Demo dApp or Back Office, rebrand it, integrate your wallet provider or custom logic, and ship fast.
→ Best for startups or teams that want to own the UI but use our underlying logic.
Scenario: A freelance marketplace wants to add milestone-based payments.
They deploy escrows in the Back Office.
Use their own frontend (built in Next.js) to list jobs and show milestone progress.
Embed the Escrow Viewer link for each job to give users transparent proof-of-funds.
When ready to scale, they integrate the API to automate escrow creation and releases.
No blockchain devs. No audits. Just composable infrastructure.
Decentralization = Independence You’re not locked into a vendor or a custodial middleman. The contract exists on-chain, and your users can verify it anytime.
Hybrid = Speed You can start no-code and move to code later. Back Office today, API tomorrow — same logic, same escrows.
Transparency = Trust The Viewer turns every transaction into a live proof-of-funds page. Users don’t have to take your word — they can see the escrow themselves.
Trustless Work isn’t just an escrow API — it’s an architecture for programmable trust. You can centralize your UX while decentralizing your money flow. You can use our Back Office as your admin layer, the Viewer as your transparency layer, and the API as your automation layer — all connected to the same on-chain contracts.
You own the experience. The blockchain owns the trust.
Testnet tokens are virtual assets used on Stellar's test network (testnet) to:
Test wallet setups.
Experiment with sending and receiving payments.
Learn Stellar operations like creating trustlines or setting up smart contracts.
Risk-Free Learning: No monetary value; perfect for practice.
Development Testing: Test your applications or smart contracts before deploying on the mainnet.
Community Access: Many developers and testers rely on the testnet for Stellar experiments.
Go to the Stellar Laboratory: Stellar Laboratory
Paste your Public Key into the faucet's input field.
Click "Request Lumens":
You’ll receive a transaction confirmation.
Check your wallet to confirm receipt of 10,000 XLM test tokens.
Install the Stellar CLI:
Install the stellar-core or stellar-horizon command-line tool (refer to Stellar documentation).
Request Tokens:
Run the following command:
Replace <Your Public Key> with your Stellar wallet address.
Verify Balance:
Use the CLI or a Stellar wallet to check your testnet account balance.
Set the Trustline: Ensure you've established a trustline for USDC on your Stellar testnet account. Issuer: GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5
Visit the Circle USDC Faucet:
Go to Circle USDC Faucet.
Select Stellar and Request USDC:
Use the dropdown menu to select "Stellar".
Paste your Stellar testnet address.
Click on "Get Tokens" to receive testnet USDC.
Send tokens between test accounts.
Experiment with memo fields, transaction fees, and multi-signature setups.
Trustlines: Use testnet tokens to create trustlines for custom assets.
Asset Issuance: Test issuing and trading custom assets.
Smart Contracts: Experiment with Stellar's pre-signed transactions to simulate smart contracts.
Use your testnet wallet with Stellar-based dApps like Trustless Work to test integrations.
Testnet Tokens Have No Value:
These tokens are strictly for testing and cannot be transferred to the mainnet.
Testnet Environment Resets:
The Stellar testnet resets periodically, clearing all test accounts and balances.
Always re-create your accounts and re-fund them when the testnet resets.
Avoid Sharing Secret Keys:
Even in a test environment, keep your Secret Key secure to mimic best practices for the mainnet.
Ensure you’ve used the correct Public Key.
Try another method (e.g., Stellar Faucet vs. Laboratory).
Wait for a few minutes as the testnet might experience delays.
Make sure your wallet supports Stellar’s testnet.
Check for updates or consider using a wallet that supports testnet, like Freighter or Rabet.
Without the Secret Key, you cannot access your testnet account. Treat it as you would a real wallet key.
By following this guide, you can confidently explore Stellar’s testnet and test a variety of operations risk-free.
Start building on Trustless Work with the REST API or SDKs.
Trustless Work is Escrow-as-a-Service on Stellar (Soroban).
Use it to deploy escrows, fund them, track milestones, and release funds. Your app drives the flow via REST API or SDKs.
Use this if you want full control and you’re already signing Stellar transactions.
Use this if you want typed hooks for every escrow action.
Use this if you want ready-made UI blocks and wallet connectivity.
Use it to request API keys and test flows end-to-end.
Request an API Key to interact with all the endpoints.
To interact with the Trustless Work API, you’ll need to generate an API Key. This key authenticates your requests and links them to your verified wallet identity. Overview: API keys are managed directly in the Trustless Work BackOffice dApp. They are required only if you plan to interact programmatically with the API — you don’t need one for using the dApp interface itself.
To begin, connect a Stellar-compatible wallet (such as Freighter, Albedo, or xBull) to the dApp. You’ll be prompted to sign a message — this confirms ownership of your wallet and automatically creates your user profile.
If you’ve never used a Stellar wallet before, check out the Stellar Wallets section for setup instructions.
Stellar WalletsOnce logged in:
Click your wallet address at the bottom-left corner.
Select Settings from the menu.
Fill out your profile with basic details — name, email, and use case.
The Use Case field is required before you can generate an API key.
This helps us understand your integration goals and provide better support.
💡 Tip: You can always update your profile later to reflect new projects or integrations.
In the Settings sidebar, navigate to the API Keys tab:
Choose a Network:
Testnet — For development and testing
Mainnet — For production (available post-audit)
Click Request API Key to generate a new key.
Copy it immediately — once you close the dialog, it cannot be viewed again for security reasons. You’ll need to generate a new one if lost.
⚠️ You must confirm that you’ve copied the key before exiting the dialog.
You must have at least the use case filled, if not, the system won't give you the API Key.
Connect Wallet
Log in and sign to create your profile.
Complete Profile
Fill in personal info and use case (required).
Request Key
Once you have your API key, you can start interacting with the Trustless Work API to:
Deploy and fund escrows
Mark milestones as complete
Approve, dispute, or release payments
Query escrow status and balances
Explore the section to see available endpoints.
How to get started in Trustless Work API REST
The Trustless Work REST API lets you create and manage decentralized escrow contracts on Stellar using Soroban smart contracts.
Use it to deploy escrows, fund them, track milestones, and release funds.
https://api.trustlesswork.comhttps://dev.api.trustlesswork.comDeploy escrows with roles, milestones, and conditions.
Fund escrows using Stellar assets (example: USDC).
Approve / update milestones to drive releases.
Dispute and resolution flows (escrow-level or milestone-level).
Release funds only when conditions are met.
Query status for escrows, milestones, and balances.
Single-release escrow
One release action for the full amount.
Multi-release escrow
Multiple milestone payouts.
Each milestone can be approved, disputed, and released independently.
Limit: 50 requests per 60 seconds per client.
Actions are role-gated (approve, dispute, resolve, release).
Use Swagger for the full spec. These groups cover most integrations:
/deployer/single-release
/deployer/multi-release
/escrow/{type}/fund-escrow
/escrow/{type}/approve-milestone
/escrow/{type}/change-milestone-status
/escrow/{type}/release-funds (single)
/escrow/{type}/release-milestone-funds (multi)
/escrow/{type}/dispute-escrow
/escrow/{type}/resolve-dispute
/escrow/{type}/dispute-milestone (multi)
/escrow/{type}/resolve-milestone-dispute (multi)
/escrow/{type}/update-escrow
/escrow/get-multiple-escrow-balance
/helper/get-escrows-by-signer
/helper/get-escrows-by-role
/helper/set-trustline
/helper/send-transaction
Mainnet charges a 0.3% protocol fee.
Deploy the escrow contract and define the escrow properties.
Content-Type
application/json
x-api-key
<token>
description
string
Text describing the function of the milestone
status
string (Default value: "peding")
Milestone status. Ex: Approved, In dispute, etc...
approved
boolean (Default value: false)
Flag indicating whether a milestone has been approved by the approver
approver
string
Address of the entity requiring the service.
serviceProvider
string
Address of the entity providing the service.
plataformAddress
string
Address of the entity that owns the escrow
releaseSigner
string
Address of the user in charge of releasing the escrow funds to the service provider.
disputeResolver
string
Address in charge of resolving disputes within the escrow.
receiver
string
Address where escrow proceeds will be sent to
address
string
Public address establishing permission to accept and use a specific token.
symbol
string
Official abbreviation representing the token in wallets, exchanges, and documentation.

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
// Execute the endpoint
const response = await http.post(
"/deployer/single-release",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}Allows users to deposit funds into an existing escrow contract, securing them until the agreed conditions are met.
Content-Type
application/json
x-api-key
<token>

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
const response = await http.post(
"/escrow/single-release/fund-escrow",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}Responsible for approving the milestone through the escrow approver.
Content-Type
application/json
x-api-key
<token>

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
const response = await http.post(
"/escrow/single-release/approve-milestone",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}Responsible for changing the milestone status of an escrow through the service provider.
Content-Type
application/json
x-api-key
<token>

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
const response = await http.post(
"/escrow/single-release/change-milestone-status",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}You release the escrow funds to the service provider through the approver.
Content-Type
application/json
x-api-key
<token>

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
const response = await http.post(
"/escrow/single-release/release-funds",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}Responsible for initiating a dispute in an escrow. Change the value of the flag “disputed” from “disputed” to true.
Content-Type
application/json
x-api-key
<token>

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
// Execute the endpoint
const response = await http.post(
"/escrow/single-release/dispute-escrow",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}Resolves escrow disputes by distributing funds to the approver and service provider as determined by the dispute resolver.
Content-Type
application/json
x-api-key
<token>

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
const response = await http.post(
"/escrow/single-release/resolve-dispute",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}This endpoint allows you to change the properties of an escrow as long as a series of requirements are met, which will be mentioned in this section.
Only the entity with the platform role has permissions to execute this endpoint
If an escrow has funds, the only thing the platform can do is add more milestones. The other properties cannot be modified under any circumstances.
Content-Type
application/json
x-api-key
<token>
approver
string
Address of the entity requiring the service.
serviceProvider
string
Address of the entity providing the service.
platformAddress
string
Address of the entity that owns the escrow
releaseSigner
string
Address of the user in charge of releasing the escrow funds to the service provider.
disputeResolver
string
Address in charge of resolving disputes within the escrow.
receiver
string
Address where escrow proceeds will be sent to
description
string
Text describing the function of the milestone.
status
string
Milestone status. Ex: Approved, In dispute, etc...
approved
boolean
Flag indicating whether a milestone has been approved by the approver.
disputed
boolean
Flag indicating that an escrow is in dispute.
released
boolean
Flag indicating that escrow funds have already been released.
resolved
boolean
Flag indicating that a disputed escrow has already been resolved.
address
string
Public address establishing permission to accept and use a specific token.

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
const response = await http.put(
"/escrow/single-release/update-escrow",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}Deploy the escrow contract and define the escrow properties.
Content-Type
application/json
x-api-key
<token>
description
string
Text describing the function of the milestone
status
string (Default value: "peding")
Milestone status. Ex: Approved, In dispute, etc...
approved
boolean (Default value: false)
Flag indicating whether a milestone has been approved by the approver
amount
string
Amount of the milestone
receiver
string
Address where escrow proceeds will be sent to
approver
string
Address of the entity requiring the service.
serviceProvider
string
Address of the entity providing the service.
plataformAddress
string
Address of the entity that owns the escrow
releaseSigner
string
Address of the user in charge of releasing the escrow funds to the service provider.
disputeResolver
string
Address in charge of resolving disputes within the escrow.
address
string
Public address establishing permission to accept and use a specific token.
symbol
string
Official abbreviation representing the token in wallets, exchanges, and documentation.

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
// Execute the endpoint
const response = await http.post(
"/deployer/multi-release",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}Allows users to deposit funds into an existing escrow contract, securing them until the agreed conditions are met.
Content-Type
application/json
x-api-key
<token>

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
const response = await http.post(
"/escrow/multi-release/fund-escrow",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}Responsible for modifying the "flag" property of a specific milestone in the escrow to approve that milestone.
Content-Type
application/json
x-api-key
<token>

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
const response = await http.post(
"/escrow/multi-release/approve-milestone",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}Responsible for modifying the "status" property of a specific milestone in the escrow.
Content-Type
application/json
x-api-key
<token>

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
const response = await http.post(
"/escrow/multi-release/change-milestone-status",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}You release the milestone escrow funds to the service provider through the approver.
Content-Type
application/json
x-api-key
<token>

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
const response = await http.post(
"/escrow/multi-release/release-milestone-funds",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}This function is used to withdraw funds that are stuck in escrow and cannot be withdrawn due to the way multi-release escrow works, since disputes in this case are handled at the milestone level.
In single-release escrow accounts, this endpoint is not necessary because disputes are handled at the escrow account level, so if there is any remaining balance in the contract, a dispute is opened and the remaining balance is withdrawn.
Content-Type
application/json
x-api-key
<token>

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
const response = await http.post(
"/escrow/multi-release/withdraw-remaining-funds",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}Responsible for setting the milestone in dispute state. Changes the value of the milestone's "flags.disputed" property to true.
Content-Type
application/json
x-api-key
<token>

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
// Execute the endpoint
const response = await http.post(
"/escrow/multi-release/dispute-milestone",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}Resolves escrow milestone disputes by distributing funds to the approver and service provider as determined by the dispute resolver.
Content-Type
application/json
x-api-key
<token>

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
const response = await http.post(
"/escrow/multi-release/resolve-milestone-dispute",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}This endpoint allows you to change the properties of an escrow as long as a series of requirements are met, which will be mentioned in this section.
Only the entity with the platform role has permissions to execute this endpoint
If an escrow has funds, the only thing the platform can do is add more milestones. The other properties cannot be modified under any circumstances.
Content-Type
application/json
x-api-key
<token>
approver
string
Address of the entity requiring the service.
serviceProvider
string
Address of the entity providing the service.
platformAddress
string
Address of the entity that owns the escrow
releaseSigner
string
Address of the user in charge of releasing the escrow funds to the service provider.
disputeResolver
string
Address in charge of resolving disputes within the escrow.
receiver
string
Address where escrow proceeds will be sent to
description
string
Text describing the function of the milestone.
status
string
Milestone status. Ex: Approved, In dispute, etc...
amount
boolean
Amount of the milestone
address
string
Public address establishing permission to accept and use a specific token.

This endpoint returns the transaction unsigned so that the transaction can be signed by means of a customer wallet.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
const response = await http.put(
"/escrow/multi-release/update-escrow",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}Most Trustless Work endpoints return an unsigned transaction in XDR format. This endpoint is used to sign such unsigned transactions and send them to the Stellar network.
Content-Type
application/json
x-api-key
<token>
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
// Get the signer address
const { address } = await kit.getAddress();
const response = await http.post(
"/any-endpoint",
{
// body requested for the endpoint
},
);
// Get the unsigned transaction hash
const { unsignedTransaction } = response.data;
// Sign the transaction by wallet
const { signedTxXdr } = await signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
// Send the transaction to Stellar Network <--------------- THIS
const tx = await http.post("/helper/send-transaction", {
signedXdr: signedTxXdr,
});
const { data } = tx;
return data;
}Get the balance of multiple escrows.
Content-Type
application/json
x-api-key
<token>
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async (addresses: string[]) => {
const response = await http.get("/helper/get-multiple-escrow-balance", {
params: { addresses },
});
return response;
};
Returns all the information of a security deposit requested through one or more requested contract ids.
Content-Type
application/json
x-api-key
<token>
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
const contractIds = [
"CCR6HLU3LQMXOESNA6TOS2RZKGEBWQG3EN5FMZNC43RVXZWTTDCZ...",
"CCA7WTCVCQ5JPKNIFSHPSJLJ3FJ3GKPNEVAIHP6T..."
];
const validateOnChain = true;
const params = new URLSearchParams();
contractIds.forEach(id => params.append("contractIds[]", id));
params.append("signer", signer);
params.append("validateOnChain", validateOnChain.toString());
const response = await http.get(`/helper/get-escrow-by-contract-ids?${params.toString()}`);
return response;
}Returns all the information of an escrow requested through the signer.
Content-Type
application/json
x-api-key
<token>
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
const data = await http.get(
"/escrow/single-release/get-escrows-by-signer?signer=GPUACN...." 👈🏼 // All required parameters are passed at the query level.
);
return data;
}Returns all the information of an escrow requested through the role.
Content-Type
application/json
x-api-key
<token>
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const useExample = async () => {
const data = await http.get(
"/escrow/single-release/get-escrows-by-role?role=approver?roleAddress=GPUACN...." 👈🏼 // All required parameters are passed at the query level.
);
return data;
}This endpoint allows you to change the properties of an escrow as long as a series of requirements are met, which will be mentioned in this section.
You must have the valid txHash generated from a transaction sent directly to the Stellar network.
The escrow data associated with this txHash must already exist in the internal queue.
Content-Type
application/json
x-api-key
<token>
The XDR is obtained from any transaction (not signed) generated with any of the endpoints of our REST API.
An unsigned XDR is generated and returned.
The XDR is signed externally and sent directly to Stellar.
The resulting txHash is retrieved.
The txHash is sent to /indexer/update-from-txHash.
The escrow information is retrieved from the internal queue and stored in Firebase.
import axios from "axios";
const http = axios.create({
baseURL: "https://dev.api.trustlesswork.com",
timeout: 10000,
headers: {
"Content-Type": "application/json",
"x-api-key": your_api_key,
},
});
export const updateEscrowFromTxHash = async (txHash) => {
const response = await http.post("/indexer/update-from-txHash", { txHash });
return response.data;
};A production-ready set of React blocks for integrating Trustless Work’s escrow flows.
UI blocks (cards/tables/dialogs/forms) to list and manage escrows
Providers for API config, wallet context, dialogs and amounts
TanStack Query hooks for fetching and mutating escrows
Wallet-kit helpers and error handling utilities
Use the CLI to print all available blocks:
npx trustless-work listThis is the fastest way to discover folder paths for npx trustless-work add ....
The context API is a global storage of escrows. It is used to store the escrows that are fetched from the API. It is also used to store the selected escrow.
When implementing the endpoints, we need to pass the data of a specific escrow to each endpoint. But how do we do that? Our library provides a context called EscrowContext, which includes some very important utilities. Among them areselectedEscrowand setSelectedEscrow, which allow us to do the following:
selectedEscrowCurrently, selectedEscrow holds a specific escrow that we are pointing to. With this, all the endpoint hooks interact with that state in order to extract data from it, such as contractId, roles, etc. For example, in the change status select, the milestoneIndex values are loaded based on the currently selected escrow. Therefore, ifsetSelectedEscrow is undefined, they won't load.
const { selectedEscrow } = useEscrowContext();
const handleSubmit = form.handleSubmit(async (payload) => {
/**
* Create the final payload for the change milestone status mutation
*
* @param payload - The payload from the form
* @returns The final payload for the change milestone status mutation
*/
const finalPayload: ChangeMilestoneStatusPayload = {
contractId: selectedEscrow?.contractId || '', // contractId from the selectedEscrow
milestoneIndex: payload.milestoneIndex,
newStatus: payload.status,
newEvidence: payload.evidence || undefined,
serviceProvider: walletAddress || '',
};
/**
* Call the change milestone status mutation
*
* @param payload - The final payload for the change milestone statusmutation
* @param type - The type of the escrow
* @param address - The address of the escrow
*/
await changeMilestoneStatus.mutateAsync({
payload: finalPayload,
type: selectedEscrow?.type || 'multi-release',
address: walletAddress || '',
});
}setSelectedEscrowsetSelectedEscrow stores the selected escrow in context.
Other hooks and UI blocks can then read selectedEscrow to get contractId, roles, etc.
Example: cards view stores the selected escrow before opening the details dialog.
const { setSelectedEscrow } = useEscrowContext();
const onCardClick = (escrow: Escrow) => {
setSelectedEscrow(escrow);
dialogStates.second.setIsOpen(true);
};updateEscrowOur updateEscrow function update the existing selectedEscrow in the context. It is useful to update a flag or others fields. For example, we use it to update the escrow status after a change milestone status mutation.
const { selectedEscrow, updateEscrow } = useEscrowContext();
const handleSubmit = form.handleSubmit(async (payload) => {
/**
* Call the change milestone status mutation
*
* @param payload - The final payload for the change milestone status mutation
* @param type - The type of the escrow
* @param address - The address of the escrow
*/
await changeMilestoneStatus.mutateAsync({
payload: finalPayload,
type: selectedEscrow?.type || "multi-release", // type from the selectedEscrow
address: walletAddress || "",
});
toast.success("Milestone status updated successfully");
// Update the selected escrow in the context with the new status and evidence
updateEscrow({
...selectedEscrow,
milestones: selectedEscrow?.milestones.map((milestone, index) => {
if (index === Number(payload.milestoneIndex)) {
return {
...milestone,
status: payload.status,
evidence: payload.evidence || undefined,
};
}
return milestone;
}),
});
}You can install whole folders (and all child blocks) with one command.
npx trustless-work add escrowsInstalls all escrow blocks.
npx trustless-work add escrows/single-releaseInstalls only single-release escrow blocks.
The deeper the folder path, the more specific the install.
Start broad (escrows), then narrow down as needed (escrows/single-release/...).
Trustless Work Blocks is a set of React UI blocks, hooks, and providers.
It bundles (or expects) these core libraries:
react-hook-form — Performant, flexible library for managing forms in React.
zod — TypeScript-first schema validation library.
@trustless-work/escrow — SDK for handling escrow logic in decentralized apps.
@tanstack/react-query — Data-fetching and caching library for React.
@tanstack/react-query-devtools — Developer tools for inspecting React Query state.
@hookform/resolvers — Resolvers for integrating validation libraries (like Zod) with React Hook Form.
@creit.tech/stellar-wallets-kit — Wallet connection toolkit for Stellar blockchain.
axios — Promise-based HTTP client for making API requests.
@tanstack/react-table — Headless table library for building flexible data grids.
react-day-picker — Lightweight date picker component for React.
recharts — Charting library built with React and D3.
The next step is to configure the Trustless Work provider. You need to configure the following:
baseURL: Trustless Work API URL. Use mainNet or development.
apiKey: Authorization provided by our dApp to use the API.
Create a provider that wraps your app with TrustlessWorkConfig.
"use client"; // make sure this is a client component
import React from "react";
import {
// development environment = "https://dev.api.trustlesswork.com"
development,
// mainnet environment = "https://api.trustlesswork.com"
mainNet,
TrustlessWorkConfig,
} from "@trustless-work/escrow";
interface TrustlessWorkProviderProps {
children: React.ReactNode;
}
export function TrustlessWorkProvider({
children,
}: TrustlessWorkProviderProps) {
/**
* Get the API key from the environment variables
*/
const apiKey = process.env.NEXT_PUBLIC_API_KEY || "";
return (
<TrustlessWorkConfig baseURL={development} apiKey={apiKey}>
{children}
</TrustlessWorkConfig>
);
}
You must wrap your app with these providers:
ReactQueryClientProvider
TrustlessWorkProvider
WalletProvider
If you want to use some blocks, you should wrap your app with their providers. See more in: Dependencies
Add wallet connectivity to your app:
npx trustless-work add wallet-kitExample usage in a page:
import { WalletButton } from "@/components/tw-blocks/wallet-kit/WalletButtons";
export default function HomePage() {
return (
<div className="container mx-auto py-8">
<div className="flex justify-between items-center mb-8">
<h1 className="text-3xl font-bold">My Escrows</h1>
<WalletButton />
</div>
</div>
);
}Now, you are able to interact with Trustless Work blocks.
Some blocks depend on shared modules (providers, helpers, query, etc).
Install the dependencies first.
If you skip dependencies, you’ll hit missing context errors at runtime.
Use the interactive dependency diagram to confirm what a block needs.
Applies to:
Required modules:
wallet-kit
providers
handle-errors
helpers
tanstack
escrows/single-release or escrows/multi-release or escrows/single-multi-release (depends on which actions you want enabled)
# Core
npx trustless-work add wallet-kit
npx trustless-work add tanstack
npx trustless-work add providers
# Actions (pick what you need)
npx trustless-work add escrows/single-release
# npx trustless-work add escrows/multi-release
# npx trustless-work add escrows/single-multi-release
# Optional utility modules
npx trustless-work add handle-errors
npx trustless-work add helpersAll single-release and multi-release actions (Initialize Escrow, Fund Escrow, Change Milestone Status, Approve Milestone, Release, Dispute, Resolve, Update Escrow) require:
wallet-kit
providers
handle-errors
tanstack
helpers
npx trustless-work add wallet-kit
npx trustless-work add tanstack
npx trustless-work add providers
npx trustless-work add handle-errors
npx trustless-work add helpersWrap your app with these providers, in this exact order.
Include EscrowDialogsProvider and EscrowAmountProvider when you use dialogs or amount context.
Do not reorder providers.
Most “hooks not working” issues come from provider order.
import { ReactQueryClientProvider } from "@/components/tw-blocks/providers/ReactQueryClientProvider";
import { TrustlessWorkProvider } from "@/components/tw-blocks/providers/TrustlessWork";
import { WalletProvider } from "@/components/tw-blocks/wallet-kit/WalletProvider";
import { EscrowProvider } from "@/components/tw-blocks/providers/EscrowProvider";
import { EscrowDialogsProvider } from "@/components/tw-blocks/providers/EscrowDialogsProvider";
import { EscrowAmountProvider } from "@/components/tw-blocks/providers/EscrowAmountProvider";
export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
<html lang="en">
<body>
<ReactQueryClientProvider>
<TrustlessWorkProvider>
<WalletProvider>
<EscrowProvider>
<EscrowDialogsProvider>
<EscrowAmountProvider>
{children}
</EscrowAmountProvider>
</EscrowDialogsProvider>
</EscrowProvider>
</WalletProvider>
</TrustlessWorkProvider>
</ReactQueryClientProvider>
</body>
</html>
);
}Community voting or delegated resolution
Private Credit & Finance
Escrow manager or legal agent
Adjusts amounts between borrower, lender, guarantor
P2P / Trust-Minimized Systems
Decentralized arbitration
Uses smart contracts or on-chain juries
Receivers themselves trigger withdrawal
Automated dApps or DAO tooling
Push or Claim
Logic bots or scripts trigger release conditions automatically
2. Integration Layer
Escrow API & SDK
Programmatic control from your backend or frontend.
Developers
3. Interaction Layer
Back Office dApp
Visual control panel for creating, funding, and managing escrows.
Ops, admins, non-dev teams
4. Transparency Layer
Escrow Viewer
Public, read-only audit tool for contracts on testnet or mainnet.
Compliance, users, investors
5. Experimentation Layer
Demo Lab dApp
Sandbox for learning and rapid testing.
Builders, hackathons
6. Automation Layer
AI Agents / Webhooks (coming soon)
Automate milestone checks, approvals, or payouts.
Advanced users
Grant disbursements
Complexity
Medium (multiple milestones, one release)
High (staged releases)


stellar-cli request-tokens --network testnet --public-key <Your Public Key>Generate a key from the API Keys tab.
Save Securely
Copy and store it safely — it’s shown only once.
In this section you will be able to see the outline of the types of escrow's that Trustless Work offers. With these diagrams you will be able to know the structure and properties of an escrow both in its Single-Release and Multi-Release versions.
engagementId
string
plataformAddress
string
Address of the entity that owns the escrow
releaseSigner
string
Address of the user in charge of releasing the escrow funds to the service provider.
disputeResolver
string
Address in charge of resolving disputes within the escrow.
receiver
string
Address where escrow proceeds will be sent to
evidence
string (optional)
Evidence of work performed by the service provider.
approved
boolean
Flag indicating whether a milestone has been approved by the approver.
resolved
boolean
Flag indicating that a disputed escrow has already been resolved.
description
string
Text describing the function of the escrow
roles
Roles Object
Roles that make up the escrow structure
plataformFee
number
Commission that the platform will receive when the escrow is completed
milestones
Milestone<Array>
Objectives to be completed to define the escrow as completed
trustline
Trustline Object
Information on the trustline that will manage the movement of funds in escrow
plataformAddress
string
Address of the entity that owns the escrow
releaseSigner
string
Address of the user in charge of releasing the escrow funds to the service provider.
disputeResolver
string
Address in charge of resolving disputes within the escrow.
flags
Flags Object
Flags validating certain escrow life states.
evidence
string (optional)
Evidence of work performed by the service provider.
amount
number
Amount to be transferred upon completion of escrow milestones.
receiver
string
Address where escrow proceeds will be sent to
resolved
boolean
Flag indicating that a disputed escrow has already been resolved.
approved
boolean
Flag indicating whether a milestone has been approved by the approver.
Unique identifier for the escrow
title
string
Name of the escrow
roles
Roles Object
Roles that make up the escrow structure
description
string
Text describing the function of the escrow
amount
number
Amount to be transferred upon completion of escrow milestones
plataformFee
number
Commission that the platform will receive when the escrow is completed
milestones
Milestone<Array>
Objectives to be completed to define the escrow as completed
flags
Flags Object
Flags validating certain escrow life states
trustline
Trustline Object
Information on the trustline that will manage the movement of funds in escrow
approver
string
Address of the entity requiring the service.
serviceProvider
string
description
string
Text describing the function of the milestone.
status
string
disputed
boolean
Flag indicating that an escrow is in dispute.
released
boolean
address
string
Public address establishing permission to accept and use a specific token.
symbol
string
engagementId
string
Unique identifier for the escrow
title
string
approver
string
Address of the entity requiring the service.
serviceProvider
string
description
string
Text describing the function of the milestone.
status
string
disputed
boolean
Flag indicating that an escrow is in dispute.
released
boolean
address
string
Public address establishing permission to accept and use a specific token.
symbol
string


Address of the entity providing the service.
Milestone status. Ex: Approved, In dispute, etc...
Flag indicating that escrow funds have already been released.
Official abbreviation representing the token in wallets, exchanges, and documentation.
Name of the escrow
Address of the entity providing the service.
Milestone status. Ex: Approved, In dispute, etc...
Flag indicating that escrow funds have already been released.
Official abbreviation representing the token in wallets, exchanges, and documentation.
/**
* Single Release Update Escrow Payload
*/
export type UpdateSingleReleaseEscrowPayload = {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Escrow data
*/
escrow: {
/**
* Unique identifier for the escrow
*/
engagementId: string;
/**
* Name of the escrow
*/
title: string;
/**
* Roles that make up the escrow structure
*/
roles: {
/**
* Address of the entity requiring the service.
*/
approver: string;
/**
* Address of the entity providing the service.
*/
serviceProvider: string;
/**
* Address of the entity that owns the escrow
*/
platformAddress: string;
/**
* Address of the user in charge of releasing the escrow funds to the service provider.
*/
releaseSigner: string;
/**
* Address in charge of resolving disputes within the escrow.
*/
disputeResolver: string;
/**
* Address where escrow proceeds will be sent to
*/
receiver: string;
};
/**
* Text describing the function of the escrow
*/
description: string;
/**
* Amount to be transferred upon completion of escrow milestones
*/
amount: number;
/**
* Commission that the platform will receive when the escrow is completed
*/
platformFee: number;
/**
* Objectives to be completed to define the escrow as completed
*/
milestones: {
/**
* Text describing the function of the milestone.
*/
description: string;
/**
* Milestone status. Ex: Approved, In dispute, etc...
*/
status?: string;
/**
* Evidence of work performed by the service provider.
*/
evidence?: string;
/**
* Approved flag, only if the escrow is single-release
*/
approved?: boolean;
}[];
/**
* Flags validating certain escrow life states
*/
flags?: {
/**
* Flag indicating that an escrow is in dispute.
*/
disputed?: boolean;
/**
* Flag indicating that escrow funds have already been released.
*/
released?: boolean;
/**
* Flag indicating that a disputed escrow has already been resolved.
*/
resolved?: boolean;
/**
* Flag indicating whether a milestone has been approved by the approver.
*/
approved?: boolean;
};
/**
* Information on the trustline that will manage the movement of funds in escrow
*/
trustline: {
/**
* Symbol of the token, example: USDC, EURC, etc...
*/
symbol: string;
/**
* Public address establishing permission to accept and use a specific token.
*/
address: string;
};
/**
* Whether the escrow is active. This comes from DB, not from the blockchain.
*/
isActive?: boolean;
};
/**
* Address of the user signing the contract transaction
*/
signer: string;
};/**
* Multi Release Update Escrow Payload
*/
export type UpdateMultiReleaseEscrowPayload = {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Escrow data
*/
escrow: {
/**
* Unique identifier for the escrow
*/
engagementId: string;
/**
* Name of the escrow
*/
title: string;
/**
* Roles that make up the escrow structure (without receiver, as each milestone has its own receiver)
*/
roles: {
/**
* Address of the entity requiring the service.
*/
approver: string;
/**
* Address of the entity providing the service.
*/
serviceProvider: string;
/**
* Address of the entity that owns the escrow
*/
platformAddress: string;
/**
* Address of the user in charge of releasing the escrow funds to the service provider.
*/
releaseSigner: string;
/**
* Address in charge of resolving disputes within the escrow.
*/
disputeResolver: string;
};
/**
* Text describing the function of the escrow
*/
description: string;
/**
* Commission that the platform will receive when the escrow is completed
*/
platformFee: number;
/**
* Objectives to be completed to define the escrow as completed
*/
milestones: {
/**
* Text describing the function of the milestone.
*/
description: string;
/**
* Milestone status. Ex: Approved, In dispute, etc...
*/
status?: string;
/**
* Evidence of work performed by the service provider.
*/
evidence?: string;
/**
* Amount to be transferred upon completion of this milestone
*/
amount: number;
/**
* Address where milestone proceeds will be sent to
*/
receiver: string;
/**
* Flags validating certain milestone life states, only if the escrow is multi-release
*/
flags?: {
/**
* Flag indicating that an escrow is in dispute.
*/
disputed?: boolean;
/**
* Flag indicating that escrow funds have already been released.
*/
released?: boolean;
/**
* Flag indicating that a disputed escrow has already been resolved.
*/
resolved?: boolean;
/**
* Flag indicating whether a milestone has been approved by the approver.
*/
approved?: boolean;
};
}[];
/**
* Information on the trustline that will manage the movement of funds in escrow
*/
trustline: {
/**
* Symbol of the token, example: USDC, EURC, etc...
*/
symbol: string;
/**
* Public address establishing permission to accept and use a specific token.
*/
address: string;
};
/**
* Whether the escrow is active. This comes from DB, not from the blockchain.
*/
isActive?: boolean;
};
/**
* Address of the user signing the contract transaction
*/
signer: string;
};Step by Step Guide to implement Escrow's Single Release Lifecycle
Important
It does not work for a real use case, only for testing purposes. But if you want to implement it, you can use the code below as a reference and customize it to your needs.
Start by creating a new Next.js project with TypeScript and Tailwind CSS. In order to make easier the setup, please use the path alias with "@/":
npx create-next-app@latestNavigate to your project directory:
cd my-trustless-appInstall the main library package:
npm
npm install @trustless-work/blocksInitialize your project with the Trustless Work CLI:
npx trustless-work initWhat the init command does:
Installs shadcn/ui components (with interactive prompts)
Installs required dependencies: @tanstack/react-query, @trustless-work/escrow, axios, zod, react-hook-form, @creit.tech/stellar-wallets-kit, react-day-picker, etc.
Creates .twblocks.json configuration file
Optionally wires providers into your Next.js app/layout.tsx
Create a .env file in your project root:
.env
Add wallet connectivity to your app:
Wrap your app with the WalletProvider in your layout.tsx:
app/layout.tsx
Add wallet connectivity to your app:
app/page.tsx
Add helpers to your app:
Add Tanstack Query to your app:
Add Handle Errors to your app:
Add Providers to your app:
Add Single Release Escrows to your app:
Add Single-Multi Release Escrows to your app:
Add Escrows by Role Cards to your app:
In the code, there are some actions commented out. You can uncomment them and import them from the single-release block. See the notes in the escrows by role or by signer components.
escrows/escrows-by-role/details/Actions.tsx
escrows/escrows-by-role/details/Actions.tsx
Wrap your app with the required providers in this specific order:
app/layout.tsx
Provider Order MattersThe providers must be nested in this exact order for proper functionality.
Now, you are able to interact with the entire escrow lifecycle.
app/page.tsx
All the blocks were added, now use them!You already have all the required blocks to start using the single-release escrow lifecycle.
By using these components, you'll be able to completed the entire escrow lifecycle.
Important Usage Advice- This cards components works by role. In the filters section, you can select the role you want to see the escrows for. Based on that, the actions buttons will be rendered. - Before you start using the UI, you must add the USDC asset to your wallet. If not, you wont be able to interact with Trustless Work.
Show the wallet connection dialog:
Show the cards by role:
Show the initialize escrow dialog:
Show the escrow details dialog:
The easiest way to implement escrows in blockchain."
# Required: Your Trustless Work API key
NEXT_PUBLIC_API_KEY=your_api_key_herenpx trustless-work add wallet-kitreturn (
<WalletProvider>{children}</WalletProvider>
);"use client";
import { WalletButton } from "@/components/tw-blocks/wallet-kit/WalletButtons";
export default function Home() {
return (
<div className="font-sans grid grid-rows-[20px_1fr_20px] items-center justify-items-center min-h-screen p-8 pb-20 gap-16 sm:p-20">
<header className="flex justify-between items-center w-full">
<h2 className="text-2xl font-bold">Trustless Work</h2>
{/* Wallet Button */}
<WalletButton />
</header>
</div>
);
}npx trustless-work add helpersnpx trustless-work add tanstacknpx trustless-work add handle-errorsnpx trustless-work add providersnpx trustless-work add escrows/single-releasenpx trustless-work add escrows/single-multi-releasenpx trustless-work add escrows/escrows-by-role/cardsreturn (
<div className="flex items-start justify-start flex-col gap-2 w-full">
{/* You can add the buttons here, using the buttons from the blocks. These actions are conditional based on the escrow flags and the user roles. */}
{hasConditionalButtons && (
<div className="flex flex-col gap-2 w-full">
{/* UpdateEscrowDialog component should be rendered based on the escrow type. It means that if the selectedEscrow.type is "single-release", then the UpdateEscrowDialog (from the single-release block) component should be rendered. If the selectedEscrow.type is "multi-release", then the UpdateEscrowDialog (from the multi-release block) component should be rendered. */}
{/* {shouldShowEditButton && <UpdateEscrowDialog />} */}
{/* Works only with single-release escrows */}
{/* Only appears if the escrow has balance */}
{/* {shouldShowDisputeButton && <DisputeEscrowButton />} */}
{/* Works only with single-release escrows */}
{/* Only appears if the escrow is disputed */}
{/* {shouldShowResolveButton && <ResolveDisputeDialog />} */}
{/* Works only with single-release escrows */}
{/* Only appears if all the milestones are approved */}
{/* {shouldShowReleaseFundsButton && <ReleaseEscrowButton />} */}
</div>
)}
<FundEscrowDialog />
</div>
);// If you need both types, you should import both versions to update escrow
import { UpdateEscrowDialog } from "../../single-release/update-escrow/dialog/UpdateEscrow";
/* import { UpdateEscrowDialog as UpdateEscrowDialogMultiRelease } from "../../multi-release/update-escrow/dialog/UpdateEscrow"; */
import { FundEscrowDialog } from "../../single-multi-release/fund-escrow/dialog/FundEscrow";
import { DisputeEscrowButton } from "../../single-release/dispute-escrow/button/DisputeEscrow";
import { ResolveDisputeDialog } from "../../single-release/resolve-dispute/dialog/ResolveDispute";
import { ReleaseEscrowButton } from "../../single-release/release-escrow/button/ReleaseEscrow";
return (
<div className="flex items-start justify-start flex-col gap-2 w-full">
{/* You can add the buttons here, using the buttons from the blocks. These actions are conditional based on the escrow flags and the user roles. */}
{hasConditionalButtons && (
<div className="flex flex-col gap-2 w-full">
{/* UpdateEscrowDialog component should be rendered based on the escrow type. It means that if the selectedEscrow.type is "single-release", then the UpdateEscrowDialog (from the single-release block) component should be rendered. If the selectedEscrow.type is "multi-release", then the UpdateEscrowDialog (from the multi-release block) component should be rendered. */}
{shouldShowEditButton && <UpdateEscrowDialog />}
{/* Works only with single-release escrows */}
{shouldShowDisputeButton && <DisputeEscrowButton />}
{/* Works only with single-release escrows */}
{shouldShowResolveButton && <ResolveDisputeDialog />}
{/* Works only with single-release escrows */}
{shouldShowReleaseFundsButton && <ReleaseEscrowButton />}
</div>
)}
<FundEscrowDialog />
</div>
);import type { Metadata } from "next";
import { Geist, Geist_Mono } from "next/font/google";
import "./globals.css";
import { ReactQueryClientProvider } from "@/components/tw-blocks/providers/ReactQueryClientProvider";
import { TrustlessWorkProvider } from "@/components/tw-blocks/providers/TrustlessWork";
import { WalletProvider } from "@/components/tw-blocks/wallet-kit/WalletProvider";
import { EscrowProvider } from "@/components/tw-blocks/providers/EscrowProvider";
import { EscrowDialogsProvider } from "@/components/tw-blocks/providers/EscrowDialogsProvider";
import { EscrowAmountProvider } from "@/components/tw-blocks/providers/EscrowAmountProvider";
import { Toaster } from "@/components/ui/sonner";
const geistSans = Geist({
variable: "--font-geist-sans",
subsets: ["latin"],
});
const geistMono = Geist_Mono({
variable: "--font-geist-mono",
subsets: ["latin"],
});
export const metadata: Metadata = {
title: "Create Next App",
description: "Generated by create next app",
};
export default function RootLayout({
children,
}: Readonly<{
children: React.ReactNode;
}>) {
return (
<html lang="en">
<body
// optional: use geistSans.variable and geistMono.variable
className="antialiased"
>
<ReactQueryClientProvider>
<TrustlessWorkProvider>
<WalletProvider>
<EscrowProvider>
<EscrowDialogsProvider>
<EscrowAmountProvider>
{children}
<Toaster />
</EscrowAmountProvider>
</EscrowDialogsProvider>
</EscrowProvider>
</WalletProvider>
</TrustlessWorkProvider>
</ReactQueryClientProvider>
</body>
</html>
);
}"use client";
import { EscrowsByRoleCards } from "@/components/tw-blocks/escrows/escrows-by-role/cards/EscrowsCards";
import { InitializeEscrowDialog } from "@/components/tw-blocks/escrows/single-release/initialize-escrow/dialog/InitializeEscrow";
import { WalletButton } from "@/components/tw-blocks/wallet-kit/WalletButtons";
export default function Home() {
return (
<div className="font-sans grid grid-rows-[20px_1fr_20px] items-center justify-items-center min-h-screen p-8 pb-20 gap-16 sm:p-20">
<header className="flex justify-between items-center w-full">
<h2 className="text-2xl font-bold">Trustless Work</h2>
<WalletButton />
</header>
<main className="flex flex-col gap-[32px] row-start-2 items-center sm:items-start">
<div className="container">
<div className="flex w-full mb-4 justify-end">
<div className="flex w-1/6">
<InitializeEscrowDialog />
</div>
</div>
<EscrowsByRoleCards />
</div>
</main>
</div>
);
}
This guide will walk you through creating a comprehensive wallet management system for Stellar blockchain integration in your React/Next.js application. The system provides secure wallet connection, disconnection, and state management with persistence.
The system consists of three main components:
Wallet Provider - Global state management for wallet information
Wallet Hook - Business logic for wallet operations
Wallet Kit Configuration - Stellar blockchain integration setup
First, install the required Stellar Wallet Kit package:
Create a configuration file that sets up the Stellar Wallet Kit with support for multiple wallet types:
The Wallet Provider manages global wallet state and persists information in localStorage for better user experienc
The wallet hook encapsulates all the business logic for wallet operations, providing a clean interface for components:
Wrap your application with the WalletProvider to enable wallet state management throughout your app:
Now you can use the wallet functionality in any component. Here's an example of a wallet connection button:
Wallet information is automatically saved to localStorage
Users don't need to reconnect their wallet every time they visit your app
Seamless user experience across browser sessions
Supports multiple Stellar wallet types (Freighter, Albedo, etc.)
Easy to add new wallet modules as they become available
Users can choose their preferred wallet
Comprehensive error handling for wallet operations
Graceful fallbacks when wallet operations fail
Easy to extend with custom error notifications
Full TypeScript support with proper type definitions
IntelliSense support for better development experience
Compile-time error checking for wallet operations
Clean separation of concerns between state management and business logic
Easy to access wallet state from any component
Centralized wallet state management
TESTNET: Use during development and testing
MAINNET: Use for production applications
npm install @creit.tech/stellar-wallets-kitimport {
StellarWalletsKit,
WalletNetwork,
FREIGHTER_ID,
AlbedoModule,
FreighterModule,
} from "@creit.tech/stellar-wallets-kit";
/**
* Main configuration for Stellar Wallet Kit
* This kit supports multiple wallet types including Freighter and Albedo
* Configure for TESTNET during development and MAINNET for production
*/
export const kit: StellarWalletsKit = new StellarWalletsKit({
network: WalletNetwork.TESTNET,
selectedWalletId: FREIGHTER_ID,
modules: [new FreighterModule(), new AlbedoModule()],
});
/**
* Interface for transaction signing parameters
*/
interface signTransactionProps {
unsignedTransaction: string;
address: string;
}
/**
* Sign a Stellar transaction using the connected wallet
* This function handles the signing process and returns the signed transaction
*
* @param unsignedTransaction - The XDR string of the unsigned transaction
* @param address - The wallet address that will sign the transaction
* @returns Promise<string> - The signed transaction XDR
*/
export const signTransaction = async ({
unsignedTransaction,
address,
}: signTransactionProps): Promise<string> => {
const { signedTxXdr } = await kit.signTransaction(unsignedTransaction, {
address,
networkPassphrase: WalletNetwork.TESTNET,
});
return signedTxXdr;
};"use client";
import {
createContext,
useContext,
useState,
useEffect,
ReactNode,
} from "react";
/**
* Type definition for the wallet context
* Contains wallet address, name, and functions to manage wallet state
*/
type WalletContextType = {
walletAddress: string | null;
walletName: string | null;
setWalletInfo: (address: string, name: string) => void;
clearWalletInfo: () => void;
};
/**
* Create the React context for wallet state management
*/
const WalletContext = createContext<WalletContextType | undefined>(undefined);
/**
* Wallet Provider component that wraps the application
* Manages wallet state and provides wallet information to child components
* Automatically loads saved wallet information from localStorage on initialization
*/
export const WalletProvider = ({ children }: { children: ReactNode }) => {
const [walletAddress, setWalletAddress] = useState<string | null>(null);
const [walletName, setWalletName] = useState<string | null>(null);
/**
* Load saved wallet information from localStorage when the component mounts
* This ensures the wallet state persists across browser sessions
*/
useEffect(() => {
const storedAddress = localStorage.getItem("walletAddress");
const storedName = localStorage.getItem("walletName");
if (storedAddress) setWalletAddress(storedAddress);
if (storedName) setWalletName(storedName);
}, []);
/**
* Set wallet information and save it to localStorage
* This function is called when a wallet is successfully connected
*
* @param address - The wallet's public address
* @param name - The name/identifier of the wallet (e.g., "Freighter", "Albedo")
*/
const setWalletInfo = (address: string, name: string) => {
setWalletAddress(address);
setWalletName(name);
localStorage.setItem("walletAddress", address);
localStorage.setItem("walletName", name);
};
/**
* Clear wallet information and remove it from localStorage
* This function is called when disconnecting a wallet
*/
const clearWalletInfo = () => {
setWalletAddress(null);
setWalletName(null);
localStorage.removeItem("walletAddress");
localStorage.removeItem("walletName");
};
return (
<WalletContext.Provider
value={{ walletAddress, walletName, setWalletInfo, clearWalletInfo }}
>
{children}
</WalletContext.Provider>
);
};
/**
* Custom hook to access the wallet context
* Provides wallet state and functions to components
* Throws an error if used outside of WalletProvider
*/
export const useWalletContext = () => {
const context = useContext(WalletContext);
if (!context) {
throw new Error("useWalletContext must be used within WalletProvider");
}
return context;
};import { kit } from "@/config/wallet-kit";
import { useWalletContext } from "@/providers/wallet.provider";
import { ISupportedWallet } from "@creit.tech/stellar-wallets-kit";
/**
* Custom hook that provides wallet connection and disconnection functionality
* Integrates with the Stellar Wallet Kit and manages wallet state through context
*/
export const useWallet = () => {
// Get wallet management functions from the context
const { setWalletInfo, clearWalletInfo } = useWalletContext();
/**
* Connect to a Stellar wallet using the Wallet Kit
* Opens a modal for wallet selection and handles the connection process
* Automatically sets wallet information in the context upon successful connection
*/
const connectWallet = async () => {
await kit.openModal({
modalTitle: "Connect to your favorite wallet",
onWalletSelected: async (option: ISupportedWallet) => {
// Set the selected wallet as the active wallet
kit.setWallet(option.id);
// Get the wallet address and name
const { address } = await kit.getAddress();
const { name } = option;
// Store wallet information in the context and localStorage
setWalletInfo(address, name);
},
});
};
/**
* Disconnect from the current wallet
* Clears wallet information from the context and localStorage
* Disconnects the wallet from the Stellar Wallet Kit
*/
const disconnectWallet = async () => {
await kit.disconnect();
clearWalletInfo();
};
/**
* Handle wallet connection with error handling
* Wraps the connectWallet function in a try-catch block for better error management
*/
const handleConnect = async () => {
try {
await connectWallet();
} catch (error) {
console.error("Error connecting wallet:", error);
// You can add additional error handling here, such as showing user notifications
}
};
/**
* Handle wallet disconnection with error handling
* Wraps the disconnectWallet function in a try-catch block for better error management
*/
const handleDisconnect = async () => {
try {
await disconnectWallet();
} catch (error) {
console.error("Error disconnecting wallet:", error);
// You can add additional error handling here, such as showing user notifications
}
};
return {
connectWallet,
disconnectWallet,
handleConnect,
handleDisconnect,
};
};import { WalletProvider } from "@/providers/wallet.provider";
export default function RootLayout({
children,
}: {
children: React.ReactNode;
}) {
return (
<html lang="en">
<body>
<WalletProvider>
{children}
</WalletProvider>
</body>
</html>
);
}import { useWallet } from "@/hooks/wallet.hook";
import { useWalletContext } from "@/providers/wallet.provider";
/**
* Wallet connection/disconnection button component
* Shows different states based on wallet connection status
*/
export const WalletButton = () => {
const { handleConnect, handleDisconnect } = useWallet();
const { walletAddress, walletName } = useWalletContext();
// If wallet is connected, show disconnect option
if (walletAddress) {
return (
<div className="flex items-center gap-4">
<div className="text-sm">
<p className="font-medium">Connected: {walletName}</p>
<p className="text-gray-500">{walletAddress}</p>
</div>
<button
onClick={handleDisconnect}
className="px-4 py-2 bg-red-500 text-white rounded hover:bg-red-600"
>
Disconnect
</button>
</div>
);
}
// If wallet is not connected, show connect option
return (
<button
onClick={handleConnect}
className="px-4 py-2 bg-blue-500 text-white rounded hover:bg-blue-600"
>
Connect Wallet
</button>
);
};import { EscrowType, SingleReleaseEscrowStatus } from "./types";
import { MultiReleaseEscrow, Role, SingleReleaseEscrow } from "./types.entity";
/**
* Documentation: https://docs.trustlesswork.com/trustless-work/developer-resources/quickstart/integration-demo-project/entities
*/
// ----------------- Milestone Payloads -----------------
/**
* Single Release Milestone Payload
*/
export type SingleReleaseMilestonePayload = {
/**
* Text describing the function of the milestone
*/
description: string;
};
/**
* Multi Release Milestone Payload
*/
export type MultiReleaseMilestonePayload = {
/**
* Text describing the function of the milestone
*/
description: string;
/**
* Amount to be transferred upon completion of this milestone
*/
amount: number;
/**
* Address where milestone proceeds will be sent to
*/
receiver: string;
};
// ----------------- Initialize Escrow -----------------
/**
* Single Release Initialize Escrow Payload
*/
export type InitializeSingleReleaseEscrowPayload = Omit<
SingleReleaseEscrow,
"contractId" | "balance" | "milestones"
> & {
/**
* Objectives to be completed to define the escrow as completed
*/
milestones: SingleReleaseMilestonePayload[];
};
/**
* Multi Release Initialize Escrow Payload
*/
export type InitializeMultiReleaseEscrowPayload = Omit<
MultiReleaseEscrow,
"contractId" | "balance" | "milestones"
> & {
/**
* Objectives to be completed to define the escrow as completed
*/
milestones: MultiReleaseMilestonePayload[];
};
// ----------------- Update Escrow -----------------
/**
* Single Release Update Escrow Payload
*/
export type UpdateSingleReleaseEscrowPayload = {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Escrow data
*/
escrow: Omit<SingleReleaseEscrow, "contractId" | "signer" | "balance"> & {
/**
* Whether the escrow is active. This comes from DB, not from the blockchain.
*/
isActive?: boolean;
};
/**
* Address of the user signing the contract transaction
*/
signer: string;
};
/**
* Multi Release Update Escrow Payload
*/
export type UpdateMultiReleaseEscrowPayload = {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Escrow data
*/
escrow: Omit<MultiReleaseEscrow, "contractId" | "signer" | "balance"> & {
/**
* Whether the escrow is active. This comes from DB, not from the blockchain.
*/
isActive?: boolean;
};
/**
* Address of the user signing the contract transaction
*/
signer: string;
};
// ----------------- Change Milestone Status -----------------
/**
* Change Milestone Status Payload, this can be a single-release or multi-release
*/
export type ChangeMilestoneStatusPayload = {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Index of the milestone to be updated
*/
milestoneIndex: string;
/**
* New status of the milestone
*/
newStatus: string;
/**
* New evidence of work performed by the service provider.
*/
newEvidence?: string;
/**
* Address of the entity providing the service.
*/
serviceProvider: string;
};
// ----------------- Approve Milestone -----------------
/**
* Approve Milestone Payload, this can be a single-release or multi-release
*/
export type ApproveMilestonePayload = Omit<
ChangeMilestoneStatusPayload,
"serviceProvider" | "newStatus"
> & {
/**
* Address of the entity requiring the service.
*/
approver: string;
};
// ----------------- Start Dispute -----------------
/**
* Single Release Start Dispute Payload. This starts a dispute for the entire escrow.
*/
export type SingleReleaseStartDisputePayload = {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Address of the user signing the contract transaction
*/
signer: string;
};
/**
* Multi Release Start Dispute Payload. This starts a dispute for a specific milestone.
*/
export type MultiReleaseStartDisputePayload =
SingleReleaseStartDisputePayload & {
/**
* Index of the milestone to be disputed
*/
milestoneIndex: string;
};
// ----------------- Resolve Dispute -----------------
/**
* Resolve Dispute Payload
*/
export type SingleReleaseResolveDisputePayload = {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Address in charge of resolving disputes within the escrow.
*/
disputeResolver: string;
/**
* Distributions of the escrow amount to the receivers.
*/
distributions: [
{
/**
* Address of the receiver
*/
address: string;
/**
* Amount to be transferred to the receiver. All the amount must be equal to the total amount of the escrow.
*/
amount: number;
},
];
};
/**
* Multi Release Resolve Dispute Payload
*/
export type MultiReleaseResolveDisputePayload =
SingleReleaseResolveDisputePayload & {
/**
* Index of the milestone to be resolved
*/
milestoneIndex: string;
};
// ----------------- Withdraw Remaining Funds -----------------
/**
* Withdraw remaining funds
*/
export type WithdrawRemainingFundsPayload = SingleReleaseResolveDisputePayload;
// ----------------- Fund Escrow -----------------
/**
* Fund Escrow Payload, this can be a single-release or multi-release
*/
export type FundEscrowPayload = {
/**
* Amount to be transferred upon completion of escrow milestones
*/
amount: number;
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Address of the user signing the contract transaction
*/
signer: string;
};
// ----------------- Get Escrows From Indexer -----------------
/**
* Get Escrows From Indexer Params
*/
export type GetEscrowsFromIndexerParams = {
/**
* Page number. Pagination
*/
page?: number;
/**
* Sorting direction. Sorting
*/
orderDirection?: "asc" | "desc";
/**
* Order by property. Sorting
*/
orderBy?: "createdAt" | "updatedAt" | "amount";
/**
* Created at = start date. Filtering
*/
startDate?: string;
/**
* Created at = end date. Filtering
*/
endDate?: string;
/**
* Max amount. Filtering
*/
maxAmount?: number;
/**
* Min amount. Filtering
*/
minAmount?: number;
/**
* Is active. Filtering
*/
isActive?: boolean;
/**
* Escrow that you are looking for. Filtering
*/
title?: string;
/**
* Engagement ID. Filtering
*/
engagementId?: string;
/**
* Status of the single-release escrow. Filtering
*/
status?: SingleReleaseEscrowStatus;
/**
* Type of the escrow. Filtering
*/
type?: EscrowType;
/**
* If true, the escrows will be validated on the blockchain to ensure data consistency.
* This performs an additional verification step to confirm that the escrow data
* returned from the indexer matches the current state on the blockchain.
* Use this when you need to ensure the most up-to-date and accurate escrow information.
* If you active this param, your request will take longer to complete.
*/
validateOnChain?: boolean;
};
export type GetEscrowsFromIndexerBySignerParams =
GetEscrowsFromIndexerParams & {
/**
* Address of the user signing the contract transaction.
*/
signer: string;
};
export type GetEscrowsFromIndexerByRoleParams = GetEscrowsFromIndexerParams & {
/**
* Role of the user. Required
*/
role: Role;
/**
* Address of the owner of the escrows. If you want to get all escrows from a specific role, you can use this parameter. But with this parameter, you can't use the signer parameter.
*/
roleAddress: string;
};
export type GetEscrowFromIndexerByContractIdsParams = {
/**
* IDs (addresses) that identifies the escrow contracts.
*/
contractIds: string[];
/**
* If true, the escrows will be validated on the blockchain to ensure data consistency.
* This performs an additional verification step to confirm that the escrow data
* returned from the indexer matches the current state on the blockchain.
* Use this when you need to ensure the most up-to-date and accurate escrow information.
* If you active this param, your request will take longer to complete.
*/
validateOnChain?: boolean;
};
// ----------------- Release Funds -----------------
/**
* Single Release Release Funds Payload
*/
export type SingleReleaseReleaseFundsPayload = {
/**
* ID (address) that identifies the escrow contract
*/
contractId: string;
/**
* Address of the user in charge of releasing the escrow funds to the service provider.
*/
releaseSigner: string;
};
/**
* Multi Release Release Funds Payload
*/
export type MultiReleaseReleaseFundsPayload =
SingleReleaseReleaseFundsPayload & {
/**
* Index of the milestone to be released
*/
milestoneIndex: string;
};
// ----------------- Get Balance -----------------
/**
* Get Balance Params
*/
export type GetBalanceParams = {
/**
* Addresses of the escrows to get the balance
*/
addresses: string[];
};
// ----------------- Update From Transaction Hash -----------------
/**
* Payload for updating escrow data from a transaction hash.
*/
export type UpdateFromTxHashPayload = {
/**
* Transaction hash to be used for the update.
*/
txHash: string;
};We don’t hold your money—we hold the logic.
Trustless Work escrows are programmable trust primitives. They allow platforms, marketplaces, applications, and organizations to define how funds should be held, updated, approved, and released between different parties. An escrow is not only a place where funds sit.
It is a coordination layer between:
parties
funds
roles
milestones
status updates
approvals
release conditions
platform fees
dispute or exception flows
Before creating an escrow, the most important question is:
Who must do what before money can move?
If you can answer that clearly, you can design a good escrow.
Before choosing an escrow type or calling the API, map the transaction.
Start with four questions:
Who are the parties involved?
Where are the funds moving?
Who has permission to update, approve, and release?
What conditions must be met before funds are released?
This is the foundation of escrow design.
Trustless Work gives you the infrastructure to turn that logic into a smart escrow.
Every escrow involves parties.
Some parties fund the escrow. Some perform work. Some update status. Some approve completion. Some resolve disputes. Some release funds. Some receive funds. Some receive platform fees.
Common roles include:
Roles are assigned to addresses.
Only the address assigned to a role can perform the actions allowed for that role.
The same real-world person, organization, or wallet can sometimes hold multiple roles, but role combinations should be intentional.
For example, a freelancer may be both the Receiver and the Service Provider, but they usually should not also be the Approver of their own work.
Next, map how funds should move.
The fund direction should answer:
Who funds the escrow, and who should receive funds after the right conditions are met?
Use case: Single-release escrow
A buyer hires or purchases from a seller, freelancer, or service provider. The buyer funds the escrow. The service provider delivers the work or product. The approver validates completion. Then funds are released once.
Use case: Multi-release escrow, same receiver
A client funds a project that has multiple milestones. The same service provider receives payments progressively as each milestone is completed and approved.
Use case: Multi-release escrow, multiple receivers
A sponsor, platform, or organization funds one escrow that needs to pay different people or entities across different milestones.
A common mistake is treating status updates, approvals, and fund releases as the same thing.
In Trustless Work, these should be understood separately:
A status update tells the other parties what is happening.
Examples:
work started
paperwork submitted
shipment in transit
delivery completed
The Service Provider or Milestone Marker usually updates the milestone status.
Status updates can happen many times before a milestone reaches its final expected state.
Approval means an authorized party has validated that the agreed condition was met.
For example:
the client approves the work
the grant reviewer approves the deliverable
the buyer confirms the shipment arrived
the platform approves submitted evidence
The Approver does not simply report progress. The Approver validates completion.
Release is when funds actually move out of the escrow.
The Release Signer can only release funds after the required approval conditions have been satisfied.
This creates a clear logic chain:
In some flows, an Approver may approve a milestone before the Service Provider updates the milestone status.
This means your escrow design should not assume that status always comes before approval.
Instead, treat status and approval as related but separate pieces of state.
The release condition should depend on the required approval logic, not only on a text status.
Every Trustless Work escrow includes a role configuration. Roles determine which address can perform which action.
Current core roles include:
Roles are assigned to addresses.
Only the address assigned to a role can perform the actions allowed for that role.
Roles are only part of the escrow design.
An escrow also includes properties that describe what the escrow is, how it should be indexed, what asset is used, and what state it is in.
Common escrow properties include:
These properties help platforms connect the on-chain escrow with real-world workflows.
Trustless Work currently supports two main escrow types:
Single-Release Escrow
Multi-Release Escrow
Both use the same core idea: funds are held until defined conditions are met.
The difference is how funds are released.
A Single-Release Escrow releases funds once.
It can contain multiple milestones, but all required milestones must be approved before the final release happens.
Typical structure:
Typical flow:
Best for:
deposits
one-off jobs
simple deliveries
full project completion
Key characteristics:
A Multi-Release Escrow releases funds progressively.
Each milestone can have its own payout, and each payout can potentially go to a different receiver.
Typical structure:
Typical flow:
Best for:
grants
bounties
milestone-based funding
phased projects
Key characteristics:
The escrow lifecycle describes how an escrow moves from configuration to completion.
Canonical lifecycle:
Map parties, fund direction, roles, milestones, release conditions, and escrow type.
Create and configure the escrow.
This includes:
roles
milestones
amount
asset
The payer deposits funds into the escrow.
Possible funding states include:
unfunded
partially funded
fully funded
The Service Provider or Milestone Marker updates the milestone status.
This creates visibility into progress.
The Approver validates whether the milestone condition was met.
Approval is the key validation step before release.
The Release Signer executes the release of funds after approval conditions are met.
In a Single-Release Escrow, this usually happens once.
In a Multi-Release Escrow, this can happen milestone by milestone.
The escrow reaches a terminal state.
Possible terminal states include:
completed
cancelled
refunded
disputed
Before creating an escrow, answer these questions:
Who funds the escrow?
Who receives funds?
Is there one receiver or multiple receivers?
Who updates milestone status?
A client wants to pay a freelancer after a project is completed.
Suggested design:
Simple version:
A foundation wants to release funding progressively after deliverables are completed.
Suggested design:
Simple version:
A renter deposits funds that should be held until the rental condition is complete.
Suggested design:
Simple version:
Trustless Work is not only an escrow application.
It is infrastructure for programmable transaction coordination.
Use it when your product needs to answer:
What must happen before funds move?
If the answer involves multiple parties, milestones, approvals, or release conditions, Trustless Work can help you encode that logic into a smart escrow.
Now that you understand the escrow design model:
Define
Choose Your
Assign
Follow the
Let's understand what each role represents!
Roles define who can do what inside a Trustless Work escrow.
Anyone can deposit funds into an escrow. But only addresses with assigned roles can update milestones, approve work, release funds, or resolve disputes.
This is what makes Trustless Work escrows programmable.
Instead of assuming that one platform, company, or person controls everything, each escrow explicitly defines the addresses responsible for each action.
A good role configuration answers:
Who must do what before money can move?
An escrow is a coordination system.
Release Signer
The party that signs or triggers the release of funds
Platform Address
Can make changes before escrow is funded and receives the platform fee
Dispute Resolver
Arbitrates disputes and can re-route funds when a dispute is raised
evidence uploaded
Release Signer
Executes fund release after approval conditions are met
Dispute Resolver
Handles disputes or exception flows when flagged
Receiver
Receives released funds
Issuer
He who deploys the contract. Has no powers over the contract
Depositor
Funds the escrow but does not automatically receive contract permissions
Observer
Coming in a future version; tracks escrows without acting on them
No
Yes
No
No
no
Updates milestone progress
Approver
No required
Yes
Yes
No
No
no
Validates milestone completion
Platform Address
Before funding
No by default
No by default
No by default
No by default
Fee recipient
Can make changes before escrow is funded
Release Signer
No required
No required
No
No
Yes
no
Releases only when conditions allow
Dispute Resolver
No required
Case-specific
No required
Yes
Case-specific
No
Arbitrates and can re-route funds
Receiver
No by default
Usually no
No by default
No
No
Yes
Final destination of released funds
Issuer
No
No
No
No
No
No
Has no powers over the contract
Depositor
No
No
No
No
No
No
Incoming transactions are indexed
Observer
No
No
No
No
No
No
Future tracking role
Description
Explanation of why the escrow exists
Roles
Addresses assigned to permissions such as status updates, approvals, releases, dispute resolution, and fee reception
Milestones
Actions, deliverables, or conditions that must be completed
Amount
Total amount locked or expected in the escrow
Platform Fee
Optional configurable fee for the platform or application
Trustline / Asset
The asset used in the escrow, such as USDC or another Stellar-issued token
Flags
State indicators such as disputed, released, or resolved
final delivery before payment
Approval logic
All required milestones must be approved before release
Complexity
Lower
multi-vendor projects
long-running service agreements
Approval logic
Each milestone can be approved separately
Complexity
Higher
Does each milestone need its own payout?
No
Yes
Should all milestones be approved before payment?
Yes
Not necessarily
Is the workflow simple?
Yes
More complex
Is the workflow grant-like, bounty-like, or phased?
Sometimes
Usually
platform fee
engagement ID
metadata
Who signs the release?
Is payment released once or by milestone?
What asset is used?
What platform fee applies?
What external system should this escrow connect to?
What happens if a milestone is not approved?
What happens if the wrong party is assigned a role?
Does this use case require dispute resolution?
Approver
Client
Release Signer
Client or platform-controlled signer
Platform Address
Marketplace fee address
Escrow Type
Single-Release or Multi-Release depending on project complexity
Approver
Grant reviewer or committee
Release Signer
Foundation signer or program signer
Platform Address
Program fee address
Escrow Type
Multi-Release
Approver
Property manager, landlord, renter, or neutral reviewer
Release Signer
Platform-controlled signer or agreed signer
Platform Address
Deposit platform fee address
Escrow Type
Single-Release or conditional flow
Receiver
The party that receives funds after release
Service Provider / Milestone Marker
The party that updates progress or marks work as completed
Approver
Status
Communication about progress
Approval
Validation that a condition has been met
Release
Service Provider
Updates milestone status and progress
Approver
Validates milestone completion
Platform Address
Service Provider
Escrow ID / Contract Address
On-chain identifier of the escrow contract. Also used as the deposit address
Engagement ID
Configurable external identifier used to connect the escrow with an invoice, order, project, or external system
Title
Release pattern
One final payout
Milestones
Can have multiple milestones
Receiver
Release pattern
Multiple payouts
Milestones
Each milestone can have its own release
Receiver
Do funds release once or progressively?
Once
Progressively
Are there multiple receivers?
Usually no
Payer
Client
Receiver
Freelancer
Service Provider
Payer
Foundation or sponsor
Receiver
Grantee
Service Provider
Payer
Renter
Receiver
Renter, landlord, or both depending on outcome
Service Provider
The party that validates whether a milestone or condition has been met
Execution of the payment
Can receive platform fees and may manage configuration before funding depending on implementation
Yes
Human-readable title of the escrow
Usually one receiver
Can support multiple receivers
Often yes
Freelancer
Grantee
Property manager or platform
Buyer / Client
→ funds escrow
→ Seller / Service Provider receives one final payoutClient
→ funds escrow
→ Milestone 1 payout to same receiver
→ Milestone 2 payout to same receiver
→ Milestone 3 payout to same receiverSponsor / Platform
→ funds escrow
→ Milestone 1 payout to Receiver A
→ Milestone 2 payout to Receiver B
→ Milestone 3 payout to Receiver CStatus update / evidence → Approval → ReleasePayer → Escrow → ReceiverCreate escrow
Fund escrow
Update milestone 1
Approve milestone 1
Update milestone 2
Approve milestone 2
Release full amount
Close escrowPayer → Escrow → Milestone 1 Receiver
→ Milestone 2 Receiver
→ Milestone 3 ReceiverCreate escrow
Fund escrow
Update milestone 1
Approve milestone 1
Release milestone 1 funds
Update milestone 2
Approve milestone 2
Release milestone 2 funds
Close escrowDesign
→ Initiation
→ Funding
→ Milestone Updates
→ Approval
→ Release
→ ClosureClient funds escrow
Freelancer completes work
Freelancer marks milestone as completed
Client approves
Release signer releases funds to freelancer
Marketplace receives feeFoundation funds escrow
Grantee submits deliverable 1
Reviewer approves deliverable 1
Release signer releases tranche 1
Grantee submits deliverable 2
Reviewer approves deliverable 2
Release signer releases tranche 2Renter funds escrow
Deposit remains locked
Condition is reviewed
Approver validates outcome
Release signer releases funds according to the resultone party funds the escrow
one party performs the work
one party updates milestone status
one party validates completion
one party releases funds
one party receives the funds
one party resolves disputes
one platform receives a fee
Trustless Work separates these responsibilities into roles.
This makes the escrow easier to reason about, safer to configure, and more flexible across use cases.
Every escrow includes a roles object.
Each role is assigned to an address.
Only the address assigned to that role can perform the actions associated with that role.
For example:
only the Service Provider can update milestone status
only the Approver can approve milestones
only the Release Signer can release funds
only the Dispute Resolver can resolve disputes
the Receiver receives funds after release
the Platform Address receives platform fees and can update escrow details before funding
This role-based model allows platforms to design different trust flows without writing custom smart contracts from scratch.
The Service Provider is responsible for delivering the product, service, milestone, or outcome defined in the escrow.
This role usually represents the party doing the work.
change milestone status
add evidence or proof of delivery
raise a dispute
Marketplace payment
Seller, freelancer, vendor, or contractor
Project milestones
Contractor or project team
Payouts
The Service Provider communicates progress.
They do not automatically approve their own work.
In most flows:
The Approver validates that a milestone has actually been completed.
This role is responsible for signing off on completion before funds can be released.
sign the approval of a milestone
raise a dispute if work is not satisfactory
Marketplace payment
Buyer, client, or platform reviewer
Project milestones
Client, project owner, or reviewer
Payouts
Approval is not the same as a status update.
A status update communicates progress.
Approval validates that the agreed condition has been met.
In some flows, the Approver may approve before the Service Provider updates the status. The important point is that approval should remain an explicit validation action.
The Release Signer triggers the actual release of funds once the required approvals are in place.
This role is responsible for executing payment movement.
release funds after all milestones are approved in a Single-Release Escrow
release funds for each approved milestone in a Multi-Release Escrow
raise a dispute if there is disagreement at the release stage
Marketplace payment
Buyer, platform signer, or authorized release address
Project milestones
Client, platform signer, or project owner
Payouts
The Release Signer executes the release.
The Release Signer should not be confused with the Approver.
In simple flows, the same address may be both Approver and Release Signer. In more sensitive flows, those roles should be separated.
Normal release flow:
The Receiver is the final destination of released funds.
This role receives funds once the escrow conditions are met and release is triggered.
receive funds once release is triggered
Marketplace payment
Seller, freelancer, vendor, or contractor
Project milestones
Same contractor or project team across milestones
Payouts
The Receiver is not automatically the Service Provider.
In many cases, they are the same party.
For example, a freelancer can be both:
But in other cases, they may be different.
Example:
The Dispute Resolver steps in when parties disagree or when something goes wrong.
This is a core role in the Trustless Work role model.
resolve disputes by redirecting funds
Marketplace payment
Marketplace, platform, or neutral resolver
Project milestones
Arbitrator, project admin, or platform reviewer
Payouts
The Dispute Resolver should be configured intentionally.
This role has important authority because it can affect where funds go when a dispute is raised.
A dispute is not part of every normal escrow path, but the Dispute Resolver role exists so the escrow has a defined resolution authority if conflict happens.
Disputed flow:
The Platform Address represents the platform or application integrating Trustless Work.
This role is usually used for platform fees and pre-funding configuration changes.
collect platform fees automatically
update escrow details while the escrow has not been funded
Marketplace payment
Marketplace fee address
Project milestones
SaaS platform or infrastructure fee address
Payouts
The Platform Address is not the same thing as the Receiver.
The Platform Address receives the platform fee.
The Receiver receives the escrow payout.
Example:
Also, fee collection should not be confused with full control over funds. The Platform Address can update escrow details before funding, but once funds are locked, the escrow flow should follow the role and lifecycle rules.
Some addresses may interact with the escrow or appear in indexed data, but they do not have the same action permissions as the core roles above.
The Issuer has no powers over the contract.
This address may be present because of how assets, contracts, or metadata are represented, but it does not control escrow actions.
no escrow actions
The Depositor is any address that sends funds into the escrow.
Every incoming transaction to the escrow is indexed.
However, depositing funds does not automatically give that address permissions inside the escrow.
deposit funds
update milestones
approve milestones
release funds
resolve disputes
This distinction matters.
A wallet can fund an escrow without becoming the Approver, Release Signer, or Receiver.
Observer is planned for a future version.
An Observer is an address that wants to track an escrow without acting on it.
observe escrow activity
make tracking easier by role
support dashboards, notifications, and transparency use cases
no escrow actions
Do not collapse these actions into one concept.
Status update
Service Provider
Communicates progress
Approval
Approver
This distinction is central to escrow design.
In a normal escrow flow:
If something goes wrong:
Use case: Single-release escrow
Depositor
Buyer or client
Service Provider
Seller, freelancer, or vendor
Approver
Best for:
one buyer
one provider
one final payout
simple delivery confirmation
Use case: Multi-release escrow, same receiver
Depositor
Client, sponsor, or project owner
Service Provider
Contractor, project team, or vendor
Approver
Best for:
phased projects
milestone-based contracts
grants to one team
implementation work
service agreements paid over time
Use case: Multi-release escrow, multiple receivers
Depositor
Sponsor, platform, organization, or treasury
Service Provider
Contributor, vendor, team, or milestone owner
Approver
Best for:
bounties
contributor payouts
multi-vendor projects
hackathon rewards
ecosystem incentive programs
grants with multiple teams
The same address can sometimes hold multiple roles.
This should be done intentionally.
Service Provider + Receiver
A freelancer performs work and receives payment
Low, common pattern
Depositor + Approver
A client funds and approves the work
Service Provider + Approver
Party can approve its own work
Receiver + Release Signer
Receiver may be able to trigger payment to itself if safeguards are weak
Platform Address + Receiver
Before deploying an escrow, confirm:
Who funds the escrow?
Who updates milestone status?
Who approves completion?
Who can raise a dispute?
Who resolves disputes?
Who releases funds?
Who receives payout?
Who receives platform fees?
Is the Receiver different from the Platform Address?
Is the Service Provider also the Receiver?
Is the Approver also the Release Signer?
Should any role be separated for safety?
Does the use case require a neutral Dispute Resolver?
Are you using Single-Release or Multi-Release?
Are there multiple receivers?

Service Provider updates status
Approver validates completion
Release Signer releases fundsStatus update → Approval → ReleaseService Provider = freelancerReceiver = freelancer walletService Provider = project managerReceiver = company treasuryDispute raised → Dispute Resolver reviews → Funds are redirected or resolvedReceiver = freelancerPlatform Address = marketplace fee wallet1. Depositor funds the escrow2. Service Provider updates milestone status3. Approver validates the milestone4. Release Signer releases the funds5. Receiver receives the payout6. Platform Address receives the platform fee1. Service Provider, Approver, or Release Signer raises a dispute2. Dispute Resolver reviews the situation3. Dispute Resolver resolves the dispute4. Funds are released, redirected, or resolved according to the escrow logicContributor, vendor, or milestone owner
Crowdfunding
Company or campaign owner updating progress
Compliance flow
Compliance team marking a check as completed
Program reviewer, maintainer, or platform admin
Security deposit
Host, property manager, renter, or neutral reviewer
Crowdfunding
Platform or campaign reviewer
Platform signer, treasury signer, or authorized release address
DAO bounty
DAO signer or authorized contributor payment signer
Security deposit
Platform-controlled signer or agreed release authority
Different contributor, vendor, or team per milestone
Crowdfunding
Company receiving milestone-based funding
Security deposit
Renter, host, or other final recipient depending on the outcome
Program admin, maintainer, or governance process
Security deposit
Platform, property manager, or neutral dispute resolver
Crowdfunding
Campaign platform or independent reviewer
Program, bounty, or treasury platform fee address
Crowdfunding
Crowdfunding platform fee address
Security deposit
Rental platform fee address
Validates completion
Dispute
Service Provider, Approver, or Release Signer
Signals disagreement
Resolution
Dispute Resolver
Resolves dispute outcome
Release
Release Signer
Moves funds
Payout
Receiver
Receives funds
Fee collection
Platform Address
Receives platform fee
Service Provider
Yes
Yes
No
Yes
No
No
Sometimes
No
No
Approver
No
No
Yes
Yes
No
No
Usually no
No
No
Release Signer
No
No
No
Yes
No
Yes
Usually no
No
No
Receiver
No
No
No
No
No
No
Yes
No
No
Dispute Resolver
No
No
Case-specific
No
Yes
Case-specific
No
No
No
Platform Address
No by default
No by default
No by default
No by default
No by default
No by default
No
Yes
Yes
Issuer
No
No
No
No
No
No
No
No
No
Depositor
No
No
No
No
No
No
No
No
No
Observer
No
No
No
No
No
No
No
No
No
Buyer, client, or platform reviewer
Release Signer
Buyer, platform signer, or authorized release address
Receiver
Seller, freelancer, or vendor
Dispute Resolver
Marketplace, platform, or neutral resolver
Platform Address
Marketplace fee address
Client, reviewer, or project owner
Release Signer
Client, platform signer, or authorized signer
Receiver
Same contractor, team, or vendor across milestones
Dispute Resolver
Platform, neutral resolver, or assigned resolver
Platform Address
Platform or infrastructure fee address
Program reviewer, maintainer, client, or platform admin
Release Signer
Platform signer, treasury signer, or authorized release address
Receiver
Different receiver per milestone
Dispute Resolver
Platform, neutral resolver, program admin, or governance process
Platform Address
Program, bounty, or platform fee address
Common, but client can delay approval
Approver + Release Signer
Simple workflows where the approver also releases funds
Concentrates validation and execution authority
Platform Address + Dispute Resolver
Platform handles fees and dispute resolution
Platform gains significant influence over outcomes
Confuses fee recipient with payout recipient
One address holding every role
Recreates centralized custody-like control
ID (address) that identifies the escrow contract
CAZ6UQX7...Position that identifies the milestone within the group of milestones in the escrow
1Address of the entity requiring the service
GCLIENT...XYZThis endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
Possible errors:
POST /escrow/single-release/approve-milestone HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 85
{
"contractId": "CAZ6UQX7...",
"milestoneIndex": "1",
"approver": "GAPPROVER1234567890..."
}{
"status": "SUCCESS",
"unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}ID (address) that identifies the escrow contract
CAZ6UQX7...Position that identifies the milestone within the group of milestones in the escrow
1Entity that signs the transaction that deploys and initializes the escrow
GSIGN...XYZThis endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
Possible errors:
POST /escrow/multi-release/dispute-milestone HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"contractId": "CAZ6UQX7...",
"milestoneIndex": "1",
"signer": "GAPPROVER1234567890..."
}{
"status": "SUCCESS",
"unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}ID (address) that identifies the escrow contract
CAZ6UQX7...Address of the user in charge of releasing the escrow funds to the receiver
GREL...XYZThis endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
Possible errors:
POST /escrow/single-release/release-funds HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 69
{
"contractId": "CAZ6UQX7...",
"releaseSigner": "GAPPROVER1234567890..."
}{
"status": "SUCCESS",
"unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}ID (address) that identifies the escrow contract
CAZ6UQX7...Address of the user in charge of releasing the escrow funds to the receiver
GAPPROVER1234567890...Position that identifies the milestone within the group of milestones in the escrow
1This endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
Possible errors:
POST /escrow/multi-release/release-milestone-funds HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 91
{
"contractId": "CAZ6UQX7...",
"releaseSigner": "GAPPPROVER1234567890...",
"milestoneIndex": "1"
}{
"status": "SUCCESS",
"unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}Address of the user who signed the transaction to create escrow
GXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXRole in escrow
approverAddress of the user in the specified role
GXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXStatus of the escrow
pendingType of the escrow
single_release | multi_releasePossible values: Engagement ID of the escrow
ENG-001Title of the escrow
Website redesignIs the escrow active
When set to true, the endpoint will verify each escrow’s data against the blockchain to ensure accuracy and integrity. Enabling this adds an extra security layer but may increase the response time slightly due to the additional validation step
Starting date range for filtering
2023-06-20 (YYYY-MM-DD)Minimum amount for filtering
100Maximum amount for filtering
1000Field to order the results by
createdAtExample: createdAt | updatedAt | amountPossible values: Direction to order the results
descExample: asc | descPossible values: Page number for pagination
1Number of items per page
8Example: 8Contract Id of the deployed escrow
CBHEQBV...Ending date range for filtering
2023-06-22 (YYYY-MM-DD)Collection of data containing information from different scans requested by a signatory, role or contract id.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
GET /helper/get-escrows-by-signer HTTP/1.1
Accept: */*
[
{
"contractId": "CB25FW....",
"signer": "GBPUA....",
"type": "multi-release",
"engagementId": "ENG-003",
"title": "Title of the Escrow",
"description": "Description of the Escrow",
"milestones": [
{
"description": "Initial payment",
"amount": 2,
"status": "pending",
"flags": {
"disputed": false,
"released": false,
"resolved": false,
"approved": false
}
},
{
"description": "Final payment",
"amount": 5,
"status": "pending",
"flags": {
"disputed": false,
"released": false,
"resolved": false,
"approved": false
}
}
],
"platformFee": 5,
"receiverMemo": 0,
"roles": {
"approver": "GBPUACN....",
"serviceProvider": "GA2RRI....",
"platformAddress": "GBPA2LO....",
"releaseSigner": "GCPZUO....",
"disputeResolver": "GDBMRV...",
"receiver": "GA2RRI...",
"issuer": "GBPUAC..."
},
"trustline": {
"address": "CBIELT...",
"name": "USDC"
},
"isActive": true,
"updatedAt": {
"_seconds": 1750698602,
"_nanoseconds": 356000000
},
"createdAt": {
"_seconds": 1750698602,
"_nanoseconds": 356000000
},
"balance": 0
}
]ID (address) that identifies the escrow contract
ENG12345Entity that signs the transaction that deploys and initializes the escrow
GSIGN...XYZAmount to transfer to the escrow contract
100This endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
Possible errors:
POST /escrow/single-release/fund-escrow HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 74
{
"contractId": "CAZ6UQX7...",
"signer": "GAPPROVER1234567890...",
"amount": 10
}{
"status": "SUCCESS",
"unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}ID (address) that identifies the escrow contract
CAZ6UQX7...Entity that signs the transaction that deploys and initializes the escrow
GSIGN...XYZThis endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
Possible errors:
POST /escrow/single-release/dispute-escrow HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 62
{
"contractId": "CAZ6UQX7...",
"signer": "GAPPROVER1234567890..."
}{
"status": "SUCCESS",
"unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}Collection of objects containing information on the balance of the requested addresses
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
GET /helper/get-multiple-escrow-balance?addresses=undefined HTTP/1.1
Accept: */*
[
{
"address": "GAWVVSA..",
"balance": 30
},
{
"address": "GAWVCG3..",
"balance": 10
}
]ID (address) that identifies the escrow contract
CAZ6UQX7...milestone within the group of milestones in the escrow
1New value for the evidence property within the escrow milestone
EvidenceNew value for the status property within the escrow milestone
CompletedAddress of the entity providing the service
CompletedThis endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
Possible errors:
POST /escrow/multi-release/change-milestone-status HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 177
{
"contractId": "CAZ6UQX7...",
"milestoneIndex": "1",
"newEvidence": "Any evidence that the milestone is completed",
"newStatus": "Completed",
"serviceProvider": "GAPPROVER1234567890..."
}{
"status": "SUCCESS",
"unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}ID (address) that identifies the escrow contract
CAZ6UQX7...milestone within the group of milestones in the escrow
1New value for the evidence property within the escrow milestone
EvidenceNew value for the status property within the escrow milestone
CompletedAddress of the entity providing the service
CompletedThis endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
Possible errors:
POST /escrow/single-release/change-milestone-status HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 177
{
"contractId": "CAZ6UQX7...",
"milestoneIndex": "1",
"newEvidence": "Any evidence that the milestone is completed",
"newStatus": "Completed",
"serviceProvider": "GAPPROVER1234567890..."
}{
"status": "SUCCESS",
"unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}The sign's hash. This come from the wallet
AAAAAgAAAAB...The transaction has been successfully sent to the Stellar network
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
POST /helper/send-transaction HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"signedXdr": "AAAAAgAAAAB..."
}{
"status": "SUCCESS",
"message": "The transaction has been successfully sent to the Stellar network.",
"contractId": "CAATN5D...",
"escrow": {
"amount": 50,
"roles": {
"approver": "GAWVVSA...",
"serviceProvider": "GAWVVSA6...",
"disputeResolver": "GAWVVSA...",
"receiver": "GAWVVSA...",
"platformAddress": "GAWVVSA...",
"releaseSigner": "GAWVVSA..."
},
"flags": {
"disputed": false,
"released": false,
"resolved": false
},
"description": "This is a sample TW escrow for testing purposes",
"engagementId": "ENG12345",
"milestones": [
{
"approved": false,
"description": "Initial milestone",
"evidence": "",
"status": "pending"
},
{
"approved": false,
"description": "Second milestone",
"evidence": "",
"status": "pending"
}
],
"platformFee": 5,
"title": "Sample TW Escrow",
"trustline": {
"address": "CBIELTK...",
"name": "USDC"
},
"receiverMemo": 90909090
}
}ID (address) that identifies the escrow contract
CAZ6UQX7...Position that identifies the milestone within the group of milestones in the escrow
1Address of the entity requiring the service
GCLIENT...XYZThis endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
Possible errors:
POST /escrow/multi-release/approve-milestone HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 85
{
"contractId": "CAZ6UQX7...",
"milestoneIndex": "1",
"approver": "GAPPROVER1234567890..."
}{
"status": "SUCCESS",
"unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}ID (address) that identifies the escrow contract
CAZ6UQX7...Address of the user defined to resolve disputes in an escrow
GDISPUTE...XYZPosition that identifies the milestone within the group of milestones in the escrow
1This endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
Possible errors:
POST /escrow/multi-release/resolve-milestone-dispute HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 210
{
"contractId": "CAZ6UQX7...",
"disputeResolver": "GAPPROVER1234567890...",
"milestoneIndex": "1",
"distributions": [
{
"address": "GAPPROVER1234567890...",
"amount": 300
},
{
"address": "GRECEIVER1234567890...",
"amount": 700
}
]
}{
"status": "SUCCESS",
"unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}ID (address) that identifies the escrow contract
CAZ6UQX7...Address of the user defined to resolve disputes in an escrow
GDISPUTE...XYZThis endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
Possible errors:
POST /escrow/single-release/resolve-dispute HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 188
{
"contractId": "CAZ6UQX7...",
"disputeResolver": "GAPPROVER1234567890...",
"distributions": [
{
"address": "GAPPROVER1234567890...",
"amount": 20
},
{
"address": "GRECIPIENT1234567890...",
"amount": 30
}
]
}{
"status": "SUCCESS",
"unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}Array of contract IDs to query
[CB25FW...,CBHEQBV...]Is the escrow active
When set to true, the endpoint will verify each escrow’s data against the blockchain to ensure accuracy and integrity. Enabling this adds an extra security layer but may increase the response time slightly due to the additional validation step
Collection of data containing information from different scans requested by a signatory, role or contract ids.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
GET /helper/get-escrow-by-contract-ids?contractIds=[CB25FW...%2CCBHEQBV...] HTTP/1.1
Accept: */*
[
{
"contractId": "CB25FW....",
"signer": "GBPUA....",
"type": "multi-release",
"engagementId": "ENG-003",
"title": "Title of the Escrow",
"description": "Description of the Escrow",
"milestones": [
{
"description": "Initial payment",
"amount": 2,
"status": "pending",
"flags": {
"disputed": false,
"released": false,
"resolved": false,
"approved": false
}
},
{
"description": "Final payment",
"amount": 5,
"status": "pending",
"flags": {
"disputed": false,
"released": false,
"resolved": false,
"approved": false
}
}
],
"platformFee": 5,
"receiverMemo": 0,
"roles": {
"approver": "GBPUACN....",
"serviceProvider": "GA2RRI....",
"platformAddress": "GBPA2LO....",
"releaseSigner": "GCPZUO....",
"disputeResolver": "GDBMRV...",
"receiver": "GA2RRI...",
"issuer": "GBPUAC..."
},
"trustline": {
"address": "CBIELT...",
"name": "USDC"
},
"isActive": true,
"updatedAt": {
"_seconds": 1750698602,
"_nanoseconds": 356000000
},
"createdAt": {
"_seconds": 1750698602,
"_nanoseconds": 356000000
},
"balance": 0
},
{
"contractId": "CF35XW....",
"signer": "GBPUA....",
"type": "single-release",
"engagementId": "ENG-003",
"title": "Title of the Escrow",
"description": "Description of the Escrow",
"milestones": [
{
"description": "Initial payment",
"amount": 5,
"status": "pending",
"flags": {
"disputed": false,
"released": false,
"resolved": false,
"approved": false
}
},
{
"description": "Final payment",
"amount": 3,
"status": "pending",
"flags": {
"disputed": false,
"released": false,
"resolved": false,
"approved": false
}
}
],
"platformFee": 3,
"receiverMemo": 0,
"roles": {
"approver": "GBPUACN....",
"serviceProvider": "GA2RRI....",
"platformAddress": "GBPA2LO....",
"releaseSigner": "GCPZUO....",
"disputeResolver": "GDBMRV...",
"receiver": "GA2RRI...",
"issuer": "GBPUAC..."
},
"trustline": {
"address": "CBIELT...",
"name": "USDC"
},
"isActive": true,
"updatedAt": {
"_seconds": 1750698602,
"_nanoseconds": 356000000
},
"createdAt": {
"_seconds": 1750698602,
"_nanoseconds": 356000000
},
"balance": 3
}
]Address of the user who signed the transaction to create escrow
GXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXRole in escrow
approverAddress of the user in the specified role
GXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXStatus of the escrow
pendingType of the escrow
single_release | multi_releasePossible values: Engagement ID of the escrow
ENG-001Title of the escrow
Website redesignIs the escrow active
When set to true, the endpoint will verify each escrow’s data against the blockchain to ensure accuracy and integrity. Enabling this adds an extra security layer but may increase the response time slightly due to the additional validation step
Starting date range for filtering
2023-06-20 (YYYY-MM-DD)Minimum amount for filtering
100Maximum amount for filtering
1000Field to order the results by
createdAtExample: createdAt | updatedAt | amountPossible values: Direction to order the results
descExample: asc | descPossible values: Page number for pagination
1Number of items per page
8Example: 8Contract Id of the deployed escrow
CBHEQBV...Ending date range for filtering
2023-06-22 (YYYY-MM-DD)Collection of data containing information from different scans requested by a signatory, role or contract id.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
GET /helper/get-escrows-by-role HTTP/1.1
Accept: */*
[
{
"contractId": "CB25FW....",
"signer": "GBPUA....",
"type": "multi-release",
"engagementId": "ENG-003",
"title": "Title of the Escrow",
"description": "Description of the Escrow",
"milestones": [
{
"description": "Initial payment",
"amount": 2,
"status": "pending",
"flags": {
"disputed": false,
"released": false,
"resolved": false,
"approved": false
}
},
{
"description": "Final payment",
"amount": 5,
"status": "pending",
"flags": {
"disputed": false,
"released": false,
"resolved": false,
"approved": false
}
}
],
"platformFee": 5,
"receiverMemo": 0,
"roles": {
"approver": "GBPUACN....",
"serviceProvider": "GA2RRI....",
"platformAddress": "GBPA2LO....",
"releaseSigner": "GCPZUO....",
"disputeResolver": "GDBMRV...",
"receiver": "GA2RRI...",
"issuer": "GBPUAC..."
},
"trustline": {
"address": "CBIELT...",
"name": "USDC"
},
"isActive": true,
"updatedAt": {
"_seconds": 1750698602,
"_nanoseconds": 356000000
},
"createdAt": {
"_seconds": 1750698602,
"_nanoseconds": 356000000
},
"balance": 0
}
]Transaction hash
b0e61d4...f1cb2d29Returns the escrow object that was just saved/updated in the indexer and the success or failure of the response.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
PUT /indexer/update-from-txhash HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 31
{
"txHash": "b0e61d4...f1cb2d29"
}{
"status": "SUCCESS",
"message": "Escrow saved successfully / The escrow has been correctly indexed in our database.",
"savedEscrow": {
"contractId": "CB25FW....",
"signer": "GBPUA....",
"type": "multi-release",
"engagementId": "ENG-003",
"title": "Title of the Escrow",
"description": "Description of the Escrow",
"milestones": [
{
"description": "Initial payment",
"amount": 2,
"status": "pending",
"flags": {
"disputed": false,
"released": false,
"resolved": false,
"approved": false
}
},
{
"description": "Final payment",
"amount": 5,
"status": "pending",
"flags": {
"disputed": false,
"released": false,
"resolved": false,
"approved": false
}
}
],
"platformFee": 5,
"receiverMemo": 0,
"roles": {
"approver": "GBPUACN....",
"serviceProvider": "GA2RRI....",
"platformAddress": "GBPA2LO....",
"releaseSigner": "GCPZUO....",
"disputeResolver": "GDBMRV...",
"receiver": "GA2RRI...",
"issuer": "GBPUAC..."
},
"trustline": {
"address": "CBIELT...",
"name": "USDC"
},
"isActive": true,
"updatedAt": {
"_seconds": 1750698602,
"_nanoseconds": 356000000
},
"createdAt": {
"_seconds": 1750698602,
"_nanoseconds": 356000000
},
"balance": 0
}
}ID (address) that identifies the escrow contract
ENG12345Entity that signs the transaction that deploys and initializes the escrow
GSIGN...XYZAmount to transfer to the escrow contract
100This endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
Possible errors:
POST /escrow/multi-release/fund-escrow HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 74
{
"contractId": "CAZ6UQX7...",
"signer": "GAPPROVER1234567890...",
"amount": 10
}{
"status": "SUCCESS",
"unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}ID (address) that identifies the escrow contract
CAZ6UQX7...Address of the user defined to resolve disputes in an escrow
GDISPUTE...XYZThis endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
Possible errors:
POST /escrow/multi-release/withdraw-remaining-funds HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 188
{
"contractId": "CAZ6UQX7...",
"disputeResolver": "GDISPUTE1234567890...",
"distributions": [
{
"address": "GAPPROVER1234567890...",
"amount": 150
},
{
"address": "GRECEIVER1234567890...",
"amount": 850
}
]
}{
"status": "SUCCESS",
"unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}Entity that signs the transaction that deploys and initializes the escrow
GSIGN...XYZID (address) that identifies the escrow contract
CAZ6UQX7...Unique identifier for the escrow
ENG12345Name of the escrow
Test TitleText describing the function of the escrow
Escrow descriptionRoles that make up the escrow structure
Amount to be transferred upon completion of escrow milestones
1000Commission that the platform will receive when the escrow is completed
5Objectives to be completed to define the escrow as completed
Flags validating certain escrow life states
Flag indicating whether the escrow is active or not at the database level. Makes only a logical deletion, the escrow will continue to function at the blockchain level.
falseField used to identify the recipient's address in transactions through an intermediary account. This value is included as a memo in the transaction and allows the funds to be correctly routed to the wallet of the specified recipient
123456Information on the trustline that will manage the movement of funds in escrow
This endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
Possible errors:
PUT /escrow/multi-release/update-escrow HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 878
{
"signer": "GAPPROVER1234567890...",
"contractId": "CAZ6UQX7...",
"isActive": true,
"escrow": {
"engagementId": "ENG12345",
"title": "Project Title",
"description": "This is a detailed description of the project.",
"roles": {
"approver": "GAPPROVER1234567890...",
"serviceProvider": "GAPPROVER1234567890...",
"platformAddress": "GAPPROVER1234567890...",
"releaseSigner": "GAPPROVER1234567890...",
"disputeResolver": "GAPPROVER1234567890..."
},
"platformFee": 1,
"milestones": [
{
"description": "test1",
"status": "pending",
"evidence": "Any evidence that the milestone is completed",
"amount": 1000,
"receiver": "GAPPROVER1234567890..."
},
{
"description": "test2",
"status": "pending",
"evidence": "Any evidence that the milestone is completed",
"amount": 1000,
"receiver": "GAPPROVER1234567890..."
}
],
"flags": {
"disputed": false,
"released": false,
"resolved": false,
"approved": false
},
"trustline": {
"address": "GAPPROVER1234567890..."
}
}
}{
"status": "SUCCESS",
"unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}Entity that signs the transaction that deploys and initializes the escrow
GABC...XYZUnique identifier for the escrow
ENG12345Name of the escrow
Escrow TestText describing the function of the escrow
Escrow Test descriptionRoles that make up the escrow structure
Amount to be transferred upon completion of escrow milestones
1000Commission that the platform will receive when the escrow is completed
5Objectives to be completed to define the escrow as completed. (In this case it is not necessary to send the properties “approvedFlag” and “status” inside the objects of these milestones)
Information on the trustline that will manage the movement of funds in escrow
This endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
Possible errors:
POST /deployer/single-release HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 603
{
"signer": "GAPPROVER1234567890...",
"engagementId": "ENG12345",
"title": "Project Title",
"description": "This is a detailed description of the project.",
"roles": {
"approver": "GAPPROVER1234567890...",
"serviceProvider": "GAPPROVER1234567890...",
"platformAddress": "GAPPROVER1234567890...",
"releaseSigner": "GAPPROVER1234567890...",
"disputeResolver": "GAPPROVER1234567890...",
"receiver": "GAPPROVER1234567890..."
},
"amount": 1000,
"platformFee": 50,
"milestones": [
{
"description": "Initial phase of the project"
},
{
"description": "Completion of design work"
}
],
"trusline": {
"symbol": "USDC",
"address": "GBBD47IF6LWK7P7MDEVSC..."
}
}{
"status": "SUCCESS",
"unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}Entity that signs the transaction that deploys and initializes the escrow
GSIGN...XYZID (address) that identifies the escrow contract
CAZ6UQX7...Unique identifier for the escrow
ENG12345Name of the escrow
Test TitleText describing the function of the escrow
Escrow descriptionRoles that make up the escrow structure
Amount to be transferred upon completion of escrow milestones
1000Commission that the platform will receive when the escrow is completed
5Objectives to be completed to define the escrow as completed
Flags validating certain escrow life states
Flag indicating whether the escrow is active or not at the database level. Makes only a logical deletion, the escrow will continue to function at the blockchain level.
falseField used to identify the recipient's address in transactions through an intermediary account. This value is included as a memo in the transaction and allows the funds to be correctly routed to the wallet of the specified recipient
123456Information on the trustline that will manage the movement of funds in escrow
This endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
Possible errors:
PUT /escrow/single-release/update-escrow HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 846
{
"signer": "GAPPROVER1234567890...",
"contractId": "CAZ6UQX7...",
"isActive": true,
"escrow": {
"signer": "GAPPROVER1234567890...",
"engagementId": "ENG12345",
"title": "Project Title",
"description": "This is a detailed description of the project.",
"roles": {
"approver": "GAPPROVER1234567890...",
"serviceProvider": "GAPPROVER1234567890...",
"platformAddress": "GAPPROVER1234567890...",
"releaseSigner": "GAPPROVER1234567890...",
"disputeResolver": "GAPPROVER1234567890...",
"receiver": "GAPPROVER1234567890..."
},
"amount": 1000,
"platformFee": 50,
"milestones": [
{
"description": "test1",
"status": "pending",
"evidence": "Any evidence that the milestone is completed"
},
{
"description": "test2",
"status": "pending",
"evidence": "Any evidence that the milestone is completed"
}
],
"flags": {
"disputed": false,
"released": false,
"resolved": false
},
"trustline": {
"address": "GAPPROVER1234567890..."
}
}
}{
"status": "SUCCESS",
"unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}Entity that signs the transaction that deploys and initializes the escrow
GABC...XYZUnique identifier for the escrow
ENG12345Name of the escrow
Escrow TestText describing the function of the escrow
Escrow Test descriptionRoles that make up the escrow structure
Commission that the platform will receive when the escrow is completed
5Objectives to be completed to define the escrow as completed. (In this case it is not necessary to send the properties “approvedFlag” and “status” inside the objects of these milestones)
Information on the trustline that will manage the movement of funds in escrow
This endpoint returns an unsigned transaction in XDR format. This XDR is then used to sign the transaction using the “/helper/send-transaction” endpoint.
Bad request
No content
Unauthorized access
No content
Too Many Requests
No content
Possible errors:
POST /deployer/multi-release HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 648
{
"signer": "GAPPROVER1234567890...",
"engagementId": "ENG12345",
"title": "Project Title",
"description": "This is a detailed description of the project.",
"roles": {
"approver": "GAPPROVER1234567890...",
"serviceProvider": "GAPPROVER1234567890...",
"platformAddress": "GAPPROVER1234567890...",
"releaseSigner": "GAPPROVER1234567890...",
"disputeResolver": "GAPPROVER1234567890..."
},
"platformFee": 50,
"milestones": [
{
"description": "Initial phase of the project",
"amount": 5,
"receiver": "GAPPROVER1234567890..."
},
{
"description": "Completion of design work",
"amount": 5,
"receiver": "GAPPROVER1234567890..."
}
],
"trustline": {
"symbol": "USDC",
"address": "GBBD47IF6LWK7P7MDEVSC..."
}
}{
"status": "SUCCESS",
"unsignedTransaction": "AAAAAgAAAAAtWsgedQ...."
}


