client-aftermath-ts-sdk/dist/packages/dca/dcaTypes.d.ts

Client Aftermath TypeScript SDK

import { ObjectId, SuiAddress } from "../../types";
import { CoinType } from "../coin/coinTypes";
import { Balance, Timestamp, TransactionDigest } from "../../general/types/generalTypes";
export interface DcaIntegratorFeeData {
    feeBps: number;
    feeRecipient: SuiAddress;
}
export interface DcaOrderStrategyData {
    minPrice: Balance;
    maxPrice: Balance;
}
export interface ApiDcaTransactionForCreateOrderBody {
    walletAddress: SuiAddress;
    allocateCoinType: CoinType;
    allocateCoinAmount: Balance;
    buyCoinType: CoinType;
    frequencyMs: Timestamp;
    tradesAmount: number;
    strategy?: DcaOrderStrategyData;
    isSponsoredTx?: boolean;
    delayTimeMs: Timestamp;
    maxAllowableSlippageBps: number;
    coinPerTradeAmount: Balance;
    customRecipient?: SuiAddress;
    integratorFee?: DcaIntegratorFeeData;
}
export interface ApiDcaTransactionForCloseOrderBody {
    walletAddress: SuiAddress;
    bytes: string;
    signature: string;
}
export type ApiDcaManualCloseOrderBody = {
    walletAddress: SuiAddress;
    buyCoinType: CoinType;
    allocateCoinType: CoinType;
    orderId: SuiAddress;
};
export type DcaFailedTradeReason = "INTERNAL" | "STRATEGY" | "GAS_CAP" | "UNKNOWN_USER" | "SLIPPAGE";
export interface DcaOrderTradeObject {
    allocatedCoin: {
        coin: CoinType;
        amount: Balance;
    };
    buyCoin: {
        coin: CoinType;
        amount: Balance;
    };
    /** @deprecated use txnDigest instead */
    tnxDigest: TransactionDigest;
    txnDigest: TransactionDigest;
    /** @deprecated use txnTimestamp instead */
    tnxDate: Timestamp;
    txnTimestamp: Timestamp;
    rate: number | undefined;
}
export interface DcaOrderFailedTradeObject {
    timestamp: number;
    reason: DcaFailedTradeReason | undefined;
}
export interface DcaOrderOverviewObject {
    allocatedCoin: {
        coin: CoinType;
        amount: Balance;
    };
    buyCoin: {
        coin: CoinType;
        amount: Balance;
    };
    totalSpent: Balance;
    intervalMs: Timestamp;
    totalTrades: number;
    tradesRemaining: number;
    maxSlippageBps: number;
    strategy?: DcaOrderStrategyData;
    recipient: SuiAddress;
    progress: number;
    created: {
        /** @deprecated use timestamp instead */
        time: Timestamp;
        timestamp: Timestamp;
        /** @deprecated use txnDigest instead */
        tnxDigest: TransactionDigest;
        txnDigest: TransactionDigest;
    };
    nextTrade?: {
        /** @deprecated use timestamp instead */
        time: Timestamp;
        timestamp: Timestamp;
        /** @deprecated use txnDigest instead */
        tnxDigest: TransactionDigest;
        txnDigest: TransactionDigest;
    };
    lastExecutedTrade?: {
        /** @deprecated use timestamp instead */
        time: Timestamp;
        timestamp: Timestamp;
        /** @deprecated use txnDigest instead */
        tnxDigest: TransactionDigest;
        txnDigest: TransactionDigest;
    };
    integratorFee?: DcaIntegratorFeeData;
}
export interface DcaOrderObject {
    objectId: ObjectId;
    overview: DcaOrderOverviewObject;
    trades: DcaOrderTradeObject[];
    failed: DcaOrderFailedTradeObject[];
}
export interface DcaOrdersObject {
    active: DcaOrderObject[];
    past: DcaOrderObject[];
}
/**
 * @deprecated please use ApiUserDataCreateUserBody from userData package instead
 * */
export interface ApiDcaCreateUserBody {
    walletAddress: SuiAddress;
    bytes: string;
    signature: string;
}
export interface ApiDCAsOwnedBody {
    walletAddress: SuiAddress;
}
/** @deprecated use `userData` package instead */
export interface ApiDcaCreateUserBody {
    walletAddress: SuiAddress;
    bytes: string;
    signature: string;
}
/** @deprecated use `userData` package instead */
export interface ApiDCAsOwnedBody {
    walletAddress: SuiAddress;
}
//# sourceMappingURL=dcaTypes.d.ts.map