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

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

@@ -1,134 +1,319 @@
 import { ObjectId, SuiAddress } from "../../types";
 import { CoinType } from "../coin/coinTypes";
 import { Balance, Timestamp, TransactionDigest } from "../../general/types/generalTypes";
+/**
+ * Describes an optional integrator fee configuration for advanced usage,
+ * allowing a portion of DCA trades to be collected by a third party.
+ */
 export interface DcaIntegratorFeeData {
+    /**
+     * The fee in basis points (bps). e.g., 100 => 1%.
+     */
     feeBps: number;
+    /**
+     * The Sui address that will receive the fee portion.
+     */
     feeRecipient: SuiAddress;
 }
+/**
+ * Optional DCA order strategy parameters, typically bounding min & max
+ * acceptable prices for the trades.
+ */
 export interface DcaOrderStrategyData {
+    /**
+     * The minimum acceptable spot price for the trade, as a bigint scaled by 1e9 or 1e18 depending on usage.
+     */
     minPrice: Balance;
+    /**
+     * The maximum acceptable spot price for the trade, similarly scaled.
+     */
     maxPrice: Balance;
 }
+/**
+ * The inputs required to create a new DCA order. This includes all relevant
+ * coin types, amounts, frequency, trade count, etc.
+ */
 export interface ApiDcaTransactionForCreateOrderBody {
+    /**
+     * The user's address that owns & initiates the DCA order.
+     */
     walletAddress: SuiAddress;
+    /**
+     * The coin type from which funds will be allocated (sold).
+     */
     allocateCoinType: CoinType;
+    /**
+     * The total amount of the allocate coin to be used across trades.
+     */
     allocateCoinAmount: Balance;
+    /**
+     * The coin type that will be purchased periodically.
+     */
     buyCoinType: CoinType;
+    /**
+     * The frequency (in ms) at which trades occur, e.g. every hour => 3600000.
+     */
     frequencyMs: Timestamp;
+    /**
+     * The total number of trades to execute before concluding the DCA plan.
+     */
     tradesAmount: number;
+    /**
+     * An optional bounding strategy specifying min & max acceptable prices.
+     */
     strategy?: DcaOrderStrategyData;
+    /**
+     * If `true`, indicates a partially or fully sponsored transaction, removing gas burden from the user.
+     */
     isSponsoredTx?: boolean;
+    /**
+     * A delay (in ms) before the first trade executes. If `0`, it starts immediately.
+     */
     delayTimeMs: Timestamp;
+    /**
+     * The maximum allowable slippage (in basis points) for each trade, e.g. 100 => 1%.
+     */
     maxAllowableSlippageBps: number;
+    /**
+     * The per-trade amount of `allocateCoinType` to be used, e.g. each trade uses 2 SUI if this is `2e9`.
+     */
     coinPerTradeAmount: Balance;
+    /**
+     * An optional alternate address to receive the purchased coin. Defaults to `walletAddress` if undefined.
+     */
     customRecipient?: SuiAddress;
+    /**
+     * Optional integrator fee data. If provided, a portion of each trade is allocated to the integrator.
+     */
     integratorFee?: DcaIntegratorFeeData;
 }
+/**
+ * The request body for closing a DCA order, typically requiring a signature
+ * over a JSON message specifying which orders to cancel.
+ */
 export interface ApiDcaTransactionForCloseOrderBody {
+    /**
+     * The user's address initiating the close/cancel action.
+     */
     walletAddress: SuiAddress;
+    /**
+     * The signed bytes of the cancellation message.
+     */
     bytes: string;
+    /**
+     * The user's signature corresponding to `bytes`.
+     */
     signature: string;
 }
+/**
+ * Represents parameters for a manual order close workflow. Typically not
+ * used in the standard approach.
+ */
 export type ApiDcaManualCloseOrderBody = {
     walletAddress: SuiAddress;
     buyCoinType: CoinType;
     allocateCoinType: CoinType;
     orderId: SuiAddress;
 };
