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

    Interface DcaOrderOverviewObject

    Summarizes the main details of a DCA order, including how much coin is allocated and how many trades remain.

    interface DcaOrderOverviewObject {
        allocatedCoin: { amount: bigint; coin: string };
        buyCoin: { amount: bigint; coin: string };
        created: {
            time: number;
            timestamp: number;
            tnxDigest: string;
            txnDigest: string;
        };
        integratorFee?: DcaIntegratorFeeData;
        intervalMs: number;
        lastExecutedTrade?: {
            time: number;
            timestamp: number;
            tnxDigest: string;
            txnDigest: string;
        };
        maxSlippageBps: number;
        nextTrade?: {
            time: number;
            timestamp: number;
            tnxDigest: string;
            txnDigest: string;
        };
        progress: number;
        recipient: string;
        strategy?: DcaOrderStrategyData;
        totalSpent: bigint;
        totalTrades: number;
        tradesRemaining: number;
    }
    Index
    allocatedCoin buyCoin created integratorFee? intervalMs lastExecutedTrade? maxSlippageBps nextTrade? progress recipient strategy? totalSpent totalTrades tradesRemaining
    allocatedCoin: { amount: bigint; coin: string }

    The coin & amount the user allocated for the entire DCA cycle.

    buyCoin: { amount: bigint; coin: string }

    The coin & amount that is being purchased in each periodic trade.

    created: {
        time: number;
        timestamp: number;
        tnxDigest: string;
        txnDigest: string;
    }

    Details about when & how the DCA was created. Contains timestamps and transaction references.

    Type Declaration

    • time: number

      use timestamp instead

    • timestamp: number
    • tnxDigest: string

      use txnDigest instead

    • txnDigest: string
    integratorFee?: DcaIntegratorFeeData

    Optional integrator fee settings that might apply to each trade.

    intervalMs: number

    The interval (in ms) between each trade, e.g., every hour => 3600000.

    lastExecutedTrade?: {
        time: number;
        timestamp: number;
        tnxDigest: string;
        txnDigest: string;
    }

    If at least one trade has already executed, shows when & how the last one occurred.

    Type Declaration

    • time: number

      use timestamp instead

    • timestamp: number
    • tnxDigest: string

      use txnDigest instead

    • txnDigest: string
    maxSlippageBps: number

    The maximum slippage (bps) allowed for each trade.

    nextTrade?: {
        time: number;
        timestamp: number;
        tnxDigest: string;
        txnDigest: string;
    }

    If the next trade is scheduled in the future, indicates when that trade will occur.

    Type Declaration

    • time: number

      use timestamp instead

    • timestamp: number
    • tnxDigest: string

      use txnDigest instead

    • txnDigest: string
    progress: number

    Represents how far along the DCA has progressed, typically out of totalTrades.

    recipient: string

    The address to receive the purchased coin. Defaults to the DCA owner's address if unspecified.

    strategy?: DcaOrderStrategyData

    Optional bounding strategy with min/max acceptable prices.

    totalSpent: bigint

    The total amount of allocateCoin actually spent so far.

    totalTrades: number

    The total number of trades that were planned.

    tradesRemaining: number

    The number of remaining trades that have not yet executed.

    Settings
    Member Visibility

    On This Page
    Properties