13 Specifications
Protocol Specifications
Authoritative wire and cryptographic specifications located under spec/ in the Ordex repository.
spec/api.md
The Ordex gateway API
Sections: The Ordex gateway API, Reads, Paging is keyset, never offset, Filters, Writes, The protocol contract is checkable, Fees are proved, not trusted, Lost replies are recovered, never repeated, `POST /orders/:id/quote`, `POST /orders/:id/preflight`
spec/batch-purchase.md
Buying several asks in one transaction
Sections: Buying several asks in one transaction, The arrangement, What Ordex refuses before composing, What Ordex refuses before handing the result over, No partial result
spec/cold-signing.md
Cold signing and watch-only mode v1
Sections: Cold signing and watch-only mode v1, The SignerAdapter contract, The expected transaction manifest, The nine refusals, The stepper, Watch-only profiles, Blind signing is prohibited
spec/collection-manifest.md
Collection provenance registry v1
Sections: Collection provenance registry v1, The manifest, Membership proofs, Publication, versioning, revocation, Verification states, Compatibility, Gates
spec/counterparty-utxo-asset.md
Counterparty heritage assets v1
Sections: Counterparty heritage assets v1, Identity, The authority, The attachment record, Attachment follows the spend, Attach and detach, Protection everywhere, Trading path, Readiness gates
spec/events.md
Realtime events and signed webhooks v1
Sections: Realtime events and signed webhooks v1, The envelope, Event families, Streaming, Signed webhooks, Historical APIs
spec/interoperability.md
Portable orders: import, export, and OpenOrdex
Sections: Portable orders: import, export, and OpenOrdex, Identity is the artifact, not the venue, Import: `POST /api/ordex/orders/import`, OpenOrdex events: `POST /api/ordex/orders/openordex-event`, Export: the envelope and the artifact, What a source may never do
spec/lifecycle.md
Order lifecycle
Sections: Order lifecycle, States, Actionability, Withdrawal is discovery, not cancellation, The activity log
spec/offers.md
Offers v1
Sections: Offers v1, The three offer kinds, Offer terms, The funded offer output, Acceptance leaf, Recovery leaf, The policy signers, Acceptance, Recovery, Offer lifecycle, What Ordex never does
spec/purchase.md
Completing a public ask
Sections: Completing a public ask, The seller half, Rule one: the indexes must match, Rule two: that index cannot be zero, The arrangement Ordex builds, What Ordex refuses, What Ordex never does, A public ask can be raced
spec/runes.md
Not burning the runes a purchase spends
Sections: Not burning the runes a purchase spends, Where a rune balance lives, The cenotaph, Reading the runestone, What makes it a cenotaph, The rule a client must apply, Conformance
spec/safeops.md
SafeOps v1
Sections: SafeOps v1, Who does what, Inventory resolution, The plan, Asset safety rules, Partitioning at scale, The execution shield, Signed results, RBF and CPFP, Monitoring
spec/swaps.md
Atomic swap links and the OTC desk v1
Sections: Atomic swap links and the OTC desk v1, The two stage model, The intent, Private encrypted links, The acceptance plan, Lifecycle, Settlement cohort, Adversarial coverage
Was this documentation helpful?
Privacy-first feedback. Your feedback is never shared with third parties.