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

    Interface ApiLimitOrdersCreateOrderTransactionBody

    Defines the body required to create a new limit order transaction. This includes coin types, amounts, expiry settings, and optional integrator fees.

    interface ApiLimitOrdersCreateOrderTransactionBody {
        allocateCoinAmount: bigint;
        allocateCoinType: string;
        buyCoinType: string;
        customRecipient?: string;
        expiryDurationMs: number;
        integratorFee?: LimitOrdersIntegratorFeeData;
        isSponsoredTx?: boolean;
        outputToInputExchangeRate: number;
        outputToInputStopLossExchangeRate?: number;
        walletAddress: string;
    }
    Index
    allocateCoinAmount allocateCoinType buyCoinType customRecipient? expiryDurationMs integratorFee? isSponsoredTx? outputToInputExchangeRate outputToInputStopLossExchangeRate? walletAddress
    allocateCoinAmount: bigint

    The total amount of the allocateCoin to be reserved for this order.

    allocateCoinType: string

    The coin type to be allocated/sold in the order.

    buyCoinType: string

    The coin type to be purchased when price conditions are met.

    customRecipient?: string

    Optionally specify a custom recipient of the purchased coin, defaulting to walletAddress.

    expiryDurationMs: number

    The duration (in ms) after which the limit order expires and becomes invalid. If 0, there's effectively no set expiry.

    integratorFee?: LimitOrdersIntegratorFeeData

    Optional integrator fee details for advanced usage.

    isSponsoredTx?: boolean

    Indicates whether the transaction is sponsored, potentially reducing user gas fees.

    outputToInputExchangeRate: number

    The "take-profit" exchange rate from buyCoinType to allocateCoinType. For example, 0.5 means one unit of buyCoinType exchanges for 0.5 units of allocateCoinType.

    outputToInputStopLossExchangeRate?: number

    Optional stop-loss exchange rate in the same units as outputToInputExchangeRate. When the backend triggers this threshold, the order can finish with StopLossTriggered.

    walletAddress: string

    The user address creating the limit order.

    Settings
    Member Visibility

    On This Page
    Properties