predict/protocol_config library
Full generated bindings for the protocol_config 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/protocol_config.dart' as protocol_config;
Properties
-
ProtocolConfig
→ BcsType<
Map< String, dynamic> , dynamic> -
final
Functions
-
bumpVersionWatermark(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder -
Advance the version floor to this package's compiled-in
current_version!(). -
frozen(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Return the global protocol-freeze state for SDK and devInspect reads.
-
id(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Return the protocol config object ID for external discovery and PTB construction.
-
noTradeWindowMs(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder -
Window before expiry in which live quotes, mints, and live redeems abort.
publicfor SDK and devInspect reads: a client that cannot see this value can only learn the window closed by decodingETradeWindowClosedfrom a failed quote. -
referralFeeRate(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Return the live referral fee rate for SDK and devInspect reads.
-
setBlockScholesPriceFreshnessMs(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set the live Block Scholes spot/forward freshness threshold.
-
setBlockScholesSviFreshnessMs(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set the live Block Scholes SVI freshness threshold.
-
setEwmaEnabled(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Enable or disable the EWMA gas-price penalty.
-
setEwmaParams(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set the EWMA gas-price penalty parameters.
-
setFrozen(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set the protocol-wide emergency freeze.
-
setLpRequestLimitFlushAttempts(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder -
Set how many frozen-mark attempts a queued LP request gets before it is
cancelled and refunded.
1is fill-or-kill. Raising it lets a request rest at the head across flushes, which stops that queue each time it misses — see RP-12 for the liveness cost that buys. -
setMaxLpPoolValue(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set the ceiling on LP-attributable pool value that queued supplies may raise the pool to. A supply that would carry the pool past it is filled up to the cap at the flush and its remainder stays queued; withdrawals and already-issued PLP are unaffected, so lowering this below current pool value closes the pool to new capital rather than forcing anyone out.
-
setMaxValuationWindowMs(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set how long a started full-pool valuation may stay in flight before anyone may discard it. A stalled flush costs LP-fill latency (and settlement latency for its own market set), not a trading pause, so this is an operator liveness knob: too short and a legitimate long flush can be discarded from under the keeper, too long and an abandoned one delays queued LP fills for that duration. See RP-29.
-
setNoTradeWindowMs(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder -
Set the window before expiry in which live quotes, mints, and live redeems
abort.
0disables the block. Read live at trade time, so a change applies to markets already trading and stays available as an incident control. -
setPlpSupplyFeeRate(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set the fee charged on executed PLP supply fills. Admin-gated and validated against its config-constants envelope. Locked during valuation so the rate a flush froze into its mark cannot change midway through that flush.
-
setPlpWithdrawFeeRate(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set the fee charged on executed PLP withdraw fills. Same gating as the supply leg; the two are independent so the exit charge can move without taxing entry.
- Set the protocol reserve profit share used when materializing aggregate expiry profit. Admin-gated; validated against its config-constants envelope.
-
setPythSpotFreshnessMs(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set the live Pyth spot freshness threshold.
-
setReferralFeeRate(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set the portion of referred mint fees routed to the referrer. The new rate applies to subsequent mints without changing their all-in account withdrawal.
-
setTemplateBackingBufferLambda(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set the backing-buffer lambda snapshotted by newly created expiry markets.
-
setTemplateBaseFee(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set the base fee multiplier snapshotted by newly created expiry markets.
-
setTemplateExpiryFeeMaxMultiplier(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set the expiry-fee max multiplier snapshotted by newly created expiry markets.
-
setTemplateExpiryFeeWindowMs(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set the expiry-fee ramp window snapshotted by newly created expiry markets.
-
setTemplateInventoryImpactMaxRate(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder -
Set the maximum marginal inventory-impact rate snapshotted by newly created
expiry markets.
0(the default) disables both charges and rebates. -
setTemplateMaxEntryProbability(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set the maximum raw entry probability snapshotted by newly created expiry markets.
-
setTemplateMinEntryProbability(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set the minimum raw entry probability snapshotted by newly created expiry markets.
-
setTemplateMinFee(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set the minimum fee floor snapshotted by newly created expiry markets.
-
setTradingPaused(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Set whether trading is paused.
-
setUsePythSpotForForward(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder -
Select which source the live forward is built from:
truecarries the Block Scholes basis on a fresh Pyth spot,falseuses the Block Scholes forward directly. Locked during valuation so one flush marks every market on one formula. -
tradingPaused(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Return the global trading-pause state for SDK and devInspect reads.
-
valuationInProgress(
{dynamic arguments, String? package, Map< String, dynamic> ? config}) → MoveCallBuilder - Return whether a full-pool valuation is in flight, for SDK and devInspect reads. The flush spans transactions, so "in flight" is an observable state: a keeper reads it to notice a flush it must finish or discard, and an integrator reads it to explain a gated keeper/config transaction. Trading is not gated on it.