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

    Interface ApiDcaTransactionForCreateOrderBody

    The inputs required to create a new DCA order. This includes all relevant coin types, amounts, frequency, trade count, etc.

    interface ApiDcaTransactionForCreateOrderBody {
        allocateCoinAmount: bigint;
        allocateCoinType: string;
        buyCoinType: string;
        coinPerTradeAmount: bigint;
        customRecipient?: string;
        delayTimeMs: number;
        frequencyMs: number;
        integratorFee?: DcaIntegratorFeeData;
        isSponsoredTx?: boolean;
        maxAllowableSlippageBps: number;
        strategy?: DcaOrderStrategyData;
        tradesAmount: number;
        walletAddress: string;
    }
    Index
    allocateCoinAmount allocateCoinType buyCoinType coinPerTradeAmount customRecipient? delayTimeMs frequencyMs integratorFee? isSponsoredTx? maxAllowableSlippageBps strategy? tradesAmount walletAddress
    allocateCoinAmount: bigint

    The total amount of the allocate coin to be used across trades.

    allocateCoinType: string

    The coin type from which funds will be allocated (sold).

    buyCoinType: string

    The coin type that will be purchased periodically.

    coinPerTradeAmount: bigint

    The per-trade amount of allocateCoinType to be used, e.g. each trade uses 2 SUI if this is 2e9.

    customRecipient?: string

    An optional alternate address to receive the purchased coin. Defaults to walletAddress if undefined.

    delayTimeMs: number

    A delay (in ms) before the first trade executes. If 0, it starts immediately.

    frequencyMs: number

    The frequency (in ms) at which trades occur, e.g. every hour => 3600000.

    integratorFee?: DcaIntegratorFeeData

    Optional integrator fee data. If provided, a portion of each trade is allocated to the integrator.

    isSponsoredTx?: boolean

    If true, indicates a partially or fully sponsored transaction, removing gas burden from the user.

    maxAllowableSlippageBps: number

    The maximum allowable slippage (in basis points) for each trade, e.g. 100 => 1%.

    strategy?: DcaOrderStrategyData

    An optional bounding strategy specifying min & max acceptable prices.

    tradesAmount: number

    The total number of trades to execute before concluding the DCA plan.

    walletAddress: string

    The user's address that owns & initiates the DCA order.

    Settings
    Member Visibility

    On This Page
    Properties