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

    Interface LimitOrderObject

    Represents the on-chain data structure for a single limit order, including allocated coin amounts, buy coin details, creation/finalization times, etc.

    interface LimitOrderObject {
        allocatedCoin: { amount: bigint; coin: string };
        buyCoin: { amount: bigint; coin: string };
        created: { timestamp: number; txnDigest: string };
        currentAmountBought: bigint;
        currentAmountSold: bigint;
        error?: string;
        expiryTimestamp: number;
        finished?: { timestamp: number; txnDigest: string };
        integratorFee?: LimitOrdersIntegratorFeeData;
        objectId: string;
        outputToInputStopLossExchangeRate?: number;
        recipient: string;
        status: LimitOrdersOrderStatus;
    }
    Index
    allocatedCoin buyCoin created currentAmountBought currentAmountSold error? expiryTimestamp finished? integratorFee? objectId outputToInputStopLossExchangeRate? recipient status
    allocatedCoin: { amount: bigint; coin: string }

    The coin & amount allocated for potential trading.

    buyCoin: { amount: bigint; coin: string }

    The coin & amount to be acquired if/when the order conditions are met.

    created: { timestamp: number; txnDigest: string }

    Contains timestamps and transaction references for order creation.

    currentAmountBought: bigint

    Tracks how much of the buy coin has actually been purchased.

    currentAmountSold: bigint

    Tracks how much of the allocated coin has actually been used (sold).

    error?: string

    If the order ended or failed with an error, this might contain a reason or message.

    expiryTimestamp: number

    The UNIX timestamp (ms) after which the order is considered expired.

    finished?: { timestamp: number; txnDigest: string }

    If the order has finished, indicates when and via which transaction it concluded.

    integratorFee?: LimitOrdersIntegratorFeeData

    Optional integrator fee data for advanced usage.

    objectId: string

    The on-chain object ID referencing this limit order.

    outputToInputStopLossExchangeRate?: number

    Optional stop-loss exchange rate; if triggered, the order might end or convert differently.

    recipient: string

    The address that will receive the bought coin, often the same as walletAddress.

    status: LimitOrdersOrderStatus

    The current status of the order (Active, Canceled, etc.).

    Settings
    Member Visibility

    On This Page
    Properties