aftermath-ts-sdk 1.1.72 → 1.1.74-dca.0

package/dist/packages/dca/api/dcaApiCasting.d.ts

@@ -0,0 +1,11 @@
+import { DcaCancelledOrderEvent, DcaCreatedOrderEvent, DcaExecutedTradeEvent, DcaOrderObject, DcaOrderTradeObject } from "../dcaTypes";
+import { DcaClosedOrderEventOnChain, DcaCreatedOrderEventOnChain, DcaExecutedTradeEventOnChain, DcaIndexerOrderResponse, DcaIndexerOrderTradeResponse } from "./dcaApiCastingTypes";
+import { Balance } from "../../../types";
+export declare class DcaApiCasting {
+    static createdDcaOrderEventFromOnChain: (eventOnChain: DcaCreatedOrderEventOnChain) => DcaCreatedOrderEvent;
+    static cancelledDcaOrderEventFromChain: (eventOnChain: DcaClosedOrderEventOnChain) => DcaCancelledOrderEvent;
+    static executedTradeEventFromChain: (eventOnChain: DcaExecutedTradeEventOnChain) => DcaExecutedTradeEvent;
+    static createdOrderEventOnIndexer: (response: DcaIndexerOrderResponse) => DcaOrderObject;
+    static createdOrderTradeEventOnIndexer: (response: DcaIndexerOrderTradeResponse, inputCounType: string, outputCoinType: string, totalSpent: Balance) => DcaOrderTradeObject;
+}
+//# sourceMappingURL=dcaApiCasting.d.ts.map

package/dist/packages/dca/api/dcaApiCasting.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dcaApiCasting.d.ts","sourceRoot":"","sources":["../../../../src/packages/dca/api/dcaApiCasting.ts"],"names":[],"mappings":"AACA,OAAO,EACN,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,cAAc,EACd,mBAAmB,EAEnB,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,uBAAuB,EACvB,4BAA4B,EAC5B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAEzC,qBAAa,aAAa;IAMzB,OAAc,+BAA+B,iDAE1C,oBAAoB,CAwBrB;IAEF,OAAc,+BAA+B,gDAE1C,sBAAsB,CAsBvB;IAEF,OAAc,2BAA2B,kDAEtC,qBAAqB,CAiBtB;IAMF,OAAc,0BAA0B,aAC7B,uBAAuB,KAC/B,cAAc,CAuFf;IAEF,OAAc,+BAA+B,aAClC,4BAA4B,iBACvB,MAAM,kBACL,MAAM,cACV,OAAO,KACjB,mBAAmB,CAepB;CACF"}

package/dist/packages/dca/api/dcaApiCasting.js