+/**
+ * Enumerates reasons that a DCA trade might fail, e.g., the price was out of bounds
+ * or the user lacked enough gas.
+ */
 export type DcaFailedTradeReason = "INTERNAL" | "STRATEGY" | "GAS_CAP" | "UNKNOWN_USER" | "SLIPPAGE";
+/**
+ * Represents data for a successful trade that occurred in a DCA sequence,
+ * including the amounts of allocated/buy coins, the final transaction info, etc.
+ */
 export interface DcaOrderTradeObject {
+    /**
+     * The coin & amount that was spent in this trade (e.g., SUI).
+     */
     allocatedCoin: {
         coin: CoinType;
         amount: Balance;
     };
+    /**
+     * The coin & amount that was purchased (e.g., USDC).
+     */
     buyCoin: {
         coin: CoinType;
         amount: Balance;
     };
-    /** @deprecated use txnDigest instead */
-    tnxDigest: TransactionDigest;
+    /**
+     * The final transaction digest for this trade. (Deprecated field `tnxDigest` also present.)
+     */
     txnDigest: TransactionDigest;
-    /** @deprecated use txnTimestamp instead */
-    tnxDate: Timestamp;
+    /** @deprecated use `txnDigest` instead */
+    tnxDigest: TransactionDigest;
+    /**
+     * The timestamp (in ms) when this trade was executed. (Deprecated field `tnxDate` also present.)
+     */
     txnTimestamp: Timestamp;
+    /** @deprecated use `txnTimestamp` instead */
+    tnxDate: Timestamp;
+    /**
+     * The effective rate of the trade, if available, e.g. "0.95" or "1.10".
+     */
     rate: number | undefined;
 }
+/**
+ * Represents a failed trade attempt in a DCA sequence, including time
+ * of failure and the reason code.
+ */
 export interface DcaOrderFailedTradeObject {
     timestamp: number;
     reason: DcaFailedTradeReason | undefined;
 }
+/**
+ * Summarizes the main details of a DCA order, including how much coin is allocated
+ * and how many trades remain.
+ */
 export interface DcaOrderOverviewObject {
+    /**
+     * The coin & amount the user allocated for the entire DCA cycle.
+     */
     allocatedCoin: {
         coin: CoinType;
         amount: Balance;
     };
+    /**
+     * The coin & amount that is being purchased in each periodic trade.
+     */
     buyCoin: {
         coin: CoinType;
         amount: Balance;
     };
+    /**
+     * The total amount of allocateCoin actually spent so far.
+     */
     totalSpent: Balance;
+    /**
+     * The interval (in ms) between each trade, e.g., every hour => 3600000.
+     */
     intervalMs: Timestamp;
+    /**
+     * The total number of trades that were planned.
+     */
     totalTrades: number;
+    /**
+     * The number of remaining trades that have not yet executed.
+     */
     tradesRemaining: number;
+    /**
+     * The maximum slippage (bps) allowed for each trade.
+     */
     maxSlippageBps: number;
+    /**
+     * Optional bounding strategy with min/max acceptable prices.
+     */
     strategy?: DcaOrderStrategyData;
+    /**
+     * The address to receive the purchased coin. Defaults to the DCA owner's address if unspecified.
+     */
     recipient: SuiAddress;
+    /**
+     * Represents how far along the DCA has progressed, typically out of `totalTrades`.
+     */
     progress: number;
+    /**
+     * Details about when & how the DCA was created. Contains timestamps and transaction references.
+     */
     created: {
-        /** @deprecated use timestamp instead */
-        time: Timestamp;
         timestamp: Timestamp;
-        /** @deprecated use txnDigest instead */
-        tnxDigest: TransactionDigest;
+        /** @deprecated use `timestamp` instead */
+        time: Timestamp;
         txnDigest: TransactionDigest;
+        /** @deprecated use `txnDigest` instead */
+        tnxDigest: TransactionDigest;
     };
+    /**
+     * If the next trade is scheduled in the future, indicates when that trade will occur.
+     */
     nextTrade?: {
-        /** @deprecated use timestamp instead */
-        time: Timestamp;
         timestamp: Timestamp;
-        /** @deprecated use txnDigest instead */
-        tnxDigest: TransactionDigest;
+        /** @deprecated use `timestamp` instead */
+        time: Timestamp;
         txnDigest: TransactionDigest;
+        /** @deprecated use `txnDigest` instead */
+        tnxDigest: TransactionDigest;
     };
+    /**
+     * If at least one trade has already executed, shows when & how the last one occurred.
+     */
     lastExecutedTrade?: {
-        /** @deprecated use timestamp instead */
-        time: Timestamp;
         timestamp: Timestamp;
-        /** @deprecated use txnDigest instead */
-        tnxDigest: TransactionDigest;
+        /** @deprecated use `timestamp` instead */
+        time: Timestamp;
         txnDigest: TransactionDigest;
+        /** @deprecated use `txnDigest` instead */
+        tnxDigest: TransactionDigest;
     };
+    /**
+     * Optional integrator fee settings that might apply to each trade.
+     */
     integratorFee?: DcaIntegratorFeeData;
 }
+/**
+ * Represents a single DCA order, including overview data, all successful trades, and all failed trades.
+ */
 export interface DcaOrderObject {
+    /**
+     * The on-chain object ID representing this DCA order.
+     */
     objectId: ObjectId;
+    /**
+     * Summary of the DCA (allocated amounts, trades remaining, etc.).
+     */
     overview: DcaOrderOverviewObject;
+    /**
+     * An array of all completed trades.
+     */
     trades: DcaOrderTradeObject[];
+    /**
+     * An array of attempted trades that failed, along with reasons/timestamps.
+     */
     failed: DcaOrderFailedTradeObject[];
 }
+/**
+ * Represents a grouping of DCA orders, typically used in the older or combined approach.
+ * Contains both `active` and `past` arrays.
+ */
 export interface DcaOrdersObject {
+    /**
+     * Active DCA orders.
+     */
     active: DcaOrderObject[];
+    /**
+     * Past (completed or canceled) DCA orders.
+     */
     past: DcaOrderObject[];
 }
 /**
- * @deprecated please use ApiUserDataCreateUserBody from userData package instead
- * */
+ * **Deprecated**. Body for creating a user public key in the old DCA system.
+ * Use `ApiUserDataCreateUserBody` from `userData` package instead.
+ */
 export interface ApiDcaCreateUserBody {
+    /**
+     * The Sui address of the user.
+     */
     walletAddress: SuiAddress;
+    /**
+     * The message bytes that the user is signing (in hex or base64).
+     */
     bytes: string;
+    /**
+     * The resulting signature from signing `bytes`.
+     */
     signature: string;
 }
+/**
+ * **Deprecated**. Body for fetching the DCA orders owned by a specific user.
+ * Use separate `getActiveDcaOrders` and `getPastDcaOrders` calls instead.
+ */
 export interface ApiDCAsOwnedBody {
-    walletAddress: SuiAddress;
-}
-/** @deprecated use `userData` package instead */
-export interface ApiDcaCreateUserBody {
-    walletAddress: SuiAddress;
-    bytes: string;
-    signature: string;
-}
-/** @deprecated use `userData` package instead */
-export interface ApiDCAsOwnedBody {
+    /**
+     * The user's Sui address whose DCA orders should be fetched.
+     */
     walletAddress: SuiAddress;
 }
 //# sourceMappingURL=dcaTypes.d.ts.map

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

@@ -1 +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,EAAmB,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EACN,OAAO,EACP,SAAS,EAET,iBAAiB,EAGjB,MAAM,kCAAkC,CAAC;AAM1C,MAAM,WAAW,oBAAoB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,UAAU,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACpC,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;CAClB;AAMD,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,oBAAoB,CAAC;IAChC,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;IAC7B,aAAa,CAAC,EAAE,oBAAoB,CAAC;CACrC;AAMD,MAAM,WAAW,kCAAkC;IAClD,aAAa,EAAE,UAAU,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CAClB;AAMD,MAAM,MAAM,0BAA0B,GAAG;IACxC,aAAa,EAAE,UAAU,CAAC;IAC1B,WAAW,EAAE,QAAQ,CAAC;IACtB,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,OAAO,EAAE,UAAU,CAAC;CACpB,CAAC;AAMF,MAAM,MAAM,oBAAoB,GAC7B,UAAU,GACV,UAAU,GACV,SAAS,GACT,cAAc,GACd,UAAU,CAAC;AAEd,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,wCAAwC;IACxC,SAAS,EAAE,iBAAiB,CAAC;IAC7B,SAAS,EAAE,iBAAiB,CAAC;IAE7B,2CAA2C;IAC3C,OAAO,EAAE,SAAS,CAAC;IACnB,YAAY,EAAE,SAAS,CAAC;IAExB,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;CACzB;AAED,MAAM,WAAW,yBAAyB;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,oBAAoB,GAAG,SAAS,CAAC;CACzC;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,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,oBAAoB,CAAC;IAChC,SAAS,EAAE,UAAU,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE;QACR,wCAAwC;QACxC,IAAI,EAAE,SAAS,CAAC;QAChB,SAAS,EAAE,SAAS,CAAC;QAErB,wCAAwC;QACxC,SAAS,EAAE,iBAAiB,CAAC;QAC7B,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF,SAAS,CAAC,EAAE;QACX,wCAAwC;QACxC,IAAI,EAAE,SAAS,CAAC;QAChB,SAAS,EAAE,SAAS,CAAC;QAErB,wCAAwC;QACxC,SAAS,EAAE,iBAAiB,CAAC;QAC7B,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF,iBAAiB,CAAC,EAAE;QACnB,wCAAwC;QACxC,IAAI,EAAE,SAAS,CAAC;QAChB,SAAS,EAAE,SAAS,CAAC;QAErB,wCAAwC;QACxC,SAAS,EAAE,iBAAiB,CAAC;QAC7B,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF,aAAa,CAAC,EAAE,oBAAoB,CAAC;CACrC;AAED,MAAM,WAAW,cAAc;IAC9B,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,EAAE,sBAAsB,CAAC;IACjC,MAAM,EAAE,mBAAmB,EAAE,CAAC;IAC9B,MAAM,EAAE,yBAAyB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,eAAe;IAC/B,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,IAAI,EAAE,cAAc,EAAE,CAAC;CACvB;AAMD;;KAEK;AACL,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;AAMD,iDAAiD;AACjD,MAAM,WAAW,oBAAoB;IACpC,aAAa,EAAE,UAAU,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CAClB;AAMD,iDAAiD;AACjD,MAAM,WAAW,gBAAgB;IAChC,aAAa,EAAE,UAAU,CAAC;CAC1B"}
+{"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,SAAS,EAET,iBAAiB,EAGjB,MAAM,kCAAkC,CAAC;AAM1C;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,YAAY,EAAE,UAAU,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CAClB;AAMD;;;GAGG;AACH,MAAM,WAAW,mCAAmC;IACnD;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,gBAAgB,EAAE,QAAQ,CAAC;IAC3B;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,WAAW,EAAE,QAAQ,CAAC;IACtB;;OAEG;IACH,WAAW,EAAE,SAAS,CAAC;IACvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,WAAW,EAAE,SAAS,CAAC;IACvB;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B;;OAEG;IACH,aAAa,CAAC,EAAE,oBAAoB,CAAC;CACrC;AAMD;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IAClD;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAMD;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACxC,aAAa,EAAE,UAAU,CAAC;IAC1B,WAAW,EAAE,QAAQ,CAAC;IACtB,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,OAAO,EAAE,UAAU,CAAC;CACpB,CAAC;AAMF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAC7B,UAAU,GACV,UAAU,GACV,SAAS,GACT,cAAc,GACd,UAAU,CAAC;AAEd;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC;;OAEG;IACH,aAAa,EAAE;QACd,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,OAAO,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,OAAO,EAAE;QACR,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,OAAO,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC;IAC7B,0CAA0C;IAC1C,SAAS,EAAE,iBAAiB,CAAC;IAE7B;;OAEG;IACH,YAAY,EAAE,SAAS,CAAC;IACxB,6CAA6C;IAC7C,OAAO,EAAE,SAAS,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,oBAAoB,GAAG,SAAS,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACtC;;OAEG;IACH,aAAa,EAAE;QACd,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,OAAO,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,OAAO,EAAE;QACR,IAAI,EAAE,QAAQ,CAAC;QACf,MAAM,EAAE,OAAO,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,UAAU,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC;IACtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE;QACR,SAAS,EAAE,SAAS,CAAC;QACrB,0CAA0C;QAC1C,IAAI,EAAE,SAAS,CAAC;QAChB,SAAS,EAAE,iBAAiB,CAAC;QAC7B,0CAA0C;QAC1C,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF;;OAEG;IACH,SAAS,CAAC,EAAE;QACX,SAAS,EAAE,SAAS,CAAC;QACrB,0CAA0C;QAC1C,IAAI,EAAE,SAAS,CAAC;QAChB,SAAS,EAAE,iBAAiB,CAAC;QAC7B,0CAA0C;QAC1C,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF;;OAEG;IACH,iBAAiB,CAAC,EAAE;QACnB,SAAS,EAAE,SAAS,CAAC;QACrB,0CAA0C;QAC1C,IAAI,EAAE,SAAS,CAAC;QAChB,SAAS,EAAE,iBAAiB,CAAC;QAC7B,0CAA0C;QAC1C,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF;;OAEG;IACH,aAAa,CAAC,EAAE,oBAAoB,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE,sBAAsB,CAAC;IACjC;;OAEG;IACH,MAAM,EAAE,mBAAmB,EAAE,CAAC;IAC9B;;OAEG;IACH,MAAM,EAAE,yBAAyB,EAAE,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB;;OAEG;IACH,IAAI,EAAE,cAAc,EAAE,CAAC;CACvB;AAMD;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAMD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;CAC1B"}

