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

Schema

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.

Single Release Escrow Schema

Escrow body:

Key
Type
Description

engagementId

string

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

dispute

Dispute Object

Dispute state of the escrow

released

boolean

Flag indicating that escrow funds have already been released

trustline

Trustline Object

Information on the trustline that will manage the movement of funds in escrow

Roles:

Name
Type
Description

approvers

array of strings

Addresses of the entity requiring the service.

serviceProviders

array of strings

Addresses of the entity providing the service.

plataform

string

Address of the entity that owns the escrow

releaseSigners

array of strings

Addresses of the user in charge of releasing the escrow funds to the service provider.

disputeResolvers

array of strings

Addresses in charge of resolving disputes within the escrow.

receiver

string

Address where escrow proceeds will be sent to

admin

string

Address of the escrow administrator

observers

array of strings

Addresses of entities observing the escrow without participating

Milestone:

Name
Type
Description

description

string

Text describing the function of the milestone.

status

string

Milestone status. Ex: Approved, In dispute, etc...

evidence

string (optional)

Evidence of work performed by the service provider.

approvals

MilestoneApprovals Object

Tracks approval progress for this milestone

MilestoneApprovals:

Name
Type
Description

target

number

Number of approvals required to complete the milestone

approvalCount

number

Current number of approvals received

approvers

array of strings

Addresses that have already approved the milestone

Dispute:

Name
Type
Description

isDisputed

boolean

Flag indicating that an escrow is in dispute.

reason

boolean

Text explaining the reason for the dispute

resolved

boolean

Flag indicating that a disputed escrow has already been resolved.

Trustline:

Name
Type
Description

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.

Single Release Escrow Flow:

Multi Release Escrow Schema

Key
Type
Description

engagementId

string

Unique identifier for the escrow

title

string

Name of the escrow

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

Roles:

Name
Type
Description

approvers

array of strings

Addresses of the entity requiring the service.

serviceProviders

array of strings

Addresses of the entity providing the service.

plataform

string

Address of the entity that owns the escrow

releaseSigners

array of strings

Address esof the user in charge of releasing the escrow funds to the service provider.

disputeResolvers

array of strings

Addresses in charge of resolving disputes within the escrow.

admin

string

Address of the escrow administrator

observers

array of strings

Addresses of entities observing the escrow without participating

Milestone:

Name
Type
Description

description

string

Text describing the function of the milestone.

status

string

Milestone status. Ex: Approved, In dispute, etc...

evidence

string (optional)

Evidence of work performed by the service provider.

approvals

MilestoneApprovals Object

Tracks approval progress for this milestone

amount

number

Amount to be transferred upon completion of escrow milestones.

dispute

Dispute Object

Dispute state of the milestone

released

boolean

Flag indicating that milestone funds have already been released

receiver

string

Address where escrow proceeds will be sent to

MilestoneApprovals:

Name
Type
Description

target

number

Number of approvals required to complete the milestone

approvalCount

number

Current number of approvals received

approvers

array of strings

Addresses that have already approved the milestone

Dispute:

Name
Type
Description

isDisputed

boolean

Flag indicating that an escrow is in dispute.

reason

string

Text explaining the reason for the dispute

resolved

boolean

Flag indicating that a disputed escrow has already been resolved.

Trustline:

Name
Type
Description

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.

Multi Release Escrow Flow:

Last updated