Documentation
    Preparing search index...

    Interface QueuedOrderPreview

    What a queued order builder previews alongside the transaction. Display only.

    interface QueuedOrderPreview {
        budget: number;
        cashNeedRaw: bigint;
        fundedInTransaction: boolean;
        kind: number;
        kindName: OrderKindName;
        marketId: string;
        needsFunding: boolean;
        orderFee: number;
        raw: { budget: bigint; orderFee: bigint; totalDebit: bigint };
        spareCashRaw: bigint;
        timing: TimingPreview;
        totalDebit: number;
    }
    Index
    budget cashNeedRaw fundedInTransaction kind kindName marketId needsFunding orderFee raw spareCashRaw timing totalDebit
    budget: number

    USDC escrowed for the premium and fees; 0 for a sell. Unused budget returns at the fill.

    cashNeedRaw: bigint

    The order's worst-case cash need against the market's spare cash.

    fundedInTransaction: boolean

    Whether the builder added rebalance_expiry_cash after the enqueue.

    kind: number
    kindName: OrderKindName
    marketId: string
    needsFunding: boolean

    Sells only: the cash need is above spare cash, so the sell may be refunded in full (reason 8) unless the market is funded before the fill.

    orderFee: number

    The flat order fee, charged once at enqueue.

    raw: { budget: bigint; orderFee: bigint; totalDebit: bigint }
    spareCashRaw: bigint
    timing: TimingPreview

    τ, deadline and cutoff for an order placed now, from the local clock.

    totalDebit: number

    What enqueue debits: budget + order fee.

    Settings
    Member Visibility

    On This Page
    Properties