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

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"}

package/dist/general/providers/aftermath.js

@@ -21,10 +21,8 @@ const casting_1 = require("../utils/casting");
 const caller_1 = require("../utils/caller");
 const prices_1 = require("../prices/prices");
 const packages_1 = require("../../packages");
-const historicalData_1 = require("../historicalData/historicalData");
 const perpetuals_1 = require("../../packages/perpetuals");
 const oracle_1 = require("../../packages/oracle/oracle");
-// import { PriceFeeds } from "../priceFeeds/priceFeeds";
 const farms_1 = require("../../packages/farms/farms");
 const dynamicGas_1 = require("../dynamicGas/dynamicGas");
 const aftermathApi_1 = require("./aftermathApi");
@@ -34,10 +32,13 @@ const multisig_1 = require("../../packages/multisig/multisig");
 const limitOrders_1 = require("../../packages/limitOrders/limitOrders");
 const userData_1 = require("../../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
@@ -54,10 +55,11 @@ class Aftermath extends caller_1.Caller {
     //  Constructor
     // =========================================================================
     /**
-     * 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, Provider) {
         super({
@@ -73,69 +75,122 @@ class Aftermath extends caller_1.Caller {
         //  Packages
         // =========================================================================
         /**
-         * 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).
          */
         this.Pools = () => new pools_1.Pools(this.config, this.Provider);
         /**
-         * 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.
          */
         this.Staking = () => new staking_1.Staking(this.config, this.Provider);
+        /**
+         * Returns an instance of `LeveragedStaking` for advanced leveraged staking workflows (if supported).
+         */
         this.LeveragedStaking = () => new packages_1.LeveragedStaking(this.config);
+        /**
+         * Returns an instance of `SuiFrens`, a specialized package for social or utility services.
+         */
         this.SuiFrens = () => new suiFrens_1.SuiFrens(this.config, this.Provider);
+        /**
+         * Returns an instance of `Faucet`, allowing test/dev networks to dispense tokens.
+         */
         this.Faucet = () => new faucet_1.Faucet(this.config, this.Provider);
         /**
-         * 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.
          */
         this.Router = () => new packages_1.Router(this.config);
+        /**
+         * Returns an instance of `NftAmm`, which supports NFT AMM (automated market maker) features.
+         */
         this.NftAmm = () => new packages_1.NftAmm(this.config, this.Provider);
+        /**
+         * Returns an instance of `ReferralVault` for referral-based interactions in the protocol.
+         */
         this.ReferralVault = () => new packages_1.ReferralVault(this.config, this.Provider);
+        /**
+         * Returns an instance of `Perpetuals` for futures or perpetual contract interactions.
+         */
         this.Perpetuals = () => new perpetuals_1.Perpetuals(this.config);
+        /**
+         * Returns an instance of `Oracle`, which provides price oracles or other data feed services.
+         */
         this.Oracle = () => new oracle_1.Oracle(this.config, this.Provider);
         /**
-         * 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.
          */
         this.Farms = () => new farms_1.Farms(this.config, this.Provider);
         /**
-         * 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.
          */
         this.Dca = () => new dca_1.Dca(this.config);
+        /**
+         * Returns an instance of `Multisig`, enabling multi-signature address creation and management.
+         */
         this.Multisig = () => new multisig_1.Multisig(this.config, this.Provider);
+        /**
+         * Returns an instance of `LimitOrders`, supporting limit order placement on certain DEX protocols.
+         */
         this.LimitOrders = () => new limitOrders_1.LimitOrders(this.config);
+        /**
+         * Returns an instance of `UserData` for creating and managing user-specific data or key storage.
+         */
         this.UserData = () => new userData_1.UserData(this.config);
         // =========================================================================
         //  General
         // =========================================================================
+        /**
+         * Returns an instance of `Sui` for low-level Sui chain information and utilities.
+         */
         this.Sui = () => new packages_1.Sui(this.config, this.Provider);
+        /**
+         * Returns an instance of `Prices`, which provides coin price data from external or internal feeds.
+         */
         this.Prices = () => new prices_1.Prices(this.config);
         /**
-         * 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>").
          */
         this.Wallet = (address) => new wallet_1.Wallet(address, this.config, this.Provider);
         /**
-         * 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.
          */
         this.Coin = (coinType) => new coin_1.Coin(coinType, this.config, this.Provider);
-        this.HistoricalData = () => new historicalData_1.HistoricalData(this.config);
-        // public PriceFeeds = () => new PriceFeeds(this.config, this.Provider);
+        /**
+         * Returns an instance of `DynamicGas`, enabling dynamic assignment of gas
+         * objects or sponsored transactions for user operations.
+         */
         this.DynamicGas = () => new dynamicGas_1.DynamicGas(this.config);
+        /**
+         * Returns an instance of `Auth`, handling user authentication or token-based flows (if applicable).
+         */
         this.Auth = () => new packages_1.Auth(this.config);
     }
     // =========================================================================
     //  Public Methods
     // =========================================================================
+    /**
+     * 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) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const addresses = yield this.getAddresses();
+            // Determine the fullnode URL based on the chosen network or user override
             const fullnodeUrl = (_a = inputs === null || inputs === void 0 ? void 0 : inputs.fullnodeUrl) !== null && _a !== void 0 ? _a : (this.network === "LOCAL"
                 ? "http://127.0.0.1:9000"
                 : this.network === "DEVNET"
@@ -143,6 +198,7 @@ class Aftermath extends caller_1.Caller {
                     : this.network === "TESTNET"
                         ? "https://fullnode.testnet.sui.io:443"
                         : "https://fullnode.mainnet.sui.io:443");
+            // Create a new AftermathApi provider
             this.Provider = new aftermathApi_1.AftermathApi(new client_1.SuiClient({
                 transport: new client_1.SuiHTTPTransport({
                     url: fullnodeUrl,
@@ -151,14 +207,32 @@ class Aftermath extends caller_1.Caller {
         });
     }
     /**
-     * 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() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.fetchApi("addresses");
         });
     }
+    /**
+     * 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() {
         return this.apiBaseUrl;
     }
@@ -167,5 +241,12 @@ exports.Aftermath = Aftermath;
 // =========================================================================
 //  Utils
 // =========================================================================
+/**
+ * Exposes a set of helper functions for general-purpose usage across
+ * the Aftermath ecosystem. Includes utilities for math, logging, etc.
+ */
 Aftermath.helpers = helpers_1.Helpers;
+/**
+ * Exposes a set of casting utilities for data type conversions (e.g., BigInt <-> fixed).
+ */
 Aftermath.casting = casting_1.Casting;

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

@@ -29,58 +29,177 @@ import { MultisigApi } from "../../packages/multisig/api/multisigApi";
 import { UserDataApi } from "../../packages/userData/api/userDataApi";
 import { LimitOrdersApi } from "../../packages/limitOrders/api/limitOrdersApi";
 /**
- * This class represents the Aftermath API and provides helper methods for various functionalities.
- * @class
+ * The `AftermathApi` class is a low-level factory and reference point for
+ * interacting directly with underlying API modules (e.g., PoolsApi, StakingApi).
+ * It encapsulates a configured `SuiClient` and the known `addresses` for the
+ * Aftermath protocol, allowing flexible or advanced usage scenarios.
+ *
+ * @example
+ * ```typescript
+ * import { AftermathApi } from "aftermath-ts-sdk";
+ * import { SuiClient, SuiHTTPTransport } from "@mysten/sui/client";
+ *
+ * const addresses = { ... }; // from aftermath.getAddresses()
+ * const suiClient = new SuiClient({
+ *   transport: new SuiHTTPTransport({
+ *     url: "https://fullnode.mainnet.sui.io",
+ *   }),
+ * });
+ *
+ * const afApi = new AftermathApi(suiClient, addresses);
+ * // access protocol APIs
+ * const poolsApi = afApi.Pools();
+ * ```
  */
 export declare class AftermathApi {
     readonly provider: SuiClient;
     readonly addresses: ConfigAddresses;
     readonly providerV0?: SuiClientV0 | undefined;
+    /**
+     * Static helper references for quick usage without instantiating the class.
+     */
     static helpers: {
+        /** Helpers for accessing or iterating over dynamic fields in Sui objects. */
         dynamicFields: typeof DynamicFieldsApiHelpers;
+        /** Helpers for working with Sui events and pagination. */
         events: typeof EventsApiHelpers;
+        /** Helpers for reading on-chain data in an "inspection" manner (designed for Summaries). */
         inspections: typeof InspectionsApiHelpers;
+        /** Helpers for retrieving and parsing Sui objects by ID or type. */
         objects: typeof ObjectsApiHelpers;
+        /** Helpers for reading transaction data (by digest, query, etc.). */
         transactions: typeof TransactionsApiHelpers;
+        /** Helper for wallet-based operations, separate from the main `Wallet` classes. */
         wallet: typeof WalletApi;
+        /** Low-level direct coin operations, separate from the higher-level `Coin` class. */
         coin: typeof CoinApi;
+        /** Low-level Sui chain data ops, separate from the higher-level `Sui` class. */
         sui: typeof SuiApi;
     };
     /**
-     * Creates an instance of AftermathApi.
-     * @param provider - The SuiClient instance to use for interacting with the blockchain.
-     * @param addresses - The configuration addresses for the Aftermath protocol.
-     * @param providerV0 - The SuiClient instance to use for interacting with the blockchain.
+     * Constructs a new instance of the `AftermathApi`, binding the given Sui client
+     * to the known `addresses`. Optionally, a `providerV0` can be passed for
+     * legacy transaction building or older Sui libraries.
+     *
+     * @param provider - The `SuiClient` for on-chain queries and transactions.
+     * @param addresses - The config addresses (object IDs, package IDs, etc.) for the Aftermath protocol.
+     * @param providerV0 - An optional legacy `SuiClient` from `@mysten/sui.js/client`.
      */
     constructor(provider: SuiClient, addresses: ConfigAddresses, providerV0?: SuiClientV0 | undefined);
+    /**
+     * Creates a new `DynamicFieldsApiHelpers` instance for complex object field queries.
+     */
     DynamicFields: () => DynamicFieldsApiHelpers;
+    /**
+     * Creates a new `EventsApiHelpers` instance for querying Sui events.
+     */
     Events: () => EventsApiHelpers;
+    /**
+     * Creates a new `InspectionsApiHelpers` instance for reading Summaries or inspection data.
+     */
     Inspections: () => InspectionsApiHelpers;
+    /**
+     * Creates a new `ObjectsApiHelpers` instance for object retrieval/manipulation.
+     */
     Objects: () => ObjectsApiHelpers;
+    /**
+     * Creates a new `TransactionsApiHelpers` instance for querying or parsing transaction data.
+     */
     Transactions: () => TransactionsApiHelpers;
+    /**
+     * Creates a new `WalletApi` instance for direct wallet-based operations (fetching balances, etc.).
+     */
     Wallet: () => WalletApi;
+    /**
+     * Creates a new `NftsApi` instance for retrieving and interacting with NFT data.
+     */
     Nfts: () => NftsApi;
+    /**
+     * Creates a new `CoinApi` instance for detailed coin operations.
+     */
     Coin: () => CoinApi;
+    /**
+     * Creates a new `SuiApi` instance for lower-level Sui chain interactions.
+     */
     Sui: () => SuiApi;
+    /**
+     * Creates a new `PoolsApi` instance for pool-related interactions (AMM pools, liquidity, etc.).
+     */
     Pools: () => PoolsApi;
+    /**
+     * Creates a new `FaucetApi` instance for dispensing tokens on supported dev/test networks.
+     */
     Faucet: () => FaucetApi;
+    /**
+     * Creates a new `SuiFrensApi` instance for special social or token gating utilities on Sui.
+     */
     SuiFrens: () => SuiFrensApi;
+    /**
+     * Creates a new `StakingApi` instance for advanced or direct staking operations on Sui.
+     */
     Staking: () => StakingApi;
+    /**
+     * Creates a new `NftAmmApi` instance for NFT AMM logic (buy, sell, liquidity).
+     */
     NftAmm: () => NftAmmApi;
+    /**
+     * Creates a new `ReferralVaultApi` instance for referral-based logic in Aftermath.
+     */
     ReferralVault: () => ReferralVaultApi;
+    /**
+     * Creates a new `PerpetualsApi` instance for futures or perpetual derivatives on Sui.
+     */
     Perpetuals: () => PerpetualsApi;
+    /**
+     * Creates a new `OracleApi` instance for price or data feed oracles.
+     */
     Oracle: () => OracleApi;
+    /**
+     * Creates a new `FarmsApi` instance for yield farming or liquidity mining interactions.
+     */
     Farms: () => FarmsApi;
+    /**
+     * Creates a new `DcaApi` instance for dollar-cost averaging logic.
+     */
     Dca: () => DcaApi;
+    /**
+     * Creates a new `MultisigApi` instance for multi-signature address creation and management.
+     */
     Multisig: () => MultisigApi;
+    /**
+     * Creates a new `LimitOrdersApi` instance for placing limit orders on supported DEX protocols.
+     */
     LimitOrders: () => LimitOrdersApi;
+    /**
+     * Creates a new `UserDataApi` instance for managing user-specific data storage or sign-on logic.
+     */
     UserData: () => UserDataApi;
     /**
-     * Creates a new instance of the RouterApi class.
-     * @returns A new instance of the RouterApi class.
+     * Creates a new `RouterApi` instance for best-price trade routing across multiple DEX liquidity sources.
      */
     Router: () => RouterApi;
+    /**
+     * Creates a new `LeveragedStakingApi` instance for leveraged staking operations,
+     * optionally using `ScallopProviders` if needed.
+     *
+     * @param ScallopProviders - An optional object containing references to Scallop's Sui modules or providers.
+     */
     LeveragedStaking: (ScallopProviders?: any) => LeveragedStakingApi;
+    /**
+     * Attempts to decode a Move error message into a structured error code,
+     * package ID, module name, and descriptive error string.
+     *
+     * @param inputs - An object containing the raw `errorMessage`.
+     * @returns An object with `errorCode`, `packageId`, `module`, and `error` if translation is successful, or `undefined`.
+     *
+     * @example
+     * ```typescript
+     * const errorDecoded = afApi.translateMoveErrorMessage({ errorMessage: "MoveAbort at ..." });
+     * if (errorDecoded) {
+     *   console.log(errorDecoded.errorCode, errorDecoded.error);
+     * }
+     * ```
+     */
     translateMoveErrorMessage: <T extends MoveErrorsInterface>(inputs: {
         errorMessage: string;
     }) => {

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

@@ -1 +1 @@
-{"version":3,"file":"aftermathApi.d.ts","sourceRoot":"","sources":["../../../src/general/providers/aftermathApi.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAC1D,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAC9E,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAC;AACrF,OAAO,EACN,UAAU,EACV,aAAa,EACb,QAAQ,EAGR,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,MAAM,6CAA6C,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,SAAS,IAAI,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,yDAAyD,CAAC;AAC9F,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,+CAA+C,CAAC;AAE/E;;;GAGG;AACH,qBAAa,YAAY;aAyCP,QAAQ,EAAE,SAAS;aACnB,SAAS,EAAE,eAAe;aAC1B,UAAU,CAAC;IAtC5B,OAAc,OAAO;;;;;;;;;MAuBnB;IAMF;;;;;OAKG;gBAEc,QAAQ,EAAE,SAAS,EACnB,SAAS,EAAE,eAAe,EAC1B,UAAU,CAAC,yBAAa;IAWlC,aAAa,gCAA2C;IACxD,MAAM,yBAAoC;IAC1C,WAAW,8BAAyC;IACpD,OAAO,0BAAqC;IAC5C,YAAY,+BAA0C;IAMtD,MAAM,kBAA6B;IACnC,IAAI,gBAA2B;IAM/B,IAAI,gBAA2B;IAC/B,GAAG,eAA0B;IAM7B,KAAK,iBAA4B;IACjC,MAAM,kBAA6B;IACnC,QAAQ,oBAA+B;IACvC,OAAO,mBAA8B;IACrC,MAAM,kBAA6B;IACnC,aAAa,yBAAoC;IACjD,UAAU,sBAAiC;IAC3C,MAAM,kBAA6B;IACnC,KAAK,iBAA4B;IACjC,GAAG,eAA0B;IAC7B,QAAQ,oBAA+B;IACvC,WAAW,uBAAkC;IAC7C,QAAQ,oBAA+B;IAE9C;;;OAGG;IACI,MAAM,kBAA6B;IAEnC,gBAAgB,sBACH,GAAG,yBAC8B;IAM9C,yBAAyB,0CAA2C;QAC1E,YAAY,EAAE,MAAM,CAAC;KACrB,KACE;QACA,SAAS,EAAE,aAAa,CAAC;QACzB,SAAS,EAAE,QAAQ,CAAC;QACpB,QAAQ,UAAU,CAAC;QACnB,KAAK,EAAE,MAAM,CAAC;KACb,GACD,SAAS,CA8BV;CACF"}
+{"version":3,"file":"aftermathApi.d.ts","sourceRoot":"","sources":["../../../src/general/providers/aftermathApi.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAC1D,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAC9E,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAC;AACrF,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,QAAQ,EAAY,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,6CAA6C,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,SAAS,IAAI,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,yDAAyD,CAAC;AAC9F,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,+CAA+C,CAAC;AAE/E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,YAAY;aAuDP,QAAQ,EAAE,SAAS;aACnB,SAAS,EAAE,eAAe;aAC1B,UAAU,CAAC;IApD5B;;OAEG;IACH,OAAc,OAAO;QAKpB,6EAA6E;;QAE7E,0DAA0D;;QAE1D,4FAA4F;;QAE5F,oEAAoE;;QAEpE,qEAAqE;;QAOrE,mFAAmF;;QAOnF,qFAAqF;;QAErF,gFAAgF;;MAE/E;IAMF;;;;;;;;OAQG;gBAEc,QAAQ,EAAE,SAAS,EACnB,SAAS,EAAE,eAAe,EAC1B,UAAU,CAAC,yBAAa;IAWzC;;OAEG;IACI,aAAa,gCAA2C;IAE/D;;OAEG;IACI,MAAM,yBAAoC;IAEjD;;OAEG;IACI,WAAW,8BAAyC;IAE3D;;OAEG;IACI,OAAO,0BAAqC;IAEnD;;OAEG;IACI,YAAY,+BAA0C;IAM7D;;OAEG;IACI,MAAM,kBAA6B;IAE1C;;OAEG;IACI,IAAI,gBAA2B;IAMtC;;OAEG;IACI,IAAI,gBAA2B;IAEtC;;OAEG;IACI,GAAG,eAA0B;IAMpC;;OAEG;IACI,KAAK,iBAA4B;IAExC;;OAEG;IACI,MAAM,kBAA6B;IAE1C;;OAEG;IACI,QAAQ,oBAA+B;IAE9C;;OAEG;IACI,OAAO,mBAA8B;IAE5C;;OAEG;IACI,MAAM,kBAA6B;IAE1C;;OAEG;IACI,aAAa,yBAAoC;IAExD;;OAEG;IACI,UAAU,sBAAiC;IAElD;;OAEG;IACI,MAAM,kBAA6B;IAE1C;;OAEG;IACI,KAAK,iBAA4B;IAExC;;OAEG;IACI,GAAG,eAA0B;IAEpC;;OAEG;IACI,QAAQ,oBAA+B;IAE9C;;OAEG;IACI,WAAW,uBAAkC;IAEpD;;OAEG;IACI,QAAQ,oBAA+B;IAE9C;;OAEG;IACI,MAAM,kBAA6B;IAE1C;;;;;OAKG;IACI,gBAAgB,sBAAuB,GAAG,yBACA;IAMjD;;;;;;;;;;;;;;OAcG;IACI,yBAAyB,0CAA2C;QAC1E,YAAY,EAAE,MAAM,CAAC;KACrB,KACE;QACA,SAAS,EAAE,aAAa,CAAC;QACzB,SAAS,EAAE,QAAQ,CAAC;QACpB,QAAQ,UAAU,CAAC;QACnB,KAAK,EAAE,MAAM,CAAC;KACb,GACD,SAAS,CAgCV;CACF"}