Documentation
    Preparing search index...

    Interface PredictPackages

    The published Move packages a Predict deployment spans.

    Delayed execution (DBU-885) ships as three packages: the Predict upgrade, the order-flow companion deepbook_predict_orders (a fresh publish), and the math library deepbook_predict_math (a fresh publish). The queued-order builders, reads and decoders need predictDelayedExecution, predictOrders, objects.orderDesk and objects.queueRegistry all recorded, and throw PredictInputError otherwise rather than address the wrong package. Pass a custom config (a localnet publish) to use them before a network record exists.

    interface PredictPackages {
        account: string;
        accountLatest?: string;
        predict: string;
        predictCurrentVersion?: bigint;
        predictDelayedExecution?: string;
        predictMath?: string;
        predictOrders?: string;
        predictOrdersCurrentVersion?: bigint;
        predictOrdersV1?: string;
        predictV1?: string;
        propbook: string;
    }
    Index
    account accountLatest? predict predictCurrentVersion? predictDelayedExecution? predictMath? predictOrders? predictOrdersCurrentVersion? predictOrdersV1? predictV1? propbook
    account: string

    ORIGINAL account package ID: type tags (DataKey, events) and the derived wrapper and account addresses are built from it, so it never moves.

    accountLatest?: string

    Latest account package once the network has upgraded it: the call target of every account call in a Predict PTB (generate_auth, deposit_funds, load_account, …). A PTB can't call a package at an older version than another package in it links, and Predict's Version 5 links account v2. Omit while account is at v1: calls then target account.

    predict: string

    Latest published package ID, used for Move calls.

    predictCurrentVersion?: bigint

    Predict's constants::current_version compiled into predict, the call target. A ProtocolConfig.version_watermark above it retires the code this config calls. It follows the Mainnet package number, not the Testnet one (Testnet's package v8 compiles 5). Defaults to PREDICT_PACKAGE_VERSION, the version these bindings were generated from.

    predictDelayedExecution?: string

    The Predict version that introduced delayed execution (Mainnet v4, Testnet v5): the defining ID of the Predict types and events that version added (ExpiryPnlRealized, FlushOperatorUpdated, OrderFlowUpdated, OrderReceipt). A later upgrade does not move it, so it is pinned once per network rather than read from the latest publication.

    predictMath?: string

    The deepbook_predict_math package ID, for its pure calls and layouts.

    predictOrders?: string

    Latest published deepbook_predict_orders package ID: the call target of every queued-order entry point (queue::enqueue_*, commit, resolve, refund, settle_step, …), the queue reads and the desk setters.

    predictOrdersCurrentVersion?: bigint

    desk::current_version compiled into predictOrders. A desk floor above it retires the order-flow code this config calls. Defaults to ORDER_FLOW_PACKAGE_VERSION.

    predictOrdersV1?: string

    Original deepbook_predict_orders ID, which types MarketQueue, OrderDesk, the queue events and the OrderFlow witness. Omit until the package is first upgraded: it then defaults to predictOrders.

    predictV1?: string

    Original ID for v1 structs/events. Omit only for an unupgraded custom deployment.

    propbook: string

    Settings
    Member Visibility

    On This Page
    Properties