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

package/dist/packages/limitOrders/limitOrders.d.ts

@@ -1,45 +1,125 @@
-import { CallerConfig, ObjectId } from "../../types";
+import { CallerConfig, ObjectId, SuiAddress } from "../../types";
 import { Caller } from "../../general/utils/caller";
-import { SuiAddress } from "../../types";
 import { ApiLimitOrdersCreateOrderTransactionBody, ApiLimitOrdersCancelOrderTransactionBody, LimitOrderObject, ApiLimitOrdersActiveOrdersOwnedBody } from "./limitOrdersTypes";
 import { Transaction } from "@mysten/sui/transactions";
+/**
+ * The `LimitOrders` class manages creation, cancellation, and querying of
+ * limit orders on the Aftermath platform. Limit orders allow you to buy or
+ * sell at a specified price, giving more control over your trades compared
+ * to market execution.
+ *
+ * @example
+ * ```typescript
+ * const afSdk = new Aftermath("MAINNET");
+ * await afSdk.init(); // initialize provider
+ *
+ * const limitOrders = afSdk.LimitOrders();
+ * ```
+ */
 export declare class LimitOrders extends Caller {
+    /**
+     * Static configuration constants, including a default gas amount for
+     * limit order transactions (50 SUI).
+     */
     static readonly constants: {
+        /**
+         * The default gas budget for limit orders. This may be subject to change.
+         */
         gasAmount: bigint;
     };
+    /**
+     * Creates a new `LimitOrders` instance for interacting with limit order functionality
+     * on Aftermath.
+     *
+     * @param config - Optional configuration, including network and access token.
+     */
     constructor(config?: CallerConfig);
     /**
-     * Fetches the API for dollar cost averaging active orders list.
-     * @async
-     * @param { LimitOrderObject } inputs - An object containing the walletAddress.
-     * @returns { Promise<LimitOrderObject[]> } A promise that resolves to object with array of fetched events for active limit orders
+     * Fetches the list of **active** limit orders for a given user. The user must
+     * provide a signature for identification.
+     *
+     * @param inputs - Contains the `walletAddress`, as well as `bytes` and `signature` if needed for auth.
+     * @returns A promise resolving to an array of `LimitOrderObject`, representing the active orders.
+     *
+     * @example
+     * ```typescript
+     * const activeOrders = await limitOrders.getActiveLimitOrders({
+     *   walletAddress: "0x<address>",
+     *   bytes: "0x<signed_bytes>",
+     *   signature: "0x<signature>"
+     * });
+     * ```
      */
     getActiveLimitOrders(inputs: ApiLimitOrdersActiveOrdersOwnedBody): Promise<LimitOrderObject[]>;
     /**
-     * Fetches the API for limit cost finished orders list.
-     * @async
-     * @param { LimitOrderObject } inputs - An object containing the walletAddress.
-     * @returns { Promise<LimitOrderObject[]> } A promise that resolves to object with array of fetched events for past limit orders
+     * Fetches the list of **past** limit orders for a given user (e.g., completed, canceled, or expired).
+     *
+     * @param inputs - An object containing the `walletAddress`.
+     * @returns A promise resolving to an array of `LimitOrderObject` representing past orders.
+     *
+     * @example
+     * ```typescript
+     * const pastOrders = await limitOrders.getPastLimitOrders({
+     *   walletAddress: "0x<address>",
+     * });
+     * ```
      */
     getPastLimitOrders(inputs: {
         walletAddress: SuiAddress;
     }): Promise<LimitOrderObject[]>;
     /**
-     * Fetches the API transaction for creating Limit order.
-     * @param { ApiLimitOrdersCreateOrderTransactionBody } inputs - The inputs for the transaction.
-     * @returns { Promise<Transaction> } A promise that resolves with the API transaction.
+     * Constructs a limit order creation transaction on the Aftermath API, returning a `Transaction`
+     * object that can be signed and submitted to the network.
+     *
+     * @param inputs - The limit order details, including coin types, amounts, expiry, etc.
+     * @returns A promise resolving to a `Transaction` that can be locally signed and executed.
+     *
+     * @example
+     * ```typescript
+     * const tx = await limitOrders.getCreateLimitOrderTx({
+     *   walletAddress: "0x<address>",
+     *   allocateCoinType: "0x<coin>",
+     *   allocateCoinAmount: BigInt(1000),
+     *   buyCoinType: "0x<other_coin>",
+     *   expiryDurationMs: 3600000, // 1 hour
+     *   outputToInputExchangeRate: 0.5,
+     * });
+     * // sign and execute the transaction
+     * ```
      */
     getCreateLimitOrderTx(inputs: ApiLimitOrdersCreateOrderTransactionBody): Promise<Transaction>;
     /**
-     * Fetches the API for canceling Limit order.
-     * @param inputs - The inputs for the transaction.
-     * @returns { Promise<boolean> } A promise that resolves with transaction execution status.
+     * Cancels an existing limit order by sending a request to the Aftermath API
+     * with the user's signed cancellation message.
+     *
+     * @param inputs - Contains the user's `walletAddress`, plus `bytes` and `signature`.
+     * @returns A boolean indicating whether the cancellation was successful.
+     *
+     * @example
+     * ```typescript
+     * const success = await limitOrders.cancelLimitOrder({
+     *   walletAddress: "0x<address>",
+     *   bytes: "0x<signed_bytes>",
+     *   signature: "0x<signature>",
+     * });
+     * ```
      */
     cancelLimitOrder(inputs: ApiLimitOrdersCancelOrderTransactionBody): Promise<boolean>;
     /**
-     * Method for getting the cancellation limit order message to sign.
-     * @param inputs - The inputs for the message.
-     * @returns Message to sign.
+     * Generates the JSON message needed to cancel one or more limit orders. The user
+     * signs this message (converted to bytes), and the resulting signature is passed
+     * to `cancelLimitOrder`.
+     *
+     * @param inputs - Object with `orderIds`, an array of order object IDs to cancel.
+     * @returns A JSON structure with the action and order IDs to be canceled.
+     *
+     * @example
+     * ```typescript
+     * const msg = limitOrders.cancelLimitOrdersMessageToSign({
+     *   orderIds: ["0x<order1>", "0x<order2>"]
+     * });
+     * // user signs this JSON
+     * ```
      */
     cancelLimitOrdersMessageToSign(inputs: {
         orderIds: ObjectId[];
@@ -48,8 +128,15 @@ export declare class LimitOrders extends Caller {
         order_object_ids: string[];
     };
     /**
-     * Method for getting a minimum allowable order size.
-     * @returns Minimum order size in usd.
+     * Retrieves the minimum allowable order size (in USD) for limit orders on Aftermath.
+     *
+     * @returns A promise resolving to a `number` (USD value) or `undefined` if not configured.
+     *
+     * @example
+     * ```typescript
+     * const minSize = await limitOrders.getMinOrderSizeUsd();
+     * console.log("Minimum order size in USD:", minSize);
+     * ```
      */
     getMinOrderSizeUsd(): Promise<number | undefined>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"limitOrders.d.ts","sourceRoot":"","sources":["../../../src/packages/limitOrders/limitOrders.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAY,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAEN,wCAAwC,EACxC,wCAAwC,EACxC,gBAAgB,EAChB,mCAAmC,EACnC,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,qBAAa,WAAY,SAAQ,MAAM;IAKtC,gBAAuB,SAAS;;MAE9B;gBAMU,MAAM,CAAC,EAAE,YAAY;IAQjC;;;;;OAKG;IAEU,oBAAoB,CAChC,MAAM,EAAE,mCAAmC;IAQ5C;;;;;OAKG;IAEU,kBAAkB,CAAC,MAAM,EAAE;QAAE,aAAa,EAAE,UAAU,CAAA;KAAE;IAWrE;;;;OAIG;IAEU,qBAAqB,CACjC,MAAM,EAAE,wCAAwC,GAC9C,OAAO,CAAC,WAAW,CAAC;IAOvB;;;;OAIG;IAEU,gBAAgB,CAC5B,MAAM,EAAE,wCAAwC,GAC9C,OAAO,CAAC,OAAO,CAAC;IAWnB;;;;OAIG;IAEI,8BAA8B,CAAC,MAAM,EAAE;QAAE,QAAQ,EAAE,QAAQ,EAAE,CAAA;KAAE,GAAG;QACxE,MAAM,EAAE,MAAM,CAAC;QACf,gBAAgB,EAAE,MAAM,EAAE,CAAC;KAC3B;IAWD;;;OAGG;IAEU,kBAAkB;CAG/B"}
+{"version":3,"file":"limitOrders.d.ts","sourceRoot":"","sources":["../../../src/packages/limitOrders/limitOrders.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAY,QAAQ,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC3E,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAEN,wCAAwC,EACxC,wCAAwC,EACxC,gBAAgB,EAChB,mCAAmC,EACnC,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD;;;;;;;;;;;;;GAaG;AACH,qBAAa,WAAY,SAAQ,MAAM;IAKtC;;;OAGG;IACH,gBAAuB,SAAS;QAC/B;;WAEG;;MAEF;IAMF;;;;;OAKG;gBACS,MAAM,CAAC,EAAE,YAAY;IAQjC;;;;;;;;;;;;;;;OAeG;IACU,oBAAoB,CAChC,MAAM,EAAE,mCAAmC;IAQ5C;;;;;;;;;;;;OAYG;IACU,kBAAkB,CAAC,MAAM,EAAE;QAAE,aAAa,EAAE,UAAU,CAAA;KAAE;IAWrE;;;;;;;;;;;;;;;;;;;OAmBG;IACU,qBAAqB,CACjC,MAAM,EAAE,wCAAwC,GAC9C,OAAO,CAAC,WAAW,CAAC;IAOvB;;;;;;;;;;;;;;;OAeG;IACU,gBAAgB,CAC5B,MAAM,EAAE,wCAAwC,GAC9C,OAAO,CAAC,OAAO,CAAC;IAWnB;;;;;;;;;;;;;;;OAeG;IACI,8BAA8B,CAAC,MAAM,EAAE;QAAE,QAAQ,EAAE,QAAQ,EAAE,CAAA;KAAE,GAAG;QACxE,MAAM,EAAE,MAAM,CAAC;QACf,gBAAgB,EAAE,MAAM,EAAE,CAAC;KAC3B;IAWD;;;;;;;;;;OAUG;IACU,kBAAkB;CAG/B"}

package/dist/packages/limitOrders/limitOrders.js

@@ -11,10 +11,30 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LimitOrders = void 0;
 const caller_1 = require("../../general/utils/caller");
+/**
+ * The `LimitOrders` class manages creation, cancellation, and querying of
+ * limit orders on the Aftermath platform. Limit orders allow you to buy or
+ * sell at a specified price, giving more control over your trades compared
+ * to market execution.
+ *
+ * @example
+ * ```typescript
+ * const afSdk = new Aftermath("MAINNET");
+ * await afSdk.init(); // initialize provider
+ *
+ * const limitOrders = afSdk.LimitOrders();
+ * ```
+ */
 class LimitOrders extends caller_1.Caller {
     // =========================================================================
     //  Constructor
     // =========================================================================
+    /**
+     * Creates a new `LimitOrders` instance for interacting with limit order functionality
+     * on Aftermath.
+     *
+     * @param config - Optional configuration, including network and access token.
+     */
     constructor(config) {
         super(config, "limit-orders");
     }
@@ -22,10 +42,20 @@ class LimitOrders extends caller_1.Caller {
     //  Class Objects
     // =========================================================================
     /**
-     * Fetches the API for dollar cost averaging active orders list.
-     * @async
-     * @param { LimitOrderObject } inputs - An object containing the walletAddress.
-     * @returns { Promise<LimitOrderObject[]> } A promise that resolves to object with array of fetched events for active limit orders
+     * Fetches the list of **active** limit orders for a given user. The user must
+     * provide a signature for identification.
+     *
+     * @param inputs - Contains the `walletAddress`, as well as `bytes` and `signature` if needed for auth.
+     * @returns A promise resolving to an array of `LimitOrderObject`, representing the active orders.
+     *
+     * @example
+     * ```typescript
+     * const activeOrders = await limitOrders.getActiveLimitOrders({
+     *   walletAddress: "0x<address>",
+     *   bytes: "0x<signed_bytes>",
+     *   signature: "0x<signature>"
+     * });
+     * ```
      */
     getActiveLimitOrders(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -33,10 +63,17 @@ class LimitOrders extends caller_1.Caller {
         });
     }
     /**
-     * Fetches the API for limit cost finished orders list.
-     * @async
-     * @param { LimitOrderObject } inputs - An object containing the walletAddress.
-     * @returns { Promise<LimitOrderObject[]> } A promise that resolves to object with array of fetched events for past limit orders
+     * Fetches the list of **past** limit orders for a given user (e.g., completed, canceled, or expired).
+     *
+     * @param inputs - An object containing the `walletAddress`.
+     * @returns A promise resolving to an array of `LimitOrderObject` representing past orders.
+     *
+     * @example
+     * ```typescript
+     * const pastOrders = await limitOrders.getPastLimitOrders({
+     *   walletAddress: "0x<address>",
+     * });
+     * ```
      */
     getPastLimitOrders(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -44,12 +81,27 @@ class LimitOrders extends caller_1.Caller {
         });
     }
     // =========================================================================
-    // Transactions
+    //  Transactions
     // =========================================================================
     /**
-     * Fetches the API transaction for creating Limit order.
-     * @param { ApiLimitOrdersCreateOrderTransactionBody } inputs - The inputs for the transaction.
-     * @returns { Promise<Transaction> } A promise that resolves with the API transaction.
+     * Constructs a limit order creation transaction on the Aftermath API, returning a `Transaction`
+     * object that can be signed and submitted to the network.
+     *
+     * @param inputs - The limit order details, including coin types, amounts, expiry, etc.
+     * @returns A promise resolving to a `Transaction` that can be locally signed and executed.
+     *
+     * @example
+     * ```typescript
+     * const tx = await limitOrders.getCreateLimitOrderTx({
+     *   walletAddress: "0x<address>",
+     *   allocateCoinType: "0x<coin>",
+     *   allocateCoinAmount: BigInt(1000),
+     *   buyCoinType: "0x<other_coin>",
+     *   expiryDurationMs: 3600000, // 1 hour
+     *   outputToInputExchangeRate: 0.5,
+     * });
+     * // sign and execute the transaction
+     * ```
      */
     getCreateLimitOrderTx(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -57,9 +109,20 @@ class LimitOrders extends caller_1.Caller {
         });
     }
     /**
-     * Fetches the API for canceling Limit order.
-     * @param inputs - The inputs for the transaction.
-     * @returns { Promise<boolean> } A promise that resolves with transaction execution status.
+     * Cancels an existing limit order by sending a request to the Aftermath API
+     * with the user's signed cancellation message.
+     *
+     * @param inputs - Contains the user's `walletAddress`, plus `bytes` and `signature`.
+     * @returns A boolean indicating whether the cancellation was successful.
+     *
+     * @example
+     * ```typescript
+     * const success = await limitOrders.cancelLimitOrder({
+     *   walletAddress: "0x<address>",
+     *   bytes: "0x<signed_bytes>",
+     *   signature: "0x<signature>",
+     * });
+     * ```
      */
     cancelLimitOrder(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -67,12 +130,23 @@ class LimitOrders extends caller_1.Caller {
         });
     }
     // =========================================================================
-    // Interactions
+    //  Interactions
     // =========================================================================
     /**
-     * Method for getting the cancellation limit order message to sign.
-     * @param inputs - The inputs for the message.
-     * @returns Message to sign.
+     * Generates the JSON message needed to cancel one or more limit orders. The user
+     * signs this message (converted to bytes), and the resulting signature is passed
+     * to `cancelLimitOrder`.
+     *
+     * @param inputs - Object with `orderIds`, an array of order object IDs to cancel.
+     * @returns A JSON structure with the action and order IDs to be canceled.
+     *
+     * @example
+     * ```typescript
+     * const msg = limitOrders.cancelLimitOrdersMessageToSign({
+     *   orderIds: ["0x<order1>", "0x<order2>"]
+     * });
+     * // user signs this JSON
+     * ```
      */
     cancelLimitOrdersMessageToSign(inputs) {
         return {
@@ -81,11 +155,18 @@ class LimitOrders extends caller_1.Caller {
         };
     }
     // =========================================================================
-    // Configuration
+    //  Configuration
     // =========================================================================
     /**
-     * Method for getting a minimum allowable order size.
-     * @returns Minimum order size in usd.
+     * Retrieves the minimum allowable order size (in USD) for limit orders on Aftermath.
+     *
+     * @returns A promise resolving to a `number` (USD value) or `undefined` if not configured.
+     *
+     * @example
+     * ```typescript
+     * const minSize = await limitOrders.getMinOrderSizeUsd();
+     * console.log("Minimum order size in USD:", minSize);
+     * ```
      */
     getMinOrderSizeUsd() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -97,6 +178,13 @@ exports.LimitOrders = LimitOrders;
 // =========================================================================
 //  Constants
 // =========================================================================
+/**
+ * Static configuration constants, including a default gas amount for
+ * limit order transactions (50 SUI).
+ */
 LimitOrders.constants = {
+    /**
+     * The default gas budget for limit orders. This may be subject to change.
+     */
     gasAmount: BigInt(50000000),
 };

package/dist/packages/limitOrders/limitOrdersTypes.d.ts

@@ -1,69 +1,211 @@
 import { ObjectId, SuiAddress } from "../../types";
 import { CoinType } from "../coin/coinTypes";
 import { Balance, Timestamp, TransactionDigest } from "../../general/types/generalTypes";
+/**
+ * Describes an optional integrator fee structure for advanced usage,
+ * allowing a portion of limit orders to be allocated to a third party.
+ */
 export interface LimitOrdersIntegratorFeeData {
+    /**
+     * The integrator fee percentage in basis points (bps), e.g., 100 => 1%.
+     */
     feeBps: number;
+    /**
+     * The recipient address for fee collection.
+     */
     feeRecipient: SuiAddress;
 }
+/**
+ * Defines the body required to create a new limit order transaction. This includes
+ * coin types, amounts, expiry settings, and optional integrator fees.
+ */
 export interface ApiLimitOrdersCreateOrderTransactionBody {
+    /**
+     * The user address creating the limit order.
+     */
     walletAddress: SuiAddress;
+    /**
+     * The coin type to be allocated/sold in the order.
+     */
     allocateCoinType: CoinType;
+    /**
+     * The total amount of the allocateCoin to be reserved for this order.
+     */
     allocateCoinAmount: Balance;
+    /**
+     * The coin type to be purchased when price conditions are met.
+     */
     buyCoinType: CoinType;
+    /**
+     * Optionally specify a custom recipient of the purchased coin, defaulting to `walletAddress`.
+     */
     customRecipient?: SuiAddress;
+    /**
+     * The duration (in ms) after which the limit order expires and becomes invalid.
+     * If `0`, there's effectively no set expiry.
+     */
     expiryDurationMs: number;
+    /**
+     * Indicates whether the transaction is sponsored, potentially reducing user gas fees.
+     */
     isSponsoredTx?: boolean;
+    /**
+     * Optional integrator fee details for advanced usage.
+     */
     integratorFee?: LimitOrdersIntegratorFeeData;
+    /**
+     * The "take-profit" exchange rate from `buyCoinType` to `allocateCoinType`.
+     * For example, if `outputToInputExchangeRate` is 0.5, it means 1 buyCoin can be sold for 0.5 allocateCoin.
+     */
     outputToInputExchangeRate: number;
+    /**
+     * Optional "stop-loss" exchange rate. If the market moves such that the trade
+     * would invert beyond this rate, the order might close early or fail, depending on logic.
+     */
     outputToInputStopLossExchangeRate?: number;
 }
+/**
+ * Additional body for sub-orders if using a multi-tier approach (ladders).
+ */
 export interface ApiLimitOrdersSubOrdersBody {
+    /**
+     * The order price (e.g., an exchange rate or threshold).
+     */
     orderPrice: Balance;
+    /**
+     * The number of partial orders to create at this price level.
+     */
     ordersAmount: number;
 }
+/**
+ * Defines a single "ladder" rung, specifying how much to trade at a certain price.
+ */
 export interface ApiLimitLaddersOrdersBody {
+    /**
+     * The specific price (exchange rate) for this rung.
+     */
     price: Balance;
+    /**
+     * The total quantity/amount to trade if the price is reached.
+     */
     quantity: Balance;
 }
+/**
+ * Body required to cancel an existing limit order, typically including the
+ * user's signature of a JSON message referencing order IDs.
+ */
 export interface ApiLimitOrdersCancelOrderTransactionBody {
+    /**
+     * The Sui address of the user who owns the order(s).
+     */
     walletAddress: SuiAddress;
+    /**
+     * The signed bytes of the cancellation message.
+     */
     bytes: string;
+    /**
+     * The signature over those bytes, verifying user intent.
+     */
     signature: string;
 }
+/**
+ * Enumerates all possible statuses for a limit order on Aftermath.
+ */
 export type LimitOrdersOrderStatus = "Active" | "Canceled" | "Failed" | "Filled" | "Expired" | "StopLossTriggered";
+/**
+ * Represents the on-chain data structure for a single limit order, including
+ * allocated coin amounts, buy coin details, creation/finalization times, etc.
+ */
 export interface LimitOrderObject {
+    /**
+     * The on-chain object ID referencing this limit order.
+     */
     objectId: ObjectId;
+    /**
+     * The coin & amount allocated for potential trading.
+     */
     allocatedCoin: {
         coin: CoinType;
         amount: Balance;
     };
+    /**
+     * The coin & amount to be acquired if/when the order conditions are met.
+     */
     buyCoin: {
         coin: CoinType;
         amount: Balance;
     };
+    /**
+     * Tracks how much of the allocated coin has actually been used (sold).
+     */
     currentAmountSold: Balance;
+    /**
+     * Tracks how much of the buy coin has actually been purchased.
+     */
     currentAmountBought: Balance;
+    /**
+     * The address that will receive the bought coin, often the same as `walletAddress`.
+     */
     recipient: SuiAddress;
+    /**
+     * Contains timestamps and transaction references for order creation.
+     */
     created: {
         timestamp: Timestamp;
         txnDigest: TransactionDigest;
     };
+    /**
+     * If the order has finished, indicates when and via which transaction it concluded.
+     */
     finished?: {
         timestamp: Timestamp;
         txnDigest: TransactionDigest;
     };
+    /**
+     * The UNIX timestamp (ms) after which the order is considered expired.
+     */
     expiryTimestamp: Timestamp;
+    /**
+     * The current status of the order (Active, Canceled, etc.).
+     */
     status: LimitOrdersOrderStatus;
+    /**
+     * If the order ended or failed with an error, this might contain a reason or message.
+     */
     error?: string;
+    /**
+     * Optional integrator fee data for advanced usage.
+     */
     integratorFee?: LimitOrdersIntegratorFeeData;
+    /**
+     * Optional stop-loss exchange rate; if triggered, the order might end or convert differently.
+     */
     outputToInputStopLossExchangeRate?: number;
 }
+/**
+ * Body for fetching past (completed, canceled, expired, etc.) limit orders of a user.
+ */
 export interface ApiLimitOrdersPastOrdersOwnedBody {
+    /**
+     * The Sui address of the user.
+     */
     walletAddress: SuiAddress;
 }
+/**
+ * Body for fetching active limit orders of a user, requiring user signature data for identification.
+ */
 export interface ApiLimitOrdersActiveOrdersOwnedBody {
+    /**
+     * The Sui address of the user.
+     */
     walletAddress: SuiAddress;
+    /**
+     * Signed bytes of a message verifying user identity.
+     */
     bytes: string;
+    /**
+     * Signature over the `bytes`.
+     */
     signature: string;
 }
 //# sourceMappingURL=limitOrdersTypes.d.ts.map

package/dist/packages/limitOrders/limitOrdersTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"limitOrdersTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/limitOrders/limitOrdersTypes.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,EACT,iBAAiB,EACjB,MAAM,kCAAkC,CAAC;AAM1C,MAAM,WAAW,4BAA4B;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,UAAU,CAAC;CACzB;AAMD,MAAM,WAAW,wCAAwC;IACxD,aAAa,EAAE,UAAU,CAAC;IAC1B,gBAAgB,EAAE,QAAQ,CAAC;IAC3B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,WAAW,EAAE,QAAQ,CAAC;IACtB,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,aAAa,CAAC,EAAE,4BAA4B,CAAC;IAC7C,yBAAyB,EAAE,MAAM,CAAC;IAClC,iCAAiC,CAAC,EAAE,MAAM,CAAC;CAC3C;AAED,MAAM,WAAW,2BAA2B;IAC3C,UAAU,EAAE,OAAO,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACrB;AAMD,MAAM,WAAW,yBAAyB;IACzC,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;CAClB;AAMD,MAAM,WAAW,wCAAwC;IACxD,aAAa,EAAE,UAAU,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CAClB;AAMD,MAAM,MAAM,sBAAsB,GAC/B,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,mBAAmB,CAAC;AAEvB,MAAM,WAAW,gBAAgB;IAChC,QAAQ,EAAE,QAAQ,CAAC;IACnB,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,iBAAiB,EAAE,OAAO,CAAC;IAC3B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,SAAS,EAAE,UAAU,CAAC;IACtB,OAAO,EAAE;QACR,SAAS,EAAE,SAAS,CAAC;QACrB,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF,QAAQ,CAAC,EAAE;QACV,SAAS,EAAE,SAAS,CAAC;QACrB,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF,eAAe,EAAE,SAAS,CAAC;IAC3B,MAAM,EAAE,sBAAsB,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,4BAA4B,CAAC;IAC7C,iCAAiC,CAAC,EAAE,MAAM,CAAC;CAC3C;AAMD,MAAM,WAAW,iCAAiC;IACjD,aAAa,EAAE,UAAU,CAAC;CAC1B;AAED,MAAM,WAAW,mCAAmC;IACnD,aAAa,EAAE,UAAU,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CAClB"}
+{"version":3,"file":"limitOrdersTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/limitOrders/limitOrdersTypes.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,EACT,iBAAiB,EACjB,MAAM,kCAAkC,CAAC;AAM1C;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC5C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,YAAY,EAAE,UAAU,CAAC;CACzB;AAMD;;;GAGG;AACH,MAAM,WAAW,wCAAwC;IACxD;;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,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,aAAa,CAAC,EAAE,4BAA4B,CAAC;IAC7C;;;OAGG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,iCAAiC,CAAC,EAAE,MAAM,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC3C;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACrB;AAMD;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACzC;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CAClB;AAMD;;;GAGG;AACH,MAAM,WAAW,wCAAwC;IACxD;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAMD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC/B,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,mBAAmB,CAAC;AAEvB;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB;;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,iBAAiB,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC;IACtB;;OAEG;IACH,OAAO,EAAE;QACR,SAAS,EAAE,SAAS,CAAC;QACrB,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF;;OAEG;IACH,QAAQ,CAAC,EAAE;QACV,SAAS,EAAE,SAAS,CAAC;QACrB,SAAS,EAAE,iBAAiB,CAAC;KAC7B,CAAC;IACF;;OAEG;IACH,eAAe,EAAE,SAAS,CAAC;IAC3B;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,aAAa,CAAC,EAAE,4BAA4B,CAAC;IAC7C;;OAEG;IACH,iCAAiC,CAAC,EAAE,MAAM,CAAC;CAC3C;AAMD;;GAEG;AACH,MAAM,WAAW,iCAAiC;IACjD;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,mCAAmC;IACnD;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB"}

package/dist/packages/multisig/multisig.d.ts

@@ -2,16 +2,45 @@ import { Caller } from "../../general/utils/caller";
 import { CallerConfig } from "../../types";
 import { AftermathApi } from "../../general/providers";
 import { ApiMultisigUserBody } from "./multisigTypes";
+/**
+ * The `Multisig` class provides methods to interact with multisig-related functionality,
+ * such as retrieving a multisig address and associated public key for a user.
+ */
 export declare class Multisig extends Caller {
     private readonly Provider?;
+    /**
+     * Creates a new instance of `Multisig`.
+     *
+     * @param config - Optional configuration for the `Caller`, including network and access token.
+     * @param Provider - An optional instance of `AftermathApi` to build or fetch multisig data.
+     */
     constructor(config?: CallerConfig, Provider?: AftermathApi | undefined);
     /**
-     * Fetches API for multisig sign for user.
-     * @async
-     * @param { ApiMultisigUserBody } inputs - An object containing the users public key.
-     * @returns {Promise<MultisigBody>} A promise that resolves to object with multisig address and public key.
+     * Retrieves a multisig address and corresponding public key for a user based on their
+     * provided single public key.
+     *
+     * @param inputs - An object implementing `ApiMultisigUserBody`, containing the user's public key as a `Uint8Array`.
+     * @returns A promise that resolves to an object containing both the multisig address and its public key.
+     *
+     * @example
+     * ```typescript
+     *
+     * const afSdk = new Aftermath("MAINNET");
+     * await afSdk.init(); // initialize provider
+     *
+     * const multisig = afSdk.Multisig();
+     *
+     * const data = await multisig.getMultisigForUser({
+     *   userPublicKey: myPublicKeyBytes
+     * });
+     * console.log(data.address, data.publicKey);
+     * ```
      */
     getMultisigForUser(inputs: ApiMultisigUserBody): import("./multisigTypes").MultisigData;
+    /**
+     * Internal helper to get the configured `Multisig` provider from `AftermathApi`.
+     * Throws an error if the provider is not available.
+     */
     private useProvider;
 }
 //# sourceMappingURL=multisig.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"multisig.d.ts","sourceRoot":"","sources":["../../../src/packages/multisig/multisig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,YAAY,EAAc,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEtD,qBAAa,QAAS,SAAQ,MAAM;IAOlC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBAD1B,MAAM,CAAC,EAAE,YAAY,EACJ,QAAQ,CAAC,0BAAc;IASzC;;;;;OAKG;IACI,kBAAkB,CAAC,MAAM,EAAE,mBAAmB;IAQrD,OAAO,CAAC,WAAW,CAIjB;CACF"}
+{"version":3,"file":"multisig.d.ts","sourceRoot":"","sources":["../../../src/packages/multisig/multisig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,YAAY,EAAc,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEtD;;;GAGG;AACH,qBAAa,QAAS,SAAQ,MAAM;IAalC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAR3B;;;;;OAKG;gBAEF,MAAM,CAAC,EAAE,YAAY,EACJ,QAAQ,CAAC,0BAAc;IASzC;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,kBAAkB,CAAC,MAAM,EAAE,mBAAmB;IAQrD;;;OAGG;IACH,OAAO,CAAC,WAAW,CAIjB;CACF"}