aftermath-ts-sdk 1.2.51 → 1.2.52-perps.4

package/dist/packages/pools/pool.d.ts

@@ -1,131 +1,261 @@
-import { ApiPoolDepositBody, ApiPoolTradeBody, ApiPoolWithdrawBody, Balance, CoinType, CoinsToBalance, PoolDataPoint, PoolGraphDataTimeframeKey, PoolObject, PoolStats, PoolDepositEvent, PoolWithdrawEvent, PoolTradeEvent, ApiPoolAllCoinWithdrawBody, ApiIndexerEventsBody, IndexerEventsWithCursor, Percentage, SuiAddress, ObjectId, CallerConfig } from "../../types";
+import { ApiPoolDepositBody, ApiPoolTradeBody, ApiPoolWithdrawBody, Balance, CoinType, CoinsToBalance, PoolDataPoint, PoolGraphDataTimeframeKey, PoolObject, PoolStats, PoolDepositEvent, PoolWithdrawEvent, ApiPoolAllCoinWithdrawBody, ApiIndexerEventsBody, IndexerEventsWithCursor, Percentage, SuiAddress, ObjectId, PoolCoin, CallerConfig } from "../../types";
 import { Caller } from "../../general/utils/caller";
 import { Transaction } from "@mysten/sui/transactions";
 import { AftermathApi } from "../../general/providers";
 /**
- * Represents a pool object and provides methods for interacting with the pool.
- * @class
+ * The `Pool` class encapsulates all the functionality needed to interact
+ * with a specific AMM pool on the Aftermath platform. It allows you to
+ * calculate trade amounts, deposit/withdraw amounts, fetch transactions,
+ * and retrieve on-chain statistics and event data.
+ *
+ * @example
+ * ```typescript
+ * const afSdk = new Aftermath("MAINNET");
+ * await afSdk.init(); // initialize provider
+ *
+ * const pools = afSdk.Pools();
+ * const pool = await pools.getPool({ objectId: "0x..." });
+ *
+ * const stats = await pool.getStats();
+ * const tradeTx = await pool.getTradeTransaction({
+ *   walletAddress: "0x...",
+ *   coinInType: "0x2::sui::SUI",
+ *   coinInAmount: BigInt(1e9),
+ *   coinOutType: "0x<yourCoin>",
+ *   slippage: 0.01,
+ * });
+ * ```
  */
 export declare class Pool extends Caller {
     readonly pool: PoolObject;
-    private readonly Provider?;
+    readonly Provider?: AftermathApi | undefined;
     /**
-     * Private constants used in the class.
+     * Internal margin of error used in trade calculations to prevent
+     * exceeding maximum allowed percentages of pool balances.
      */
     private static readonly constants;
     /**
-     * The pool statistics.
+     * An optional cached object containing statistical data about the pool
+     * (volume, fees, APR, etc.).
      */
     stats: PoolStats | undefined;
     /**
-     * Creates a new instance of the Pool class.
-     * @constructor
-     * @param {PoolObject} pool - The pool object.
-     * @param {SuiNetwork} [network] - The network to use.
+     * Creates a new instance of the `Pool` class for on-chain interaction.
+     *
+     * @param pool - The fetched `PoolObject` from Aftermath API or on-chain query.
+     * @param config - Optional caller configuration (e.g., network, access token).
+     * @param Provider - An optional `AftermathApi` instance for advanced transaction usage.
      */
     constructor(pool: PoolObject, config?: CallerConfig, Provider?: AftermathApi | undefined);
     /**
-     * Fetches the deposit transaction for the pool.
-     * @async
-     * @param {ApiPoolDepositBody} inputs - The inputs for the method.
-     * @returns {Promise<Transaction>} The deposit transaction for the pool.
+     * Builds or fetches a deposit transaction to add liquidity to this pool.
+     * The resulting `Transaction` can be signed and submitted by the user.
+     *
+     * @param inputs - The deposit parameters including coin amounts, slippage, etc.
+     * @returns A `Transaction` to deposit funds into the pool.
+     *
+     * @example
+     * ```typescript
+     * const depositTx = await pool.getDepositTransaction({
+     *   walletAddress: "0x...",
+     *   amountsIn: { "0x<coin>": BigInt(1000000) },
+     *   slippage: 0.01,
+     * });
+     * ```
      */
     getDepositTransaction(inputs: ApiPoolDepositBody): Promise<Transaction>;
     /**
-     * Fetches the withdraw transaction for the pool.
-     * @async
-     * @param {ApiPoolWithdrawBody} inputs - The inputs for the method.
-     * @returns {Promise<Transaction>} The withdraw transaction for the pool.
+     * Builds or fetches a withdrawal transaction to remove liquidity from this pool.
+     *
+     * @param inputs - The parameters specifying how much LP is burned, desired coins out, slippage, etc.
+     * @returns A `Transaction` to withdraw funds from the pool.
+     *
+     * @example
+     * ```typescript
+     * const withdrawTx = await pool.getWithdrawTransaction({
+     *   walletAddress: "0x...",
+     *   amountsOutDirection: {
+     *     "0x<coin>": BigInt(500000),
+     *   },
+     *   lpCoinAmount: BigInt(1000000),
+     *   slippage: 0.01,
+     * });
+     * ```
      */
     getWithdrawTransaction(inputs: ApiPoolWithdrawBody): Promise<Transaction>;
     /**
-     * Fetches the all coin withdraw transaction for the pool.
-     * @async
-     * @param {ApiPoolAllCoinWithdrawBody} inputs - The inputs for the method.
-     * @returns {Promise<Transaction>} The all coin withdraw transaction for the pool.
+     * Builds or fetches a transaction to withdraw all coin types from this pool,
+     * effectively "burning" an LP position in exchange for multiple coin outputs.
+     *
+     * @param inputs - The parameters specifying how much LP to burn.
+     * @returns A `Transaction` to withdraw all coins from the pool in proportion.
+     *
+     * @example
+     * ```typescript
+     * const allCoinWithdrawTx = await pool.getAllCoinWithdrawTransaction({
+     *   walletAddress: "0x...",
+     *   lpCoinAmount: BigInt(500000),
+     * });
+     * ```
      */
     getAllCoinWithdrawTransaction(inputs: ApiPoolAllCoinWithdrawBody): Promise<Transaction>;
     /**
-     * Fetches the trade transaction for the pool.
-     * @async
-     * @param {ApiPoolTradeBody} inputs - The inputs for the method.
-     * @returns {Promise<Transaction>} The trade transaction for the pool.
+     * Builds or fetches a trade transaction to swap between two coin types in this pool.
+     *
+     * @param inputs - The trade parameters including coin in/out, amounts, slippage, etc.
+     * @returns A `Transaction` that can be signed and executed for the swap.
+     *
+     * @example
+     * ```typescript
+     * const tradeTx = await pool.getTradeTransaction({
+     *   walletAddress: "0x...",
+     *   coinInType: "0x<coinA>",
+     *   coinInAmount: BigInt(1000000),
+     *   coinOutType: "0x<coinB>",
+     *   slippage: 0.005,
+     * });
+     * ```
      */
     getTradeTransaction(inputs: ApiPoolTradeBody): Promise<Transaction>;
+    /**
+     * Builds a transaction to update the DAO fee percentage for this pool,
+     * if it has a DAO fee configured. The user must own the appropriate
+     * `daoFeePoolOwnerCap`.
+     *
+     * @param inputs - Includes user wallet, `daoFeePoolOwnerCapId`, and the new fee percentage.
+     * @returns A `Transaction` that can be signed to update the DAO fee on chain.
+     * @throws If this pool has no DAO fee configuration.
+     *
+     * @example
+     * ```typescript
+     * const tx = await pool.getUpdateDaoFeeTransaction({
+     *   walletAddress: "0x...",
+     *   daoFeePoolOwnerCapId: "0x<capId>",
+     *   newFeePercentage: 0.01, // 1%
+     * });
+     * ```
+     */
     getUpdateDaoFeeTransaction(inputs: {
         walletAddress: SuiAddress;
         daoFeePoolOwnerCapId: ObjectId;
         newFeePercentage: Percentage;
     }): Promise<Transaction>;
+    /**
+     * Builds a transaction to update the DAO fee recipient for this pool,
+     * if it has a DAO fee configured. The user must own the appropriate
+     * `daoFeePoolOwnerCap`.
+     *
+     * @param inputs - Includes user wallet, `daoFeePoolOwnerCapId`, and the new fee recipient.
+     * @returns A `Transaction` that can be signed to update the DAO fee recipient on chain.
+     * @throws If this pool has no DAO fee configuration.
+     *
+     * @example
+     * ```typescript
+     * const tx = await pool.getUpdateDaoFeeRecipientTransaction({
+     *   walletAddress: "0x...",
+     *   daoFeePoolOwnerCapId: "0x<capId>",
+     *   newFeeRecipient: "0x<recipient>",
+     * });
+     * ```
+     */
     getUpdateDaoFeeRecipientTransaction(inputs: {
         walletAddress: SuiAddress;
         daoFeePoolOwnerCapId: ObjectId;
         newFeeRecipient: SuiAddress;
     }): Promise<Transaction>;
     /**
-     * Fetches the pool statistics.
-     * @async
-     * @returns {Promise<PoolStats>} The pool statistics.
+     * Fetches comprehensive pool statistics (volume, TVL, fees, APR, etc.) from the Aftermath API.
+     * Also caches the result in `this.stats`.
+     *
+     * @returns A promise resolving to `PoolStats` object.
+     *
+     * @example
+     * ```typescript
+     * const stats = await pool.getStats();
+     * console.log(stats.volume, stats.fees, stats.apr);
+     * ```
      */
     getStats(): Promise<PoolStats>;
     /**
-     * Sets the pool statistics.
-     * @param {PoolStats} stats - The pool statistics.
+     * Caches the provided stats object into `this.stats`.
+     *
+     * @param stats - The `PoolStats` object to store.
      */
     setStats(stats: PoolStats): void;
     /**
-     * Fetches the volume data for the pool.
-     * @async
-     * @param {Object} inputs - The inputs for the method.
-     * @param {PoolGraphDataTimeframeKey} inputs.timeframe - The timeframe for the data.
-     * @returns {Promise<PoolDataPoint[]>} The volume data for the pool.
+     * Fetches an array of volume data points for a specified timeframe.
+     * This is often used for charting or historical references.
+     *
+     * @param inputs - Contains a `timeframe` key, such as `"1D"` or `"1W"`.
+     * @returns A promise resolving to an array of `PoolDataPoint`.
+     *
+     * @example
+     * ```typescript
+     * const volumeData = await pool.getVolumeData({ timeframe: "1D" });
+     * console.log(volumeData); // e.g. [{ time: 1686000000, value: 123.45 }, ...]
+     * ```
      */
     getVolumeData(inputs: {
         timeframe: PoolGraphDataTimeframeKey;
     }): Promise<PoolDataPoint[]>;
     /**
-     * Fetches the fee data for the pool.
-     * @async
-     * @param {Object} inputs - The inputs for the method.
-     * @param {PoolGraphDataTimeframeKey} inputs.timeframe - The timeframe for the data.
-     * @returns {Promise<PoolDataPoint[]>} The fee data for the pool.
+     * Fetches an array of fee data points for a specified timeframe.
+     *
+     * @param inputs - Contains a `timeframe` key, e.g., `"1D"` or `"1W"`.
+     * @returns A promise resolving to an array of `PoolDataPoint`.
+     *
+     * @example
+     * ```typescript
+     * const feeData = await pool.getFeeData({ timeframe: "1D" });
+     * console.log(feeData);
+     * ```
      */
     getFeeData(inputs: {
         timeframe: PoolGraphDataTimeframeKey;
     }): Promise<PoolDataPoint[]>;
     /**
-     * Retrieves the volume in the last 24 hours for the pool.
-     * @returns A promise that resolves to the volume in the last 24 hours.
+     * Retrieves the 24-hour volume for this specific pool.
+     *
+     * @returns A promise resolving to a number (volume in 24h).
+     *
+     * @example
+     * ```typescript
+     * const vol24h = await pool.getVolume24hrs();
+     * console.log("Pool 24h Volume:", vol24h);
+     * ```
      */
     getVolume24hrs: () => Promise<number>;
     /**
-     * Fetches the deposit events for the pool.
-     * @async
-     * @param {ApiIndexerEventsBody} inputs - The inputs for the method.
-     * @returns {Promise<IndexerEventsWithCursor<PoolDepositEvent>>} The deposit events for the pool.
-     */
-    getDepositEvents(inputs: ApiIndexerEventsBody): Promise<IndexerEventsWithCursor<PoolDepositEvent>>;
-    /**
-     * Fetches the withdraw events for the pool.
-     * @async
-     * @param {ApiIndexerEventsBody} inputs - The inputs for the method.
-     * @returns {Promise<IndexerEventsWithCursor<PoolWithdrawEvent>>} The withdraw events for the pool.
-     */
-    getWithdrawEvents(inputs: ApiIndexerEventsBody): Promise<IndexerEventsWithCursor<PoolWithdrawEvent>>;
-    /**
-     * Fetches the trade events for the pool.
-     * @async
-     * @param {ApiIndexerEventsBody} inputs - The inputs for the method.
-     * @returns {Promise<IndexerEventsWithCursor<PoolTradeEvent>>} The trade events for the pool.
+     * Fetches user interaction events (deposit/withdraw) with this pool, optionally paginated.
+     *
+     * @param inputs - Includes user `walletAddress` and optional pagination fields.
+     * @returns A promise that resolves to `PoolDepositEvent | PoolWithdrawEvent` objects with a cursor if more exist.
+     *
+     * @example
+     * ```typescript
+     * const events = await pool.getInteractionEvents({ walletAddress: "0x...", limit: 10 });
+     * console.log(events.events, events.nextCursor);
+     * ```
      */
-    getTradeEvents(inputs: ApiIndexerEventsBody): Promise<IndexerEventsWithCursor<PoolTradeEvent>>;
+    getInteractionEvents(inputs: ApiIndexerEventsBody & {
+        walletAddress: SuiAddress;
+    }): Promise<IndexerEventsWithCursor<PoolDepositEvent | PoolWithdrawEvent>>;
     /**
-     * Calculates the spot price for the pool.
-     * @param {Object} inputs - The inputs for the method.
-     * @param {CoinType} inputs.coinInType - The input coin type.
-     * @param {CoinType} inputs.coinOutType - The output coin type.
-     * @param {boolean} [inputs.withFees] - Whether to include fees in the calculation.
-     * @returns {number} The spot price for the pool.
+     * Calculates the instantaneous spot price for swapping from `coinInType`
+     * to `coinOutType` within this pool. Optionally includes fees in the price.
+     *
+     * @param inputs - Object specifying input coin, output coin, and a boolean for `withFees`.
+     * @returns The numerical spot price (float).
+     *
+     * @example
+     * ```typescript
+     * const price = pool.getSpotPrice({
+     *   coinInType: "0x<coinA>",
+     *   coinOutType: "0x<coinB>",
+     *   withFees: true,
+     * });
+     * console.log("Spot Price:", price);
+     * ```
      */
     getSpotPrice: (inputs: {
         coinInType: CoinType;
@@ -133,13 +263,22 @@ export declare class Pool extends Caller {
         withFees?: boolean;
     }) => number;
     /**
-     * Calculates the output amount for a trade.
-     * @param {Object} inputs - The inputs for the method.
-     * @param {CoinType} inputs.coinInType - The input coin type.
-     * @param {Balance} inputs.coinInAmount - The input coin amount.
-     * @param {CoinType} inputs.coinOutType - The output coin type.
-     * @param {boolean} [inputs.referral] - Whether the trade includes a referral.
-     * @returns {Balance} The output amount for the trade.
+     * Calculates how much output coin you would receive when trading
+     * a given input coin and amount in this pool, factoring in protocol
+     * and optional DAO fees.
+     *
+     * @param inputs - Includes `coinInType`, `coinInAmount`, and `coinOutType`.
+     * @returns A bigint representing how many output coins you'd get.
+     * @throws Error if the trade amount is too large relative to the pool balance.
+     *
+     * @example
+     * ```typescript
+     * const amountOut = pool.getTradeAmountOut({
+     *   coinInType: "0x<coinA>",
+     *   coinInAmount: BigInt(1000000),
+     *   coinOutType: "0x<coinB>",
+     * });
+     * ```
      */
     getTradeAmountOut: (inputs: {
         coinInType: CoinType;
@@ -148,13 +287,21 @@ export declare class Pool extends Caller {
         referral?: boolean;
     }) => Balance;
     /**
-     * Calculates the input amount for a trade.
-     * @param {Object} inputs - The inputs for the method.
-     * @param {CoinType} inputs.coinInType - The input coin type.
-     * @param {Balance} inputs.coinOutAmount - The output coin amount.
-     * @param {CoinType} inputs.coinOutType - The output coin type.
-     * @param {boolean} [inputs.referral] - Whether the trade includes a referral.
-     * @returns {Balance} The input amount for the trade.
+     * Calculates how much input coin is required to obtain a certain output coin amount
+     * from this pool, factoring in fees.
+     *
+     * @param inputs - Includes `coinInType`, desired `coinOutAmount`, and `coinOutType`.
+     * @returns A bigint representing the needed input amount.
+     * @throws Error if the desired output is too large relative to pool balances.
+     *
+     * @example
+     * ```typescript
+     * const amountIn = pool.getTradeAmountIn({
+     *   coinInType: "0x<coinA>",
+     *   coinOutAmount: BigInt(1000000),
+     *   coinOutType: "0x<coinB>"
+     * });
+     * ```
      */
     getTradeAmountIn: (inputs: {
         coinInType: CoinType;
@@ -163,11 +310,19 @@ export declare class Pool extends Caller {
         referral?: boolean;
     }) => Balance;
     /**
-     * Calculates the LP amount and ratio for a deposit.
-     * @param {Object} inputs - The inputs for the method.
-     * @param {CoinsToBalance} inputs.amountsIn - The input amounts.
-     * @param {boolean} [inputs.referral] - Whether the deposit includes a referral.
-     * @returns {Object} The LP amount and ratio for the deposit.
+     * Calculates how many LP tokens you receive for providing liquidity
+     * in specific coin amounts. Also returns a ratio for reference.
+     *
+     * @param inputs - Contains the amounts in for each coin in the pool.
+     * @returns An object with `lpAmountOut` and `lpRatio`.
+     *
+     * @example
+     * ```typescript
+     * const depositCalc = pool.getDepositLpAmountOut({
+     *   amountsIn: { "0x<coinA>": BigInt(1000000), "0x<coinB>": BigInt(500000) },
+     * });
+     * console.log(depositCalc.lpAmountOut, depositCalc.lpRatio);
+     * ```
      */
     getDepositLpAmountOut: (inputs: {
         amountsIn: CoinsToBalance;
@@ -177,56 +332,128 @@ export declare class Pool extends Caller {
         lpRatio: number;
     };
     /**
-     * Calculates the output amounts for a withdraw.
-     * @param {Object} inputs - The inputs for the method.
-     * @param {number} inputs.lpRatio - The LP ratio.
-     * @param {CoinsToBalance} inputs.amountsOutDirection - The output amounts.
-     * @param {boolean} [inputs.referral] - Whether the withdraw includes a referral.
-     * @returns {CoinsToBalance} The output amounts for the withdraw.
+     * Calculates how many coins a user will receive when withdrawing a specific ratio or LP amount.
+     * This method is used in multi-coin withdrawals where you specify how much of each coin you want.
+     *
+     * @param inputs - The LP ratio and an object specifying direction amounts for each coin.
+     * @returns A `CoinsToBalance` object with final amounts out, factoring in DAO fees.
+     *
+     * @example
+     * ```typescript
+     * const outAmounts = pool.getWithdrawAmountsOut({
+     *   lpRatio: 0.1,
+     *   amountsOutDirection: { "0x<coinA>": BigInt(500000) },
+     * });
+     * console.log(outAmounts);
+     * ```
      */
     getWithdrawAmountsOut: (inputs: {
         lpRatio: number;
         amountsOutDirection: CoinsToBalance;
         referral?: boolean;
     }) => CoinsToBalance;
+    /**
+     * A simplified multi-coin withdraw approach: calculates all outputs by proportion of the
+     * user's LP share among selected coin types. Useful for approximate or "blind" all-coin out logic.
+     *
+     * @param inputs - Contains the `lpCoinAmountIn` to burn, and which coin types to receive.
+     * @returns A record mapping coin type => final amounts out.
+     */
     getWithdrawAmountsOutSimple: (inputs: {
         lpCoinAmountIn: Balance;
         coinTypesOut: CoinType[];
         referral?: boolean;
     }) => CoinsToBalance;
     /**
-     * Calculates the output amounts for an all coin withdraw.
-     * @param {Object} inputs - The inputs for the method.
-     * @param {number} inputs.lpRatio - The LP ratio.
-     * @param {boolean} [inputs.referral] - Whether the withdraw includes a referral.
-     * @returns {CoinsToBalance} The output amounts for the all coin withdraw.
+     * Calculates how many coins you get when withdrawing **all** coin types from the pool,
+     * given a ratio. This is typically used for proportionate withdrawal.
+     *
+     * @param inputs - Includes `lpRatio`, the portion of your LP to burn (0 < ratio < 1).
+     * @returns A record of coin type => amounts out, after factoring in any fees.
+     *
+     * @example
+     * ```typescript
+     * const allOut = pool.getAllCoinWithdrawAmountsOut({ lpRatio: 0.1 });
+     * console.log(allOut); // amounts for each coin
+     * ```
      */
     getAllCoinWithdrawAmountsOut: (inputs: {
         lpRatio: number;
         referral?: boolean;
     }) => CoinsToBalance;
     /**
-     * Calculates the LP ratio for a multi-coin withdraw.
-     * @param {Object} inputs - The inputs for the method.
-     * @param {bigint} inputs.lpCoinAmountIn - The LP coin amount out.
-     * @returns {number} The LP ratio for the multi-coin withdraw.
+     * For multi-coin withdraw, calculates the ratio of how much LP you are burning
+     * relative to the total supply. e.g. if user burns 100 of 1000 supply => ratio 0.1.
+     *
+     * @param inputs - Contains the `lpCoinAmountIn` to burn.
+     * @returns A float ratio (0 < ratio < 1).
      */
     getMultiCoinWithdrawLpRatio: (inputs: {
         lpCoinAmountIn: bigint;
     }) => number;
     /**
-     * Calculates the LP ratio for an all coin withdraw.
-     * @param {Object} inputs - The inputs for the method.
-     * @param {bigint} inputs.lpCoinAmountIn - The LP coin amount out.
-     * @returns {number} The LP ratio for the all coin withdraw.
+     * For an all-coin withdraw, calculates the ratio of how much LP is burned
+     * relative to total supply. e.g. if user burns 50 of 200 supply => ratio 0.25.
+     *
+     * @param inputs - Contains the `lpCoinAmountIn`.
+     * @returns A float ratio, typically 0 < ratio < 1.
      */
     getAllCoinWithdrawLpRatio: (inputs: {
         lpCoinAmountIn: bigint;
     }) => number;
+    /**
+     * Returns an array of coin types in ascending lexicographic order
+     * for the coins contained in this pool.
+     *
+     * @returns An array of coin type strings.
+     */
+    coins: () => CoinType[];
+    /**
+     * Returns an array of `PoolCoin` objects, one for each coin in this pool,
+     * sorted lexicographically by coin type.
+     *
+     * @returns An array of `PoolCoin`.
+     */
+    poolCoins: () => PoolCoin[];
+    /**
+     * Returns an array of `[CoinType, PoolCoin]` pairs, sorted by coin type.
+     *
+     * @returns An array of coin-type => `PoolCoin` pairs.
+     */
+    poolCoinEntries: () => [CoinType, PoolCoin][];
+    /**
+     * Returns the current DAO fee percentage, if configured (0 < fee <= 100%).
+     *
+     * @returns A decimal fraction representing the fee (e.g., 0.01 = 1%) or `undefined`.
+     */
     daoFeePercentage: () => Percentage | undefined;
+    /**
+     * Returns the Sui address that currently receives the DAO fee portion of
+     * pool trades, or `undefined` if no DAO fee is configured.
+     *
+     * @returns The DAO fee recipient address.
+     */
     daoFeeRecipient: () => SuiAddress | undefined;
+    /**
+     * Applies the DAO fee (if present) to a given `amount`, effectively reducing
+     * that amount by the fee fraction. e.g. if fee is 2%, it returns 98% of the input.
+     *
+     * @param inputs - Contains `amount` as a bigint.
+     * @returns The post-fee amount as a bigint.
+     */
     private getAmountWithDAOFee;
+    /**
+     * The inverse operation of `getAmountWithDAOFee`, used in internal calculations
+     * when we need to back out how much input was needed prior to the fee cut.
+     *
+     * @param inputs - Contains `amount` as a bigint.
+     * @returns The pre-fee amount as a bigint.
+     */
     private getAmountWithoutDAOFee;
+    /**
+     * Provides an instance of the Pools provider from `AftermathApi`.
+     * Throws an error if not defined.
+     */
     private useProvider;
 }
 //# sourceMappingURL=pool.d.ts.map

package/dist/packages/pools/pool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pool.d.ts","sourceRoot":"","sources":["../../../src/packages/pools/pool.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACnB,OAAO,EACP,QAAQ,EACR,cAAc,EACd,aAAa,EACb,yBAAyB,EACzB,UAAU,EACV,SAAS,EAET,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EAEd,0BAA0B,EAC1B,oBAAoB,EACpB,uBAAuB,EACvB,UAAU,EACV,UAAU,EACV,QAAQ,EACR,YAAY,EACZ,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAGpD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD;;;GAGG;AACH,qBAAa,IAAK,SAAQ,MAAM;aAoBd,IAAI,EAAE,UAAU;IAEhC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IArB3B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAE/B;IAEF;;OAEG;IACI,KAAK,EAAE,SAAS,GAAG,SAAS,CAAC;IAEpC;;;;;OAKG;gBAEc,IAAI,EAAE,UAAU,EAChC,MAAM,CAAC,EAAE,YAAY,EACJ,QAAQ,CAAC,0BAAc;IAUzC;;;;;OAKG;IACU,qBAAqB,CACjC,MAAM,EAAE,kBAAkB,GACxB,OAAO,CAAC,WAAW,CAAC;IAOvB;;;;;OAKG;IACU,sBAAsB,CAClC,MAAM,EAAE,mBAAmB,GACzB,OAAO,CAAC,WAAW,CAAC;IAOvB;;;;;OAKG;IACU,6BAA6B,CACzC,MAAM,EAAE,0BAA0B,GAChC,OAAO,CAAC,WAAW,CAAC;IAOvB;;;;;OAKG;IACU,mBAAmB,CAC/B,MAAM,EAAE,gBAAgB,GACtB,OAAO,CAAC,WAAW,CAAC;IAOV,0BAA0B,CAAC,MAAM,EAAE;QAC/C,aAAa,EAAE,UAAU,CAAC;QAC1B,oBAAoB,EAAE,QAAQ,CAAC;QAC/B,gBAAgB,EAAE,UAAU,CAAC;KAC7B,GAAG,OAAO,CAAC,WAAW,CAAC;IAYX,mCAAmC,CAAC,MAAM,EAAE;QACxD,aAAa,EAAE,UAAU,CAAC;QAC1B,oBAAoB,EAAE,QAAQ,CAAC;QAC/B,eAAe,EAAE,UAAU,CAAC;KAC5B,GAAG,OAAO,CAAC,WAAW,CAAC;IAkBxB;;;;OAIG;IACU,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC;IAM3C;;;OAGG;IACI,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAIvC;;;;;;OAMG;IACU,aAAa,CAAC,MAAM,EAAE;QAClC,SAAS,EAAE,yBAAyB,CAAC;KACrC,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAI5B;;;;;;OAMG;IACU,UAAU,CAAC,MAAM,EAAE;QAC/B,SAAS,EAAE,yBAAyB,CAAC;KACrC,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAI5B;;;OAGG;IACI,cAAc,QAAa,QAAQ,MAAM,CAAC,CAE/C;IAEF;;;;;OAKG;IACU,gBAAgB,CAAC,MAAM,EAAE,oBAAoB;IAO1D;;;;;OAKG;IACU,iBAAiB,CAC7B,MAAM,EAAE,oBAAoB,GAC1B,OAAO,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,CAAC;IAOtD;;;;;OAKG;IACU,cAAc,CAC1B,MAAM,EAAE,oBAAoB,GAC1B,OAAO,CAAC,uBAAuB,CAAC,cAAc,CAAC,CAAC;IAWnD;;;;;;;OAOG;IACI,YAAY,WAAY;QAC9B,UAAU,EAAE,QAAQ,CAAC;QACrB,WAAW,EAAE,QAAQ,CAAC;QACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB,YAaC;IAIF;;;;;;;;OAQG;IACI,iBAAiB,WAAY;QACnC,UAAU,EAAE,QAAQ,CAAC;QACrB,YAAY,EAAE,OAAO,CAAC;QACtB,WAAW,EAAE,QAAQ,CAAC;QACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB,KAAG,OAAO,CAuCT;IAEF;;;;;;;;OAQG;IACI,gBAAgB,WAAY;QAClC,UAAU,EAAE,QAAQ,CAAC;QACrB,aAAa,EAAE,OAAO,CAAC;QACvB,WAAW,EAAE,QAAQ,CAAC;QACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB,KAAG,OAAO,CAuCT;IAEF;;;;;;OAMG;IACI,qBAAqB,WAAY;QACvC,SAAS,EAAE,cAAc,CAAC;QAC1B,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB;qBACa,OAAO;iBACX,MAAM;MAyBd;IAEF;;;;;;;OAOG;IACI,qBAAqB,WAAY;QACvC,OAAO,EAAE,MAAM,CAAC;QAChB,mBAAmB,EAAE,cAAc,CAAC;QACpC,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB,KAAG,cAAc,CAiChB;IAEK,2BAA2B,WAAY;QAC7C,cAAc,EAAE,OAAO,CAAC;QACxB,YAAY,EAAE,QAAQ,EAAE,CAAC;QACzB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB,KAAG,cAAc,CAuDhB;IAEF;;;;;;OAMG;IACI,4BAA4B,WAAY;QAC9C,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB,KAAG,cAAc,CAiBhB;IAEF;;;;;OAKG;IACI,2BAA2B,WAAY;QAC7C,cAAc,EAAE,MAAM,CAAC;KACvB,KAAG,MAAM,CAEsB;IAEhC;;;;;OAKG;IACI,yBAAyB,WAAY;QAC3C,cAAc,EAAE,MAAM,CAAC;KACvB,KAAG,MAAM,CACsD;IAMzD,gBAAgB,QAAO,UAAU,GAAG,SAAS,CAIlD;IAEK,eAAe,QAAO,UAAU,GAAG,SAAS,CAEjD;IAMF,OAAO,CAAC,mBAAmB,CAOzB;IAEF,OAAO,CAAC,sBAAsB,CAO5B;IAEF,OAAO,CAAC,WAAW,CAIjB;CACF"}
+{"version":3,"file":"pool.d.ts","sourceRoot":"","sources":["../../../src/packages/pools/pool.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACnB,OAAO,EACP,QAAQ,EACR,cAAc,EACd,aAAa,EACb,yBAAyB,EACzB,UAAU,EACV,SAAS,EAET,gBAAgB,EAChB,iBAAiB,EAGjB,0BAA0B,EAC1B,oBAAoB,EACpB,uBAAuB,EACvB,UAAU,EACV,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,YAAY,EACZ,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAGpD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,IAAK,SAAQ,MAAM;aAuBd,IAAI,EAAE,UAAU;aAEhB,QAAQ,CAAC;IAxB1B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAE/B;IAEF;;;OAGG;IACI,KAAK,EAAE,SAAS,GAAG,SAAS,CAAC;IAEpC;;;;;;OAMG;gBAEc,IAAI,EAAE,UAAU,EAChC,MAAM,CAAC,EAAE,YAAY,EACL,QAAQ,CAAC,0BAAc;IAUxC;;;;;;;;;;;;;;;OAeG;IACU,qBAAqB,CACjC,MAAM,EAAE,kBAAkB,GACxB,OAAO,CAAC,WAAW,CAAC;IAOvB;;;;;;;;;;;;;;;;;OAiBG;IACU,sBAAsB,CAClC,MAAM,EAAE,mBAAmB,GACzB,OAAO,CAAC,WAAW,CAAC;IAOvB;;;;;;;;;;;;;;OAcG;IACU,6BAA6B,CACzC,MAAM,EAAE,0BAA0B,GAChC,OAAO,CAAC,WAAW,CAAC;IAOvB;;;;;;;;;;;;;;;;OAgBG;IACU,mBAAmB,CAC/B,MAAM,EAAE,gBAAgB,GACtB,OAAO,CAAC,WAAW,CAAC;IAOvB;;;;;;;;;;;;;;;;;OAiBG;IACU,0BAA0B,CAAC,MAAM,EAAE;QAC/C,aAAa,EAAE,UAAU,CAAC;QAC1B,oBAAoB,EAAE,QAAQ,CAAC;QAC/B,gBAAgB,EAAE,UAAU,CAAC;KAC7B,GAAG,OAAO,CAAC,WAAW,CAAC;IAYxB;;;;;;;;;;;;;;;;;OAiBG;IACU,mCAAmC,CAAC,MAAM,EAAE;QACxD,aAAa,EAAE,UAAU,CAAC;QAC1B,oBAAoB,EAAE,QAAQ,CAAC;QAC/B,eAAe,EAAE,UAAU,CAAC;KAC5B,GAAG,OAAO,CAAC,WAAW,CAAC;IAkBxB;;;;;;;;;;;OAWG;IACU,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC;IAM3C;;;;OAIG;IACI,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAIvC;;;;;;;;;;;;OAYG;IACU,aAAa,CAAC,MAAM,EAAE;QAClC,SAAS,EAAE,yBAAyB,CAAC;KACrC,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAI5B;;;;;;;;;;;OAWG;IACU,UAAU,CAAC,MAAM,EAAE;QAC/B,SAAS,EAAE,yBAAyB,CAAC;KACrC,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAI5B;;;;;;;;;;OAUG;IACI,cAAc,QAAa,QAAQ,MAAM,CAAC,CAE/C;IAMF;;;;;;;;;;;OAWG;IACU,oBAAoB,CAChC,MAAM,EAAE,oBAAoB,GAAG;QAC9B,aAAa,EAAE,UAAU,CAAC;KAC1B;IAYF;;;;;;;;;;;;;;;;OAgBG;IACI,YAAY,WAAY;QAC9B,UAAU,EAAE,QAAQ,CAAC;QACrB,WAAW,EAAE,QAAQ,CAAC;QACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB,YAcC;IAIF;;;;;;;;;;;;;;;;;OAiBG;IACI,iBAAiB,WAAY;QACnC,UAAU,EAAE,QAAQ,CAAC;QACrB,YAAY,EAAE,OAAO,CAAC;QACtB,WAAW,EAAE,QAAQ,CAAC;QACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB,KAAG,OAAO,CAuCT;IAEF;;;;;;;;;;;;;;;;OAgBG;IACI,gBAAgB,WAAY;QAClC,UAAU,EAAE,QAAQ,CAAC;QACrB,aAAa,EAAE,OAAO,CAAC;QACvB,WAAW,EAAE,QAAQ,CAAC;QACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB,KAAG,OAAO,CAuCT;IAEF;;;;;;;;;;;;;;OAcG;IACI,qBAAqB,WAAY;QACvC,SAAS,EAAE,cAAc,CAAC;QAC1B,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB;qBACa,OAAO;iBACX,MAAM;MAyBd;IAEF;;;;;;;;;;;;;;;OAeG;IACI,qBAAqB,WAAY;QACvC,OAAO,EAAE,MAAM,CAAC;QAChB,mBAAmB,EAAE,cAAc,CAAC;QACpC,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB,KAAG,cAAc,CAgChB;IAEF;;;;;;OAMG;IACI,2BAA2B,WAAY;QAC7C,cAAc,EAAE,OAAO,CAAC;QACxB,YAAY,EAAE,QAAQ,EAAE,CAAC;QACzB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB,KAAG,cAAc,CAsDhB;IAEF;;;;;;;;;;;;OAYG;IACI,4BAA4B,WAAY;QAC9C,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB,KAAG,cAAc,CAiBhB;IAEF;;;;;;OAMG;IACI,2BAA2B,WAAY;QAC7C,cAAc,EAAE,MAAM,CAAC;KACvB,KAAG,MAAM,CAEsB;IAEhC;;;;;;OAMG;IACI,yBAAyB,WAAY;QAC3C,cAAc,EAAE,MAAM,CAAC;KACvB,KAAG,MAAM,CACsD;IAMhE;;;;;OAKG;IACI,KAAK,QAAO,QAAQ,EAAE,CAE3B;IAEF;;;;;OAKG;IACI,SAAS,QAAO,QAAQ,EAAE,CAI/B;IAEF;;;;OAIG;IACI,eAAe,QAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAIjD;IAEF;;;;OAIG;IACI,gBAAgB,QAAO,UAAU,GAAG,SAAS,CAIlD;IAEF;;;;;OAKG;IACI,eAAe,QAAO,UAAU,GAAG,SAAS,CAEjD;IAMF;;;;;;OAMG;IACH,OAAO,CAAC,mBAAmB,CAOzB;IAEF;;;;;;OAMG;IACH,OAAO,CAAC,sBAAsB,CAO5B;IAEF;;;OAGG;IACH,OAAO,CAAC,WAAW,CAIjB;CACF"}