aftermath-ts-sdk 1.2.63 → 1.2.64-docs.1

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

@@ -1,52 +1,138 @@
-import { CallerConfig, ObjectId } from "../../types";
+import { CallerConfig, ObjectId, SuiAddress } from "../../types";
 import { Caller } from "../../general/utils/caller";
-import { SuiAddress } from "../../types";
 import { ApiDCAsOwnedBody, ApiDcaTransactionForCreateOrderBody, ApiDcaTransactionForCloseOrderBody, DcaOrderObject, DcaOrdersObject, ApiDcaCreateUserBody } from "./dcaTypes";
 import { Transaction } from "@mysten/sui/transactions";
+/**
+ * The `Dca` class provides functionality for automating Dollar-Cost Averaging
+ * (DCA) strategies on the Aftermath platform. It allows you to create, query,
+ * and close DCA orders that execute periodic trades based on user-defined
+ * parameters.
+ *
+ * @example
+ * ```typescript
+ * const afSdk = new Aftermath("MAINNET");
+ * await afSdk.init(); // initialize provider
+ *
+ * const dca = afSdk.Dca();
+ * ```
+ */
 export declare class Dca extends Caller {
+    /**
+     * Contains static values related to DCA on the Aftermath platform, such as
+     * default gas usage for DCA transactions.
+     */
     static readonly constants: {
+        /**
+         * The default gas budget for DCA-related transactions (50 SUI).
+         */
         gasAmount: bigint;
     };
+    /**
+     * Creates a new instance of the `Dca` class, responsible for
+     * managing DCA orders (querying, creating, closing).
+     *
+     * @param config - Optional caller configuration, such as network and access token.
+     */
     constructor(config?: CallerConfig);
     /**
-     * Fetches the API for dollar cost averaging orders list.
-     * @deprecated please use `getActiveDcaOrders` and `getPastDcaOrders` instead
+     * **Deprecated**. Fetches both active and past DCA orders for a given user in one response.
+     * Use `getActiveDcaOrders` and `getPastDcaOrders` for a more explicit approach.
+     *
+     * @param inputs - Object containing the user's `walletAddress`.
+     * @returns A `DcaOrdersObject` grouping active and past orders.
+     *
+     * @deprecated Please use `getActiveDcaOrders` & `getPastDcaOrders` instead.
+     * @example
+     * ```typescript
+     * // Old usage:
+     * const allOrders = await dca.getAllDcaOrders({ walletAddress: "0x..." });
+     * console.log(allOrders.active, allOrders.past);
+     * ```
      */
     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.
+     * Retrieves the currently active DCA orders for a specific user.
+     *
+     * @param inputs - An object containing the user's `walletAddress`.
+     * @returns A promise that resolves to an array of `DcaOrderObject` for the active orders.
+     *
+     * @example
+     * ```typescript
+     * const activeOrders = await dca.getActiveDcaOrders({ walletAddress: "0x..." });
+     * console.log(activeOrders); // Array of active DCA orders
+     * ```
      */
     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.
+     * Retrieves the past (completed or canceled) DCA orders for a specific user.
+     *
+     * @param inputs - An object containing the user's `walletAddress`.
+     * @returns A promise that resolves to an array of `DcaOrderObject` for the past orders.
+     *
+     * @example
+     * ```typescript
+     * const pastOrders = await dca.getPastDcaOrders({ walletAddress: "0x..." });
+     * console.log(pastOrders); // Array of past DCA orders
+     * ```
      */
     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.
+     * Builds a transaction block on the Aftermath API to create a new DCA order.
+     * The resulting `Transaction` can then be signed and executed by the user.
+     *
+     * @param inputs - The parameters describing the DCA order (coin types, amounts, frequency, etc.).
+     * @returns A `Transaction` object that can be signed and submitted to the Sui network.
+     *
+     * @example
+     * ```typescript
+     * const createOrderTx = await dca.getCreateDcaOrderTx({
+     *   walletAddress: "0x<user>",
+     *   allocateCoinType: "0x2::sui::SUI",
+     *   allocateCoinAmount: BigInt(1_000_000_000),
+     *   buyCoinType: "0x<coin>",
+     *   frequencyMs: 3600000, // Every hour
+     *   tradesAmount: 5,
+     *   // ...other fields...
+     * });
+     * // sign & send the 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.
+     * Closes (cancels) an existing DCA order by sending a transaction with user signature.
+     * Typically used after generating a message to sign with `closeDcaOrdersMessageToSign`.
+     *
+     * @param inputs - Contains the user's `walletAddress`, plus the `bytes` and `signature` from message signing.
+     * @returns A boolean indicating success or failure (true if canceled).
+     *
+     * @example
+     * ```typescript
+     * const success = await dca.closeDcaOrder({
+     *   walletAddress: "0x...",
+     *   bytes: "0x<signed_bytes>",
+     *   signature: "0x<signature>",
+     * });
+     * ```
      */
     closeDcaOrder(inputs: ApiDcaTransactionForCloseOrderBody): Promise<boolean>;
     /**
-     * Method for getting the cancellation dca order message to sign.
-     * @param inputs - The inputs for the message.
-     * @returns Message to sign.
+     * Generates a JSON object representing the message to sign for canceling one or more DCA orders.
+     * The user can sign this message (converted to bytes) locally, then submit the signature to
+     * `closeDcaOrder`.
+     *
+     * @param inputs - An object containing `orderIds`, an array of order object IDs to cancel.
+     * @returns An object with `action: "CANCEL_DCA_ORDERS"` and the `order_object_ids`.
+     *
+     * @example
+     * ```typescript
+     * const msg = dca.closeDcaOrdersMessageToSign({ orderIds: ["0x<order1>", "0x<order2>"] });
+     * console.log(msg);
+     * // sign this as JSON or string-encode, then pass to closeDcaOrder
+     * ```
      */
     closeDcaOrdersMessageToSign(inputs: {
         orderIds: ObjectId[];
@@ -55,30 +141,33 @@ export declare class Dca extends Caller {
         order_object_ids: string[];
     };
     /**
-     * Method for getting the creation user message to sign.
-     * @param inputs - The inputs for the message.
-     * @returns Message to sign.
-     * @deprecated please use method from `userData` package instead
+     * **Deprecated**. Generates a message object used in older flows to create
+     * a DCA user account. Use the `userData` package for user key storage or account creation.
+     *
+     * @deprecated Please use method from `userData` package instead.
+     * @returns An object with `action: "CREATE_DCA_ACCOUNT"`.
      */
     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.
-     * @deprecated please use method `getUserPublicKey` from `userData` package instead
+     * **Deprecated**. Fetches the user's public key from the older DCA system.
+     * Please use `getUserPublicKey` from the `userData` package instead.
+     *
+     * @deprecated Use `userData` package method instead
+     * @param inputs - Contains the user's `walletAddress`.
+     * @returns The public key as a string or `undefined`.
      */
     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.
-     * @deprecated please use method `createUserPublicKey` from `userData` package instead
+     * **Deprecated**. Creates the user's public key in the older DCA system.
+     * Please use `createUserPublicKey` from the `userData` package instead.
+     *
+     * @deprecated Use `userData` package method instead
+     * @param inputs - Body containing the user address, bytes, and signature.
+     * @returns `true` if the public key was successfully stored, otherwise `false`.
      */
     createUserPublicKey(inputs: ApiDcaCreateUserBody): Promise<boolean>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"dca.d.ts","sourceRoot":"","sources":["../../../src/packages/dca/dca.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EACN,gBAAgB,EAChB,mCAAmC,EACnC,kCAAkC,EAClC,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,qBAAa,GAAI,SAAQ,MAAM;IAK9B,gBAAuB,SAAS;;MAE9B;gBAMU,MAAM,CAAC,EAAE,YAAY;IAQjC;;;OAGG;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,2BAA2B,CAAC,MAAM,EAAE;QAAE,QAAQ,EAAE,QAAQ,EAAE,CAAA;KAAE,GAAG;QACrE,MAAM,EAAE,MAAM,CAAC;QACf,gBAAgB,EAAE,MAAM,EAAE,CAAC;KAC3B;IAWD;;;;;OAKG;IAEI,8BAA8B,IAAI;QACxC,MAAM,EAAE,MAAM,CAAC;KACf;IAUD;;;;;;OAMG;IAEU,gBAAgB,CAAC,MAAM,EAAE;QACrC,aAAa,EAAE,UAAU,CAAC;KAC1B,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAS/B;;;;;;OAMG;IAEU,mBAAmB,CAC/B,MAAM,EAAE,oBAAoB,GAC1B,OAAO,CAAC,OAAO,CAAC;CAMnB"}
+{"version":3,"file":"dca.d.ts","sourceRoot":"","sources":["../../../src/packages/dca/dca.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EACN,gBAAgB,EAChB,mCAAmC,EACnC,kCAAkC,EAClC,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD;;;;;;;;;;;;;GAaG;AACH,qBAAa,GAAI,SAAQ,MAAM;IAK9B;;;OAGG;IACH,gBAAuB,SAAS;QAC/B;;WAEG;;MAEF;IAMF;;;;;OAKG;gBACS,MAAM,CAAC,EAAE,YAAY;IAQjC;;;;;;;;;;;;;;OAcG;IACU,eAAe,CAAC,MAAM,EAAE,gBAAgB;IAOrD;;;;;;;;;;;OAWG;IACU,kBAAkB,CAAC,MAAM,EAAE;QAAE,aAAa,EAAE,UAAU,CAAA;KAAE;IAOrE;;;;;;;;;;;OAWG;IACU,gBAAgB,CAAC,MAAM,EAAE;QAAE,aAAa,EAAE,UAAU,CAAA;KAAE;IAWnE;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,mBAAmB,CAC/B,MAAM,EAAE,mCAAmC,GACzC,OAAO,CAAC,WAAW,CAAC;IAOvB;;;;;;;;;;;;;;;OAeG;IACU,aAAa,CACzB,MAAM,EAAE,kCAAkC,GACxC,OAAO,CAAC,OAAO,CAAC;IAWnB;;;;;;;;;;;;;;OAcG;IACI,2BAA2B,CAAC,MAAM,EAAE;QAAE,QAAQ,EAAE,QAAQ,EAAE,CAAA;KAAE,GAAG;QACrE,MAAM,EAAE,MAAM,CAAC;QACf,gBAAgB,EAAE,MAAM,EAAE,CAAC;KAC3B;IAWD;;;;;;OAMG;IACI,8BAA8B,IAAI;QACxC,MAAM,EAAE,MAAM,CAAC;KACf;IAUD;;;;;;;OAOG;IACU,gBAAgB,CAAC,MAAM,EAAE;QACrC,aAAa,EAAE,UAAU,CAAC;KAC1B,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAS/B;;;;;;;OAOG;IACU,mBAAmB,CAC/B,MAAM,EAAE,oBAAoB,GAC1B,OAAO,CAAC,OAAO,CAAC;CAMnB"}

package/dist/packages/dca/dca.js

@@ -11,10 +11,30 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Dca = void 0;
 const caller_1 = require("../../general/utils/caller");
+/**
+ * The `Dca` class provides functionality for automating Dollar-Cost Averaging
+ * (DCA) strategies on the Aftermath platform. It allows you to create, query,
+ * and close DCA orders that execute periodic trades based on user-defined
+ * parameters.
+ *
+ * @example
+ * ```typescript
+ * const afSdk = new Aftermath("MAINNET");
+ * await afSdk.init(); // initialize provider
+ *
+ * const dca = afSdk.Dca();
+ * ```
+ */
 class Dca extends caller_1.Caller {
     // =========================================================================
     //  Constructor
     // =========================================================================
+    /**
+     * Creates a new instance of the `Dca` class, responsible for
+     * managing DCA orders (querying, creating, closing).
+     *
+     * @param config - Optional caller configuration, such as network and access token.
+     */
     constructor(config) {
         super(config, "dca");
     }
@@ -22,8 +42,19 @@ class Dca extends caller_1.Caller {
     //  Class Objects
     // =========================================================================
     /**
-     * Fetches the API for dollar cost averaging orders list.
-     * @deprecated please use `getActiveDcaOrders` and `getPastDcaOrders` instead
+     * **Deprecated**. Fetches both active and past DCA orders for a given user in one response.
+     * Use `getActiveDcaOrders` and `getPastDcaOrders` for a more explicit approach.
+     *
+     * @param inputs - Object containing the user's `walletAddress`.
+     * @returns A `DcaOrdersObject` grouping active and past orders.
+     *
+     * @deprecated Please use `getActiveDcaOrders` & `getPastDcaOrders` instead.
+     * @example
+     * ```typescript
+     * // Old usage:
+     * const allOrders = await dca.getAllDcaOrders({ walletAddress: "0x..." });
+     * console.log(allOrders.active, allOrders.past);
+     * ```
      */
     getAllDcaOrders(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -31,10 +62,16 @@ class Dca extends caller_1.Caller {
         });
     }
     /**
-     * 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.
+     * Retrieves the currently active DCA orders for a specific user.
+     *
+     * @param inputs - An object containing the user's `walletAddress`.
+     * @returns A promise that resolves to an array of `DcaOrderObject` for the active orders.
+     *
+     * @example
+     * ```typescript
+     * const activeOrders = await dca.getActiveDcaOrders({ walletAddress: "0x..." });
+     * console.log(activeOrders); // Array of active DCA orders
+     * ```
      */
     getActiveDcaOrders(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -42,10 +79,16 @@ class Dca extends caller_1.Caller {
         });
     }
     /**
-     * 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.
+     * Retrieves the past (completed or canceled) DCA orders for a specific user.
+     *
+     * @param inputs - An object containing the user's `walletAddress`.
+     * @returns A promise that resolves to an array of `DcaOrderObject` for the past orders.
+     *
+     * @example
+     * ```typescript
+     * const pastOrders = await dca.getPastDcaOrders({ walletAddress: "0x..." });
+     * console.log(pastOrders); // Array of past DCA orders
+     * ```
      */
     getPastDcaOrders(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -53,12 +96,28 @@ class Dca extends caller_1.Caller {
         });
     }
     // =========================================================================
-    // Transactions
+    //  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.
+     * Builds a transaction block on the Aftermath API to create a new DCA order.
+     * The resulting `Transaction` can then be signed and executed by the user.
+     *
+     * @param inputs - The parameters describing the DCA order (coin types, amounts, frequency, etc.).
+     * @returns A `Transaction` object that can be signed and submitted to the Sui network.
+     *
+     * @example
+     * ```typescript
+     * const createOrderTx = await dca.getCreateDcaOrderTx({
+     *   walletAddress: "0x<user>",
+     *   allocateCoinType: "0x2::sui::SUI",
+     *   allocateCoinAmount: BigInt(1_000_000_000),
+     *   buyCoinType: "0x<coin>",
+     *   frequencyMs: 3600000, // Every hour
+     *   tradesAmount: 5,
+     *   // ...other fields...
+     * });
+     * // sign & send the transaction
+     * ```
      */
     getCreateDcaOrderTx(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -66,9 +125,20 @@ class Dca extends caller_1.Caller {
         });
     }
     /**
-     * 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.
+     * Closes (cancels) an existing DCA order by sending a transaction with user signature.
+     * Typically used after generating a message to sign with `closeDcaOrdersMessageToSign`.
+     *
+     * @param inputs - Contains the user's `walletAddress`, plus the `bytes` and `signature` from message signing.
+     * @returns A boolean indicating success or failure (true if canceled).
+     *
+     * @example
+     * ```typescript
+     * const success = await dca.closeDcaOrder({
+     *   walletAddress: "0x...",
+     *   bytes: "0x<signed_bytes>",
+     *   signature: "0x<signature>",
+     * });
+     * ```
      */
     closeDcaOrder(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -76,12 +146,22 @@ class Dca extends caller_1.Caller {
         });
     }
     // =========================================================================
-    // Interactions
+    //  Interactions
     // =========================================================================
     /**
-     * Method for getting the cancellation dca order message to sign.
-     * @param inputs - The inputs for the message.
-     * @returns Message to sign.
+     * Generates a JSON object representing the message to sign for canceling one or more DCA orders.
+     * The user can sign this message (converted to bytes) locally, then submit the signature to
+     * `closeDcaOrder`.
+     *
+     * @param inputs - An object containing `orderIds`, an array of order object IDs to cancel.
+     * @returns An object with `action: "CANCEL_DCA_ORDERS"` and the `order_object_ids`.
+     *
+     * @example
+     * ```typescript
+     * const msg = dca.closeDcaOrdersMessageToSign({ orderIds: ["0x<order1>", "0x<order2>"] });
+     * console.log(msg);
+     * // sign this as JSON or string-encode, then pass to closeDcaOrder
+     * ```
      */
     closeDcaOrdersMessageToSign(inputs) {
         return {
@@ -90,13 +170,14 @@ class Dca extends caller_1.Caller {
         };
     }
     // =========================================================================
-    // Interactions - Deprecated
+    //  Interactions - Deprecated
     // =========================================================================
     /**
-     * Method for getting the creation user message to sign.
-     * @param inputs - The inputs for the message.
-     * @returns Message to sign.
-     * @deprecated please use method from `userData` package instead
+     * **Deprecated**. Generates a message object used in older flows to create
+     * a DCA user account. Use the `userData` package for user key storage or account creation.
+     *
+     * @deprecated Please use method from `userData` package instead.
+     * @returns An object with `action: "CREATE_DCA_ACCOUNT"`.
      */
     createUserAccountMessageToSign() {
         return {
@@ -104,14 +185,15 @@ class Dca extends caller_1.Caller {
         };
     }
     // =========================================================================
-    // User Public Key
+    //  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.
-     * @deprecated please use method `getUserPublicKey` from `userData` package instead
+     * **Deprecated**. Fetches the user's public key from the older DCA system.
+     * Please use `getUserPublicKey` from the `userData` package instead.
+     *
+     * @deprecated Use `userData` package method instead
+     * @param inputs - Contains the user's `walletAddress`.
+     * @returns The public key as a string or `undefined`.
      */
     getUserPublicKey(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -119,11 +201,12 @@ class Dca extends caller_1.Caller {
         });
     }
     /**
-     * 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.
-     * @deprecated please use method `createUserPublicKey` from `userData` package instead
+     * **Deprecated**. Creates the user's public key in the older DCA system.
+     * Please use `createUserPublicKey` from the `userData` package instead.
+     *
+     * @deprecated Use `userData` package method instead
+     * @param inputs - Body containing the user address, bytes, and signature.
+     * @returns `true` if the public key was successfully stored, otherwise `false`.
      */
     createUserPublicKey(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -135,6 +218,13 @@ exports.Dca = Dca;
 // =========================================================================
 //  Constants
 // =========================================================================
+/**
+ * Contains static values related to DCA on the Aftermath platform, such as
+ * default gas usage for DCA transactions.
+ */
 Dca.constants = {
+    /**
+     * The default gas budget for DCA-related transactions (50 SUI).
+     */
     gasAmount: BigInt(50000000),
 };