aftermath-ts-sdk 1.3.28 → 2.0.0

package/dist/packages/pools/api/poolsApiCasting.d.ts

@@ -1,13 +0,0 @@
-import { DaoFeePoolOwnerCapObject, PoolDepositEvent, PoolObject, PoolTradeEvent, PoolWithdrawEvent } from "../poolsTypes";
-import { PoolCreateEventOnChain, PoolTradeEventOnChain, PoolDepositEventOnChain, PoolWithdrawEventOnChain } from "./poolsApiCastingTypes";
-import { ObjectId } from "../../../types";
-import { SuiObjectResponse } from "@mysten/sui/client";
-export declare class PoolsApiCasting {
-    static poolObjectFromSuiObject: (suiObject: SuiObjectResponse) => PoolObject;
-    static daoFeePoolOwnerCapObjectFromSuiObjectResponse: (data: SuiObjectResponse) => DaoFeePoolOwnerCapObject;
-    static poolObjectIdfromPoolCreateEventOnChain: (eventOnChain: PoolCreateEventOnChain) => ObjectId;
-    static poolTradeEventFromOnChain: (eventOnChain: PoolTradeEventOnChain) => PoolTradeEvent;
-    static poolDepositEventFromOnChain: (eventOnChain: PoolDepositEventOnChain) => PoolDepositEvent;
-    static poolWithdrawEventFromOnChain: (eventOnChain: PoolWithdrawEventOnChain) => PoolWithdrawEvent;
-}
-//# sourceMappingURL=poolsApiCasting.d.ts.map

package/dist/packages/pools/api/poolsApiCasting.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"poolsApiCasting.d.ts","sourceRoot":"","sources":["../../../../src/packages/pools/api/poolsApiCasting.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,wBAAwB,EAExB,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,iBAAiB,EACjB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,sBAAsB,EAKtB,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EAGxB,MAAM,wBAAwB,CAAC;AAGhC,OAAO,EAAiB,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAEzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAEvD,qBAAa,eAAe;IAK3B,OAAc,uBAAuB,GACpC,WAAW,iBAAiB,KAC1B,UAAU,CAsDX;IAEF,OAAc,6CAA6C,GAC1D,MAAM,iBAAiB,KACrB,wBAAwB,CAczB;IAMF,OAAc,sCAAsC,GACnD,cAAc,sBAAsB,KAClC,QAAQ,CAGT;IAEF,OAAc,yBAAyB,GACtC,cAAc,qBAAqB,KACjC,cAAc,CAiBf;IAEF,OAAc,2BAA2B,GACxC,cAAc,uBAAuB,KACnC,gBAAgB,CAcjB;IAEF,OAAc,4BAA4B,GACzC,cAAc,wBAAwB,KACpC,iBAAiB,CAclB;CACF"}

package/dist/packages/pools/api/poolsApiCasting.js

@@ -1,91 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PoolsApiCasting = void 0;
-const coin_1 = require("../../coin");
-const utils_1 = require("../../../general/utils");
-class PoolsApiCasting {
-}
-exports.PoolsApiCasting = PoolsApiCasting;
-// =========================================================================
-//  Objects
-// =========================================================================
-PoolsApiCasting.poolObjectFromSuiObject = (suiObject) => {
-    const objectId = utils_1.Helpers.getObjectId(suiObject);
-    const objectType = utils_1.Helpers.getObjectType(suiObject);
-    const poolFieldsOnChain = utils_1.Helpers.getObjectFields(suiObject);
-    const lpCoinType = utils_1.Helpers.addLeadingZeroesToType(coin_1.Coin.getInnerCoinType(poolFieldsOnChain.lp_supply.type));
-    const coins = poolFieldsOnChain.type_names.reduce((acc, cur, index) => (Object.assign(Object.assign({}, acc), { [utils_1.Helpers.addLeadingZeroesToType("0x" + cur)]: Object.assign({ weight: BigInt(poolFieldsOnChain.weights[index]), balance: BigInt(poolFieldsOnChain.normalized_balances[index]) /
-                BigInt(poolFieldsOnChain.decimal_scalars[index]), tradeFeeIn: BigInt(poolFieldsOnChain.fees_swap_in[index]), tradeFeeOut: BigInt(poolFieldsOnChain.fees_swap_out[index]), depositFee: BigInt(poolFieldsOnChain.fees_deposit[index]), withdrawFee: BigInt(poolFieldsOnChain.fees_withdraw[index]), normalizedBalance: BigInt(poolFieldsOnChain.normalized_balances[index]), decimalsScalar: BigInt(poolFieldsOnChain.decimal_scalars[index]) }, (poolFieldsOnChain.coin_decimals
-            ? {
-                decimals: Number(poolFieldsOnChain.coin_decimals[index]),
-            }
-            : {})) })), {});
-    return {
-        objectType,
-        objectId,
-        lpCoinType,
-        name: poolFieldsOnChain.name,
-        creator: poolFieldsOnChain.creator,
-        lpCoinSupply: BigInt(poolFieldsOnChain.lp_supply.fields.value),
-        illiquidLpCoinSupply: BigInt(poolFieldsOnChain.illiquid_lp_supply),
-        flatness: BigInt(poolFieldsOnChain.flatness),
-        lpCoinDecimals: Number(poolFieldsOnChain.lp_decimals),
-        coins,
-    };
-};
-PoolsApiCasting.daoFeePoolOwnerCapObjectFromSuiObjectResponse = (data) => {
-    const objectType = utils_1.Helpers.getObjectType(data);
-    const fields = utils_1.Helpers.getObjectFields(data);
-    return {
-        objectType,
-        objectId: utils_1.Helpers.getObjectId(data),
-        daoFeePoolId: utils_1.Helpers.addLeadingZeroesToType(fields.dao_fee_pool_id),
-    };
-};
-// =========================================================================
-//  Events
-// =========================================================================
-PoolsApiCasting.poolObjectIdfromPoolCreateEventOnChain = (eventOnChain) => {
-    const fields = eventOnChain.parsedJson;
-    return fields.pool_id;
-};
-PoolsApiCasting.poolTradeEventFromOnChain = (eventOnChain) => {
-    const fields = eventOnChain.parsedJson;
-    return {
-        poolId: fields.pool_id,
-        trader: fields.issuer,
-        typesIn: fields.types_in.map((type) => utils_1.Helpers.addLeadingZeroesToType("0x" + type)),
-        amountsIn: fields.amounts_in.map((amount) => BigInt(amount)),
-        typesOut: fields.types_out.map((type) => utils_1.Helpers.addLeadingZeroesToType("0x" + type)),
-        amountsOut: fields.amounts_out.map((amount) => BigInt(amount)),
-        timestamp: Number(eventOnChain.timestampMs),
-        txnDigest: eventOnChain.id.txDigest,
-        type: eventOnChain.type,
-    };
-};
-PoolsApiCasting.poolDepositEventFromOnChain = (eventOnChain) => {
-    const fields = eventOnChain.parsedJson;
-    return {
-        poolId: fields.pool_id,
-        depositor: fields.issuer,
-        types: fields.types.map((type) => utils_1.Helpers.addLeadingZeroesToType("0x" + type)),
-        deposits: fields.deposits.map((deposit) => BigInt(deposit)),
-        lpMinted: BigInt(fields.lp_coins_minted),
-        timestamp: Number(eventOnChain.timestampMs),
-        txnDigest: eventOnChain.id.txDigest,
-        type: eventOnChain.type,
-    };
-};
-PoolsApiCasting.poolWithdrawEventFromOnChain = (eventOnChain) => {
-    const fields = eventOnChain.parsedJson;
-    return {
-        poolId: fields.pool_id,
-        withdrawer: fields.issuer,
-        types: fields.types.map((type) => utils_1.Helpers.addLeadingZeroesToType("0x" + type)),
-        withdrawn: fields.withdrawn.map((withdraw) => BigInt(withdraw)),
-        lpBurned: BigInt(fields.lp_coins_burned),
-        timestamp: Number(eventOnChain.timestampMs),
-        txnDigest: eventOnChain.id.txDigest,
-        type: eventOnChain.type,
-    };
-};

package/dist/packages/pools/api/poolsApiCastingTypes.d.ts

@@ -1,64 +0,0 @@
-import { BigIntAsString, CoinType, PoolName, ObjectId, SuiAddress } from "../../../types";
-import { EventOnChain, SupplyOnChain } from "../../../general/types/castingTypes";
-export interface PoolFieldsOnChain {
-    name: PoolName;
-    creator: SuiAddress;
-    lp_supply: SupplyOnChain;
-    illiquid_lp_supply: BigIntAsString;
-    type_names: CoinType[];
-    normalized_balances: BigIntAsString[];
-    weights: BigIntAsString[];
-    flatness: BigIntAsString;
-    fees_swap_in: BigIntAsString[];
-    fees_swap_out: BigIntAsString[];
-    fees_deposit: BigIntAsString[];
-    fees_withdraw: BigIntAsString[];
-    decimal_scalars: BigIntAsString[];
-    lp_decimals: BigIntAsString;
-    lp_decimal_scalar: BigIntAsString;
-    coin_decimals?: BigIntAsString[];
-}
-export interface DaoFeePoolFieldsOnChain {
-    fee_bps: BigIntAsString;
-    fee_recipient: SuiAddress;
-}
-export interface DaoFeePoolOwnerCapFieldsOnChain {
-    id: ObjectId;
-    dao_fee_pool_id: ObjectId;
-}
-export type PoolCreateEventOnChain = EventOnChain<{
-    pool_id: ObjectId;
-    lp_type: CoinType;
-} & PoolFieldsOnChain>;
-export type PoolSpotPriceEventOnChain = EventOnChain<{
-    pool_id: ObjectId;
-    base_type: CoinType;
-    quote_type: CoinType;
-    spot_price: BigIntAsString;
-}>;
-export interface PoolTradeEventOnChainFields {
-    pool_id: ObjectId;
-    issuer: SuiAddress;
-    types_in: CoinType[];
-    amounts_in: BigIntAsString[];
-    types_out: CoinType[];
-    amounts_out: BigIntAsString[];
-}
-export interface PoolDepositEventFieldsOnChain {
-    pool_id: ObjectId;
-    issuer: SuiAddress;
-    types: CoinType[];
-    deposits: BigIntAsString[];
-    lp_coins_minted: BigIntAsString;
-}
-export interface PoolWithdrawEventFieldsOnChain {
-    pool_id: ObjectId;
-    issuer: SuiAddress;
-    types: CoinType[];
-    withdrawn: BigIntAsString[];
-    lp_coins_burned: BigIntAsString;
-}
-export type PoolTradeEventOnChain = EventOnChain<PoolTradeEventOnChainFields>;
-export type PoolDepositEventOnChain = EventOnChain<PoolDepositEventFieldsOnChain>;
-export type PoolWithdrawEventOnChain = EventOnChain<PoolWithdrawEventFieldsOnChain>;
-//# sourceMappingURL=poolsApiCastingTypes.d.ts.map

package/dist/packages/pools/api/poolsApiCastingTypes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"poolsApiCastingTypes.d.ts","sourceRoot":"","sources":["../../../../src/packages/pools/api/poolsApiCastingTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAGN,cAAc,EACd,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACN,YAAY,EAEZ,aAAa,EACb,MAAM,qCAAqC,CAAC;AAM7C,MAAM,WAAW,iBAAiB;IACjC,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,UAAU,CAAC;IACpB,SAAS,EAAE,aAAa,CAAC;IACzB,kBAAkB,EAAE,cAAc,CAAC;IACnC,UAAU,EAAE,QAAQ,EAAE,CAAC;IACvB,mBAAmB,EAAE,cAAc,EAAE,CAAC;IACtC,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,QAAQ,EAAE,cAAc,CAAC;IACzB,YAAY,EAAE,cAAc,EAAE,CAAC;IAC/B,aAAa,EAAE,cAAc,EAAE,CAAC;IAChC,YAAY,EAAE,cAAc,EAAE,CAAC;IAC/B,aAAa,EAAE,cAAc,EAAE,CAAC;IAChC,eAAe,EAAE,cAAc,EAAE,CAAC;IAClC,WAAW,EAAE,cAAc,CAAC;IAC5B,iBAAiB,EAAE,cAAc,CAAC;IAClC,aAAa,CAAC,EAAE,cAAc,EAAE,CAAC;CACjC;AAED,MAAM,WAAW,uBAAuB;IACvC,OAAO,EAAE,cAAc,CAAC;IACxB,aAAa,EAAE,UAAU,CAAC;CAC1B;AAED,MAAM,WAAW,+BAA+B;IAC/C,EAAE,EAAE,QAAQ,CAAC;IACb,eAAe,EAAE,QAAQ,CAAC;CAC1B;AAMD,MAAM,MAAM,sBAAsB,GAAG,YAAY,CAChD;IACC,OAAO,EAAE,QAAQ,CAAC;IAClB,OAAO,EAAE,QAAQ,CAAC;CAClB,GAAG,iBAAiB,CACrB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,YAAY,CAAC;IACpD,OAAO,EAAE,QAAQ,CAAC;IAClB,SAAS,EAAE,QAAQ,CAAC;IACpB,UAAU,EAAE,QAAQ,CAAC;IACrB,UAAU,EAAE,cAAc,CAAC;CAC3B,CAAC,CAAC;AAMH,MAAM,WAAW,2BAA2B;IAC3C,OAAO,EAAE,QAAQ,CAAC;IAClB,MAAM,EAAE,UAAU,CAAC;IACnB,QAAQ,EAAE,QAAQ,EAAE,CAAC;IACrB,UAAU,EAAE,cAAc,EAAE,CAAC;IAC7B,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,WAAW,EAAE,cAAc,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,6BAA6B;IAC7C,OAAO,EAAE,QAAQ,CAAC;IAClB,MAAM,EAAE,UAAU,CAAC;IACnB,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,eAAe,EAAE,cAAc,CAAC;CAChC;AAED,MAAM,WAAW,8BAA8B;IAC9C,OAAO,EAAE,QAAQ,CAAC;IAClB,MAAM,EAAE,UAAU,CAAC;IACnB,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,SAAS,EAAE,cAAc,EAAE,CAAC;IAC5B,eAAe,EAAE,cAAc,CAAC;CAChC;AAMD,MAAM,MAAM,qBAAqB,GAAG,YAAY,CAAC,2BAA2B,CAAC,CAAC;AAE9E,MAAM,MAAM,uBAAuB,GAClC,YAAY,CAAC,6BAA6B,CAAC,CAAC;AAE7C,MAAM,MAAM,wBAAwB,GACnC,YAAY,CAAC,8BAA8B,CAAC,CAAC"}

