Skip to content

DX-087: Document the OrderVault contract #599

Description

@IbrahimIjai

Context

OrderVault custodies collateral between order submission and execution. Users
ask where their funds are during that window, and integrators need to know the
lifecycle to handle stuck or cancelled orders correctly.

Scope

  • The contract's role and the custody lifecycle: deposit, execution, refund on
    cancellation.
  • Every public function with parameters, authorisation, and errors, following
    the DX-084 template.
  • What happens to collateral when an order fails, expires, or is cancelled —
    including who may trigger a refund and when.
  • The events emitted, and how the indexer consumes them.
  • A worked example tracing collateral through a cancelled order.

Acceptance criteria

  • Function coverage asserted against the generated bindings.
  • The custody lifecycle is verified against contract source, with the file
    and function named in the PR.
  • Emitted events match what the indexer actually handles.
  • The cancelled-order example was executed on testnet.

Out of scope

  • Keeper and executor operation.

Spec: docs/dx_1/003_content_map.md §2 · Depends on: DX-086

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions