@somnia-chain/markets-sdk

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

Interface: ClaimableInput

Defined in: packages/sdk/src/derivedReads.ts:775

A settled binary position to evaluate for claimability.

Properties

marketId

marketId: string

Defined in: packages/sdk/src/derivedReads.ts:777

Market id (bytes32 hex), passed through to the output.

pool

pool: string

Defined in: packages/sdk/src/derivedReads.ts:779

The market's pool address, passed through to the output.

outcomeIdx

outcomeIdx: 0 | 1

Defined in: packages/sdk/src/derivedReads.ts:781

0 = YES, 1 = NO ā€” which outcome this position holds.

amount

amount: bigint

Defined in: packages/sdk/src/derivedReads.ts:783

Held outcome-token balance (raw). Non-positive positions are dropped.

winningOutcome

winningOutcome: number | null

Defined in: packages/sdk/src/derivedReads.ts:785

Winning outcome (0/1) when resolved; null when voided/unresolved.

voided

voided: boolean

Defined in: packages/sdk/src/derivedReads.ts:792

True when the market voided. A void redeems against the market's stored payout vector (ClaimableInput.payoutNumerators), which is a half per side under the UNIFORM void policy but [p, Dāˆ’p] on a CLOB_SNAPSHOT void that captured a two-sided close.

payoutNumerators?

optional payoutNumerators?: string[] | null

Defined in: packages/sdk/src/derivedReads.ts:800

Per-outcome payout numerators the market settled to (decimal strings), from BinaryMarket.payoutNumerators. Supply these on a voided position so the payout comes from the vector rather than an assumed half. Null/omitted on markets indexed before the vector fields existed ā€” the estimate then falls back to the half, unchanged from pre-vector behaviour.

payoutDenominator?

optional payoutDenominator?: string | null

Defined in: packages/sdk/src/derivedReads.ts:802

Denominator the numerators are scaled against (decimal string); null/omitted with them.

status

status: string

Defined in: packages/sdk/src/derivedReads.ts:804

Market lifecycle status ("Resolved" | "Voided" | ā€¦), passed through to the output.

settlementFeeBps

settlementFeeBps: bigint

Defined in: packages/sdk/src/derivedReads.ts:806

Settlement fee in bps (1 = 0.01%); the winner payout skims this.