aftermath-ts-sdk 1.3.28 → 2.0.0

package/dist/packages/perpetuals/perpetualsCastingTypes.d.ts

@@ -1,170 +0,0 @@
-import { EventOnChain } from "../../general/types/castingTypes";
-import { BigIntAsString, Byte, IFixedAsString, ObjectId, PerpetualsAccountId, SuiAddress } from "../../types";
-export type UpdatedMarketVersionEventOnChain = EventOnChain<{
-    ch_id: ObjectId;
-    version: BigIntAsString;
-}>;
-export type WithdrewCollateralEventOnChain = EventOnChain<{
-    account_id: BigIntAsString;
-    collateral: BigIntAsString;
-}>;
-export type DepositedCollateralEventOnChain = EventOnChain<{
-    account_id: BigIntAsString;
-    collateral: BigIntAsString;
-}>;
-export type AllocatedCollateralEventOnChain = EventOnChain<{
-    ch_id: ObjectId;
-    account_id: BigIntAsString;
-    collateral: BigIntAsString;
-}>;
-export type DeallocatedCollateralEventOnChain = EventOnChain<{
-    ch_id: ObjectId;
-    account_id: BigIntAsString;
-    collateral: BigIntAsString;
-}>;
-export type SettledFundingEventOnChain = EventOnChain<{
-    ch_id: ObjectId;
-    account_id: BigIntAsString;
-    collateral_change_usd: IFixedAsString;
-    mkt_funding_rate_long: IFixedAsString;
-    mkt_funding_rate_short: IFixedAsString;
-}>;
-export type LiquidatedEventOnChain = EventOnChain<{
-    ch_id: ObjectId;
-    liqee_account_id: BigIntAsString;
-    liqor_account_id: BigIntAsString;
-    is_liqee_long: boolean;
-    base_liquidated: IFixedAsString;
-    quote_liquidated: IFixedAsString;
-    liqee_pnl: IFixedAsString;
-    liquidation_fees: IFixedAsString;
-    force_cancel_fees: IFixedAsString;
-    insurance_fund_fees: IFixedAsString;
-    bad_debt: IFixedAsString;
-}>;
-export type PerformedLiquidationEventOnChain = EventOnChain<{
-    ch_id: ObjectId;
-    liqee_account_id: BigIntAsString;
-    liqor_account_id: BigIntAsString;
-    is_liqee_long: boolean;
-    base_liquidated: IFixedAsString;
-    quote_liquidated: IFixedAsString;
-    liqor_pnl: IFixedAsString;
-    liqor_fees: IFixedAsString;
-}>;
-export type CreatedAccountEventOnChain = EventOnChain<{
-    user: SuiAddress;
-    account_id: BigIntAsString;
-}>;
-export type CreatedSubAccountEventOnChain = EventOnChain<{
-    users: SuiAddress[];
-    account_id: PerpetualsAccountId;
-    subaccount_id: ObjectId;
-}>;
-export type SetSubAccountUsersEventOnChain = EventOnChain<{
-    users: SuiAddress[];
-    account_id: PerpetualsAccountId;
-    subaccount_id: ObjectId;
-}>;
-export type SetPositionInitialMarginRatioEventOnChain = EventOnChain<{
-    ch_id: ObjectId;
-    account_id: BigIntAsString;
-    initial_margin_ratio: IFixedAsString;
-}>;
-export type CanceledOrderEventOnChain = EventOnChain<{
-    ch_id: ObjectId;
-    account_id: BigIntAsString;
-    size: BigIntAsString;
-    order_id: BigIntAsString;
-}>;
-export type FilledMakerOrdersEventOnChain = EventOnChain<{
-    events: {
-        ch_id: ObjectId;
-        maker_account_id: BigIntAsString;
-        taker_account_id: BigIntAsString;
-        fees: IFixedAsString;
-        filled_size: BigIntAsString;
-        order_id: BigIntAsString;
-        pnl: IFixedAsString;
-        remaining_size: BigIntAsString;
-        canceled_size: BigIntAsString;
-    }[];
-}>;
-export type FilledTakerOrderEventOnChain = EventOnChain<{
-    ch_id: ObjectId;
-    taker_account_id: BigIntAsString;
-    taker_pnl: IFixedAsString;
-    taker_fees: IFixedAsString;
-    base_asset_delta_ask: IFixedAsString;
-    quote_asset_delta_ask: IFixedAsString;
-    base_asset_delta_bid: IFixedAsString;
-    quote_asset_delta_bid: IFixedAsString;
-}>;
-export type PostedOrderEventOnChain = EventOnChain<{
-    ch_id: ObjectId;
-    account_id: BigIntAsString;
-    order_id: BigIntAsString;
-    order_size: BigIntAsString;
-    reduce_only: boolean;
-    expiration_timestamp_ms: BigIntAsString | null;
-}>;
-export type ReducedOrderEventOnChain = EventOnChain<{
-    ch_id: ObjectId;
-    account_id: BigIntAsString;
-    size_change: BigIntAsString;
-    order_id: BigIntAsString;
-}>;
-export type CreatedStopOrderTicketEventOnChain = EventOnChain<{
-    ticket_id: ObjectId;
-    account_id: BigIntAsString;
-    subaccount_id: BigIntAsString | null;
-    executors: SuiAddress[];
-    gas: BigIntAsString;
-    stop_order_type: BigIntAsString;
-    encrypted_details: Byte[];
-}>;
-export type ExecutedStopOrderTicketEventOnChain = EventOnChain<{
-    ticket_id: ObjectId;
-    account_id: BigIntAsString;
-    executor: SuiAddress;
-}>;
-export type DeletedStopOrderTicketEventOnChain = EventOnChain<{
-    ticket_id: ObjectId;
-    account_id: BigIntAsString;
-    subaccount_id: ObjectId | null;
-    executor: SuiAddress;
-}>;
-export type EditedStopOrderTicketDetailsEventOnChain = EventOnChain<{
-    ticket_id: ObjectId;
-    account_id: BigIntAsString;
-    subaccount_id: ObjectId | null;
-    stop_order_type: BigIntAsString;
-    encrypted_details: Byte[];
-}>;
-export type EditedStopOrderTicketExecutorEventOnChain = EventOnChain<{
-    ticket_id: ObjectId;
-    account_id: BigIntAsString;
-    subaccount_id: ObjectId | null;
-    executors: SuiAddress[];
-}>;
-export type UpdatedPremiumTwapEventOnChain = EventOnChain<{
-    ch_id: ObjectId;
-    index_price: IFixedAsString;
-    book_price: IFixedAsString;
-    premium_twap: IFixedAsString;
-    premium_twap_last_upd_ms: BigIntAsString;
-}>;
-export type UpdatedSpreadTwapEventOnChain = EventOnChain<{
-    ch_id: ObjectId;
-    book_price: IFixedAsString;
-    index_price: IFixedAsString;
-    spread_twap: IFixedAsString;
-    spread_twap_last_upd_ms: BigIntAsString;
-}>;
-export type UpdatedFundingEventOnChain = EventOnChain<{
-    ch_id: ObjectId;
-    cum_funding_rate_long: IFixedAsString;
-    cum_funding_rate_short: IFixedAsString;
-    funding_last_upd_ms: BigIntAsString;
-}>;
-//# sourceMappingURL=perpetualsCastingTypes.d.ts.map

