aftermath-ts-sdk 1.1.76 → 1.1.78

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

@@ -0,0 +1,170 @@
+"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: utils_1.Helpers.addLeadingZeroesToType(fields.order_id),
+        owner: utils_1.Helpers.addLeadingZeroesToType(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.closedDcaOrderEventFromOnChain = (eventOnChain) => {
+    const fields = eventOnChain.parsedJson;
+    return {
+        orderId: utils_1.Helpers.addLeadingZeroesToType(fields.order_id),
+        owner: utils_1.Helpers.addLeadingZeroesToType(fields.user),
+        remainingValue: BigInt(fields.remaining_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),
+        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.executedTradeEventFromOnChain = (eventOnChain) => {
+    const fields = eventOnChain.parsedJson;
+    return {
+        orderId: utils_1.Helpers.addLeadingZeroesToType(fields.order_id),
+        user: utils_1.Helpers.addLeadingZeroesToType(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 = utils_1.Helpers.addLeadingZeroesToType(String(response.coin_sell));
+    const outputCoinType = utils_1.Helpers.addLeadingZeroesToType(String(response.coin_buy));
+    const strategy = BigInt(response.min_amount_out) === BigInt(0) &&
+        BigInt(response.max_amount_out) === utils_1.Casting.u64MaxBigInt
+        ? undefined
+        : {
+            minPrice: BigInt(response.min_amount_out),
+            maxPrice: 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) => {
+        return _a.createdOrderTradeEventOnIndexer(trade, inputCoinType, outputCoinType);
+    });
+    const started = tradesPrepared.length > 0
+        ? {
+            timestamp: tradesPrepared[0].tnxDate,
+            digest: tradesPrepared[0].tnxDigest,
+        }
+        : {
+            timestamp: Number(response.next_execution_timestamp_ms),
+            digest: "",
+        };
+    const lastTrade = tradesPrepared.length > 0
+        ? {
+            timestamp: tradesPrepared[tradesPrepared.length - 1].tnxDate,
+            digest: tradesPrepared[tradesPrepared.length - 1]
+                .tnxDigest,
+        }
+        : undefined;
+    return {
+        objectId: utils_1.Helpers.addLeadingZeroesToType(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,
+            intervalMs: Number(response.frequency_ms),
+            totalTrades: totalOrdersAmount,
+            tradesRemaining: ordersLeft,
+            maxSlippageBps: Number(response.slippage),
+            strategy: strategy,
+            progress: progress,
+            recipient: utils_1.Helpers.addLeadingZeroesToType(response.recipient),
+            created: {
+                time: response.created.timestamp,
+                tnxDigest: response.created.tx_digest,
+            },
+            nextTrade: {
+                time: started.timestamp,
+                tnxDigest: started.digest,
+            },
+            lastExecutedTrade: lastTrade
+                ? {
+                    time: lastTrade.timestamp,
+                    tnxDigest: lastTrade.digest,
+                }
+                : undefined,
+        },
+        trades: tradesPrepared,
+    };
+};
+DcaApiCasting.createdOrderTradeEventOnIndexer = (response, inputCoinType, outputCoinType) => {
+    const inputAmount = BigInt(response.input_amount);
+    const outputAmount = BigInt(response.output_amount);
+    return {
+        allocatedCoin: {
+            coin: inputCoinType,
+            amount: inputAmount,
+        },
+        buyCoin: {
+            coin: outputCoinType,
+            amount: outputAmount,
+        },
+        tnxDigest: response.event.tx_digest,
+        tnxDate: response.event.timestamp,
+        rate: undefined,
+    };
+};

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

@@ -0,0 +1,132 @@
+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_amount: BigIntAsString;
+    input_type: Uint8Array;
+    output_type: Uint8Array;
+    gas_amount: 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_amount: BigIntAsString;
+    input_type: Uint8Array;
+    output_amount: BigIntAsString;
+    output_type: Uint8Array;
+}>;
+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;
+    recipient: SuiAddress;
+    created: {
+        timestamp: Timestamp;
+        tx_digest: TransactionDigest;
+    };
+    average_price: BigIntAsString;
+    min_amount_out: BigIntAsString;
+    max_amount_out: BigIntAsString;
+    next_execution_timestamp_ms: string;
+    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;
+        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 DcaIndexerOrderCloseRequest = {
+    wallet_address: string;
+    signature: string;
+    bytes: string;
+};
+export type DcaIndexerOrderCloseResponse = boolean;
+export type DcaIndexerUserRequest = {
+    wallet_address: string;
+};
+export type DcaIndexerUserResponse = {
+    public_key?: string;
+};
+export type DcaIndexerCreateUserRequest = {
+    wallet_address: string;
+    signature: string;
+    bytes: string;
+};
+export type DcaIndexerCreateUserResponse = boolean;
+//# 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,EACN,cAAc,EACd,QAAQ,EACR,QAAQ,EACR,qBAAqB,EACrB,eAAe,EACf,UAAU,EACV,SAAS,EACT,iBAAiB,EACjB,MAAM,gBAAgB,CAAC;AAMxB,MAAM,WAAW,qBAAqB;IACrC,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;CACpB;AAMD,MAAM,MAAM,2BAA2B,GAAG,YAAY,CAAC;IACtD,QAAQ,EAAE,QAAQ,CAAC;IACnB,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,EAAE,QAAQ,CAAC;IACpB,OAAO,EAAE,UAAU,CAAC;IACpB,YAAY,EAAE,cAAc,CAAC;IAC7B,UAAU,EAAE,UAAU,CAAC;IACvB,WAAW,EAAE,UAAU,CAAC;IACxB,UAAU,EAAE,cAAc,CAAC;IAC3B,YAAY,EAAE,cAAc,CAAC;IAC7B,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;CACjC,CAAC,CAAC;AAEH,MAAM,MAAM,0BAA0B,GAAG,YAAY,CAAC;IACrD,QAAQ,EAAE,QAAQ,CAAC;IACnB,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,EAAE,QAAQ,CAAC;IACpB,gBAAgB,EAAE,cAAc,CAAC;IACjC,UAAU,EAAE,UAAU,CAAC;IACvB,WAAW,EAAE,UAAU,CAAC;IACxB,UAAU,EAAE,cAAc,CAAC;IAC3B,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;CACjC,CAAC,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,YAAY,CAAC;IACvD,QAAQ,EAAE,QAAQ,CAAC;IACnB,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,EAAE,QAAQ,CAAC;IACpB,YAAY,EAAE,cAAc,CAAC;IAC7B,UAAU,EAAE,UAAU,CAAC;IACvB,aAAa,EAAE,cAAc,CAAC;IAC9B,WAAW,EAAE,UAAU,CAAC;CACxB,CAAC,CAAC;AAMH,MAAM,MAAM,uBAAuB,GAAG;IACrC,MAAM,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACtC,MAAM,EAAE,uBAAuB,EAAE,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACrC,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,SAAS,EAAE,UAAU,CAAC;IACtB,OAAO,EAAE;QACR,SAAS,EAAE,SAAS,CAAC;QACrB,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF,aAAa,EAAE,cAAc,CAAC;IAC9B,cAAc,EAAE,cAAc,CAAC;IAC/B,cAAc,EAAE,cAAc,CAAC;IAC/B,2BAA2B,EAAE,MAAM,CAAC;IACpC,MAAM,EAAE,4BAA4B,EAAE,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IAC1C,YAAY,EAAE,cAAc,CAAC;IAC7B,aAAa,EAAE,cAAc,CAAC;IAC9B,KAAK,EAAE;QACN,SAAS,EAAE,SAAS,CAAC;QACrB,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;CACF,CAAC;AAMF,MAAM,MAAM,4BAA4B,GAAG;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE;QACN,UAAU,EAAE,eAAe,CAAC;QAC5B,eAAe,EAAE,QAAQ,CAAC;QAC1B,gBAAgB,EAAE,QAAQ,CAAC;QAC3B,QAAQ,EAAE,eAAe,CAAC;QAC1B,KAAK,EAAE,UAAU,CAAC;QAClB,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;KACzB,CAAC;CACF,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC3C,OAAO,EAAE,qBAAqB,CAAC;CAC/B,CAAC;AAMF,MAAM,MAAM,2BAA2B,GAAG;IACzC,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,OAAO,CAAC;AAMnD,MAAM,MAAM,qBAAqB,GAAG;IACnC,cAAc,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAMF,MAAM,MAAM,2BAA2B,GAAG;IACzC,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,OAAO,CAAC"}

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,87 @@
+import { ObjectId, SuiNetwork } from "../../types";
+import { Caller } from "../../general/utils/caller";
+import { AftermathApi } from "../../general/providers";
+import { SuiAddress } from "../../types";
+import { ApiDCAsOwnedBody, DcaOrdersObject, ApiDcaTransactionForCreateOrderBody, ApiDcaTransactionForCloseOrderBody, DcaOrderObject, ApiDcaCreateUserBody } from "./dcaTypes";
+import { Transaction } from "@mysten/sui/transactions";
+export declare class Dca extends Caller {
+    readonly network?: SuiNetwork | undefined;
+    private readonly Provider?;
+    static readonly constants: {
+        gasAmount: bigint;
+    };
+    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<DcaOrderObject[]> } A promise that resolves to object with array of fetched events for active dca's.
+     */
+    getActiveDcaOrders(inputs: {
+        walletAddress: SuiAddress;
+    }): Promise<DcaOrderObject[]>;
+    /**
+     * Fetches the API for dollar cost averaging past orders list.
+     * @async
+     * @param { ApiDCAsOwnedBody } inputs - An object containing the walletAddress.
+     * @returns { Promise<DcaOrderObject[]> } A promise that resolves to object with array of fetched events for past dca's.
+     */
+    getPastDcaOrders(inputs: {
+        walletAddress: SuiAddress;
+    }): Promise<DcaOrderObject[]>;
+    /**
+     * Fetches the API transaction for creating DCA order.
+     * @param { ApiDcaTransactionForCreateOrderBody } inputs - The inputs for the transaction.
+     * @returns { Promise<Transaction> } A promise that resolves with the API transaction.
+     */
+    getCreateDcaOrderTx(inputs: ApiDcaTransactionForCreateOrderBody): Promise<Transaction>;
+    /**
+     * Fetches the API for canceling DCA order.
+     * @param inputs - The inputs for the transaction.
+     * @returns { Promise<boolean> } A promise that resolves with transaction execution status.
+     */
+    closeDcaOrder(inputs: ApiDcaTransactionForCloseOrderBody): Promise<boolean>;
+    /**
+     * Method for getting the cancelation dca order message to sign.
+     * @param inputs - The inputs for the message.
+     * @returns Message to sign.
+     */
+    closeDcaOrderMessageToSign(inputs: {
+        orderId: ObjectId;
+    }): {
+        action: string;
+        order_object_id: string;
+    };
+    /**
+     * Method for getting the creation user message to sign.
+     * @param inputs - The inputs for the message.
+     * @returns Message to sign.
+     */
+    createUserAccountMessageToSign(): {
+        action: string;
+    };
+    /**
+     * Fetches the API for users public key.
+     * @async
+     * @param { ApiDCAsOwnedBody } inputs - An object containing the walletAddress.
+     * @returns { Promise<string | undefined> } A promise that resolves users public key.
+     */
+    getUserPublicKey(inputs: {
+        walletAddress: SuiAddress;
+    }): Promise<string | undefined>;
+    /**
+     * Fetches the API to create users public key.
+     * @async
+     * @param { ApiDcaCreateUserBody } inputs - The inputs for creating users public key on BE side.
+     * @returns { Promise<boolean> } A promise that resolves to result if user pk has been created.
+     */
+    createUserPublicKey(inputs: ApiDcaCreateUserBody): Promise<boolean>;
+}
+//# 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":"AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACnD,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,eAAe,EACf,mCAAmC,EACnC,kCAAkC,EAClC,cAAc,EACd,oBAAoB,EACpB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,qBAAa,GAAI,SAAQ,MAAM;aAcb,OAAO,CAAC;IACxB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAV3B,gBAAuB,SAAS;;MAE9B;gBAOe,OAAO,CAAC,wBAAY,EACnB,QAAQ,CAAC,0BAAc;IASzC;;;;;OAKG;IAEU,eAAe,CAAC,MAAM,EAAE,gBAAgB;IAOrD;;;;;OAKG;IAEU,kBAAkB,CAAC,MAAM,EAAE;QAAE,aAAa,EAAE,UAAU,CAAA;KAAE;IAOrE;;;;;OAKG;IAEU,gBAAgB,CAAC,MAAM,EAAE;QAAE,aAAa,EAAE,UAAU,CAAA;KAAE;IAWnE;;;;OAIG;IAEU,mBAAmB,CAC/B,MAAM,EAAE,mCAAmC,GACzC,OAAO,CAAC,WAAW,CAAC;IAOvB;;;;OAIG;IAEU,aAAa,CACzB,MAAM,EAAE,kCAAkC,GACxC,OAAO,CAAC,OAAO,CAAC;IAWnB;;;;OAIG;IAEI,0BAA0B,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,QAAQ,CAAA;KAAE,GAAG;QACjE,MAAM,EAAE,MAAM,CAAC;QACf,eAAe,EAAE,MAAM,CAAC;KACxB;IAOD;;;;OAIG;IAEI,8BAA8B,IAAI;QACxC,MAAM,EAAE,MAAM,CAAC;KACf;IAUD;;;;;OAKG;IAEU,gBAAgB,CAAC,MAAM,EAAE;QACrC,aAAa,EAAE,UAAU,CAAC;KAC1B,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAS/B;;;;;OAKG;IAEU,mBAAmB,CAC/B,MAAM,EAAE,oBAAoB,GAC1B,OAAO,CAAC,OAAO,CAAC;CAMnB"}

package/dist/packages/dca/dca.js

@@ -0,0 +1,138 @@
+"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;
+    }
+    // =========================================================================
+    //  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("orders", inputs);
+        });
+    }
+    /**
+     * Fetches the API for dollar cost averaging active orders list.
+     * @async
+     * @param { ApiDCAsOwnedBody } inputs - An object containing the walletAddress.
+     * @returns { Promise<DcaOrderObject[]> } 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("orders/active", inputs);
+        });
+    }
+    /**
+     * Fetches the API for dollar cost averaging past orders list.
+     * @async
+     * @param { ApiDCAsOwnedBody } inputs - An object containing the walletAddress.
+     * @returns { Promise<DcaOrderObject[]> } 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("orders/past", inputs);
+        });
+    }
+    // =========================================================================
+    // Transactions
+    // =========================================================================
+    /**
+     * Fetches the API transaction for creating DCA order.
+     * @param { ApiDcaTransactionForCreateOrderBody } inputs - The inputs for the transaction.
+     * @returns { Promise<Transaction> } 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 for canceling DCA order.
+     * @param inputs - The inputs for the transaction.
+     * @returns { Promise<boolean> } A promise that resolves with transaction execution status.
+     */
+    closeDcaOrder(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApi(`interactions/close-order`, inputs);
+        });
+    }
+    // =========================================================================
+    // Interactions
+    // =========================================================================
+    /**
+     * Method for getting the cancelation dca order message to sign.
+     * @param inputs - The inputs for the message.
+     * @returns Message to sign.
+     */
+    closeDcaOrderMessageToSign(inputs) {
+        return {
+            action: "CANCEL_DCA_ORDER",
+            order_object_id: inputs.orderId,
+        };
+    }
+    /**
+     * Method for getting the creation user message to sign.
+     * @param inputs - The inputs for the message.
+     * @returns Message to sign.
+     */
+    createUserAccountMessageToSign() {
+        return {
+            action: "CREATE_DCA_ACCOUNT",
+        };
+    }
+    // =========================================================================
+    // User Public Key
+    // =========================================================================
+    /**
+     * Fetches the API for users public key.
+     * @async
+     * @param { ApiDCAsOwnedBody } inputs - An object containing the walletAddress.
+     * @returns { Promise<string | undefined> } A promise that resolves users public key.
+     */
+    getUserPublicKey(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApi(`public-key`, inputs);
+        });
+    }
+    /**
+     * Fetches the API to create users public key.
+     * @async
+     * @param { ApiDcaCreateUserBody } inputs - The inputs for creating users public key on BE side.
+     * @returns { Promise<boolean> } A promise that resolves to result if user pk has been created.
+     */
+    createUserPublicKey(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApi(`save-public-key`, inputs);
+        });
+    }
+}
+exports.Dca = Dca;
+// =========================================================================
+//  Constants
+// =========================================================================
+Dca.constants = {
+    gasAmount: BigInt(50000000),
+};

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

