Muon oracle

Muon is a decentralized oracle network. SYMMIO uses it to attest to prices, unrealized-PnL (uPnL) values, and account overviews that the contract will only accept when signed by a trusted quorum (removeMargin / deallocate, settlement, force-close, liquidation).

@symmio/trading-core exposes each documented Muon endpoint as its own typed read. Every method resolves the oracle gateway URLs and the SYMMIO diamond address (the symmio request param) from config, tries the configured gateways in order until one succeeds, and returns a normalized attestation — typed bigint / Address fields plus the shared signature envelope. The raw envelope fields common to every return are documented once on MuonAttestationBase.

Each method has its own page with the full signature, parameters, return shape, examples, and query options.

Prices

getMuonPrice

Validated prices for a set of quote ids.

getMuonPriceRange

TWAP-style price range over a time window for force-close validation.

uPnL attestations

getMuonUpnl

Combined partyA + partyB unrealized PnL in one attestation.

getMuonUpnlA

A partyA’s unrealized-PnL attestation.

getMuonUpnlB

A partyB’s unrealized PnL computed against a partyA.

getMuonUpnlWithSymbolPrice

Both parties’ uPnL plus a single symbol price.

getMuonUpnlAWithSymbolPrice

A partyA’s uPnL plus a single symbol price.

getMuonSettleUpnl

A partyA’s uPnL settlement data for a set of quotes.

getMuonPartyAOverview

A partyA’s liquidation overview.

Contract signatures

getDeallocateUpnlSig

A uPnl_A attestation assembled into the contract-ready SingleUpnlSig that removeMargin / deallocate need.

Types

MuonAttestationBase

The signature envelope every normalized attestation return extends.

Query options

Each read ships a matching …QueryOptions factory and a …QueryKey builder for TanStack Query. See each method’s page for the exact call, and Query options for the shared pattern. Attestations are timestamped and short-lived — cache them with a low staleTime, and for a signature you intend to submit on-chain fetch a fresh one on demand rather than serving a cached one.

Errors

MUON_URLS_NOT_CONFIGURED — the chain has no Muon gateway URLs in its config. Surfaces as a SymmError with kind: "config".
MUON_REQUEST_UNSUCCESSFUL — a gateway responded but the attestation was unsuccessful (quorum failure, invalid request). Surfaces as a SymmError with kind: "api".
FETCH_MUON_REQUEST_FAILED — every configured gateway failed at the transport / HTTP layer. Surfaces as a SymmApiError (kind: "api") carrying the last transport error.

SYMMIO Contract — writes that consume Muon attestations (removeMargin, settle, force-close).
AccountLayer — removeMargin / deallocate, which need getDeallocateUpnlSig.
Errors — the full SymmError catalogue.