package/dist/packages/perpetuals/perpetualsCastingTypes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"perpetualsCastingTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/perpetuals/perpetualsCastingTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAChE,OAAO,EAEN,cAAc,EACd,IAAI,EAIJ,cAAc,EAEd,QAAQ,EACR,mBAAmB,EAInB,UAAU,EACV,MAAM,aAAa,CAAC;AAUrB,MAAM,MAAM,gCAAgC,GAAG,YAAY,CAAC;IAC3D,KAAK,EAAE,QAAQ,CAAC;IAChB,OAAO,EAAE,cAAc,CAAC;CACxB,CAAC,CAAC;AAEH,MAAM,MAAM,8BAA8B,GAAG,YAAY,CAAC;IACzD,UAAU,EAAE,cAAc,CAAC;IAE3B,UAAU,EAAE,cAAc,CAAC;CAC3B,CAAC,CAAC;AAEH,MAAM,MAAM,+BAA+B,GAAG,YAAY,CAAC;IAC1D,UAAU,EAAE,cAAc,CAAC;IAE3B,UAAU,EAAE,cAAc,CAAC;CAC3B,CAAC,CAAC;AAEH,MAAM,MAAM,+BAA+B,GAAG,YAAY,CAAC;IAC1D,KAAK,EAAE,QAAQ,CAAC;IAChB,UAAU,EAAE,cAAc,CAAC;IAE3B,UAAU,EAAE,cAAc,CAAC;CAC3B,CAAC,CAAC;AAEH,MAAM,MAAM,iCAAiC,GAAG,YAAY,CAAC;IAC5D,KAAK,EAAE,QAAQ,CAAC;IAChB,UAAU,EAAE,cAAc,CAAC;IAE3B,UAAU,EAAE,cAAc,CAAC;CAC3B,CAAC,CAAC;AAEH,MAAM,MAAM,0BAA0B,GAAG,YAAY,CAAC;IACrD,KAAK,EAAE,QAAQ,CAAC;IAChB,UAAU,EAAE,cAAc,CAAC;IAC3B,qBAAqB,EAAE,cAAc,CAAC;IACtC,qBAAqB,EAAE,cAAc,CAAC;IACtC,sBAAsB,EAAE,cAAc,CAAC;CACvC,CAAC,CAAC;AAMH,MAAM,MAAM,sBAAsB,GAAG,YAAY,CAAC;IACjD,KAAK,EAAE,QAAQ,CAAC;IAChB,gBAAgB,EAAE,cAAc,CAAC;IACjC,gBAAgB,EAAE,cAAc,CAAC;IACjC,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,EAAE,cAAc,CAAC;IAChC,gBAAgB,EAAE,cAAc,CAAC;IACjC,SAAS,EAAE,cAAc,CAAC;IAC1B,gBAAgB,EAAE,cAAc,CAAC;IACjC,iBAAiB,EAAE,cAAc,CAAC;IAClC,mBAAmB,EAAE,cAAc,CAAC;IACpC,QAAQ,EAAE,cAAc,CAAC;CACzB,CAAC,CAAC;AAEH,MAAM,MAAM,gCAAgC,GAAG,YAAY,CAAC;IAC3D,KAAK,EAAE,QAAQ,CAAC;IAChB,gBAAgB,EAAE,cAAc,CAAC;IACjC,gBAAgB,EAAE,cAAc,CAAC;IACjC,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,EAAE,cAAc,CAAC;IAChC,gBAAgB,EAAE,cAAc,CAAC;IACjC,SAAS,EAAE,cAAc,CAAC;IAC1B,UAAU,EAAE,cAAc,CAAC;CAC3B,CAAC,CAAC;AAMH,MAAM,MAAM,0BAA0B,GAAG,YAAY,CAAC;IACrD,IAAI,EAAE,UAAU,CAAC;IACjB,UAAU,EAAE,cAAc,CAAC;CAC3B,CAAC,CAAC;AAEH,MAAM,MAAM,6BAA6B,GAAG,YAAY,CAAC;IACxD,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,UAAU,EAAE,mBAAmB,CAAC;IAChC,aAAa,EAAE,QAAQ,CAAC;CACxB,CAAC,CAAC;AAEH,MAAM,MAAM,8BAA8B,GAAG,YAAY,CAAC;IACzD,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,UAAU,EAAE,mBAAmB,CAAC;IAChC,aAAa,EAAE,QAAQ,CAAC;CACxB,CAAC,CAAC;AAEH,MAAM,MAAM,yCAAyC,GAAG,YAAY,CAAC;IACpE,KAAK,EAAE,QAAQ,CAAC;IAChB,UAAU,EAAE,cAAc,CAAC;IAC3B,oBAAoB,EAAE,cAAc,CAAC;CACrC,CAAC,CAAC;AAMH,MAAM,MAAM,yBAAyB,GAAG,YAAY,CAAC;IACpD,KAAK,EAAE,QAAQ,CAAC;IAChB,UAAU,EAAE,cAAc,CAAC;IAC3B,IAAI,EAAE,cAAc,CAAC;IACrB,QAAQ,EAAE,cAAc,CAAC;CACzB,CAAC,CAAC;AAEH,MAAM,MAAM,6BAA6B,GAAG,YAAY,CAAC;IACxD,MAAM,EAAE;QACP,KAAK,EAAE,QAAQ,CAAC;QAChB,gBAAgB,EAAE,cAAc,CAAC;QACjC,gBAAgB,EAAE,cAAc,CAAC;QACjC,IAAI,EAAE,cAAc,CAAC;QACrB,WAAW,EAAE,cAAc,CAAC;QAC5B,QAAQ,EAAE,cAAc,CAAC;QACzB,GAAG,EAAE,cAAc,CAAC;QACpB,cAAc,EAAE,cAAc,CAAC;QAC/B,aAAa,EAAE,cAAc,CAAC;KAC9B,EAAE,CAAC;CACJ,CAAC,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,YAAY,CAAC;IACvD,KAAK,EAAE,QAAQ,CAAC;IAChB,gBAAgB,EAAE,cAAc,CAAC;IACjC,SAAS,EAAE,cAAc,CAAC;IAC1B,UAAU,EAAE,cAAc,CAAC;IAC3B,oBAAoB,EAAE,cAAc,CAAC;IACrC,qBAAqB,EAAE,cAAc,CAAC;IACtC,oBAAoB,EAAE,cAAc,CAAC;IACrC,qBAAqB,EAAE,cAAc,CAAC;CACtC,CAAC,CAAC;AAEH,MAAM,MAAM,uBAAuB,GAAG,YAAY,CAAC;IAClD,KAAK,EAAE,QAAQ,CAAC;IAChB,UAAU,EAAE,cAAc,CAAC;IAC3B,QAAQ,EAAE,cAAc,CAAC;IACzB,UAAU,EAAE,cAAc,CAAC;IAC3B,WAAW,EAAE,OAAO,CAAC;IACrB,uBAAuB,EAAE,cAAc,GAAG,IAAI,CAAC;CAC/C,CAAC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,YAAY,CAAC;IACnD,KAAK,EAAE,QAAQ,CAAC;IAChB,UAAU,EAAE,cAAc,CAAC;IAC3B,WAAW,EAAE,cAAc,CAAC;IAC5B,QAAQ,EAAE,cAAc,CAAC;CACzB,CAAC,CAAC;AAMH,MAAM,MAAM,kCAAkC,GAAG,YAAY,CAAC;IAC7D,SAAS,EAAE,QAAQ,CAAC;IACpB,UAAU,EAAE,cAAc,CAAC;IAC3B,aAAa,EAAE,cAAc,GAAG,IAAI,CAAC;IACrC,SAAS,EAAE,UAAU,EAAE,CAAC;IACxB,GAAG,EAAE,cAAc,CAAC;IACpB,eAAe,EAAE,cAAc,CAAC;IAChC,iBAAiB,EAAE,IAAI,EAAE,CAAC;CAC1B,CAAC,CAAC;AAEH,MAAM,MAAM,mCAAmC,GAAG,YAAY,CAAC;IAC9D,SAAS,EAAE,QAAQ,CAAC;IACpB,UAAU,EAAE,cAAc,CAAC;IAC3B,QAAQ,EAAE,UAAU,CAAC;CACrB,CAAC,CAAC;AAEH,MAAM,MAAM,kCAAkC,GAAG,YAAY,CAAC;IAC7D,SAAS,EAAE,QAAQ,CAAC;IACpB,UAAU,EAAE,cAAc,CAAC;IAC3B,aAAa,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC/B,QAAQ,EAAE,UAAU,CAAC;CACrB,CAAC,CAAC;AAEH,MAAM,MAAM,wCAAwC,GAAG,YAAY,CAAC;IACnE,SAAS,EAAE,QAAQ,CAAC;IACpB,UAAU,EAAE,cAAc,CAAC;IAC3B,aAAa,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC/B,eAAe,EAAE,cAAc,CAAC;IAChC,iBAAiB,EAAE,IAAI,EAAE,CAAC;CAC1B,CAAC,CAAC;AAEH,MAAM,MAAM,yCAAyC,GAAG,YAAY,CAAC;IACpE,SAAS,EAAE,QAAQ,CAAC;IACpB,UAAU,EAAE,cAAc,CAAC;IAC3B,aAAa,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC/B,SAAS,EAAE,UAAU,EAAE,CAAC;CACxB,CAAC,CAAC;AAmCH,MAAM,MAAM,8BAA8B,GAAG,YAAY,CAAC;IACzD,KAAK,EAAE,QAAQ,CAAC;IAChB,WAAW,EAAE,cAAc,CAAC;IAC5B,UAAU,EAAE,cAAc,CAAC;IAC3B,YAAY,EAAE,cAAc,CAAC;IAC7B,wBAAwB,EAAE,cAAc,CAAC;CACzC,CAAC,CAAC;AAEH,MAAM,MAAM,6BAA6B,GAAG,YAAY,CAAC;IACxD,KAAK,EAAE,QAAQ,CAAC;IAChB,UAAU,EAAE,cAAc,CAAC;IAC3B,WAAW,EAAE,cAAc,CAAC;IAC5B,WAAW,EAAE,cAAc,CAAC;IAC5B,uBAAuB,EAAE,cAAc,CAAC;CACxC,CAAC,CAAC;AAMH,MAAM,MAAM,0BAA0B,GAAG,YAAY,CAAC;IACrD,KAAK,EAAE,QAAQ,CAAC;IAChB,qBAAqB,EAAE,cAAc,CAAC;IACtC,sBAAsB,EAAE,cAAc,CAAC;IACvC,mBAAmB,EAAE,cAAc,CAAC;CACpC,CAAC,CAAC"}

