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

    Class PerpetualsApi

    Low-level perpetuals API metadata and transaction helper surface.

    The high-level Perpetuals client uses this provider-backed class for configured package addresses, fully qualified event types, and Move error mappings. Construct it with an AftermathApi whose perpetuals addresses have been resolved.

    Implements

    Index
    constructor
    addresses eventTypes moveErrors
    getAccountCapType
    addresses: PerpetualsAddresses

    Resolved package and object addresses for the configured network.

    eventTypes: {
        addedStopOrderTicketCollateral: string;
        allocatedCollateral: string;
        canceledOrder: string;
        createdAccount: string;
        createdStopOrderTicket: string;
        deallocatedCollateral: string;
        deletedStopOrderTicket: string;
        depositedCollateral: string;
        editedStopOrderTicketDetails: string;
        editedStopOrderTicketExecutor: string;
        executedStopOrderTicket: string;
        filledMakerOrder: string;
        filledMakerOrders: string;
        filledTakerOrder: string;
        filledTakerOrderLiquidator: string;
        liquidated: string;
        performedAdl: string;
        performedLiquidation: string;
        postedOrder: string;
        reducedOrder: string;
        removedStopOrderTicketCollateral: string;
        settledFunding: string;
        updatedFunding: string;
        updatedMarketVersion: string;
        updatedPremiumTwap: string;
        updatedSpreadTwap: string;
        withdrewCollateral: string;
    }

    Fully qualified Sui event struct types used by perpetuals event queries.

    Type Declaration

    • addedStopOrderTicketCollateral: string

      Event type for adding collateral to a stop-order ticket.

    • allocatedCollateral: string

      Event type for collateral allocation to a market.

    • canceledOrder: string

      Event type for order cancellation.

    • createdAccount: string

      Event type for account creation.

    • createdStopOrderTicket: string

      Event type for stop-order ticket creation.

    • deallocatedCollateral: string

      Event type for collateral deallocation from a market.

    • deletedStopOrderTicket: string

      Event type for stop-order ticket deletion.

    • depositedCollateral: string

      Event type for collateral deposits.

    • editedStopOrderTicketDetails: string

      Event type for stop-order detail changes.

    • editedStopOrderTicketExecutor: string

      Event type for stop-order executor changes.

    • executedStopOrderTicket: string

      Event type for stop-order ticket execution.

    • filledMakerOrder: string

      Event type for an individual maker-order fill.

    • filledMakerOrders: string

      Aggregate event type for maker-order fills.

    • filledTakerOrder: string

      Event type for a taker-order fill.

    • filledTakerOrderLiquidator: string

      Event type for liquidator-side taker fills.

    • liquidated: string

      Event type for a liquidated position.

    • performedAdl: string

      Event type for auto-deleveraging events.

    • performedLiquidation: string

      Event type for performed liquidations.

    • postedOrder: string

      Event type for an order being posted.

    • reducedOrder: string

      Event type for reduced orders.

    • removedStopOrderTicketCollateral: string

      Event type for removing collateral from a stop-order ticket.

    • settledFunding: string

      Event type for funding settlement.

    • updatedFunding: string

      Event type for a funding update.

    • updatedMarketVersion: string

      Event type for a clearing-house version update.

    • updatedPremiumTwap: string

      Event type for a premium TWAP update.

    • updatedSpreadTwap: string

      Event type for a spread TWAP update.

    • withdrewCollateral: string

      Event type for collateral withdrawals.

    moveErrors: MoveErrors

    Move error map used by the shared caller error decoder.

    • Builds the fully qualified Move type for an account capability.

      Parameters

      • inputs: { collateralCoinType: string }
        • collateralCoinType: string

          Collateral coin type parameter of the on-chain Account object.

      Returns string

      The fully qualified Account<collateralCoinType> type string.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods