Documentation
    Preparing search index...

    Interface RedeemLiveInputs

    Inputs for redeemLiveProceeds. The range is the ORDER's own range — the same two boundaries it was minted over, which is what redeem_live reprices.

    interface RedeemLiveInputs {
        book?: CloseBookTerms;
        builderCode?: boolean;
        closeQuantity: number | bigint;
        expiryMs: number | bigint;
        fees: FeePolicy;
        lotSize?: bigint;
        nowMs?: number | bigint;
        penaltyRate?: bigint;
        positionQuantity?: number | bigint;
        probabilities: ProbabilitySource;
    }
    Index
    book? builderCode? closeQuantity expiryMs fees lotSize? nowMs? penaltyRate? positionQuantity? probabilities
    book?: CloseBookTerms

    Pre-trade payout-tree terms. Required when inventory impact is enabled.

    builderCode?: boolean
    closeQuantity: number | bigint

    Payout being closed — the whole order, or part of it.

    expiryMs: number | bigint
    fees: FeePolicy
    lotSize?: bigint
    nowMs?: number | bigint
    penaltyRate?: bigint
    positionQuantity?: number | bigint

    Current position payout quantity, when known. Validates the close and returns the remainder.

    probabilities: ProbabilitySource

    The order's boundary probabilities now, or a pricer snapshot plus the order's strikes.

    Settings
    Member Visibility

    On This Page
    Properties