Use this page as the shortest path for AI tools, coding agents, and search systems that need reliable Oryn context.
Machine-readable entry points
| Resource | Purpose |
|---|
/llms.txt | Index of available docs pages with descriptions. |
/llms-full.txt | Full documentation bundle for tools that need broad context. |
/skill.md | Capability summary for agents building with Oryn. |
/openapi/orderbook.json | Orderbook API specification. |
/openapi/relayer.json | Relayer API specification. |
Mintlify hosts llms.txt, llms-full.txt, and skill.md automatically for public docs sites. This repo also includes a custom skill.md to keep Oryn terminology and integration constraints explicit.
Read order for agents
- Overview
- Glossary
- Developer Overview
- Developer Quickstart
- Integration Guide
- API Conventions
- Generated Orderbook and Relayer API references
Oryn terminology rules
| Use | Avoid |
|---|
| claim | redeem, redemption |
| cancel, cancelled | refund, refunded, refundable |
| solver | filler, executor |
| source side / destination side | vague “from chain” / “to chain” when precision matters |
| order | swap record, request, ticket |
Agent safety constraints
- Do not invent route fields after a quote is returned.
- Do not modify quote amounts locally.
- Do not use JavaScript floating point numbers for token amounts.
- Do not log raw secrets, preimages, wallet signatures, or private keys.
- Do not present planned SDK or widget APIs as released packages.
- Treat orderbook status as indexed chain state, not final chain truth.
- Keep literal Solidity names when referencing contract functions such as
claim, claimHop, and refund().
