search
Ctrlk

Omniston API v1beta8

What changed in Omniston v1beta8, how the API makes cross-chain settlement explicit, and where to find migration, SDK, and concept docs.

v1beta8 makes cross-chain settlement explicit in the API model. It uses RFQ, Quote, Order, Execution, Input position, and Output position to describe the swap lifecycle.

Instead of treating cross-chain settlement as a special case of trade tracking, v1beta8 separates source and destination blockchains, swap and order settlement, and execution-level state.

The core goal remains the same: get a competitive quote and settle. What changed is the protocol model around that flow.

The lifecycle is now described more explicitly as RFQ → Quote → swap or order settlement → executions and positions for orders, with clearer branching for intrachain settlement and HTLC-based cross-chain settlement. This helps clients branch earlier by settlement mode, flow type, and fee semantics.

The same terminology is now used across user-facing swaps, resolver operations, partner fees, and support runbooks.

hashtag
What changed at a glance

  • The package namespace is stonfi.omni.v1beta8.

  • Cross-chain settlement is now represented directly in the lifecycle.

  • RFQ, Quote, Order, Execution, and position concepts are defined explicitly.

  • Swap settlement and order settlement are separate branches.

  • Intrachain and HTLC-based cross-chain flows use different data shapes.

  • Partner fees use integrator terminology and pips.

  • ChainAddress and AssetId are separate concepts and should not share one validation path.

hashtag
Who this is for

  • Backend and low-level clients integrating with WebSocket or gRPC directly.

  • Resolver operators reasoning about quotes, reservations, and execution phases.

  • SDK users who want the protocol vocabulary behind SDK concepts. Practical SDK migration steps live in SDK-focused docs.

hashtag
Terminology

  • Input asset / output asset and input / output amounts use the trader's perspective: what the trader sends and receives.

  • Source blockchain and destination blockchain describe where the Input asset is provided and where the Output asset is delivered. For intrachain swaps, they are the same blockchain. For cross-chain swaps, they differ.

  • Swap settlement and order settlement are the two main settlement branches in quote data: immediate routing for swap settlement, and an order with Executions for order settlement.

  • Input position / Output position are protocol positions tied to an Execution in order settlement. Output position fields are used for HTLC-based cross-chain settlement and are not included in simple intrachain cases.

  • ChainAddress and AssetId (stonfi.common.v1) are separate types. Addresses identify wallets, contracts, and positions. Asset IDs identify assets. Validation and storage should treat them differently.

  • Integrator fees use integrator_address, integrator_fee_pips on the RFQ, and fee amounts in units on the quote: integrator_fee_units and protocol_fee_units. One pip is 0.0001%. This replaces the older referrer and bps terminology.

  • Gasless quotes may not include gas_budget and estimated_gas_consumption. Client code should not require these fields for every quote.

These terms are used across the docs, SDK examples, and resolver-facing APIs. Use them when naming internal fields, logs, dashboards, and support materials.

For the full list of changes, see Migration guide: v1beta7 → v1beta8. For the canonical term list, see Glossary.

hashtag
SDK

Recommended SDK docs:

PreviousOmniston GlossaryNextMigration v1beta7 → v1beta8

Last updated