Documentation
    Preparing search index...

    Interface MintBudgetInputs

    Inputs for mintCostForBudget: an all-in budget, the mint_exact_cost shape.

    interface MintBudgetInputs {
        accountBalance?: number | bigint;
        book?: MintBookTerms;
        budget: number | bigint;
        builderCode?: boolean;
        expiryMs: number | bigint;
        feeIncentiveBalance?: number | bigint;
        fees: FeePolicy;
        lotSize?: bigint;
        minQuantity?: number | bigint;
        nowMs?: number | bigint;
        penaltyRate?: bigint;
        probabilities: ProbabilitySource;
    }

    Hierarchy

    • MintInputsBase
      • MintBudgetInputs
    Index
    accountBalance? book? budget builderCode? expiryMs feeIncentiveBalance? fees lotSize? minQuantity? nowMs? penaltyRate? probabilities
    accountBalance?: number | bigint

    The account's settled USDC. The chain caps the budget at it before sizing; pass it to reproduce that cap (and to let U64_MAX mean "my whole balance").

    book?: MintBookTerms

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

    budget: number | bigint

    The total to spend, fees included.

    builderCode?: boolean

    Whether the minting account carries a builder code (it pays the builder fee).

    expiryMs: number | bigint

    Market expiry, ms since epoch.

    feeIncentiveBalance?: number | bigint

    The expiry's remaining sponsored fee balance (fee_incentive_balance). Default 0n.

    fees: FeePolicy

    The market's snapshotted fee policy.

    lotSize?: bigint

    The deployment's position_lot_size. Defaults to the Move constant, 10_000n.

    minQuantity?: number | bigint

    Floor on the fill; a smaller result aborts, as mint_exact_cost does. Default one lot.

    nowMs?: number | bigint

    The clock the trade will price against, ms since epoch. Defaults to Date.now().

    penaltyRate?: bigint

    Per-unit congestion surcharge rate — see congestionPenaltyRate. Default 0n.

    probabilities: ProbabilitySource

    Boundary probabilities, or a pricer snapshot plus the range's strikes.

    Settings
    Member Visibility

    On This Page
    Properties