{s}omniamarkets

@somnia-chain/markets-sdk


@somnia-chain/markets-sdk / index / SettlementRecord

Interface: SettlementRecord

Defined in: trade.ts:553

A market's settlement record on the BinarySettlement singleton (the permanent redemption home). Mirrors the on-chain MarketSettlement struct.

Properties

collateralToken

collateralToken: `0x${string}`

Defined in: trade.ts:555

The ERC-20 collateral the net backing is held in.


backing

backing: bigint

Defined in: trade.ts:558

The NET collateral held for this market (post fee-skim on resolution), decremented by each redemption's payout.


finalized

finalized: boolean

Defined in: trade.ts:560

True once the pool's backing + snapshot have been swept in. Gates redemption.


voided

voided: boolean

Defined in: trade.ts:562

True if the market voided (both sides redeem at half; never a settlement fee).


winningOutcome

winningOutcome: number

Defined in: trade.ts:565

The winning outcome index (0 = YES, 1 = NO); derived as argmax of payoutNumerators. Meaningful only when !voided.


payoutNumerators

payoutNumerators: bigint[]

Defined in: trade.ts:568

Settlement v3 fee-scaled payout VECTOR (denominator 10_000_000). Redemption of outcome i pays amount × payoutNumerators[i] / 10_000_000.


settlementFeeBpsTimes1k

settlementFeeBpsTimes1k: bigint

Defined in: trade.ts:570

The one-time settlement-fee rate skimmed at finalize (bps×1000; retained for audit).


feeRecipient

feeRecipient: `0x${string}`

Defined in: trade.ts:572

The address the settlement fee was skimmed to at finalize.


pool

pool: `0x${string}`

Defined in: trade.ts:574

The pool that finalized this market (the address encoded in the outcome ids).


nonce

nonce: bigint

Defined in: trade.ts:576

The pool's market nonce for this record.