getMuonPartyAOverview

Fetch a fresh Muon partyA_overview attestation for partyA and normalize it to typed fields. This is the uPnL + liquidation data behind liquidatePartyA / setSymbolsPrice (it produces a LiquidationSig). The oracle URLs and the SYMMIO diamond address are resolved from config; gateways are tried in order until one succeeds.


import { getMuonPartyAOverview } from "@symmio/trading-core";
 
const overview = await getMuonPartyAOverview(config, { partyA: "0xva..." });
console.log(overview.uPnl, overview.liquidationId);

Parameters

partyAAddressrequired

The partyA (virtual account for lowcap) to attest.

chainIdnumberoptional

Optional chain override.

Returns

GetMuonPartyAOverviewReturnType

partyAAddress

The attested partyA.

uPnlbigintrequired

Signed unrealized PnL (18-decimal, signed).

notionalValueSumbigintoptional

Sum of notional values across the partyA’s positions.

lossbigintoptional

Aggregated loss used by the liquidation flow.

liquidationIdstringoptional

Raw liquidation id for this partyA, when the attestation carries one.

symbolIdsbigint[]

Symbol ids included in the attestation.

quoteIdsbigint[]

Quote ids included in the attestation.

Plus the MuonAttestationBase signature envelope fields.

Query options


import { getMuonPartyAOverviewQueryOptions } from "@symmio/trading-core";
import { useQuery } from "@tanstack/react-query";
 
useQuery(getMuonPartyAOverviewQueryOptions(config, { partyA }));

GetMuonPartyAOverviewOptions requires partyA; the factory does not accept missing inputs or validate them inside queryFn. The getMuonPartyAOverviewQueryKey builder still accepts partial inputs for cache matching and invalidation.