package/dist/packages/farms/farms.d.ts

@@ -4,35 +4,218 @@ import { ApiFarmsCreateStakingPoolBody, ApiFarmsCreateStakingPoolBodyV1, ApiFarm
 import { FarmsStakingPool } from "./farmsStakingPool";
 import { FarmsStakedPosition } from "./farmsStakedPosition";
 import { AftermathApi } from "../../general/providers";
+/**
+ * The `Farms` class provides high-level methods for interacting with
+ * staking pools (farms) on the Sui network. It allows fetching pool
+ * details, user staked positions, and building transactions for creating
+ * new pools. This class also enables retrieving user interactions (events)
+ * with the farming system.
+ */
 export declare class Farms extends Caller {
     private readonly Provider?;
+    /**
+     * Contains constants relevant to farming, including minimum rewards to claim
+     * and maximum lock multipliers.
+     */
     static readonly constants: {
+        /**
+         * The minimum number of rewards (in smallest units) that can be claimed.
+         */
         minRewardsToClaim: bigint;
+        /**
+         * The maximum lock multiplier that can be applied when locking a staked position.
+         */
         maxLockMultiplier: number;
     };
+    /**
+     * Creates a new `Farms` instance for fetching staking pool data and building
+     * farm-related transactions.
+     *
+     * @param config - Optional configuration, including network and access token.
+     * @param Provider - An optional `AftermathApi` instance for advanced transaction building.
+     */
     constructor(config?: CallerConfig, Provider?: AftermathApi | undefined);
+    /**
+     * Fetches a single staking pool by its `objectId` from the farm API/indexer.
+     *
+     * @param inputs - An object containing the `objectId` of the staking pool.
+     * @returns A `FarmsStakingPool` object representing the staking pool.
+     *
+     * @example
+     * ```typescript
+     * const pool = await farms.getStakingPool({ objectId: "0x<pool_id>" });
+     * console.log(pool.stakingPool);
+     * ```
+     */
     getStakingPool(inputs: {
         objectId: ObjectId;
     }): Promise<FarmsStakingPool>;
+    /**
+     * Fetches multiple staking pools by their `objectIds`.
+     *
+     * @param inputs - An object containing an array of `objectIds`.
+     * @returns An array of `FarmsStakingPool` instances corresponding to each `objectId`.
+     *
+     * @example
+     * ```typescript
+     * const pools = await farms.getStakingPools({
+     *   objectIds: ["0x<id1>", "0x<id2>"]
+     * });
+     * console.log(pools[0].stakingPool, pools[1].stakingPool);
+     * ```
+     */
     getStakingPools(inputs: {
         objectIds: ObjectId[];
     }): Promise<FarmsStakingPool[]>;
+    /**
+     * Fetches all existing staking pools registered within the indexer or farm API.
+     *
+     * @returns An array of `FarmsStakingPool` objects.
+     *
+     * @example
+     * ```typescript
+     * const allPools = await farms.getAllStakingPools();
+     * console.log(allPools.map(pool => pool.stakingPool));
+     * ```
+     */
     getAllStakingPools(): Promise<FarmsStakingPool[]>;
+    /**
+     * Fetches all staked positions owned by a given user.
+     *
+     * @param inputs - An object containing the user's `walletAddress`.
+     * @returns An array of `FarmsStakedPosition` objects representing each of the user's staked positions.
+     *
+     * @example
+     * ```typescript
+     * const positions = await farms.getOwnedStakedPositions({
+     *   walletAddress: "0x<user_address>"
+     * });
+     * console.log(positions);
+     * ```
+     */
     getOwnedStakedPositions(inputs: ApiFarmsOwnedStakedPositionsBody): Promise<FarmsStakedPosition[]>;
+    /**
+     * Fetches all `StakingPoolOwnerCapObject`s that a given address owns.
+     * These caps grant the owner the ability to modify staking pool parameters.
+     *
+     * @param inputs - An object containing the owner's `walletAddress`.
+     * @returns An array of `StakingPoolOwnerCapObject`s.
+     *
+     * @example
+     * ```typescript
+     * const ownerCaps = await farms.getOwnedStakingPoolOwnerCaps({
+     *   walletAddress: "0x<user_address>"
+     * });
+     * console.log(ownerCaps);
+     * ```
+     */
     getOwnedStakingPoolOwnerCaps(inputs: ApiFarmsOwnedStakingPoolOwnerCapsBody): Promise<StakingPoolOwnerCapObject[]>;
+    /**
+     * Fetches all `StakingPoolOneTimeAdminCapObject`s that a given address owns.
+     * These caps grant one-time admin privileges, typically for initializing reward coins.
+     *
+     * @param inputs - An object containing the admin's `walletAddress`.
+     * @returns An array of `StakingPoolOneTimeAdminCapObject`s.
+     *
+     * @example
+     * ```typescript
+     * const adminCaps = await farms.getOwnedStakingPoolOneTimeAdminCaps({
+     *   walletAddress: "0x<user_address>"
+     * });
+     * console.log(adminCaps);
+     * ```
+     */
     getOwnedStakingPoolOneTimeAdminCaps(inputs: ApiFarmsOwnedStakingPoolOneTimeAdminCapsBody): Promise<StakingPoolOneTimeAdminCapObject[]>;
+    /**
+     * Retrieves the total value locked (TVL) in the specified farm IDs or in all farms if none are specified.
+     *
+     * @param inputs - An optional object containing an array of `farmIds` to filter TVL by. If not provided, returns global TVL.
+     * @returns A promise that resolves to a `number` representing the TVL in USD (or another relevant currency).
+     *
+     * @example
+     * ```typescript
+     * const tvl = await farms.getTVL();
+     * console.log("All farms' TVL:", tvl);
+     *
+     * const tvlForSpecificFarm = await farms.getTVL({ farmIds: ["0x<farm_id>"] });
+     * console.log("Specific farm's TVL:", tvlForSpecificFarm);
+     * ```
+     */
     getTVL(inputs?: {
         farmIds?: ObjectId[];
     }): Promise<number>;
+    /**
+     * Retrieves the total value locked (TVL) of reward coins across specified farm IDs or all farms if none are specified.
+     *
+     * @param inputs - An optional object containing an array of `farmIds`. If not provided, returns global reward TVL.
+     * @returns A promise that resolves to a `number` representing the total rewards TVL in USD (or another relevant currency).
+     *
+     * @example
+     * ```typescript
+     * const rewardsTvl = await farms.getRewardsTVL();
+     * console.log("All farms' rewards TVL:", rewardsTvl);
+     *
+     * const singleFarmRewardsTvl = await farms.getRewardsTVL({ farmIds: ["0x<farm_id>"] });
+     * console.log("Single farm's rewards TVL:", singleFarmRewardsTvl);
+     * ```
+     */
     getRewardsTVL(inputs?: {
         farmIds?: ObjectId[];
     }): Promise<number>;
-    /** @deprecated use getCreateStakingPoolTransactionV2 instead */
+    /**
+     * **Deprecated**: Use `getCreateStakingPoolTransactionV2()` instead.
+     *
+     * Builds a transaction to create a new staking pool (farming vault) on version 1 of the farm system.
+     *
+     * @param inputs - Contains pool creation parameters such as `minLockDurationMs`, `maxLockDurationMs`, etc.
+     * @returns A transaction object (or bytes) that can be signed and submitted.
+     *
+     * @deprecated Please use `getCreateStakingPoolTransactionV2`.
+     */
     getCreateStakingPoolTransactionV1(inputs: ApiFarmsCreateStakingPoolBodyV1): Promise<import("@mysten/sui/transactions").Transaction>;
+    /**
+     * Builds a transaction to create a new staking pool (farming vault) on version 2 of the farm system.
+     *
+     * @param inputs - Contains pool creation parameters such as `minLockDurationMs`, `maxLockDurationMs`, etc.
+     * @returns A transaction object (or bytes) that can be signed and submitted.
+     *
+     * @example
+     * ```typescript
+     * const tx = await farms.getCreateStakingPoolTransactionV2({
+     *   minLockDurationMs: 604800000, // 1 week
+     *   maxLockDurationMs: 31536000000, // 1 year
+     *   maxLockMultiplier: BigInt("2000000000"), // e.g. 2.0x
+     *   minStakeAmount: BigInt("1000000"),
+     *   stakeCoinType: "0x<coin_type>",
+     *   walletAddress: "0x<admin_address>"
+     * });
+     * // sign and submit the transaction
+     * ```
+     */
     getCreateStakingPoolTransactionV2(inputs: ApiFarmsCreateStakingPoolBody): Promise<import("@mysten/sui/transactions").Transaction>;
+    /**
+     * Fetches user-specific farm interaction events (e.g., staked, unlocked, withdrew) with optional pagination.
+     *
+     * @param inputs - Includes the user's `walletAddress`, along with `cursor` and `limit` for pagination.
+     * @returns A paginated set of events of type `FarmUserEvent`.
+     *
+     * @example
+     * ```typescript
+     * const userEvents = await farms.getInteractionEvents({
+     *   walletAddress: "0x<user_address>",
+     *   cursor: 0,
+     *   limit: 10
+     * });
+     * console.log(userEvents);
+     * ```
+     */
     getInteractionEvents(inputs: ApiIndexerEventsBody & {
         walletAddress: SuiAddress;
     }): Promise<import("../../types").IndexerEventsWithCursor<FarmUserEvent>>;
+    /**
+     * Retrieves an instance of the `Farms` provider from the passed `AftermathApi`,
+     * throwing an error if not available.
+     */
     private useProvider;
 }
 //# sourceMappingURL=farms.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"farms.d.ts","sourceRoot":"","sources":["../../../src/packages/farms/farms.ts"],"names":[],"mappings":"AAAA,OAAO,EAIN,QAAQ,EACR,UAAU,EACV,oBAAoB,EACpB,YAAY,EACZ,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EACN,6BAA6B,EAC7B,+BAA+B,EAC/B,gCAAgC,EAChC,4CAA4C,EAC5C,qCAAqC,EAUrC,aAAa,EACb,gCAAgC,EAChC,yBAAyB,EACzB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,qBAAa,KAAM,SAAQ,MAAM;IAgB/B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAX3B,gBAAuB,SAAS;;;MAG9B;gBAOD,MAAM,CAAC,EAAE,YAAY,EACJ,QAAQ,CAAC,0BAAc;IAa5B,cAAc,CAAC,MAAM,EAAE;QACnC,QAAQ,EAAE,QAAQ,CAAC;KACnB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAOhB,eAAe,CAAC,MAAM,EAAE;QACpC,SAAS,EAAE,QAAQ,EAAE,CAAC;KACtB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAelB,kBAAkB;IAUlB,uBAAuB,CACnC,MAAM,EAAE,gCAAgC;IAiB5B,4BAA4B,CACxC,MAAM,EAAE,qCAAqC;IAWjC,mCAAmC,CAC/C,MAAM,EAAE,4CAA4C;IAexC,MAAM,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAI1D,aAAa,CAAC,MAAM,CAAC,EAAE;QACnC,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC;KACrB,GAAG,OAAO,CAAC,MAAM,CAAC;IAQnB,gEAAgE;IACnD,iCAAiC,CAC7C,MAAM,EAAE,+BAA+B;IAK3B,iCAAiC,CAC7C,MAAM,EAAE,6BAA6B;IASzB,oBAAoB,CAChC,MAAM,EAAE,oBAAoB,GAAG;QAC9B,aAAa,EAAE,UAAU,CAAC;KAC1B;IAcF,OAAO,CAAC,WAAW,CAIjB;CACF"}
+{"version":3,"file":"farms.d.ts","sourceRoot":"","sources":["../../../src/packages/farms/farms.ts"],"names":[],"mappings":"AAAA,OAAO,EAIN,QAAQ,EACR,UAAU,EACV,oBAAoB,EACpB,YAAY,EACZ,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EACN,6BAA6B,EAC7B,+BAA+B,EAC/B,gCAAgC,EAChC,4CAA4C,EAC5C,qCAAqC,EAUrC,aAAa,EACb,gCAAgC,EAChC,yBAAyB,EACzB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD;;;;;;GAMG;AACH,qBAAa,KAAM,SAAQ,MAAM;IAiC/B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IA5B3B;;;OAGG;IACH,gBAAuB,SAAS;QAC/B;;WAEG;;QAEH;;WAEG;;MAEF;IAMF;;;;;;OAMG;gBAEF,MAAM,CAAC,EAAE,YAAY,EACJ,QAAQ,CAAC,0BAAc;IAazC;;;;;;;;;;;OAWG;IACU,cAAc,CAAC,MAAM,EAAE;QACnC,QAAQ,EAAE,QAAQ,CAAC;KACnB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAO7B;;;;;;;;;;;;;OAaG;IACU,eAAe,CAAC,MAAM,EAAE;QACpC,SAAS,EAAE,QAAQ,EAAE,CAAC;KACtB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAe/B;;;;;;;;;;OAUG;IACU,kBAAkB;IAU/B;;;;;;;;;;;;;OAaG;IACU,uBAAuB,CACnC,MAAM,EAAE,gCAAgC;IAiBzC;;;;;;;;;;;;;;OAcG;IACU,4BAA4B,CACxC,MAAM,EAAE,qCAAqC;IAM9C;;;;;;;;;;;;;;OAcG;IACU,mCAAmC,CAC/C,MAAM,EAAE,4CAA4C;IASrD;;;;;;;;;;;;;;OAcG;IACU,MAAM,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvE;;;;;;;;;;;;;;OAcG;IACU,aAAa,CAAC,MAAM,CAAC,EAAE;QACnC,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC;KACrB,GAAG,OAAO,CAAC,MAAM,CAAC;IAQnB;;;;;;;;;OASG;IACU,iCAAiC,CAC7C,MAAM,EAAE,+BAA+B;IAKxC;;;;;;;;;;;;;;;;;;OAkBG;IACU,iCAAiC,CAC7C,MAAM,EAAE,6BAA6B;IAStC;;;;;;;;;;;;;;;OAeG;IACU,oBAAoB,CAChC,MAAM,EAAE,oBAAoB,GAAG;QAC9B,aAAa,EAAE,UAAU,CAAC;KAC1B;IAcF;;;OAGG;IACH,OAAO,CAAC,WAAW,CAIjB;CACF"}