@@ -0,0 +1,130 @@
+import { ObjectId, SuiAddress } from "../../types";
+import { CoinType } from "../coin/coinTypes";
+import { Balance, Event, Timestamp, TransactionDigest } from "../../general/types/generalTypes";
+export interface ApiDcaInitializeOrdertStrategyBody {
+    minPrice: Balance;
+    maxPrice: Balance;
+}
+export interface ApiDcaTransactionForCreateOrderBody {
+    walletAddress: SuiAddress;
+    allocateCoinType: CoinType;
+    allocateCoinAmount: Balance;
+    buyCoinType: CoinType;
+    frequencyMs: Timestamp;
+    tradesAmount: number;
+    strategy?: ApiDcaInitializeOrdertStrategyBody;
+    isSponsoredTx?: boolean;
+    delayTimeMs: Timestamp;
+    maxAllowableSlippageBps: number;
+    coinPerTradeAmount: Balance;
+    customRecipient?: SuiAddress;
+}
+export interface ApiDcaTransactionForCloseOrderBody {
+    walletAddress: SuiAddress;
+    bytes: string;
+    signature: string;
+}
+export interface DcaOrderTradeObject {
+    allocatedCoin: {
+        coin: CoinType;
+        amount: Balance;
+    };
+    buyCoin: {
+        coin: CoinType;
+        amount: Balance;
+    };
+    tnxDigest: TransactionDigest;
+    tnxDate: Timestamp;
+    rate: number | undefined;
+}
+export interface DcaOrdertStrategyObject {
+    minPrice: Balance;
+    maxPrice: Balance;
+}
+export interface DcaOrderOverviewObject {
+    allocatedCoin: {
+        coin: CoinType;
+        amount: Balance;
+    };
+    buyCoin: {
+        coin: CoinType;
+        amount: Balance;
+    };
+    averagePrice: Balance;
+    totalSpent: Balance;
+    intervalMs: Timestamp;
+    totalTrades: number;
+    tradesRemaining: number;
+    maxSlippageBps: number;
+    strategy?: DcaOrdertStrategyObject;
+    recipient?: SuiAddress;
+    progress: number;
+    created: {
+        time: Timestamp;
+        tnxDigest: TransactionDigest;
+    };
+    nextTrade: {
+        time: Timestamp;
+        tnxDigest: TransactionDigest;
+    };
+    lastExecutedTrade?: {
+        time: Timestamp;
+        tnxDigest: TransactionDigest;
+    };
+}
+export interface DcaOrderObject {
+    objectId: ObjectId;
+    overview: DcaOrderOverviewObject;
+    trades: DcaOrderTradeObject[];
+}
+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: bigint;
+}
+export interface DcaClosedOrderEvent 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: bigint;
+}
+export interface DcaExecutedTradeEvent extends Event {
+    orderId: ObjectId;
+    user: ObjectId;
+    inputType: CoinType;
+    inputAmount: Balance;
+    outputType: CoinType;
+    outputAmount: Balance;
+}
+export interface ApiDcaCreateUserBody {
+    walletAddress: SuiAddress;
+    bytes: string;
+    signature: string;
+}
+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,SAAS,EACT,iBAAiB,EACjB,MAAM,kCAAkC,CAAC;AAM1C,MAAM,WAAW,kCAAkC;IAClD,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,mCAAmC;IACnD,aAAa,EAAE,UAAU,CAAC;IAC1B,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,WAAW,EAAE,QAAQ,CAAC;IACtB,WAAW,EAAE,SAAS,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,kCAAkC,CAAC;IAC9C,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,WAAW,EAAE,SAAS,CAAC;IACvB,uBAAuB,EAAE,MAAM,CAAC;IAChC,kBAAkB,EAAE,OAAO,CAAC;IAC5B,eAAe,CAAC,EAAE,UAAU,CAAC;CAC7B;AAMD,MAAM,WAAW,kCAAkC;IAClD,aAAa,EAAE,UAAU,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CAClB;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,GAAG,SAAS,CAAC;CACzB;AAED,MAAM,WAAW,uBAAuB;IACvC,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;CAClB;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,UAAU,EAAE,SAAS,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,uBAAuB,CAAC;IACnC,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE;QACR,IAAI,EAAE,SAAS,CAAC;QAChB,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF,SAAS,EAAE;QACV,IAAI,EAAE,SAAS,CAAC;QAChB,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF,iBAAiB,CAAC,EAAE;QACnB,IAAI,EAAE,SAAS,CAAC;QAChB,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;CACF;AAED,MAAM,WAAW,cAAc;IAC9B,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,EAAE,sBAAsB,CAAC;IACjC,MAAM,EAAE,mBAAmB,EAAE,CAAC;CAC9B;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;IAClB,KAAK,EAAE,QAAQ,CAAC;IAChB,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,QAAQ,CAAC;IACpB,UAAU,EAAE,QAAQ,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,SAAS,CAAC;IACvB,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;CACxB;AAED,MAAM,WAAW,mBAAoB,SAAQ,KAAK;IACjD,OAAO,EAAE,QAAQ,CAAC;IAClB,KAAK,EAAE,QAAQ,CAAC;IAChB,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,QAAQ,CAAC;IACpB,UAAU,EAAE,QAAQ,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,SAAS,CAAC;IACvB,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;CACxB;AAED,MAAM,WAAW,qBAAsB,SAAQ,KAAK;IACnD,OAAO,EAAE,QAAQ,CAAC;IAClB,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,EAAE,QAAQ,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,QAAQ,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;CACtB;AAMD,MAAM,WAAW,oBAAoB;IACpC,aAAa,EAAE,UAAU,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CAClB;AAMD,MAAM,WAAW,gBAAgB;IAChC,aAAa,EAAE,UAAU,CAAC;CAC1B"}