aftermath-ts-sdk - v6.1.0
    Preparing search index...

    Interface PerpetualsTwapOrderData

    A TWAP order as surfaced to clients by the read endpoint.

    interface PerpetualsTwapOrderData {
        collateralType: string;
        details: PerpetualsTwapOrderDetailsData;
        invalidReason?: string;
        lastError?: PerpetualsTwapOrderLastError;
        lastExecutionTimestampMs: number;
        orderCreationTimestampMs?: number;
        orderState: PerpetualsTwapOrderState;
        priceConditions?: PerpetualsTwapOrderPriceConditions;
        processedAmount: bigint;
        scheduledAmount: bigint;
        statusMessage?: string;
        twapOrderObjectId: string;
    }
    Index
    collateralType details invalidReason? lastError? lastExecutionTimestampMs orderCreationTimestampMs? orderState priceConditions? processedAmount scheduledAmount statusMessage? twapOrderObjectId
    collateralType: string

    Collateral coin type backing the order.

    details: PerpetualsTwapOrderDetailsData

    Order details.

    invalidReason?: string

    Reason the order is invalid, when orderState === "invalid".

    lastError?: PerpetualsTwapOrderLastError

    Latest unresolved action error from the perpetuals HTTP API. JSON null on the wire becomes undefined after SDK decode, so omit/undefined means no current error.

    lastExecutionTimestampMs: number

    Timestamp (ms since epoch) of the most recent chunk execution.

    orderCreationTimestampMs?: number

    Order creation time (ms since epoch). Prefer this over lastExecutionTimestampMs for newest-first sorting.

    orderState: PerpetualsTwapOrderState

    Current lifecycle state of the TWAP order.

    priceConditions?: PerpetualsTwapOrderPriceConditions

    Normalized trigger/stop conditions from the TWAP order response. Omitted for unconditional / legacy TWAPs.

    processedAmount: bigint

    Base-asset amount already executed (scaled base units).

    scheduledAmount: bigint

    Base-asset amount currently reserved for execution (scaled base units).

    statusMessage?: string

    Free-form status message about the order, if any.

    twapOrderObjectId: string

    ID of the TWAP order object on-chain.

    Settings
    Member Visibility

    On This Page
    Properties