What Oryn unlocks
| Capability | Use it when |
|---|---|
| Cross-chain swap flow | You want users to move value between supported chains without leaving your app. |
| Solver-backed settlement | You want destination liquidity and escrow settlement coordinated through Oryn orders. |
| Gas-assisted claim | You want the relayer to submit supported destination claims for users. |
| Route-aware status | You need UI states for initiated, claimed, bridged, completed, expired, and cancelled swaps. |
Choose SDK, API, or widget
| Surface | Best for | Current status |
|---|---|---|
| SDK | React and Node apps that want typed helpers for quotes, orders, secrets, claims, and polling. | Planned |
| API | Wallets, backends, custom frontends, mobile apps, and non-TypeScript stacks. | Available for orderbook and relayer |
| Widget | Partner apps that want an embedded Oryn swap UI with minimal integration work. | Planned |
Until the public SDK and widget ship, the recommended path is API-first integration using Developer Quickstart, API Conventions, and the generated API references.
Integration types
| Integration | You build | You depend on |
|---|---|---|
| Swap UI | Quote selection, wallet prompts, source initiation, status timeline | Orderbook API, relayer API, route metadata |
| Solver | Destination liquidity, destination initiation, source claim | Order status, escrow parameters, chain events |
| Backend operator | Relayer, watcher, route monitoring, RPC infrastructure | Registry config, indexed events, contract state |
| Analytics/indexer | Volume, route, status, and completion dashboards | Orderbook API and chain events |
Minimum API integration
An app needs to:- request or receive a quote
- generate a secret and commitment hash
- create an order
- initiate or fund the source escrow
- submit the destination claim through the relayer or wallet flow
- poll order status until completed, expired, or cancelled
UX rules
| Rule | Why it matters |
|---|---|
| Show the active route | Users should know whether the swap is direct or has a hop. |
| Preserve quote data | Amounts and assets should match the quote exactly. |
| Display transaction hashes | Users trust pending flows when they can inspect chain activity. |
| Separate pending from confirmed | Detected and finalized transactions are not the same thing. |
| Make cancellations visible | Expired swaps should lead users toward cancellation recovery. |