@@ -0,0 +1,164 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DcaApiCasting = void 0;
+const utils_1 = require("../../../general/utils");
+class DcaApiCasting {
+}
+exports.DcaApiCasting = DcaApiCasting;
+_a = DcaApiCasting;
+// =========================================================================
+// Chain Event objects
+// =========================================================================
+DcaApiCasting.createdDcaOrderEventFromOnChain = (eventOnChain) => {
+    const fields = eventOnChain.parsedJson;
+    return {
+        orderId: fields.order_id,
+        owner: fields.user,
+        inputValue: BigInt(fields.input_amount),
+        inputType: utils_1.Helpers.addLeadingZeroesToType("0x" + Buffer.from(fields.input_type).toString()),
+        outputType: utils_1.Helpers.addLeadingZeroesToType("0x" + Buffer.from(fields.output_type).toString()),
+        gasValue: BigInt(fields.gas_amount),
+        frequencyMs: Number(fields.frequency_ms),
+        startTimestampMs: Number(fields.start_timestamp_ms),
+        amountPerTrade: BigInt(fields.amount_per_trade),
+        maxAllowableSlippageBps: BigInt(fields.max_allowable_slippage_bps),
+        minAmountOut: BigInt(fields.min_amount_out),
+        maxAmountOut: BigInt(fields.max_amount_out),
+        remainingTrades: BigInt(fields.remaining_trades),
+        timestamp: eventOnChain.timestampMs,
+        txnDigest: eventOnChain.id.txDigest,
+        type: eventOnChain.type,
+    };
+};
+DcaApiCasting.cancelledDcaOrderEventFromChain = (eventOnChain) => {
+    const fields = eventOnChain.parsedJson;
+    return {
+        orderId: fields.order_id,
+        owner: fields.user,
+        remainingValue: BigInt(fields.remaining_value),
+        inputType: utils_1.Helpers.addLeadingZeroesToType("0x" + fields.input_type),
+        outputType: utils_1.Helpers.addLeadingZeroesToType("0x" + fields.output_type),
+        gasValue: BigInt(fields.gas_value),
+        frequencyMs: Number(fields.frequency_ms),
+        lastTradeTimestampMs: Number(fields.last_trade_timestamp_ms),
+        amountPerTrade: BigInt(fields.amount_per_trade),
+        maxAllowableSlippageBps: BigInt(fields.max_allowable_slippage_bps),
+        minAmountOut: BigInt(fields.min_amount_out),
+        maxAmountOut: BigInt(fields.max_amount_out),
+        remainingTrades: BigInt(fields.remaining_trades),
+        timestamp: eventOnChain.timestampMs,
+        txnDigest: eventOnChain.id.txDigest,
+        type: eventOnChain.type,
+    };
+};
+DcaApiCasting.executedTradeEventFromChain = (eventOnChain) => {
+    const fields = eventOnChain.parsedJson;
+    return {
+        orderId: fields.order_id,
+        user: fields.user,
+        inputType: utils_1.Helpers.addLeadingZeroesToType("0x" + Buffer.from(fields.input_type).toString()),
+        inputAmount: BigInt(fields.input_amount),
+        outputType: utils_1.Helpers.addLeadingZeroesToType("0x" + Buffer.from(fields.output_type).toString()),
+        outputAmount: BigInt(fields.output_amount),
+        timestamp: eventOnChain.timestampMs,
+        txnDigest: eventOnChain.id.txDigest,
+        type: eventOnChain.type,
+    };
+};
+// =========================================================================
+// Indexer
+// =========================================================================
+DcaApiCasting.createdOrderEventOnIndexer = (response) => {
+    const totalOrdersAmount = Number(response.orders_num);
+    const ordersLeft = Number(response.orders_left);
+    const progress = totalOrdersAmount > 0
+        ? (totalOrdersAmount - ordersLeft) / totalOrdersAmount
+        : 1;
+    const inputCoinType = String(response.coin_sell);
+    const outputCoinType = String(response.coin_buy);
+    const strategy = Number(response.min_amount_out) === 0 &&
+        BigInt(response.max_amount_out) === utils_1.Casting.u64MaxBigInt
+        ? undefined
+        : {
+            priceMin: BigInt(response.min_amount_out),
+            priceMax: BigInt(response.max_amount_out),
+        };
+    const { totalSpent, totalBought } = response.trades.reduce((total, order) => {
+        total.totalSpent += BigInt(order.input_amount);
+        total.totalBought += BigInt(order.output_amount);
+        return total;
+    }, {
+        totalSpent: BigInt(0),
+        totalBought: BigInt(0)
+    });
+    const tradesPrepared = response.trades.map((trade) => {
+        const tradePrepared = _a.createdOrderTradeEventOnIndexer(trade, inputCoinType, outputCoinType, totalSpent);
+        return tradePrepared;
+    });
+    const started = tradesPrepared.length > 0 ? {
+        timestamp: tradesPrepared[0].tnxDate,
+        digest: tradesPrepared[0].tnxDigest,
+    } : undefined;
+    const lastTrade = tradesPrepared.length > 0 ? {
+        timestamp: tradesPrepared[tradesPrepared.length - 1].tnxDate,
+        digest: tradesPrepared[tradesPrepared.length - 1].tnxDigest,
+    } : undefined;
+    return {
+        objectId: response.order_object_id,
+        overview: {
+            allocatedCoin: {
+                coin: inputCoinType,
+                amount: BigInt(response.coin_sell_amount),
+            },
+            buyCoin: {
+                coin: outputCoinType,
+                amount: totalBought,
+            },
+            averagePrice: tradesPrepared.length > 0
+                ? totalBought / BigInt(tradesPrepared.length)
+                : BigInt(0),
+            totalSpent: totalSpent,
+            interval: BigInt(response.frequency_ms),
+            totalTrades: totalOrdersAmount,
+            tradesRemaining: ordersLeft,
+            maxSlippage: BigInt(response.slippage),
+            strategy: strategy,
+            progress: progress,
+            recipient: response.recipient,
+            created: {
+                time: response.created.timestamp,
+                tnxDigest: response.created.tx_digest,
+            },
+            started: started
+                ? {
+                    time: started.timestamp,
+                    tnxDigest: started.digest,
+                }
+                : undefined,
+            lastExecutedTradeTime: lastTrade
+                ? {
+                    time: lastTrade.timestamp,
+                    tnxDigest: lastTrade.digest,
+                }
+                : undefined,
+        },
+        trades: tradesPrepared,
+    };
+};
+DcaApiCasting.createdOrderTradeEventOnIndexer = (response, inputCounType, outputCoinType, totalSpent) => {
+    const rate = totalSpent > 0 ? Number(BigInt(response.input_amount) / totalSpent) : 0;
+    return {
+        allocatedCoin: {
+            coin: inputCounType,
+            amount: BigInt(response.input_amount),
+        },
+        buyCoin: {
+            coin: outputCoinType,
+            amount: BigInt(response.output_amount),
+        },
+        tnxDigest: response.event.tx_digest,
+        tnxDate: response.event.timestamp,
+        rate: rate
+    };
+};

