aftermath-ts-sdk 1.2.64 → 1.2.65

package/dist/general/dynamicGas/dynamicGas.d.ts

@@ -3,8 +3,42 @@ import { CoinType } from "../../packages/coin/coinTypes";
 import { Caller } from "../utils/caller";
 import { Transaction } from "@mysten/sui/transactions";
 import { ApiDynamicGasResponse } from "./dynamicGasTypes";
+/**
+ * The `DynamicGas` class provides functionality for dynamically determining
+ * or attaching a suitable gas payment object to a transaction. This allows
+ * for more flexible transaction building when exact gas objects are not
+ * predetermined.
+ */
 export declare class DynamicGas extends Caller {
+    /**
+     * Creates a new `DynamicGas` instance for interacting with dynamic gas endpoints.
+     *
+     * @param config - Optional caller config, including the Sui network and an access token.
+     */
     constructor(config?: CallerConfig);
+    /**
+     * Requests the dynamic gas service to set up a transaction with an appropriate gas coin,
+     * or sponsor signature if needed, based on the user's wallet and coin type preference.
+     *
+     * @param inputs - An object containing the `Transaction` to be adjusted, the `walletAddress`, and `gasCoinType`.
+     * @returns A promise that resolves to an `ApiDynamicGasResponse`, which includes the new transaction bytes
+     *  (`txBytes`) and possibly a `sponsoredSignature`.
+     *
+     * @example
+     * ```typescript
+     * const afSdk = new Aftermath("MAINNET");
+     * await afSdk.init(); // initialize provider
+     *
+     * const dynamicGas = afSdk.DynamicGas();
+     *
+     * const updatedTx = await dynamicGas.getUseDynamicGasForTx({
+     *   tx: transactionBlock,
+     *   walletAddress: "0x<user_address>",
+     *   gasCoinType: "0x2::sui::SUI"
+     * });
+     * // updatedTx.txBytes and updatedTx.sponsoredSignature can now be used for signing/execution
+     * ```
+     */
     getUseDynamicGasForTx(inputs: {
         tx: Transaction;
         walletAddress: SuiAddress;

package/dist/general/dynamicGas/dynamicGas.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dynamicGas.d.ts","sourceRoot":"","sources":["../../../src/general/dynamicGas/dynamicGas.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAO,MAAM,uBAAuB,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAqB,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAE7E,qBAAa,UAAW,SAAQ,MAAM;gBAKzB,MAAM,CAAC,EAAE,YAAY;IAQpB,qBAAqB,CAAC,MAAM,EAAE;QAC1C,EAAE,EAAE,WAAW,CAAC;QAChB,aAAa,EAAE,UAAU,CAAC;QAC1B,WAAW,EAAE,QAAQ,CAAC;KACtB;CAQD"}
+{"version":3,"file":"dynamicGas.d.ts","sourceRoot":"","sources":["../../../src/general/dynamicGas/dynamicGas.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAO,MAAM,uBAAuB,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAqB,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAE7E;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,MAAM;IAKrC;;;;OAIG;gBACS,MAAM,CAAC,EAAE,YAAY;IAQjC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,qBAAqB,CAAC,MAAM,EAAE;QAC1C,EAAE,EAAE,WAAW,CAAC;QAChB,aAAa,EAAE,UAAU,CAAC;QAC1B,WAAW,EAAE,QAAQ,CAAC;KACtB;CAQD"}

package/dist/general/dynamicGas/dynamicGas.js

@@ -11,16 +11,50 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DynamicGas = void 0;
 const caller_1 = require("../utils/caller");
+/**
+ * The `DynamicGas` class provides functionality for dynamically determining
+ * or attaching a suitable gas payment object to a transaction. This allows
+ * for more flexible transaction building when exact gas objects are not
+ * predetermined.
+ */
 class DynamicGas extends caller_1.Caller {
     // =========================================================================
     //  Constructor
     // =========================================================================
+    /**
+     * Creates a new `DynamicGas` instance for interacting with dynamic gas endpoints.
+     *
+     * @param config - Optional caller config, including the Sui network and an access token.
+     */
     constructor(config) {
         super(config, "dynamic-gas");
     }
     // =========================================================================
     //  Tx Setup
     // =========================================================================
+    /**
+     * Requests the dynamic gas service to set up a transaction with an appropriate gas coin,
+     * or sponsor signature if needed, based on the user's wallet and coin type preference.
+     *
+     * @param inputs - An object containing the `Transaction` to be adjusted, the `walletAddress`, and `gasCoinType`.
+     * @returns A promise that resolves to an `ApiDynamicGasResponse`, which includes the new transaction bytes
+     *  (`txBytes`) and possibly a `sponsoredSignature`.
+     *
+     * @example
+     * ```typescript
+     * const afSdk = new Aftermath("MAINNET");
+     * await afSdk.init(); // initialize provider
+     *
+     * const dynamicGas = afSdk.DynamicGas();
+     *
+     * const updatedTx = await dynamicGas.getUseDynamicGasForTx({
+     *   tx: transactionBlock,
+     *   walletAddress: "0x<user_address>",
+     *   gasCoinType: "0x2::sui::SUI"
+     * });
+     * // updatedTx.txBytes and updatedTx.sponsoredSignature can now be used for signing/execution
+     * ```
+     */
     getUseDynamicGasForTx(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
             const { tx, walletAddress, gasCoinType } = inputs;

package/dist/general/dynamicGas/dynamicGasTypes.d.ts

@@ -1,12 +1,37 @@
 import { CoinType } from "../../types";
 import { SerializedTransaction, SuiAddress } from "../types";
+/**
+ * Represents the body payload sent to the dynamic gas service,
+ * which includes the serialized transaction and any user-provided
+ * gas configuration (e.g., coin type).
+ */
 export interface ApiDynamicGasBody {
+    /**
+     * The serialized transaction block in base64 or similar format.
+     */
     serializedTx: SerializedTransaction;
+    /**
+     * The address of the user for whom the dynamic gas is being set.
+     */
     walletAddress: SuiAddress;
+    /**
+     * The coin type to be used for gas payment (e.g., "0x2::sui::SUI").
+     */
     gasCoinType: CoinType;
 }
+/**
+ * Represents the response from the dynamic gas service, typically returning
+ * updated transaction bytes and possibly a sponsored signature if the
+ * transaction gas is being partially or fully sponsored.
+ */
 export interface ApiDynamicGasResponse {
+    /**
+     * The modified transaction bytes that incorporate a gas coin or sponsor information.
+     */
     txBytes: SerializedTransaction;
+    /**
+     * A signature used to sponsor or verify the updated transaction, if applicable.
+     */
     sponsoredSignature: string;
 }
 //# sourceMappingURL=dynamicGasTypes.d.ts.map

package/dist/general/dynamicGas/dynamicGasTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dynamicGasTypes.d.ts","sourceRoot":"","sources":["../../../src/general/dynamicGas/dynamicGasTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAM7D,MAAM,WAAW,iBAAiB;IACjC,YAAY,EAAE,qBAAqB,CAAC;IACpC,aAAa,EAAE,UAAU,CAAC;IAC1B,WAAW,EAAE,QAAQ,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACrC,OAAO,EAAE,qBAAqB,CAAC;IAC/B,kBAAkB,EAAE,MAAM,CAAC;CAC3B"}
+{"version":3,"file":"dynamicGasTypes.d.ts","sourceRoot":"","sources":["../../../src/general/dynamicGas/dynamicGasTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE7D;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IACjC;;OAEG;IACH,YAAY,EAAE,qBAAqB,CAAC;IACpC;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,WAAW,EAAE,QAAQ,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACrC;;OAEG;IACH,OAAO,EAAE,qBAAqB,CAAC;IAC/B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC3B"}

package/dist/general/prices/prices.d.ts

@@ -1,17 +1,90 @@
 import { CoinPriceInfo, CoinType, CoinsToPrice, CoinsToPriceInfo } from "../../packages/coin/coinTypes";
 import { Caller } from "../utils/caller";
 import { CallerConfig } from "../types";
+/**
+ * The `Prices` class provides methods for fetching price information for various
+ * coins on the Sui network, including single-coin or multi-coin queries.
+ */
 export declare class Prices extends Caller {
+    /**
+     * Creates a new `Prices` instance for retrieving coin price data from
+     * Aftermath's backend or other data sources.
+     *
+     * @param config - Optional configuration, including network and access token.
+     */
     constructor(config?: CallerConfig);
+    /**
+     * Retrieves detailed price information (including current price and 24h change)
+     * for a single coin.
+     *
+     * @param inputs - Contains the `coin` type (e.g., "0x2::sui::SUI").
+     * @returns A promise resolving to a `CoinPriceInfo` object.
+     *
+     * @example
+     * ```typescript
+     *
+     * const afSdk = new Aftermath("MAINNET");
+     * await afSdk.init(); // initialize provider
+     *
+     * const prices = afSdk.Prices();
+     *
+     * const suiPriceInfo = await prices.getCoinPriceInfo({
+     *   coin: "0x2::sui::SUI"
+     * });
+     * console.log(suiPriceInfo.price, suiPriceInfo.priceChange24HoursPercentage);
+     * ```
+     */
     getCoinPriceInfo(inputs: {
         coin: CoinType;
     }): Promise<CoinPriceInfo>;
+    /**
+     * Retrieves detailed price information for multiple coins simultaneously,
+     * returning a record keyed by `CoinType`.
+     *
+     * @param inputs - An object containing an array of `coins`.
+     * @returns A promise resolving to a `CoinsToPriceInfo` mapping each coin type to its price info.
+     *
+     * @example
+     * ```typescript
+     * const prices = new Prices();
+     * const info = await prices.getCoinsToPriceInfo({
+     *   coins: ["0x2::sui::SUI", "0x<some_other_coin>"]
+     * });
+     * console.log(info);
+     * ```
+     */
     getCoinsToPriceInfo(inputs: {
         coins: CoinType[];
     }): Promise<CoinsToPriceInfo>;
+    /**
+     * Fetches only the current price in USD for a single coin.
+     *
+     * @param inputs - Contains the `coin` type.
+     * @returns A promise resolving to a `number` representing the price in USD.
+     *
+     * @example
+     * ```typescript
+     * const prices = new Prices();
+     * const suiPrice = await prices.getCoinPrice({ coin: "0x2::sui::SUI" });
+     * console.log("SUI price in USD:", suiPrice);
+     * ```
+     */
     getCoinPrice(inputs: {
         coin: CoinType;
     }): Promise<number>;
+    /**
+     * Fetches current prices in USD for multiple coins, returning a record keyed by `CoinType`.
+     *
+     * @param inputs - Contains an array of `coins`.
+     * @returns A promise resolving to a `CoinsToPrice` object mapping coin types to their prices in USD.
+     *
+     * @example
+     * ```typescript
+     * const prices = new Prices();
+     * const multiPrices = await prices.getCoinsToPrice({ coins: ["0x2::sui::SUI", "0x<other>"] });
+     * console.log(multiPrices["0x2::sui::SUI"]); // e.g. 1.23
+     * ```
+     */
     getCoinsToPrice(inputs: {
         coins: CoinType[];
     }): Promise<CoinsToPrice>;

package/dist/general/prices/prices.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prices.d.ts","sourceRoot":"","sources":["../../../src/general/prices/prices.ts"],"names":[],"mappings":"AACA,OAAO,EACN,aAAa,EAGb,QAAQ,EACR,YAAY,EACZ,gBAAgB,EAChB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,YAAY,EAAO,MAAM,UAAU,CAAC;AAE7C,qBAAa,MAAO,SAAQ,MAAM;gBAKrB,MAAM,CAAC,EAAE,YAAY;IAQpB,gBAAgB,CAAC,MAAM,EAAE;QACrC,IAAI,EAAE,QAAQ,CAAC;KACf,GAAG,OAAO,CAAC,aAAa,CAAC;IAOb,mBAAmB,CAAC,MAAM,EAAE;QACxC,KAAK,EAAE,QAAQ,EAAE,CAAC;KAClB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAIhB,YAAY,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,QAAQ,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAKzD,eAAe,CAAC,MAAM,EAAE;QACpC,KAAK,EAAE,QAAQ,EAAE,CAAC;KAClB,GAAG,OAAO,CAAC,YAAY,CAAC;CAazB"}
+{"version":3,"file":"prices.d.ts","sourceRoot":"","sources":["../../../src/general/prices/prices.ts"],"names":[],"mappings":"AACA,OAAO,EACN,aAAa,EAGb,QAAQ,EACR,YAAY,EACZ,gBAAgB,EAChB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,YAAY,EAAO,MAAM,UAAU,CAAC;AAE7C;;;GAGG;AACH,qBAAa,MAAO,SAAQ,MAAM;IAKjC;;;;;OAKG;gBACS,MAAM,CAAC,EAAE,YAAY;IAQjC;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,gBAAgB,CAAC,MAAM,EAAE;QACrC,IAAI,EAAE,QAAQ,CAAC;KACf,GAAG,OAAO,CAAC,aAAa,CAAC;IAO1B;;;;;;;;;;;;;;;OAeG;IACU,mBAAmB,CAAC,MAAM,EAAE;QACxC,KAAK,EAAE,QAAQ,EAAE,CAAC;KAClB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI7B;;;;;;;;;;;;OAYG;IACU,YAAY,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,QAAQ,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAKtE;;;;;;;;;;;;OAYG;IACU,eAAe,CAAC,MAAM,EAAE;QACpC,KAAK,EAAE,QAAQ,EAAE,CAAC;KAClB,GAAG,OAAO,CAAC,YAAY,CAAC;CAazB"}

package/dist/general/prices/prices.js

@@ -11,16 +11,47 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Prices = void 0;
 const caller_1 = require("../utils/caller");
+/**
+ * The `Prices` class provides methods for fetching price information for various
+ * coins on the Sui network, including single-coin or multi-coin queries.
+ */
 class Prices extends caller_1.Caller {
     // =========================================================================
     //  Constructor
     // =========================================================================
+    /**
+     * Creates a new `Prices` instance for retrieving coin price data from
+     * Aftermath's backend or other data sources.
+     *
+     * @param config - Optional configuration, including network and access token.
+     */
     constructor(config) {
         super(config, "price-info");
     }
     // =========================================================================
     //  Prices
     // =========================================================================
+    /**
+     * Retrieves detailed price information (including current price and 24h change)
+     * for a single coin.
+     *
+     * @param inputs - Contains the `coin` type (e.g., "0x2::sui::SUI").
+     * @returns A promise resolving to a `CoinPriceInfo` object.
+     *
+     * @example
+     * ```typescript
+     *
+     * const afSdk = new Aftermath("MAINNET");
+     * await afSdk.init(); // initialize provider
+     *
+     * const prices = afSdk.Prices();
+     *
+     * const suiPriceInfo = await prices.getCoinPriceInfo({
+     *   coin: "0x2::sui::SUI"
+     * });
+     * console.log(suiPriceInfo.price, suiPriceInfo.priceChange24HoursPercentage);
+     * ```
+     */
     getCoinPriceInfo(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
             const coinsToPriceInfo = yield this.getCoinsToPriceInfo({
@@ -29,17 +60,59 @@ class Prices extends caller_1.Caller {
             return Object.values(coinsToPriceInfo)[0];
         });
     }
+    /**
+     * Retrieves detailed price information for multiple coins simultaneously,
+     * returning a record keyed by `CoinType`.
+     *
+     * @param inputs - An object containing an array of `coins`.
+     * @returns A promise resolving to a `CoinsToPriceInfo` mapping each coin type to its price info.
+     *
+     * @example
+     * ```typescript
+     * const prices = new Prices();
+     * const info = await prices.getCoinsToPriceInfo({
+     *   coins: ["0x2::sui::SUI", "0x<some_other_coin>"]
+     * });
+     * console.log(info);
+     * ```
+     */
     getCoinsToPriceInfo(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.fetchApi("", inputs);
         });
     }
+    /**
+     * Fetches only the current price in USD for a single coin.
+     *
+     * @param inputs - Contains the `coin` type.
+     * @returns A promise resolving to a `number` representing the price in USD.
+     *
+     * @example
+     * ```typescript
+     * const prices = new Prices();
+     * const suiPrice = await prices.getCoinPrice({ coin: "0x2::sui::SUI" });
+     * console.log("SUI price in USD:", suiPrice);
+     * ```
+     */
     getCoinPrice(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
             const priceInfo = yield this.getCoinPriceInfo(inputs);
             return priceInfo.price;
         });
     }
+    /**
+     * Fetches current prices in USD for multiple coins, returning a record keyed by `CoinType`.
+     *
+     * @param inputs - Contains an array of `coins`.
+     * @returns A promise resolving to a `CoinsToPrice` object mapping coin types to their prices in USD.
+     *
+     * @example
+     * ```typescript
+     * const prices = new Prices();
+     * const multiPrices = await prices.getCoinsToPrice({ coins: ["0x2::sui::SUI", "0x<other>"] });
+     * console.log(multiPrices["0x2::sui::SUI"]); // e.g. 1.23
+     * ```
+     */
     getCoinsToPrice(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
             const coinsToPriceInfo = yield this.getCoinsToPriceInfo(inputs);

package/dist/general/providers/aftermath.d.ts

@@ -10,7 +10,6 @@ import { Casting } from "../utils/casting";
 import { Caller } from "../utils/caller";
 import { Prices } from "../prices/prices";
 import { Auth, LeveragedStaking, NftAmm, ReferralVault, Router, Sui } from "../../packages";
-import { HistoricalData } from "../historicalData/historicalData";
 import { Perpetuals } from "../../packages/perpetuals";
 import { Oracle } from "../../packages/oracle/oracle";
 import { Farms } from "../../packages/farms/farms";
@@ -21,10 +20,13 @@ import { Multisig } from "../../packages/multisig/multisig";
 import { LimitOrders } from "../../packages/limitOrders/limitOrders";
 import { UserData } from "../../packages/userData/userData";
 /**
- * @class Aftermath Provider
+ * The `Aftermath` class serves as the primary entry point for interacting with
+ * the Aftermath Finance protocols and utilities on the Sui blockchain.
+ * It provides various sub-providers (e.g. `Router`, `Staking`, `Farms`)
+ * initialized under the specified network environment (MAINNET, TESTNET, etc).
  *
  * @example
- * ```
+ * ```typescript
  * // Create provider
  * const aftermath = new Aftermath("MAINNET");
  * // Create package provider
@@ -40,74 +42,153 @@ export declare class Aftermath extends Caller {
     private readonly network?;
     private Provider?;
     /**
-     * Creates `Aftermath` provider to call api.
+     * Creates an `Aftermath` provider instance to call the Aftermath Finance APIs
+     * and interact with Sui-based protocols.
      *
-     * @param network - The Sui network to interact with
-     * @returns New `Aftermath` instance
+     * @param network - The target Sui network ("MAINNET", "TESTNET", "DEVNET", or "LOCAL").
+     * @param Provider - Optionally pass a custom `AftermathApi` instance if you already have one.
      */
     constructor(network?: SuiNetwork | undefined, Provider?: AftermathApi | undefined);
+    /**
+     * Initializes the Aftermath provider by fetching addresses from the backend
+     * and configuring the Sui fullnode client. This method must be called before
+     * performing many API operations.
+     *
+     * @param inputs - Optional object allowing you to override the default `fullnodeUrl`.
+     * @example
+     * ```typescript
+     * const afSdk = new Aftermath("MAINNET");
+     * await afSdk.init(); // sets up internal providers
+     * ```
+     */
     init(inputs?: {
         fullnodeUrl: Url;
     }): Promise<void>;
     /**
-     * Retrieves the addresses from the Aftermath API.
-     * @returns A promise that resolves to a ConfigAddresses object.
+     * Retrieves the Aftermath-specific on-chain addresses (object IDs, packages, etc.).
+     *
+     * @returns A `ConfigAddresses` object containing relevant addresses for the protocol.
+     *
+     * @example
+     * ```typescript
+     * const addresses = await aftermath.getAddresses();
+     * console.log(addresses); // { routerPackageId: "...", someOtherPackageId: "..." }
+     * ```
      */
     getAddresses(): Promise<ConfigAddresses>;
+    /**
+     * Returns the base URL used for Aftermath API calls.
+     *
+     * @returns The base URL for this instance's API.
+     *
+     * @example
+     * ```typescript
+     * const apiBaseUrl = aftermath.getApiBaseUrl();
+     * console.log(apiBaseUrl); // "https://api.after..."
+     * ```
+     */
     getApiBaseUrl(): string | undefined;
     /**
-     * Returns an instance of the Pools class.
-     * @returns {Pools} An instance of the Pools class.
+     * Returns an instance of the `Pools` class, which handles DEX pool operations
+     * within the Aftermath platform (if supported).
      */
     Pools: () => Pools;
     /**
-     * Creates a new instance of the Staking class.
-     * @returns A new instance of the Staking class.
+     * Returns an instance of the `Staking` class for Aftermath's staking and unstaking features.
      */
     Staking: () => Staking;
+    /**
+     * Returns an instance of `LeveragedStaking` for advanced leveraged staking workflows (if supported).
+     */
     LeveragedStaking: () => LeveragedStaking;
+    /**
+     * Returns an instance of `SuiFrens`, a specialized package for social or utility services.
+     */
     SuiFrens: () => SuiFrens;
+    /**
+     * Returns an instance of `Faucet`, allowing test/dev networks to dispense tokens.
+     */
     Faucet: () => Faucet;
     /**
-     * Creates a new instance of the Router class with the current network.
-     * @returns A new instance of the Router class.
+     * Returns an instance of the `Router` class, which handles smart order routing
+     * across multiple DEX protocols.
      */
     Router: () => Router;
+    /**
+     * Returns an instance of `NftAmm`, which supports NFT AMM (automated market maker) features.
+     */
     NftAmm: () => NftAmm;
+    /**
+     * Returns an instance of `ReferralVault` for referral-based interactions in the protocol.
+     */
     ReferralVault: () => ReferralVault;
+    /**
+     * Returns an instance of `Perpetuals` for futures or perpetual contract interactions.
+     */
     Perpetuals: () => Perpetuals;
+    /**
+     * Returns an instance of `Oracle`, which provides price oracles or other data feed services.
+     */
     Oracle: () => Oracle;
     /**
-     * Creates a new instance of the Farms class.
-     * @returns A new instance of the Farms class.
+     * Returns an instance of `Farms` for yield farming or liquidity mining functionalities.
      */
     Farms: () => Farms;
     /**
-     * Creates a new instance of the DCA class.
-     * @returns A new instance of the DCA class.
+     * Returns an instance of the `Dca` class, supporting dollar-cost averaging logic.
      */
     Dca: () => Dca;
+    /**
+     * Returns an instance of `Multisig`, enabling multi-signature address creation and management.
+     */
     Multisig: () => Multisig;
+    /**
+     * Returns an instance of `LimitOrders`, supporting limit order placement on certain DEX protocols.
+     */
     LimitOrders: () => LimitOrders;
+    /**
+     * Returns an instance of `UserData` for creating and managing user-specific data or key storage.
+     */
     UserData: () => UserData;
+    /**
+     * Returns an instance of `Sui` for low-level Sui chain information and utilities.
+     */
     Sui: () => Sui;
+    /**
+     * Returns an instance of `Prices`, which provides coin price data from external or internal feeds.
+     */
     Prices: () => Prices;
     /**
-     * Creates a new instance of the Wallet class.
-     * @param address - The address of the wallet.
-     * @returns A new instance of the Wallet class.
+     * Creates a new `Wallet` instance for a specific user address, enabling you to fetch balances,
+     * transaction history, etc.
+     *
+     * @param address - The Sui address of the wallet (e.g., "0x<32_byte_hex>").
      */
     Wallet: (address: SuiAddress) => Wallet;
     /**
-     * Creates a new instance of the Coin class.
-     * @param coinType The type of coin to create.
-     * @returns A new instance of the Coin class.
+     * Returns an instance of the `Coin` class, which handles coin metadata, decimal conversions,
+     * and other coin-related utilities for a specified `CoinType`.
+     *
+     * @param coinType - Optionally specify a coin type for immediate usage in coin methods.
      */
     Coin: (coinType?: CoinType) => Coin;
-    HistoricalData: () => HistoricalData;
+    /**
+     * Returns an instance of `DynamicGas`, enabling dynamic assignment of gas
+     * objects or sponsored transactions for user operations.
+     */
     DynamicGas: () => DynamicGas;
+    /**
+     * Returns an instance of `Auth`, handling user authentication or token-based flows (if applicable).
+     */
     Auth: () => Auth;
+    /**
+     * Exposes a set of helper functions for general-purpose usage across
+     * the Aftermath ecosystem. Includes utilities for math, logging, etc.
+     */
     static helpers: typeof Helpers;
+    /**
+     * Exposes a set of casting utilities for data type conversions (e.g., BigInt <-> fixed).
+     */
     static casting: typeof Casting;
 }
 //# sourceMappingURL=aftermath.d.ts.map

package/dist/general/providers/aftermath.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"aftermath.d.ts","sourceRoot":"","sources":["../../../src/general/providers/aftermath.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACnD,OAAO,EACN,QAAQ,EACR,eAAe,EACf,UAAU,EACV,UAAU,EACV,GAAG,EACH,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EACN,IAAI,EACJ,gBAAgB,EAChB,MAAM,EACN,aAAa,EACb,MAAM,EACN,GAAG,EACH,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAEtD,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAC;AACrE,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAE5D;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,SAAU,SAAQ,MAAM;IAYnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC;IARlB;;;;;OAKG;gBAEe,OAAO,CAAC,wBAAY,EAC7B,QAAQ,CAAC,0BAAc;IAYnB,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,WAAW,EAAE,GAAG,CAAA;KAAE;IAsB/C;;;OAGG;IACU,YAAY;IAIlB,aAAa;IAYpB;;;OAGG;IACI,KAAK,cAA+C;IAC3D;;;OAGG;IACI,OAAO,gBAAiD;IACxD,gBAAgB,yBAA2C;IAC3D,QAAQ,iBAAkD;IAC1D,MAAM,eAAgD;IAC7D;;;OAGG;IACI,MAAM,eAAiC;IACvC,MAAM,eAAgD;IACtD,aAAa,sBAAuD;IACpE,UAAU,mBAAqC;IAC/C,MAAM,eAAgD;IAC7D;;;OAGG;IACI,KAAK,cAA+C;IAC3D;;;OAGG;IACI,GAAG,YAA8B;IACjC,QAAQ,iBAAkD;IAC1D,WAAW,oBAAsC;IACjD,QAAQ,iBAAmC;IAM3C,GAAG,YAA6C;IAChD,MAAM,eAAiC;IAC9C;;;;OAIG;IACI,MAAM,YAAa,UAAU,YACa;IACjD;;;;OAIG;IACI,IAAI,cAAe,QAAQ,UACc;IACzC,cAAc,uBAAyC;IAEvD,UAAU,mBAAqC;IAC/C,IAAI,aAA+B;IAM1C,OAAc,OAAO,iBAAW;IAChC,OAAc,OAAO,iBAAW;CAChC"}
+{"version":3,"file":"aftermath.d.ts","sourceRoot":"","sources":["../../../src/general/providers/aftermath.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACnD,OAAO,EACN,QAAQ,EACR,eAAe,EACf,UAAU,EACV,UAAU,EACV,GAAG,EACH,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EACN,IAAI,EACJ,gBAAgB,EAChB,MAAM,EACN,aAAa,EACb,MAAM,EACN,GAAG,EACH,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAC;AACrE,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAE5D;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,SAAU,SAAQ,MAAM;IAanC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC;IATlB;;;;;;OAMG;gBAEe,OAAO,CAAC,wBAAY,EAC7B,QAAQ,CAAC,0BAAc;IAYhC;;;;;;;;;;;OAWG;IACU,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,WAAW,EAAE,GAAG,CAAA;KAAE;IAyB/C;;;;;;;;;;OAUG;IACU,YAAY;IAIzB;;;;;;;;;;OAUG;IACI,aAAa;IAYpB;;;OAGG;IACI,KAAK,cAA+C;IAE3D;;OAEG;IACI,OAAO,gBAAiD;IAE/D;;OAEG;IACI,gBAAgB,yBAA2C;IAElE;;OAEG;IACI,QAAQ,iBAAkD;IAEjE;;OAEG;IACI,MAAM,eAAgD;IAE7D;;;OAGG;IACI,MAAM,eAAiC;IAE9C;;OAEG;IACI,MAAM,eAAgD;IAE7D;;OAEG;IACI,aAAa,sBAAuD;IAE3E;;OAEG;IACI,UAAU,mBAAqC;IAEtD;;OAEG;IACI,MAAM,eAAgD;IAE7D;;OAEG;IACI,KAAK,cAA+C;IAE3D;;OAEG;IACI,GAAG,YAA8B;IAExC;;OAEG;IACI,QAAQ,iBAAkD;IAEjE;;OAEG;IACI,WAAW,oBAAsC;IAExD;;OAEG;IACI,QAAQ,iBAAmC;IAMlD;;OAEG;IACI,GAAG,YAA6C;IAEvD;;OAEG;IACI,MAAM,eAAiC;IAE9C;;;;;OAKG;IACI,MAAM,YAAa,UAAU,YACa;IAEjD;;;;;OAKG;IACI,IAAI,cAAe,QAAQ,UACc;IAEhD;;;OAGG;IACI,UAAU,mBAAqC;IAEtD;;OAEG;IACI,IAAI,aAA+B;IAM1C;;;OAGG;IACH,OAAc,OAAO,iBAAW;IAEhC;;OAEG;IACH,OAAc,OAAO,iBAAW;CAChC"}