Documentation
    Preparing search index...

    Interface MintCostInputs

    Inputs for mintCost: an exact payout quantity.

    interface MintCostInputs {
        book?: MintBookTerms;
        builderCode?: boolean;
        expiryMs: number | bigint;
        feeIncentiveBalance?: number | bigint;
        feeIncentiveSubsidyRate?: bigint;
        fees: FeePolicy;
        lotSize?: bigint;
        nowMs?: number | bigint;
        penaltyRate?: bigint;
        probabilities: ProbabilitySource;
        quantity: number | bigint;
    }

    Hierarchy

    • MintInputsBase
      • MintCostInputs
    Index
    book? builderCode? expiryMs feeIncentiveBalance? feeIncentiveSubsidyRate? fees lotSize? nowMs? penaltyRate? probabilities quantity
    book?: MintBookTerms

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

    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.

    feeIncentiveSubsidyRate?: bigint

    The protocol's admin-set mint fee subsidy rate (protocol_config::fee_incentive_subsidy_rate), 1e9-scaled. Defaults to the 20% the chain reads while unset.

    fees: FeePolicy

    The market's snapshotted fee policy.

    lotSize?: bigint

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

    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. A queued (delayed-execution) fill pays no congestion penalty, so queued previews keep it 0.

    probabilities: ProbabilitySource

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

    quantity: number | bigint

    Maximum payout bought, in quote units — number is human USD, bigint is raw.

    Settings
    Member Visibility

    On This Page
    Properties