package/dist/packages/dca/api/dcaApiCastingTypes.d.ts

@@ -0,0 +1,119 @@
+import { EventOnChain } from "../../../general/types/castingTypes";
+import { BigIntAsString, CoinType, ObjectId, SerializedTransaction, ServiceCoinData, SuiAddress, Timestamp, TransactionDigest } from "../../../types";
+export interface DcaOrderFieldsOnChain {
+    id: ObjectId;
+    user: ObjectId;
+    recipient: ObjectId;
+    balance: BigIntAsString;
+    frequency_ms: BigIntAsString;
+    last_trade_timestamp_ms: BigIntAsString;
+    amount_per_trade: BigIntAsString;
+    max_allowable_slippage_bps: BigIntAsString;
+    min_amount_out: BigIntAsString;
+    max_amount_out: BigIntAsString;
+    remaining_trades: BigIntAsString;
+    gas: BigIntAsString;
+}
+export type DcaCreatedOrderEventOnChain = EventOnChain<{
+    order_id: ObjectId;
+    user: ObjectId;
+    recipient: ObjectId;
+    user_pk: Uint8Array;
+    input_amount: BigIntAsString;
+    input_type: Uint8Array;
+    output_type: Uint8Array;
+    gas_amount: BigIntAsString;
+    frequency_ms: BigIntAsString;
+    start_timestamp_ms: BigIntAsString;
+    amount_per_trade: BigIntAsString;
+    max_allowable_slippage_bps: BigIntAsString;
+    min_amount_out: BigIntAsString;
+    max_amount_out: BigIntAsString;
+    remaining_trades: BigIntAsString;
+}>;
+export type DcaClosedOrderEventOnChain = EventOnChain<{
+    order_id: ObjectId;
+    user: ObjectId;
+    recipient: ObjectId;
+    remaining_value: BigIntAsString;
+    input_type: Uint8Array;
+    output_type: Uint8Array;
+    gas_value: BigIntAsString;
+    frequency_ms: BigIntAsString;
+    last_trade_timestamp_ms: BigIntAsString;
+    amount_per_trade: BigIntAsString;
+    max_allowable_slippage_bps: BigIntAsString;
+    min_amount_out: BigIntAsString;
+    max_amount_out: BigIntAsString;
+    remaining_trades: BigIntAsString;
+}>;
+export type DcaExecutedTradeEventOnChain = EventOnChain<{
+    order_id: ObjectId;
+    user: ObjectId;
+    recipient: ObjectId;
+    input_type: Uint8Array;
+    input_amount: BigIntAsString;
+    output_type: Uint8Array;
+    output_amount: BigIntAsString;
+}>;
+export type DcaIndexerOrdersRequest = {
+    sender: SuiAddress;
+};
+export type DcaIndexerOrdersResponse = {
+    orders: DcaIndexerOrderResponse[];
+};
+export type DcaIndexerOrderResponse = {
+    order_object_id: ObjectId;
+    coin_sell: String;
+    coin_sell_amount: BigIntAsString;
+    coin_buy: String;
+    orders_num: BigIntAsString;
+    orders_left: BigIntAsString;
+    frequency_ms: BigIntAsString;
+    slippage: BigIntAsString;
+    total_spent: BigIntAsString;
+    recipient: SuiAddress;
+    created: {
+        timestamp: Timestamp;
+        tx_digest: TransactionDigest;
+    };
+    average_price: BigIntAsString;
+    min_amount_out: BigIntAsString;
+    max_amount_out: BigIntAsString;
+    trades: DcaIndexerOrderTradeResponse[];
+};
+export type DcaIndexerOrderTradeResponse = {
+    input_amount: BigIntAsString;
+    output_amount: BigIntAsString;
+    event: {
+        timestamp: Timestamp;
+        tx_digest: TransactionDigest;
+    };
+};
+export type DcaIndexerOrderCreateRequest = {
+    tx_kind: string;
+    order: {
+        input_coin: ServiceCoinData;
+        input_coin_type: CoinType;
+        output_coin_type: CoinType;
+        gas_coin: ServiceCoinData;
+        owner: SuiAddress;
+        user_pk: string;
+        recipient: SuiAddress;
+        frequency_ms: string;
+        delay_timestamp_ms: string;
+        amount_per_trade: string;
+        max_allowable_slippage_bps: number;
+        min_amount_out: string;
+        max_amount_out: string;
+        number_of_trades: number;
+    };
+};
+export type DcaIndexerOrderCreateResponse = {
+    tx_data: SerializedTransaction;
+};
+export type DcaIndexerOrderCancelRequest = {
+    order_object_id: ObjectId;
+};
+export type DcaIndexerOrderCancelResponse = {};
+//# sourceMappingURL=dcaApiCastingTypes.d.ts.map