package/dist/packages/pools/api/poolsApiCastingTypes.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,3 +0,0 @@
-export * from "./pool";
-export * from "./pools";
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packages/pools/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC"}

package/dist/packages/pools/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./pool"), exports);
-__exportStar(require("./pools"), exports);

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

@@ -1,459 +0,0 @@
-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";
-/**
- * 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;
-    readonly Provider?: AftermathApi | undefined;
-    /**
-     * Internal margin of error used in trade calculations to prevent
-     * exceeding maximum allowed percentages of pool balances.
-     */
-    private static readonly constants;
-    /**
-     * 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 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);
-    /**
-     * 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>;
-    /**
-     * 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>;
-    /**
-     * 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>;
-    /**
-     * 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 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>;
-    /**
-     * Caches the provided stats object into `this.stats`.
-     *
-     * @param stats - The `PoolStats` object to store.
-     */
-    setStats(stats: PoolStats): void;
-    /**
-     * 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 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 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 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);
-     * ```
-     */
-    getInteractionEvents(inputs: ApiIndexerEventsBody & {
-        walletAddress: SuiAddress;
-    }): Promise<IndexerEventsWithCursor<PoolDepositEvent | PoolWithdrawEvent>>;
-    /**
-     * 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;
-        coinOutType: CoinType;
-        withFees?: boolean;
-    }) => number;
-    /**
-     * 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;
-        coinInAmount: Balance;
-        coinOutType: CoinType;
-        referral?: boolean;
-    }) => Balance;
-    /**
-     * 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;
-        coinOutAmount: Balance;
-        coinOutType: CoinType;
-        referral?: boolean;
-    }) => Balance;
-    /**
-     * 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;
-        referral?: boolean;
-    }) => {
-        lpAmountOut: Balance;
-        lpRatio: number;
-    };
-    /**
-     * 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 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;
-    /**
-     * 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;
-    /**
-     * 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 +0,0 @@
-{"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,EAAE,YAAY;IAxBxC;;;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,EAAE,YAAY,YAAA;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,OAAO,CAAC,MAAM,CAAC,CAE/C;IAMF;;;;;;;;;;;OAWG;IACU,oBAAoB,CAChC,MAAM,EAAE,oBAAoB,GAAG;QAC9B,aAAa,EAAE,UAAU,CAAC;KAC1B;IAYF;;;;;;;;;;;;;;;;OAgBG;IACI,YAAY,GAAI,QAAQ;QAC9B,UAAU,EAAE,QAAQ,CAAC;QACrB,WAAW,EAAE,QAAQ,CAAC;QACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB,YAcC;IAIF;;;;;;;;;;;;;;;;;OAiBG;IACI,iBAAiB,GAAI,QAAQ;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,GAAI,QAAQ;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,GAAI,QAAQ;QACvC,SAAS,EAAE,cAAc,CAAC;QAC1B,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB,KAAG;QACH,WAAW,EAAE,OAAO,CAAC;QACrB,OAAO,EAAE,MAAM,CAAC;KAChB,CAwBC;IAEF;;;;;;;;;;;;;;;OAeG;IACI,qBAAqB,GAAI,QAAQ;QACvC,OAAO,EAAE,MAAM,CAAC;QAChB,mBAAmB,EAAE,cAAc,CAAC;QACpC,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB,KAAG,cAAc,CAgChB;IAEF;;;;;;OAMG;IACI,2BAA2B,GAAI,QAAQ;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,GAAI,QAAQ;QAC9C,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;KACnB,KAAG,cAAc,CAiBhB;IAEF;;;;;;OAMG;IACI,2BAA2B,GAAI,QAAQ;QAC7C,cAAc,EAAE,MAAM,CAAC;KACvB,KAAG,MAAM,CAEsB;IAEhC;;;;;;OAMG;IACI,yBAAyB,GAAI,QAAQ;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"}