package/dist/packages/perpetuals/perpetualsCastingTypes.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/packages/perpetuals/perpetualsMarket.d.ts

@@ -1,360 +0,0 @@
-import { AftermathApi } from "../..";
-import { Caller } from "../../general/utils/caller";
-import { CoinType, PerpetualsMarketId, PerpetualsMarketParams, PerpetualsMarketState, PerpetualsOrderData, PerpetualsOrderbook, PerpetualsPosition, Timestamp, PerpetualsMarketData, ApiPerpetualsMaxOrderSizeBody, ApiPerpetualsMarketOrderHistoryResponse, CallerConfig, Percentage, ApiPerpetualsPreviewPlaceOrderResponse, PerpetualsMarket24hrStats, SdkPerpetualsPlaceLimitOrderPreviewInputs, SdkPerpetualsPlaceMarketOrderPreviewInputs, ApiPerpetualsMarketOrderHistoryBody } from "../../types";
-/**
- * High-level wrapper around a single perpetuals market.
- *
- * This class provides:
- *
- * - Lightweight accessors for immutable market properties:
- *   - `marketId`, `indexPrice`, `collateralPrice`, `collateralCoinType`
- *   - `marketParams`, `marketState`
- * - Read endpoints for:
- *   - Orderbook snapshots
- *   - 24h stats and order history
- *   - Market prices and derived funding metrics
- * - Helpers for:
- *   - Order sizing (max size, lot/tick rounding)
- *   - Margin and collateral calculations
- *   - Constructing an “empty” position for a market
- *
- * Typical usage:
- *
- * ```ts
- * const perps = new Perpetuals(config);
- * const { markets } = await perps.getMarkets({ marketIds: ["0x..."] });
- * const market = markets[0];
- *
- * const { orderbook } = await market.getOrderbook();
- * const stats = await market.get24hrStats();
- * const { basePrice, collateralPrice } = await market.getPrices();
- * ```
- */
-export declare class PerpetualsMarket extends Caller {
-    marketData: PerpetualsMarketData;
-    readonly Provider?: AftermathApi | undefined;
-    /** Unique identifier for this perpetuals market (object ID on chain). */
-    readonly marketId: PerpetualsMarketId;
-    /**
-     * Current oracle/index price for the market's underlying asset, quoted in
-     * the index unit (typically USD).
-     */
-    readonly indexPrice: number;
-    /**
-     * Current price of the collateral asset in USD (or the platform's base
-     * pricing unit).
-     */
-    readonly collateralPrice: number;
-    /** Sui type of the collateral coin (e.g. `"0x2::sui::SUI"`). */
-    readonly collateralCoinType: CoinType;
-    /** Static market configuration parameters (lot size, tick size, margins, etc.). */
-    readonly marketParams: PerpetualsMarketParams;
-    /** Dynamic market state (funding rates, open interest, etc.). */
-    readonly marketState: PerpetualsMarketState;
-    /**
-     * Create a new {@link PerpetualsMarket} wrapper from raw market data.
-     *
-     * @param marketData - Snapshot of market configuration and state.
-     * @param config - Optional {@link CallerConfig} (network, base URL, etc.).
-     * @param Provider - Optional shared {@link AftermathApi} provider instance.
-     *
-     * @remarks
-     * This class extends {@link Caller} with the `"perpetuals"` route prefix, meaning
-     * all HTTP requests resolve under `/perpetuals/...`.
-     */
-    constructor(marketData: PerpetualsMarketData, config?: CallerConfig, Provider?: AftermathApi | undefined);
-    /**
-     * Fetch the 24-hour volume and price change statistics for this market.
-     *
-     * Under the hood, this calls {@link Perpetuals.getMarkets24hrStats} and
-     * returns the first (and only) entry.
-     *
-     * @returns {@link PerpetualsMarket24hrStats}.
-     *
-     * @remarks
-     * This method creates a new {@link Perpetuals} instance using `this.config`.
-     * If you need shared Provider behavior, prefer calling `perps.getMarkets24hrStats`
-     * directly with the same Provider you initialized.
-     */
-    get24hrStats(): Promise<PerpetualsMarket24hrStats>;
-    /**
-     * Fetch the full orderbook snapshot for this market.
-     *
-     * @returns Object containing `orderbook`.
-     *
-     * @example
-     * ```ts
-     * const { orderbook } = await market.getOrderbook();
-     * console.log(orderbook.bids[0], orderbook.asks[0]);
-     * ```
-     */
-    getOrderbook(): Promise<{
-        orderbook: PerpetualsOrderbook;
-    }>;
-    /**
-     * Compute the maximum order size that can be placed by a given account
-     * in this market, under optional leverage and price assumptions.
-     *
-     * This is a common frontend helper for:
-     * - "max size" buttons
-     * - input validation against risk limits
-     *
-     * **Note:** This is routed through the `account` namespace because it depends on
-     * the account's collateral and positions.
-     *
-     * @param inputs.accountId - Perpetuals account ID.
-     * @param inputs.side - Order side (Bid/Ask).
-     * @param inputs.leverage - Optional assumed leverage.
-     * @param inputs.price - Optional assumed price (e.g. for limit orders).
-     *
-     * @returns `{ maxOrderSize }` in base units (scaled integer as `bigint`).
-     *
-     * @example
-     * ```ts
-     * const { maxOrderSize } = await market.getMaxOrderSize({
-     *   accountId: 123n,
-     *   side: PerpetualsOrderSide.Bid,
-     *   leverage: 5,
-     * });
-     * ```
-     */
-    getMaxOrderSize: (inputs: Omit<ApiPerpetualsMaxOrderSizeBody, "marketId">) => Promise<{
-        maxOrderSize: bigint;
-    }>;
-    /**
-     * Market-level preview of placing a market order.
-     *
-     * Unlike {@link PerpetualsAccount.getPlaceMarketOrderPreview}, this version:
-     * - Calls `account/previews/place-market-order`
-     * - Explicitly sets `accountId: undefined`, allowing a “generic” preview that
-     *   doesn’t rely on a specific account’s on-chain positions/collateral.
-     *
-     * @param inputs - {@link SdkPerpetualsPlaceMarketOrderPreviewInputs}.
-     * @param abortSignal - Optional abort signal to cancel the request.
-     *
-     * @returns Either `{ error }` or a preview containing the simulated updated position,
-     * slippage, filled/posted sizes, collateral change, and execution price.
-     */
-    getPlaceMarketOrderPreview(inputs: SdkPerpetualsPlaceMarketOrderPreviewInputs, abortSignal?: AbortSignal): Promise<ApiPerpetualsPreviewPlaceOrderResponse>;
-    /**
-     * Market-level preview of placing a limit order.
-     *
-     * Similar to {@link getPlaceMarketOrderPreview}, this uses:
-     * - `account/previews/place-limit-order`
-     * - `accountId: undefined`
-     *
-     * @param inputs - {@link SdkPerpetualsPlaceLimitOrderPreviewInputs}.
-     * @param abortSignal - Optional abort signal to cancel the request.
-     *
-     * @returns Either `{ error }` or a preview describing the simulated post-order state.
-     */
-    getPlaceLimitOrderPreview(inputs: SdkPerpetualsPlaceLimitOrderPreviewInputs, abortSignal?: AbortSignal): Promise<ApiPerpetualsPreviewPlaceOrderResponse>;
-    /**
-     * Fetch paginated order history for this market.
-     *
-     * This is market-wide (public) history, not scoped to any account.
-     *
-     * @param inputs.beforeTimestampCursor - Optional pagination cursor.
-     * @param inputs.limit - Optional page size.
-     *
-     * @returns {@link ApiPerpetualsMarketOrderHistoryResponse} containing:
-     * - `orders`
-     * - `nextBeforeTimestampCursor`
-     */
-    getOrderHistory(inputs: Omit<ApiPerpetualsMarketOrderHistoryBody, "marketId">): Promise<ApiPerpetualsMarketOrderHistoryResponse>;
-    /**
-     * Fetch the current prices for this market.
-     *
-     * Internally calls {@link Perpetuals.getPrices} and returns the first result.
-     *
-     * @returns `{ marketId, basePrice, collateralPrice, midPrice, markPrice }`.
-     *
-     * @remarks
-     * This method instantiates a new {@link Perpetuals} client using `this.config`.
-     * If you rely on a shared Provider, call `perps.getPrices(...)` directly instead.
-     */
-    getPrices(): Promise<{
-        marketId: PerpetualsMarketId;
-        basePrice: number;
-        collateralPrice: number;
-        midPrice: number | undefined;
-        markPrice: number;
-    }>;
-    /**
-     * Compute the remaining time until the next funding event, in milliseconds.
-     *
-     * @returns `nextFundingTimeMs() - Date.now()`.
-     *
-     * @remarks
-     * If the next funding timestamp does not fit safely into a JS `number`,
-     * {@link nextFundingTimeMs} returns `Number.MAX_SAFE_INTEGER`, and the
-     * difference may be very large.
-     */
-    timeUntilNextFundingMs: () => Timestamp;
-    /**
-     * Get the scheduled timestamp for the next funding event, in milliseconds.
-     *
-     * Safety behavior:
-     * - If `marketData.nextFundingTimestampMs` exceeds `Number.MAX_SAFE_INTEGER`,
-     *   this returns `Number.MAX_SAFE_INTEGER`.
-     *
-     * @returns Next funding timestamp (ms) as a JS `number`.
-     */
-    nextFundingTimeMs: () => Timestamp;
-    /**
-     * Estimated funding rate per period for this market.
-     *
-     * This is read directly from `marketData.estimatedFundingRate`.
-     *
-     * @returns Estimated funding rate as a fraction (e.g. `0.01` = 1%).
-     */
-    estimatedFundingRate: () => Percentage;
-    /**
-     * Calculate the collateral required to support an order given leverage and prices.
-     *
-     * The computed collateral is based on the *remaining* unfilled size:
-     * `remaining = initialSize - filledSize`.
-     *
-     * USD requirement:
-     * ```text
-     * remainingBase * indexPrice * initialMarginRatio
-     * ```
-     * where `initialMarginRatio = 1 / leverage` (or 1 if leverage is falsy).
-     *
-     * @param inputs.leverage - Target leverage for the order (>= 1).
-     * @param inputs.orderData - Order data containing `initialSize` and `filledSize`.
-     * @param inputs.indexPrice - Index/oracle price of the base asset.
-     * @param inputs.collateralPrice - Price of the collateral asset.
-     *
-     * @returns Object with:
-     * - `collateralUsd`: required collateral in USD
-     * - `collateral`: required collateral in collateral coin units
-     */
-    calcCollateralUsedForOrder: (inputs: {
-        leverage: number;
-        orderData: PerpetualsOrderData;
-        indexPrice: number;
-        collateralPrice: number;
-    }) => {
-        collateral: number;
-        collateralUsd: number;
-    };
-    /**
-     * Get the base-asset lot size for this market as a `number`.
-     *
-     * Order sizes must be multiples of this lot size.
-     *
-     * @returns Lot size in base asset units.
-     */
-    lotSize(): number;
-    /**
-     * Get the minimal price tick size for this market as a `number`.
-     *
-     * Limit prices must be multiples of this tick size.
-     *
-     * @returns Tick size in quote units (e.g. USD).
-     */
-    tickSize(): number;
-    /**
-     * Get the maximum theoretical leverage for this market.
-     *
-     * Computed as:
-     * ```ts
-     * 1 / marginRatioInitial
-     * ```
-     *
-     * @returns Maximum leverage.
-     */
-    maxLeverage(): number;
-    /**
-     * Get the initial margin ratio for this market.
-     *
-     * This is the minimum margin required when opening a position.
-     *
-     * @returns Initial margin ratio as a fraction (e.g. 0.05 = 20x).
-     */
-    initialMarginRatio(): number;
-    /**
-     * Get the maintenance margin ratio for this market.
-     *
-     * Falling below this ratio may trigger liquidation.
-     *
-     * @returns Maintenance margin ratio as a fraction.
-     */
-    maintenanceMarginRatio(): number;
-    /**
-     * Round a price to the nearest valid tick for this market.
-     *
-     * Rounding mode:
-     * - `floor: true` => round down
-     * - `ceil: true`  => round up
-     * - neither       => nearest tick (`Math.round`)
-     *
-     * @param inputs.price - Raw price to round.
-     * @param inputs.floor - Force floor rounding.
-     * @param inputs.ceil - Force ceil rounding.
-     * @returns Price snapped to the market tick size.
-     */
-    roundToValidPrice: (inputs: {
-        price: number;
-        floor?: boolean;
-        ceil?: boolean;
-    }) => number;
-    /**
-     * Round a price to the nearest valid tick as a fixed-point `bigint` (1e9 precision).
-     *
-     * This is helpful when you need the on-chain representation directly
-     * (e.g. order price fields stored in 9-decimal fixed).
-     *
-     * @param inputs.price - Raw price as a JS number.
-     * @param inputs.floor - Force floor rounding.
-     * @param inputs.ceil - Force ceil rounding.
-     * @returns Tick-snapped price scaled by `1e9`.
-     */
-    roundToValidPriceBigInt: (inputs: {
-        price: number;
-        floor?: boolean;
-        ceil?: boolean;
-    }) => bigint;
-    /**
-     * Round a base-asset size to the nearest valid lot size for this market.
-     *
-     * Rounding mode:
-     * - `floor: true` => round down
-     * - `ceil: true`  => round up
-     * - neither       => nearest lot (`Math.round`)
-     *
-     * @param inputs.size - Raw size in base asset units.
-     * @param inputs.floor - Force floor rounding.
-     * @param inputs.ceil - Force ceil rounding.
-     * @returns Size snapped to the market lot size.
-     */
-    roundToValidSize: (inputs: {
-        size: number;
-        floor?: boolean;
-        ceil?: boolean;
-    }) => number;
-    /**
-     * Round a base-asset size to the nearest valid lot as a fixed-point `bigint` (1e9 precision).
-     *
-     * @param inputs.size - Raw base size as a JS number.
-     * @param inputs.floor - Force floor rounding.
-     * @param inputs.ceil - Force ceil rounding.
-     * @returns Lot-snapped size scaled by `1e9`.
-     */
-    roundToValidSizeBigInt: (inputs: {
-        size: number;
-        floor?: boolean;
-        ceil?: boolean;
-    }) => bigint;
-    /**
-     * Construct an "empty" position object for this market.
-     *
-     * Useful when an account has no open position but downstream UI/calculations
-     * expect a {@link PerpetualsPosition}-shaped object.
-     *
-     * @returns A zeroed-out {@link PerpetualsPosition} for `this.marketId`.
-     */
-    emptyPosition: () => PerpetualsPosition;
-}
-//# sourceMappingURL=perpetualsMarket.d.ts.map