package/dist/packages/dca/api/dcaApiCastingTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dcaApiCastingTypes.d.ts","sourceRoot":"","sources":["../../../../src/packages/dca/api/dcaApiCastingTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AACnE,OAAO,EACH,cAAc,EACd,QAAQ,EAAC,QAAQ,EACjB,qBAAqB,EACrB,eAAe,EACf,UAAU,EACV,SAAS,EACT,iBAAiB,EACpB,MAAM,gBAAgB,CAAC;AAOxB,MAAM,WAAW,qBAAqB;IAClC,EAAE,EAAE,QAAQ,CAAC;IACb,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,EAAE,QAAQ,CAAC;IACpB,OAAO,EAAE,cAAc,CAAC;IACxB,YAAY,EAAE,cAAc,CAAC;IAC7B,uBAAuB,EAAE,cAAc,CAAC;IACxC,gBAAgB,EAAE,cAAc,CAAC;IACjC,0BAA0B,EAAE,cAAc,CAAC;IAC3C,cAAc,EAAE,cAAc,CAAC;IAC/B,cAAc,EAAE,cAAc,CAAC;IAC/B,gBAAgB,EAAE,cAAc,CAAC;IACjC,GAAG,EAAE,cAAc,CAAC;CACvB;AAMD,MAAM,MAAM,2BAA2B,GAAG,YAAY,CAAC;IACtD,QAAQ,EAAE,QAAQ,CAAC;IAChB,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,EAAE,QAAQ,CAAC;IACpB,OAAO,EAAE,UAAU,CAAC;IACvB,YAAY,EAAE,cAAc,CAAC;IAC7B,UAAU,EAAE,UAAU,CAAC;IACvB,WAAW,EAAE,UAAU,CAAC;IACxB,UAAU,EAAE,cAAc,CAAC;IAC3B,YAAY,EAAE,cAAc,CAAC;IAC1B,kBAAkB,EAAE,cAAc,CAAC;IACnC,gBAAgB,EAAE,cAAc,CAAC;IACjC,0BAA0B,EAAE,cAAc,CAAC;IAC3C,cAAc,EAAE,cAAc,CAAC;IAC/B,cAAc,EAAE,cAAc,CAAC;IAC/B,gBAAgB,EAAE,cAAc,CAAC;CACpC,CAAC,CAAC;AAEH,MAAM,MAAM,0BAA0B,GAAG,YAAY,CAAC;IACrD,QAAQ,EAAE,QAAQ,CAAC;IAChB,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,EAAE,QAAQ,CAAC;IACvB,eAAe,EAAE,cAAc,CAAC;IAChC,UAAU,EAAE,UAAU,CAAC;IACvB,WAAW,EAAE,UAAU,CAAC;IACxB,SAAS,EAAE,cAAc,CAAC;IAC1B,YAAY,EAAE,cAAc,CAAC;IAC1B,uBAAuB,EAAE,cAAc,CAAC;IACxC,gBAAgB,EAAE,cAAc,CAAC;IACjC,0BAA0B,EAAE,cAAc,CAAC;IAC3C,cAAc,EAAE,cAAc,CAAC;IAC/B,cAAc,EAAE,cAAc,CAAC;IAC/B,gBAAgB,EAAE,cAAc,CAAC;CACpC,CAAC,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,YAAY,CAAC;IACvD,QAAQ,EAAE,QAAQ,CAAC;IAChB,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,EAAE,QAAQ,CAAC;IACpB,UAAU,EAAE,UAAU,CAAC;IACvB,YAAY,EAAE,cAAc,CAAC;IAC7B,WAAW,EAAE,UAAU,CAAC;IACxB,aAAa,EAAE,cAAc,CAAC;CACjC,CAAC,CAAC;AAOH,MAAM,MAAM,uBAAuB,GAAG;IAClC,MAAM,EAAE,UAAU,CAAC;CACtB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACnC,MAAM,EAAE,uBAAuB,EAAE,CAAA;CACpC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IAClC,eAAe,EAAE,QAAQ,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,cAAc,CAAC;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,cAAc,CAAC;IAC3B,WAAW,EAAE,cAAc,CAAC;IAC5B,YAAY,EAAE,cAAc,CAAC;IAC7B,QAAQ,EAAE,cAAc,CAAC;IACzB,WAAW,EAAE,cAAc,CAAC;IAC5B,SAAS,EAAE,UAAU,CAAC;IACtB,OAAO,EAAE;QACL,SAAS,EAAE,SAAS,CAAC;QACrB,SAAS,EAAE,iBAAiB,CAAC;KAChC,CAAA;IACD,aAAa,EAAE,cAAc,CAAC;IAC9B,cAAc,EAAE,cAAc,CAAC;IAC/B,cAAc,EAAE,cAAc,CAAC;IAC/B,MAAM,EAAE,4BAA4B,EAAE,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACvC,YAAY,EAAE,cAAc,CAAC;IAC7B,aAAa,EAAE,cAAc,CAAC;IAC9B,KAAK,EAAE;QACH,SAAS,EAAE,SAAS,CAAC;QACrB,SAAS,EAAE,iBAAiB,CAAC;KAChC,CAAA;CACJ,CAAC;AAMF,MAAM,MAAM,4BAA4B,GAAG;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE;QACH,UAAU,EAAE,eAAe,CAAC;QAC5B,eAAe,EAAE,QAAQ,CAAC;QAC1B,gBAAgB,EAAE,QAAQ,CAAC;QAC3B,QAAQ,EAAE,eAAe,CAAC;QAC1B,KAAK,EAAE,UAAU,CAAA;QACjB,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,UAAU,CAAC;QACtB,YAAY,EAAE,MAAM,CAAC;QACrB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,gBAAgB,EAAE,MAAM,CAAC;QACzB,0BAA0B,EAAE,MAAM,CAAC;QACnC,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,gBAAgB,EAAE,MAAM,CAAC;KAC5B,CAAA;CACJ,CAAA;AAED,MAAM,MAAM,6BAA6B,GAAG;IACxC,OAAO,EAAE,qBAAqB,CAAC;CAClC,CAAA;AAMD,MAAM,MAAM,4BAA4B,GAAG;IACvC,eAAe,EAAE,QAAQ,CAAC;CAC7B,CAAA;AAED,MAAM,MAAM,6BAA6B,GAAG,EAAG,CAAA"}

