aftermath-ts-sdk - v3.3.3
    Preparing search index...

    Interface PerpetualsMarketParams

    Static configuration parameters describing a perpetuals market.

    These values are typically immutable or rarely changed, and are used to drive risk limits, pricing, and fee schedules.

    interface PerpetualsMarketParams {
        baseAssetSymbol: string;
        baseOracleTolerance: bigint;
        basePriceFeedId: number;
        collateralOracleTolerance: bigint;
        collateralPriceFeedId: number;
        fundingFrequencyMs: bigint;
        fundingPeriodMs: bigint;
        insuranceFundFee: number;
        liquidationFee: number;
        lotSize: bigint;
        makerFee: number;
        marginRatioInitial: number;
        marginRatioMaintenance: number;
        maxOpenInterest: number;
        maxOpenInterestPositionPercent: number;
        maxOpenInterestThreshold: number;
        maxPendingOrders: bigint;
        minOrderUsdValue: number;
        premiumTwapFrequencyMs: bigint;
        premiumTwapPeriodMs: bigint;
        priorityTakerFee: number | undefined;
        scalingFactor: number;
        spreadTwapFrequencyMs: bigint;
        spreadTwapPeriodMs: bigint;
        takerFee: number;
        tickSize: bigint;
    }
    Index
    baseAssetSymbol baseOracleTolerance basePriceFeedId collateralOracleTolerance collateralPriceFeedId fundingFrequencyMs fundingPeriodMs insuranceFundFee liquidationFee lotSize makerFee marginRatioInitial marginRatioMaintenance maxOpenInterest maxOpenInterestPositionPercent maxOpenInterestThreshold maxPendingOrders minOrderUsdValue premiumTwapFrequencyMs premiumTwapPeriodMs priorityTakerFee scalingFactor spreadTwapFrequencyMs spreadTwapPeriodMs takerFee tickSize
    baseAssetSymbol: string

    Symbol of the underlying asset.

    baseOracleTolerance: bigint

    Oracle tolerance for the base asset price (scaled bigint).

    basePriceFeedId: number

    Numeric price-feed storage id of the base asset's oracle feed.

    collateralOracleTolerance: bigint

    Oracle tolerance for the collateral price (scaled bigint).

    collateralPriceFeedId: number

    Numeric price-feed storage id of the collateral asset's oracle feed.

    fundingFrequencyMs: bigint

    Funding interval duration in milliseconds.

    fundingPeriodMs: bigint

    Funding period used for calculations in milliseconds.

    insuranceFundFee: number

    Fraction of fees directed to the insurance fund.

    liquidationFee: number

    Liquidation fee rate (fraction) charged on liquidations.

    lotSize: bigint

    Minimum base size increment for orders (lot size, scaled bigint).

    makerFee: number

    Maker fee rate (fraction) charged for providing liquidity.

    marginRatioInitial: number

    Initial margin requirement for new positions (fraction).

    marginRatioMaintenance: number

    Maintenance margin requirement for open positions (fraction).

    maxOpenInterest: number

    Maximum open interest (absolute).

    maxOpenInterestPositionPercent: number

    Maximum fraction of open interest a single position can hold.

    maxOpenInterestThreshold: number

    Threshold above which open interest is considered elevated.

    maxPendingOrders: bigint

    Maximum open interest (notional or base) allowed in the market.

    minOrderUsdValue: number

    Minimum notional order value in USD.

    premiumTwapFrequencyMs: bigint

    TWAP frequency for the premium in milliseconds.

    premiumTwapPeriodMs: bigint

    TWAP period for the premium in milliseconds.

    priorityTakerFee: number | undefined

    Additional taker fee charged when the transaction is submitted with a gas price above the epoch reference gas price. undefined means priority-gas transactions are rejected on-chain; a value means the surcharge applies.

    scalingFactor: number

    Scaling factor used in internal fixed-point conversions.

    spreadTwapFrequencyMs: bigint

    TWAP frequency for the spread in milliseconds.

    spreadTwapPeriodMs: bigint

    TWAP period for the spread in milliseconds.

    takerFee: number

    Taker fee rate (fraction) charged for taking liquidity.

    tickSize: bigint

    Minimum price increment (tick size, scaled bigint).

    Settings
    Member Visibility

    On This Page
    Properties