predict/expiry_market library

Full generated bindings for the expiry_market Move module (deepbook_predict): every move-call builder and BCS struct, including symbols the flat package:deepbook/predict.dart surface hides to avoid name collisions. Import with a prefix: import 'package:deepbook/predict/expiry_market.dart' as expiry_market;

Properties

ExpiryMarket → BcsType<Map<String, dynamic>, dynamic>

final

MintQuote → BcsType<Map<String, dynamic>, dynamic>

final

ValuationStamp → BcsType<Map<String, dynamic>, dynamic>

final

Functions

admissionTickSize({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the admission-grid step for SDK and devInspect range construction.

allInCost({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the total quoted account withdrawal for SDK and devInspect consumers.

backingBufferLambda({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the snapshotted backing-buffer lambda for SDK and devInspect reads.

builderFee({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the quoted builder fee for SDK and devInspect consumers.

cashBalance({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return expiry USDC custody for SDK and devInspect state reads.

currentNav({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return live marked NAV as free expiry cash minus the exposure book's marked liability, floored at zero. This read requires a market-bound pre-expiry Pricer; an expired but unsettled market cannot be valued through this path. Public for PTB composition and devInspect pool valuation.

entryProbability({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the quoted range probability for SDK and devInspect consumers.

expiry({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the expiry timestamp for SDK and devInspect market reads.

expiryFeeMaxMultiplier({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the snapshotted fee-ramp multiplier for SDK and devInspect reads.

expiryFeeWindowMs({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the snapshotted fee-ramp window for SDK and devInspect reads.

feeIncentiveBalance({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return local fee incentives for SDK and devInspect state reads.

feeIncentiveSubsidy({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the sponsor-funded portion of the quoted fee for SDK and devInspect consumers.

id({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the market object ID for external discovery and PTB construction.

inventoryImpactCharge({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the separate inventory-impact charge for SDK and devInspect quote consumers.

inventoryImpactMaxRate({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return this market's immutable maximum marginal inventory-impact rate for SDK and devInspect state reads.

inventoryImpactReserve({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the isolated inventory-impact escrow for SDK and devInspect state reads.

inventoryImpactScale({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the immutable USDC scale of this market's inventory-impact curve for SDK and devInspect state reads.

isPendingValuation({dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return whether this market is snapshotted into the in-flight flush and still awaiting its value_expiry. For SDK, keeper, and devInspect reads. It gates nothing: settlement and trading both run regardless — the frozen mark is settlement-invariant, so a stamped market settles the instant it expires. Do not defer a settlement attempt on this read.

isSettled({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return whether terminal settlement has been recorded for this market. Public read for SDK/devInspect settlement-state checks.

liveOrderValue({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return one live order's full-close range value before fees. Requires a market-bound Pricer and does not prove account ownership of order_id. Public for SDK, PTB, and devInspect position valuation.

loadLivePricer({dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Load a PTB-local live pricing snapshot for this market.

mintExactAmount({dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Mint a conservatively sized lot-rounded position whose premium does not exceed max_premium. The result may be one lot below the largest fitting quantity and must meet min_quantity.

mintExactCost({dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Mint a lot-rounded position within an all-in max_cost budget.

mintExactQuantity({dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Mint an exact live position quantity against this expiry market.

mintPaused({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the market mint-pause state for SDK and devInspect reads.

payoutLiability({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return payout reserve or settled liability for external accounting observability.

penaltyFee({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the quoted EWMA congestion surcharge for SDK and devInspect consumers.

premium({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the quoted premium for SDK and devInspect consumers.

propbookUnderlyingId({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the Propbook underlying for SDK and devInspect market reads.

quantity({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the sized quantity for SDK and devInspect quote consumers.

quoteMint({dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Quote the all-in cost of a mint request for an anonymous taker (no builder code) without mutating any market state. Exact-quantity mode uses min_quantity; budget mode conservatively sizes a lot-rounded fill under max_premium. The quote applies live-mint and admission gates but does not preflight account balance, slippage caps, or exposure-index capacity. Its penalty uses the current pre-update EWMA state. Public for SDK and devInspect pre-trade pricing.

quoteMintExactCostForAccount({dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Quote mint_exact_cost for one account: the fill that mint would size for max_cost, capped by total account balance including unsettled accumulator funds, with that fill's cost decomposition. Applies the mint's live-mint gates, sizing, min_quantity floor, and admission, but does not preflight exposure-index capacity or cash backing. quantity is the figure to derive a min_quantity slippage floor from. Public for SDK and devInspect pre-trade pricing.

quoteMintForAccount({dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Quote the all-in cost of a mint request for one account, reading its builder code. Budget mode caps premium by total account balance, including unsettled accumulator funds. Public for SDK and devInspect pre-trade pricing.

redeemLive({dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Redeem a live order you hold account authority over.

redeemSettled({dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Redeem a settled order you hold account authority over.

redeemSettledPermissionless({dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Permissionlessly redeem a settled order without account-owner authority.

referenceTick({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the admitted reference tick for SDK and devInspect range construction.

referenceTickSourceTimestampMs({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the reference observation timestamp for SDK and devInspect reads.

requiredCash({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return required expiry cash for external accounting observability.

setMintPaused({dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Set whether new mints are paused on this expiry market. Admin-only and version-gated. A PauseCap holder can force-engage the pause one-way under a version freeze via registry::pause_expiry_market_mint_pause_cap.

setReferenceTick({dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Set this expiry's reference fine-grid tick from the exact previous-window Propbook Pyth observation. The source observation must be inserted into the feed at reference_tick_source_timestamp_ms before this call, and the normalized spot is floored to the market's tick_size. Not gated on the valuation lock: the reference tick shapes mint admission only, and a mint it admits mid-flush is invisible to the captured snapshot like any other.

settledOrderPayout({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return one settled order's terminal payout. This function does not prove account ownership of order_id. Public for SDK, PTB, and devInspect position valuation.

settlementPrice({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the recorded settlement price. Aborts if the market is not settled.

tickSize({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the strike tick size for SDK and devInspect range construction. Raw strikes are tick * tick_size.

tradingFee({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the quoted trading fee before subsidy for SDK and devInspect consumers.

trySettle({dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Settle from Propbook's exact positive Pyth spot at expiry, or from the exact Block Scholes minute-boundary spot when Pyth remains unavailable after the compiled grace period. Permissionless and idempotent; missing or unusable observations leave the market unsettled.

trySettlementPrice({required dynamic arguments, String? package, Map<String, dynamic>? config}) → MoveCallBuilder

Return the recorded settlement price, or none while the market is live. Non-aborting companion to settlement_price for SDK/devInspect reads.