package/dist/packages/dca/api/dcaApiCastingTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/packages/dca/dca.d.ts

@@ -0,0 +1,66 @@
+import { SuiNetwork } from "../../types";
+import { Caller } from "../../general/utils/caller";
+import { AftermathApi } from "../../general/providers";
+import { SuiAddress } from "../../types";
+import { ApiDCAsOwnedBody, ApiDcaTransactionForCancelOrderBody, DcaOrdersObject, ApiDcaTransactionForCreateOrderBody } from "./dcaTypes";
+import { DcaIndexerOrderCancelRequest, DcaIndexerOrderCancelResponse } from "./api/dcaApiCastingTypes";
+import { Transaction } from "@mysten/sui/transactions";
+export declare class Dca extends Caller {
+    readonly network?: SuiNetwork | undefined;
+    private readonly Provider?;
+    constructor(network?: SuiNetwork | undefined, Provider?: AftermathApi | undefined);
+    /**
+     * Fetches the API for dollar cost averaging orders list.
+     * @async
+     * @param { ApiDCAsOwnedBody } inputs - An object containing the walletAddress.
+     * @returns { Promise<DcaOrdersObject> } A promise that resolves to object with array of fetched events for active and past dca's.
+     */
+    getAllDcaOrders(inputs: ApiDCAsOwnedBody): Promise<DcaOrdersObject>;
+    /**
+     * Fetches the API for dollar cost averaging active orders list.
+     * @async
+     * @param { ApiDCAsOwnedBody } inputs - An object containing the walletAddress.
+     * @returns {Promise<DcaOrdersObject>} A promise that resolves to object with array of fetched events for active dca's.
+     */
+    getActiveDcaOrders(inputs: {
+        walletAddress: SuiAddress;
+    }): Promise<DcaOrdersObject>;
+    /**
+     * Fetches the API for dollar cost averaging past orders list.
+     * @async
+     * @param { ApiDCAsOwnedBody } inputs - An object containing the walletAddress.
+     * @returns {Promise<DcaOrdersObject>} A promise that resolves to object with array of fetched events for past dca's.
+     */
+    getPastDcaOrders(inputs: {
+        walletAddress: SuiAddress;
+    }): Promise<DcaOrdersObject>;
+    /**
+     * Fetches backend to stop / delay order execution on BE before executing canceling TX onchain.
+     * @async
+     * @param { ObjectId } inputs - An object containing the DCA object identificator.
+     * @returns {Promise<DcaIndexerOrderCancelResponse>} A promise that resolves to result of delaying
+     */
+    createOrderExecutionPause(inputs: DcaIndexerOrderCancelRequest): Promise<DcaIndexerOrderCancelResponse>;
+    /**
+     * Fetches the API transaction for creating DCA order.
+     * @param inputs - The inputs for the transaction.
+     * @returns A promise that resolves with the API transaction.
+     */
+    getCreateDcaOrderTx(inputs: ApiDcaTransactionForCreateOrderBody): Promise<Transaction>;
+    /**
+     * Fetches the API transaction for canceling DCA order.
+     * @param inputs - The inputs for the transaction.
+     * @returns A promise that resolves with the API transaction.
+     */
+    getCancelDcaOrderTx(inputs: ApiDcaTransactionForCancelOrderBody): Promise<Transaction>;
+    /**
+     * Fetches address by SuiNS domain
+     * @async
+     * @param string domainName - An object containing the walletAddress.
+     * @returns {Promise<string | undefined | null>} A promise that resolves to a
+     * string object with wallet address if it exist
+     */
+    getNameServiceAddress(domainName: string): Promise<string | undefined | null>;
+    private useProvider;
+}
+//# sourceMappingURL=dca.d.ts.map