package/dist/packages/perpetuals/perpetualsMarket.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"perpetualsMarket.d.ts","sourceRoot":"","sources":["../../../src/packages/perpetuals/perpetualsMarket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAA6C,MAAM,OAAO,CAAC;AAChF,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAGpD,OAAO,EAIN,QAAQ,EAKR,kBAAkB,EAClB,sBAAsB,EACtB,qBAAqB,EACrB,mBAAmB,EAInB,mBAAmB,EACnB,kBAAkB,EAElB,SAAS,EAET,oBAAoB,EAGpB,6BAA6B,EAG7B,uCAAuC,EACvC,YAAY,EACZ,UAAU,EACV,sCAAsC,EACtC,yBAAyB,EAEzB,yCAAyC,EAEzC,0CAA0C,EAE1C,mCAAmC,EAKnC,MAAM,aAAa,CAAC;AAIrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,gBAAiB,SAAQ,MAAM;IA6CnC,UAAU,EAAE,oBAAoB;aAEvB,QAAQ,CAAC,EAAE,YAAY;IA1CxC,yEAAyE;IACzE,SAAgB,QAAQ,EAAE,kBAAkB,CAAC;IAE7C;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IAEnC;;;OAGG;IACH,SAAgB,eAAe,EAAE,MAAM,CAAC;IAExC,gEAAgE;IAChE,SAAgB,kBAAkB,EAAE,QAAQ,CAAC;IAE7C,mFAAmF;IACnF,SAAgB,YAAY,EAAE,sBAAsB,CAAC;IAErD,iEAAiE;IACjE,SAAgB,WAAW,EAAE,qBAAqB,CAAC;IAMnD;;;;;;;;;;OAUG;gBAEK,UAAU,EAAE,oBAAoB,EACvC,MAAM,CAAC,EAAE,YAAY,EACL,QAAQ,CAAC,EAAE,YAAY,YAAA;IAexC;;;;;;;;;;;;OAYG;IACU,YAAY,IAAI,OAAO,CAAC,yBAAyB,CAAC;IAO/D;;;;;;;;;;OAUG;IAEU,YAAY,IAAI,OAAO,CAAC;QACpC,SAAS,EAAE,mBAAmB,CAAC;KAC/B,CAAC;IAYF;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEI,eAAe,GACrB,QAAQ,IAAI,CAAC,6BAA6B,EAAE,UAAU,CAAC;sBAIvC,MAAM;OAOrB;IAEF;;;;;;;;;;;;;OAaG;IACU,0BAA0B,CACtC,MAAM,EAAE,0CAA0C,EAClD,WAAW,CAAC,EAAE,WAAW,GACvB,OAAO,CAAC,sCAAsC,CAAC;IAclD;;;;;;;;;;;OAWG;IACU,yBAAyB,CACrC,MAAM,EAAE,yCAAyC,EACjD,WAAW,CAAC,EAAE,WAAW,GACvB,OAAO,CAAC,sCAAsC,CAAC;IAkBlD;;;;;;;;;;;OAWG;IACU,eAAe,CAC3B,MAAM,EAAE,IAAI,CAAC,mCAAmC,EAAE,UAAU,CAAC;IAe9D;;;;;;;;;;OAUG;IACU,SAAS,IAAI,OAAO,CAAC;QACjC,QAAQ,EAAE,kBAAkB,CAAC;QAC7B,SAAS,EAAE,MAAM,CAAC;QAClB,eAAe,EAAE,MAAM,CAAC;QACxB,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;QAC7B,SAAS,EAAE,MAAM,CAAC;KAClB,CAAC;IAYF;;;;;;;;;OASG;IACI,sBAAsB,QAAO,SAAS,CAE3C;IAEF;;;;;;;;OAQG;IACI,iBAAiB,QAAO,SAAS,CAKtC;IAEF;;;;;;OAMG;IACI,oBAAoB,QAAO,UAAU,CAE1C;IAMF;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,0BAA0B,GAAI,QAAQ;QAC5C,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,mBAAmB,CAAC;QAC/B,UAAU,EAAE,MAAM,CAAC;QACnB,eAAe,EAAE,MAAM,CAAC;KACxB,KAAG;QACH,UAAU,EAAE,MAAM,CAAC;QACnB,aAAa,EAAE,MAAM,CAAC;KACtB,CAgBC;IAMF;;;;;;OAMG;IACI,OAAO;IAId;;;;;;OAMG;IACI,QAAQ;IAIf;;;;;;;;;OASG;IACI,WAAW;IAIlB;;;;;;OAMG;IACI,kBAAkB;IAIzB;;;;;;OAMG;IACI,sBAAsB;IAQ7B;;;;;;;;;;;;OAYG;IACI,iBAAiB,GAAI,QAAQ;QACnC,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,IAAI,CAAC,EAAE,OAAO,CAAC;KACf,YASC;IAEF;;;;;;;;;;OAUG;IACI,uBAAuB,GAAI,QAAQ;QACzC,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,IAAI,CAAC,EAAE,OAAO,CAAC;KACf,YAaC;IAEF;;;;;;;;;;;;OAYG;IACI,gBAAgB,GAAI,QAAQ;QAClC,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,IAAI,CAAC,EAAE,OAAO,CAAC;KACf,YASC;IAEF;;;;;;;OAOG;IACI,sBAAsB,GAAI,QAAQ;QACxC,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,IAAI,CAAC,EAAE,OAAO,CAAC;KACf,YAaC;IAEF;;;;;;;OAOG;IACI,aAAa,QAAO,kBAAkB,CAwB3C;CACF"}