package/dist/packages/dca/dca.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dca.d.ts","sourceRoot":"","sources":["../../../src/packages/dca/dca.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EACN,gBAAgB,EAChB,mCAAmC,EACnC,eAAe,EACf,mCAAmC,EACnC,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,MAAM,0BAA0B,CAAC;AACvG,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,qBAAa,GAAI,SAAQ,MAAM;aAOb,OAAO,CAAC;IACxB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBADV,OAAO,CAAC,wBAAY,EACnB,QAAQ,CAAC,0BAAc;IASzC;;;;;OAKG;IAEU,eAAe,CAAC,MAAM,EAAE,gBAAgB;IAIrD;;;;;OAKG;IAEa,kBAAkB,CAAC,MAAM,EAAE;QAAE,aAAa,EAAE,UAAU,CAAC;KAAE;IAIzE;;;;;OAKG;IAEa,gBAAgB,CAAC,MAAM,EAAE;QAAE,aAAa,EAAE,UAAU,CAAC;KAAE;IAIvE;;;;;OAKG;IACU,yBAAyB,CAAC,MAAM,EAAE,4BAA4B;IAW3E;;;;OAIG;IAEa,mBAAmB,CAAC,MAAM,EAAE,mCAAmC,GAAG,OAAO,CAAC,WAAW,CAAC;IAOtG;;;;OAIG;IAEU,mBAAmB,CAAC,MAAM,EAAE,mCAAmC;IAW5E;;;;;;OAMG;IAEU,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAU1F,OAAO,CAAC,WAAW,CAIjB;CACF"}

package/dist/packages/dca/dca.js

@@ -0,0 +1,122 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Dca = void 0;
+const caller_1 = require("../../general/utils/caller");
+class Dca extends caller_1.Caller {
+    // =========================================================================
+    //  Constructor
+    // =========================================================================
+    constructor(network, Provider) {
+        super(network, "dca");
+        this.network = network;
+        this.Provider = Provider;
+        // =========================================================================
+        //  Private Helpers
+        // =========================================================================
+        this.useProvider = () => {
+            var _a;
+            const provider = (_a = this.Provider) === null || _a === void 0 ? void 0 : _a.Dca();
+            if (!provider)
+                throw new Error("missing AftermathApi Provider");
+            return provider;
+        };
+    }
+    // =========================================================================
+    //  Class Objects
+    // =========================================================================
+    /**
+     * Fetches the API for dollar cost averaging orders list.
+     * @async
+     * @param { ApiDCAsOwnedBody } inputs - An object containing the walletAddress.
+     * @returns { Promise<DcaOrdersObject> } A promise that resolves to object with array of fetched events for active and past dca's.
+     */
+    getAllDcaOrders(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApi("", inputs);
+        });
+    }
+    /**
+     * Fetches the API for dollar cost averaging active orders list.
+     * @async
+     * @param { ApiDCAsOwnedBody } inputs - An object containing the walletAddress.
+     * @returns {Promise<DcaOrdersObject>} A promise that resolves to object with array of fetched events for active dca's.
+     */
+    getActiveDcaOrders(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApi("owned-active-orders", inputs);
+        });
+    }
+    /**
+     * Fetches the API for dollar cost averaging past orders list.
+     * @async
+     * @param { ApiDCAsOwnedBody } inputs - An object containing the walletAddress.
+     * @returns {Promise<DcaOrdersObject>} A promise that resolves to object with array of fetched events for past dca's.
+     */
+    getPastDcaOrders(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApi("owned-past-orders", inputs);
+        });
+    }
+    /**
+     * Fetches backend to stop / delay order execution on BE before executing canceling TX onchain.
+     * @async
+     * @param { ObjectId } inputs - An object containing the DCA object identificator.
+     * @returns {Promise<DcaIndexerOrderCancelResponse>} A promise that resolves to result of delaying
+     */
+    createOrderExecutionPause(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApi("pause-order-execution", inputs);
+        });
+    }
+    // =========================================================================
+    // Transactions
+    // =========================================================================
+    /**
+     * Fetches the API transaction for creating DCA order.
+     * @param inputs - The inputs for the transaction.
+     * @returns A promise that resolves with the API transaction.
+     */
+    getCreateDcaOrderTx(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApiTransaction("transactions/create-order", inputs);
+        });
+    }
+    /**
+     * Fetches the API transaction for canceling DCA order.
+     * @param inputs - The inputs for the transaction.
+     * @returns A promise that resolves with the API transaction.
+     */
+    getCancelDcaOrderTx(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApiTransaction("transactions/cancel-order", inputs);
+        });
+    }
+    // =========================================================================
+    // Helpers
+    // =========================================================================
+    /**
+     * Fetches address by SuiNS domain
+     * @async
+     * @param string domainName - An object containing the walletAddress.
+     * @returns {Promise<string | undefined | null>} A promise that resolves to a
+     * string object with wallet address if it exist
+     */
+    getNameServiceAddress(domainName) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            return (_a = this.Provider) === null || _a === void 0 ? void 0 : _a.provider.resolveNameServiceAddress({
+                name: domainName
+            });
+        });
+    }
+}
+exports.Dca = Dca;

package/dist/packages/dca/dcaTypes.d.ts

@@ -0,0 +1,129 @@
+import { ObjectId, SuiAddress } from "../../types";
+import { CoinType } from "../coin/coinTypes";
+import { Balance, Event, IFixed, Timestamp, TransactionDigest } from "../../general/types/generalTypes";
+export type DcaOrderTrades = DcaOrderTradeObject[];
+export interface ApiDcaInitializeOrdertStrategyBody {
+    priceMin: Balance;
+    priceMax: Balance;
+}
+export interface ApiDcaTransactionForCreateOrderBody {
+    walletAddress: SuiAddress;
+    allocateCoinType: CoinType;
+    allocateCoinAmount: Balance;
+    buyCoinType: CoinType;
+    frequencyMs: Timestamp;
+    tradesAmount: number;
+    straregy?: ApiDcaInitializeOrdertStrategyBody;
+    isSponsoredTx?: boolean;
+    delayTimeMs: Timestamp;
+    maxAllowableSlippageBps: Balance;
+    coinPerTradeAmount: Balance;
+    publicKey: string;
+    customRecipient?: SuiAddress;
+}
+export interface ApiDcaTransactionForCancelOrderBody {
+    walletAddress: SuiAddress;
+    buyCoinType: CoinType;
+    allocateCoinType: CoinType;
+    orderId: SuiAddress;
+    userPublicKey: string;
+}
+export interface DcaOrderTradeObject {
+    allocatedCoin: {
+        coin: CoinType;
+        amount: Balance;
+    };
+    buyCoin: {
+        coin: CoinType;
+        amount: Balance;
+    };
+    tnxDigest: TransactionDigest;
+    tnxDate: Timestamp;
+    rate: number;
+}
+export interface DcaOrdertStrategyObject {
+    priceMin: Balance;
+    priceMax: Balance;
+}
+export interface DcaOrderOverviewObject {
+    allocatedCoin: {
+        coin: CoinType;
+        amount: Balance;
+    };
+    buyCoin: {
+        coin: CoinType;
+        amount: Balance;
+    };
+    averagePrice: Balance;
+    totalSpent: Balance;
+    interval: IFixed;
+    totalTrades: number;
+    tradesRemaining: number;
+    maxSlippage: Balance;
+    strategy?: DcaOrdertStrategyObject;
+    recipient?: SuiAddress;
+    progress: number;
+    created: {
+        time: Timestamp | undefined;
+        tnxDigest: TransactionDigest;
+    };
+    started?: {
+        time: Timestamp | undefined;
+        tnxDigest: TransactionDigest;
+    };
+    lastExecutedTradeTime?: {
+        time: Timestamp | undefined;
+        tnxDigest: TransactionDigest;
+    };
+}
+export interface DcaOrderObject {
+    objectId: ObjectId;
+    overview: DcaOrderOverviewObject;
+    trades: DcaOrderTrades;
+}
+export interface DcaOrdersObject {
+    active: DcaOrderObject[];
+    past: DcaOrderObject[];
+}
+export interface DcaCreatedOrderEvent extends Event {
+    orderId: ObjectId;
+    owner: ObjectId;
+    inputValue: Balance;
+    inputType: CoinType;
+    outputType: CoinType;
+    gasValue: Balance;
+    frequencyMs: Timestamp;
+    startTimestampMs: Timestamp;
+    amountPerTrade: Balance;
+    maxAllowableSlippageBps: Balance;
+    minAmountOut: Balance;
+    maxAmountOut: Balance;
+    remainingTrades: IFixed;
+}
+export interface DcaCancelledOrderEvent extends Event {
+    orderId: ObjectId;
+    owner: ObjectId;
+    remainingValue: Balance;
+    inputType: CoinType;
+    outputType: CoinType;
+    gasValue: Balance;
+    frequencyMs: Timestamp;
+    lastTradeTimestampMs: Timestamp;
+    amountPerTrade: Balance;
+    maxAllowableSlippageBps: Balance;
+    minAmountOut: Balance;
+    maxAmountOut: Balance;
+    remainingTrades: IFixed;
+}
+export interface DcaExecutedTradeEvent extends Event {
+    orderId: ObjectId;
+    user: ObjectId;
+    inputType: CoinType;
+    inputAmount: Balance;
+    outputType: CoinType;
+    outputAmount: Balance;
+}
+export interface ApiDCAsOwnedBody {
+    walletAddress: SuiAddress;
+}
+//# sourceMappingURL=dcaTypes.d.ts.map

package/dist/packages/dca/dcaTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dcaTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/dca/dcaTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EACN,OAAO,EACP,KAAK,EACL,MAAM,EACN,SAAS,EACT,iBAAiB,EACjB,MAAM,kCAAkC,CAAC;AAO1C,MAAM,MAAM,cAAc,GAAG,mBAAmB,EAAE,CAAC;AAMnD,MAAM,WAAW,kCAAkC;IAC/C,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,mCAAmC;IACnD,aAAa,EAAE,UAAU,CAAC;IAC1B,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,kBAAkB,EAAE,OAAO,CAAC;IACzB,WAAW,EAAE,QAAQ,CAAC;IACzB,WAAW,EAAE,SAAS,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,kCAAkC,CAAC;IACjD,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,WAAW,EAAE,SAAS,CAAC;IACvB,uBAAuB,EAAE,OAAO,CAAC;IACjC,kBAAkB,EAAE,OAAO,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,UAAU,CAAC;CAC7B;AAMD,MAAM,WAAW,mCAAmC;IACnD,aAAa,EAAE,UAAU,CAAC;IACvB,WAAW,EAAE,QAAQ,CAAC;IACzB,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,OAAO,EAAE,UAAU,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;CACtB;AAMD,MAAM,WAAW,mBAAmB;IACnC,aAAa,EAAE;QACd,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,OAAO,CAAC;KAChB,CAAC;IACF,OAAO,EAAE;QACR,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,OAAO,CAAC;KAChB,CAAC;IACF,SAAS,EAAE,iBAAiB,CAAC;IAC7B,OAAO,EAAE,SAAS,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,uBAAuB;IACpC,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,sBAAsB;IACtC,aAAa,EAAE;QACd,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,OAAO,CAAC;KAChB,CAAC;IACF,OAAO,EAAE;QACR,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,OAAO,CAAC;KAChB,CAAC;IACF,YAAY,EAAE,OAAO,CAAC;IACtB,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,uBAAuB,CAAC;IACnC,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE;QACR,IAAI,EAAE,SAAS,GAAG,SAAS,CAAC;QAC5B,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF,OAAO,CAAC,EAAE;QACT,IAAI,EAAE,SAAS,GAAG,SAAS,CAAC;QAC5B,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF,qBAAqB,CAAC,EAAE;QACvB,IAAI,EAAE,SAAS,GAAG,SAAS,CAAC;QAC5B,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;CACF;AAED,MAAM,WAAW,cAAc;IAC9B,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,EAAE,sBAAsB,CAAC;IACjC,MAAM,EAAE,cAAc,CAAC;CACvB;AAED,MAAM,WAAW,eAAe;IAC/B,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,IAAI,EAAE,cAAc,EAAE,CAAC;CACvB;AAMD,MAAM,WAAW,oBAAqB,SAAQ,KAAK;IAClD,OAAO,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,QAAQ,CAAC;IACpB,UAAU,EAAE,QAAQ,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,SAAS,CAAC;IACpB,gBAAgB,EAAE,SAAS,CAAC;IAC5B,cAAc,EAAE,OAAO,CAAC;IACxB,uBAAuB,EAAE,OAAO,CAAC;IACjC,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,sBAAuB,SAAQ,KAAK;IACpD,OAAO,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,QAAQ,CAAC;IACnB,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,QAAQ,CAAC;IACpB,UAAU,EAAE,QAAQ,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,SAAS,CAAC;IACpB,oBAAoB,EAAE,SAAS,CAAC;IAChC,cAAc,EAAE,OAAO,CAAC;IACxB,uBAAuB,EAAE,OAAO,CAAC;IACjC,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAsB,SAAQ,KAAK;IACnD,OAAO,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,EAAE,QAAQ,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,QAAQ,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;CACzB;AAMD,MAAM,WAAW,gBAAgB;IAChC,aAAa,EAAE,UAAU,CAAC;CAC1B"}

package/dist/packages/dca/dcaTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/packages/dca/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./dca";
+//# sourceMappingURL=index.d.ts.map

package/dist/packages/dca/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packages/dca/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC"}

package/dist/packages/dca/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./dca"), exports);