aftermath-ts-sdk 1.2.64 → 1.2.65

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

@@ -2,104 +2,319 @@ import { Balance, Event, Object, ObjectId, Percentage, Slippage, SuiAddress, Tim
 import { ManipulateType } from "dayjs";
 import { CoinDecimal, CoinsToBalance, CoinType } from "../coin/coinTypes";
 import { UniqueId } from "../router/routerTypes";
+/**
+ * Name or label used to identify a pool. e.g., "My Stable Pool" or "SUI-COIN LP".
+ */
 export type PoolName = string;
+/**
+ * Represents a coin's weight in a weighted pool, stored as a bigint for
+ * 1e9 or 1e18 style scaling.
+ */
 export type PoolWeight = bigint;
+/**
+ * Represents the trade fee for a coin in the pool, stored as a bigint
+ * in a scaled format (e.g. 1 = 1e9).
+ */
 export type PoolTradeFee = bigint;
+/**
+ * Represents the deposit fee for a coin in the pool, stored as a bigint
+ * in a scaled format.
+ */
 export type PoolDepositFee = bigint;
+/**
+ * Represents the withdrawal fee for a coin in the pool, stored as a bigint
+ * in a scaled format.
+ */
 export type PoolWithdrawFee = bigint;
+/**
+ * Represents "flatness" in a pool, used for certain advanced pool calculations
+ * or invariants. Often 0 or 1, depending on stable vs. uncorrelated logic.
+ */
 export type PoolFlatness = bigint;
+/**
+ * Represents a normalized balance in the pool, often used for
+ * internal calculations to standardize coin decimals.
+ */
 export type NormalizedBalance = bigint;
+/**
+ * A big integer scalar used for decimals conversion (1e9 or 1e18, etc.).
+ */
 export type DecimalsScalar = bigint;
+/**
+ * A record mapping `CoinType` => a `PoolCoin` structure, describing
+ * each coin's weight, balance, fees, and decimal scaling within a pool.
+ */
 export type PoolCoins = Record<CoinType, PoolCoin>;
+/**
+ * Details about a coin in the pool, including the on-chain balance,
+ * trade fees (in/out), deposit/withdraw fees, and decimal scaling factors.
+ */
 export interface PoolCoin {
+    /**
+     * The coin's weight in the pool (e.g., for a weight-based AMM).
+     */
     weight: PoolWeight;
+    /**
+     * The on-chain balance of this coin in the pool.
+     */
     balance: Balance;
+    /**
+     * The inbound trade fee (scaled) for this coin.
+     */
     tradeFeeIn: PoolTradeFee;
+    /**
+     * The outbound trade fee (scaled) for this coin.
+     */
     tradeFeeOut: PoolTradeFee;
+    /**
+     * The deposit fee (scaled) for adding this coin into the pool.
+     */
     depositFee: PoolDepositFee;
+    /**
+     * The withdrawal fee (scaled) for removing this coin from the pool.
+     */
     withdrawFee: PoolWithdrawFee;
+    /**
+     * A scaling factor (like 1e9 or 1e18) used to unify coin decimals
+     * for internal math.
+     */
     decimalsScalar: DecimalsScalar;
+    /**
+     * The "normalized" balance, factoring in `decimalsScalar`.
+     */
     normalizedBalance: NormalizedBalance;
+    /**
+     * The displayed decimals for user-facing reference (e.g., 6, 9, 18).
+     */
     decimals?: CoinDecimal;
 }
+/**
+ * The primary pool object structure stored on-chain.
+ * `lpCoinType` is the minted LP token, `coins` is a record of coin data.
+ */
 export interface PoolObject extends Object {
+    /**
+     * The human-readable name of the pool (e.g., "My Weighted Pool").
+     */
     name: PoolName;
+    /**
+     * The address of the pool's creator.
+     */
     creator: SuiAddress;
+    /**
+     * The LP coin type for this pool, e.g., "0x<...>::af_lp::AF_LP_xyz".
+     */
     lpCoinType: CoinType;
+    /**
+     * The total supply of LP tokens currently minted.
+     */
     lpCoinSupply: Balance;
+    /**
+     * The amount of LP tokens that are illiquid (locked for some reason).
+     */
     illiquidLpCoinSupply: Balance;
+    /**
+     * A "flatness" parameter used for stable vs. uncorrelated logic. 0 or 1 typically.
+     */
     flatness: PoolFlatness;
+    /**
+     * A record of coin data for each coin type in the pool.
+     */
     coins: PoolCoins;
+    /**
+     * The decimals used by the LP coin.
+     */
     lpCoinDecimals: CoinDecimal;
+    /**
+     * An optional DAO fee object, if the pool is configured to support a fee for a DAO or treasury.
+     */
     daoFeePoolObject?: DaoFeePoolObject;
 }
+/**
+ * Minimal information about a user's LP coin in a specific pool,
+ * including the pool ID and balance of that LP coin type.
+ */
 export interface PoolLpInfo {
     lpCoinType: CoinType;
     poolId: ObjectId;
     balance: Balance;
 }
+/**
+ * An on-chain object representing DAO fee configuration for a pool:
+ * it stores the fee basis points and the fee recipient address.
+ */
 export interface DaoFeePoolObject extends Object {
+    /**
+     * The fee in basis points, e.g., 100 => 1%.
+     */
     feeBps: bigint;
+    /**
+     * The Sui address receiving the fee portion from trades or other actions.
+     */
     feeRecipient: SuiAddress;
 }
+/**
+ * A capability object indicating ownership of a `DaoFeePoolObject`.
+ * Whomever holds this can update the fee parameters or recipient.
+ */
 export interface DaoFeePoolOwnerCapObject extends Object {
+    /**
+     * The `DaoFeePoolObject` ID this cap is associated with.
+     */
     daoFeePoolId: ObjectId;
 }
+/**
+ * Represents a trade event within a pool, indicating coins in/out,
+ * final amounts, etc.
+ */
 export interface PoolTradeEvent extends Event {
     poolId: ObjectId;
     trader: SuiAddress;
+    /**
+     * The array of coin types that were spent in the trade.
+     */
     typesIn: CoinType[];
+    /**
+     * The amounts of each coin type that were spent.
+     */
     amountsIn: Balance[];
+    /**
+     * The coin types that were received.
+     */
     typesOut: CoinType[];
+    /**
+     * The amounts of each output coin.
+     */
     amountsOut: Balance[];
 }
+/**
+ * Represents a deposit event where a user adds liquidity to a pool,
+ * receiving minted LP tokens in return.
+ */
 export interface PoolDepositEvent extends Event {
     poolId: ObjectId;
+    /**
+     * The address that deposited into the pool.
+     */
     depositor: SuiAddress;
+    /**
+     * The coin types that were deposited.
+     */
     types: CoinType[];
+    /**
+     * The amounts for each deposited coin type.
+     */
     deposits: Balance[];
+    /**
+     * The amount of LP minted for the depositor.
+     */
     lpMinted: Balance;
 }
+/**
+ * Represents a withdrawal event where a user removes liquidity from a pool,
+ * burning LP tokens and receiving coin amounts in return.
+ */
 export interface PoolWithdrawEvent extends Event {
     poolId: ObjectId;
+    /**
+     * The user who withdrew from the pool.
+     */
     withdrawer: SuiAddress;
+    /**
+     * The coin types that were returned upon withdrawal.
+     */
     types: CoinType[];
+    /**
+     * The amounts for each returned coin type.
+     */
     withdrawn: Balance[];
+    /**
+     * The amount of LP burned in exchange for these outputs.
+     */
     lpBurned: Balance;
 }
+/**
+ * Fired when a new DAO fee pool is created for a specific internal pool.
+ */
 export interface CreatedDaoFeePoolEvent extends Event {
     daoFeePoolId: ObjectId;
     innerPoolId: ObjectId;
     feeBps: bigint;
     feeRecipient: SuiAddress;
 }
+/**
+ * Fired when the fee basis points in a `DaoFeePoolObject` are updated.
+ */
 export interface UpdatedFeeBpsEvent extends Event {
     daoFeePoolId: ObjectId;
     oldFeeBps: bigint;
     newFeeBps: bigint;
 }
+/**
+ * Fired when the fee recipient address in a `DaoFeePoolObject` changes.
+ */
 export interface UpdatedFeeRecipientEvent extends Event {
     daoFeePoolId: ObjectId;
     oldFeeAddress: SuiAddress;
     newFeeAddress: SuiAddress;
 }
+/**
+ * Basic statistical data about a pool, including volume, TVL, supply per LPS,
+ * fees, and APR.
+ */
 export interface PoolStats {
+    /**
+     * The 24-hour volume or some aggregated volume metric for the pool.
+     */
     volume: number;
+    /**
+     * The total value locked in the pool, often in USD or stablecoin value.
+     */
     tvl: number;
+    /**
+     * A representation of the distribution of supply among liquidity providers,
+     * e.g., how many tokens each user holds. May be used for advanced UI.
+     */
     supplyPerLps: number[];
+    /**
+     * The price of 1 LP token in reference to a stable baseline (USD).
+     */
     lpPrice: number;
+    /**
+     * The total fees generated by the pool in a given period (often 24h or 7d).
+     */
     fees: number;
+    /**
+     * The approximate annual percentage rate (yield) derived from fees, volume, or
+     * other data. This can be used to estimate LP profits or compare pools.
+     */
     apr: number;
 }
+/**
+ * Represents a data point for pool analytics, including a Unix timestamp (in ms)
+ * and a numeric value (e.g., volume or fee data).
+ */
 export interface PoolDataPoint {
     time: Timestamp;
     value: number;
 }
+/**
+ * Supported timeframes for graphing or fetching historical data:
+ * 1 day, 1 week, 1 month, 3 months, 6 months, or 1 year.
+ */
 export type PoolGraphDataTimeframeKey = "1D" | "1W" | "1M" | "3M" | "6M" | "1Y";
+/**
+ * An optional object or approach to define timeframe windows, using
+ * dayjs manipulation. Not always used directly.
+ */
 export interface PoolGraphDataTimeframe {
     time: Timestamp;
     timeUnit: ManipulateType;
 }
+/**
+ * An object describing how each coin in a newly created pool is configured,
+ * including initial deposit, weight, and fees.
+ */
 export interface PoolCreationCoinInfo {
     coinType: CoinType;
     weight: PoolWeight;
@@ -110,11 +325,18 @@ export interface PoolCreationCoinInfo {
     withdrawFee: PoolWithdrawFee;
     initialDeposit: Balance;
 }
+/**
+ * Metadata for the newly published LP coin, specifying name, symbol, and optional icon URL.
+ */
 export interface PoolCreationLpCoinMetadata {
     name: string;
     symbol: string;
     iconUrl?: Url;
 }
+/**
+ * A data structure used for integration with CoinGecko, representing
+ * an aggregated ticker ID, base/target coins, price, volumes, and liquidity.
+ */
 export interface CoinGeckoTickerData {
     ticker_id: UniqueId;
     base_currency: CoinType;
@@ -125,6 +347,10 @@ export interface CoinGeckoTickerData {
     target_volume: number;
     liquidity_in_usd: number;
 }
+/**
+ * Represents a historical trade record for integration with CoinGecko,
+ * storing a trade ID, price, volumes, timestamp, and buy/sell type.
+ */
 export interface CoinGeckoHistoricalTradeData {
     trade_id: UniqueId;
     price: number;
@@ -133,6 +359,10 @@ export interface CoinGeckoHistoricalTradeData {
     trade_timestamp: Timestamp;
     type: "buy" | "sell";
 }
+/**
+ * Request body for a user trade, specifying which coin to send in and how much,
+ * which coin to receive, plus slippage and optional referral info.
+ */
 export interface ApiPoolTradeBody {
     walletAddress: SuiAddress;
     coinInType: CoinType;
@@ -142,6 +372,10 @@ export interface ApiPoolTradeBody {
     referrer?: SuiAddress;
     isSponsoredTx?: boolean;
 }
+/**
+ * Request body for depositing liquidity into a pool, specifying the amounts in,
+ * slippage, and optional referral or sponsorship data.
+ */
 export interface ApiPoolDepositBody {
     walletAddress: SuiAddress;
     amountsIn: CoinsToBalance;
@@ -149,6 +383,10 @@ export interface ApiPoolDepositBody {
     referrer?: SuiAddress;
     isSponsoredTx?: boolean;
 }
+/**
+ * Request body for withdrawing specific amounts from the pool, specifying
+ * which coins to remove, how much LP is burned, slippage, etc.
+ */
 export interface ApiPoolWithdrawBody {
     walletAddress: SuiAddress;
     amountsOutDirection: CoinsToBalance;
@@ -156,15 +394,27 @@ export interface ApiPoolWithdrawBody {
     slippage: Slippage;
     referrer?: SuiAddress;
 }
+/**
+ * Request body for withdrawing all coin types from a pool using a single
+ * ratio or entire LP amount, simplifying the multi-coin approach.
+ */
 export interface ApiPoolAllCoinWithdrawBody {
     walletAddress: SuiAddress;
     lpCoinAmount: Balance;
     referrer?: SuiAddress;
 }
+/**
+ * Request body for publishing a new LP coin on-chain,
+ * typically specifying the coin's decimals.
+ */
 export interface ApiPublishLpCoinBody {
     walletAddress: SuiAddress;
-    lpCoinDecimals: CoinDecimal;
+    lpCoinDecimals: number;
 }
+/**
+ * Request body for creating a new pool, specifying coin information,
+ * the LP coin metadata, and optional DAO fee info.
+ */
 export interface ApiCreatePoolBody {
     walletAddress: SuiAddress;
     lpCoinType: CoinType;
@@ -172,7 +422,7 @@ export interface ApiCreatePoolBody {
     coinsInfo: {
         coinType: CoinType;
         weight: Percentage;
-        decimals?: CoinDecimal;
+        decimals?: number;
         tradeFeeIn: Percentage;
         initialDeposit: Balance;
     }[];
@@ -188,16 +438,31 @@ export interface ApiCreatePoolBody {
         feeRecipient: SuiAddress;
     };
 }
+/**
+ * For retrieving the spot price of a pool, specifying coin in/out.
+ * Not always used directly, but present in certain route building contexts.
+ */
 export interface ApiPoolSpotPriceBody {
     coinInType: CoinType;
     coinOutType: CoinType;
 }
+/**
+ * Request body for obtaining a pool object ID from an LP coin type.
+ * Useful to confirm if a coin is indeed an LP token and which pool it references.
+ */
 export interface ApiPoolObjectIdForLpCoinTypeBody {
     lpCoinTypes: CoinType[];
 }
+/**
+ * Request body for fetching statistics about one or more pools.
+ */
 export interface ApiPoolsStatsBody {
     poolIds: ObjectId[];
 }
+/**
+ * Request body for listing the owned DAO fee pool owner caps,
+ * letting a user see if they can update fees/recipients in certain pools.
+ */
 export interface ApiPoolsOwnedDaoFeePoolOwnerCapsBody {
     walletAddress: SuiAddress;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"poolsTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/pools/poolsTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,OAAO,EACP,KAAK,EACL,MAAM,EACN,QAAQ,EACR,UAAU,EACV,QAAQ,EACR,UAAU,EACV,SAAS,EACT,GAAG,EACH,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAQjD,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAChC,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAClC,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AACpC,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AACrC,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAClC,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACvC,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AAMpC,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAEnD,MAAM,WAAW,QAAQ;IACxB,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,YAAY,CAAC;IACzB,WAAW,EAAE,YAAY,CAAC;IAC1B,UAAU,EAAE,cAAc,CAAC;IAC3B,WAAW,EAAE,eAAe,CAAC;IAC7B,cAAc,EAAE,cAAc,CAAC;IAC/B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,QAAQ,CAAC,EAAE,WAAW,CAAC;CACvB;AAED,MAAM,WAAW,UAAW,SAAQ,MAAM;IACzC,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,UAAU,CAAC;IACpB,UAAU,EAAE,QAAQ,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,oBAAoB,EAAE,OAAO,CAAC;IAC9B,QAAQ,EAAE,YAAY,CAAC;IACvB,KAAK,EAAE,SAAS,CAAC;IACjB,cAAc,EAAE,WAAW,CAAC;IAC5B,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACpC;AAED,MAAM,WAAW,UAAU;IAC1B,UAAU,EAAE,QAAQ,CAAC;IACrB,MAAM,EAAE,QAAQ,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,gBAAiB,SAAQ,MAAM;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,UAAU,CAAC;CACzB;AAED,MAAM,WAAW,wBAAyB,SAAQ,MAAM;IACvD,YAAY,EAAE,QAAQ,CAAC;CACvB;AAMD,MAAM,WAAW,cAAe,SAAQ,KAAK;IAC5C,MAAM,EAAE,QAAQ,CAAC;IACjB,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,QAAQ,EAAE,CAAC;IACpB,SAAS,EAAE,OAAO,EAAE,CAAC;IACrB,QAAQ,EAAE,QAAQ,EAAE,CAAC;IACrB,UAAU,EAAE,OAAO,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,gBAAiB,SAAQ,KAAK;IAC9C,MAAM,EAAE,QAAQ,CAAC;IACjB,SAAS,EAAE,UAAU,CAAC;IACtB,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,iBAAkB,SAAQ,KAAK;IAC/C,MAAM,EAAE,QAAQ,CAAC;IACjB,UAAU,EAAE,UAAU,CAAC;IACvB,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,SAAS,EAAE,OAAO,EAAE,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,sBAAuB,SAAQ,KAAK;IACpD,YAAY,EAAE,QAAQ,CAAC;IACvB,WAAW,EAAE,QAAQ,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,UAAU,CAAC;CACzB;AAED,MAAM,WAAW,kBAAmB,SAAQ,KAAK;IAChD,YAAY,EAAE,QAAQ,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,wBAAyB,SAAQ,KAAK;IACtD,YAAY,EAAE,QAAQ,CAAC;IACvB,aAAa,EAAE,UAAU,CAAC;IAC1B,aAAa,EAAE,UAAU,CAAC;CAC1B;AAMD,MAAM,WAAW,SAAS;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,aAAa;IAC7B,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,yBAAyB,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;AAEhF,MAAM,WAAW,sBAAsB;IACtC,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,EAAE,cAAc,CAAC;CACzB;AAMD,MAAM,WAAW,oBAAoB;IACpC,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,UAAU,CAAC;IACnB,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB,UAAU,EAAE,YAAY,CAAC;IACzB,WAAW,EAAE,YAAY,CAAC;IAC1B,UAAU,EAAE,cAAc,CAAC;IAC3B,WAAW,EAAE,eAAe,CAAC;IAC7B,cAAc,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,0BAA0B;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,GAAG,CAAC;CACd;AAMD,MAAM,WAAW,mBAAmB;IACnC,SAAS,EAAE,QAAQ,CAAC;IACpB,aAAa,EAAE,QAAQ,CAAC;IACxB,eAAe,EAAE,QAAQ,CAAC;IAC1B,OAAO,EAAE,QAAQ,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,4BAA4B;IAC5C,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,SAAS,CAAC;IAC3B,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC;CACrB;AAUD,MAAM,WAAW,gBAAgB;IAChC,aAAa,EAAE,UAAU,CAAC;IAC1B,UAAU,EAAE,QAAQ,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,WAAW,EAAE,QAAQ,CAAC;IACtB,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IAClC,aAAa,EAAE,UAAU,CAAC;IAC1B,SAAS,EAAE,cAAc,CAAC;IAC1B,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IACnC,aAAa,EAAE,UAAU,CAAC;IAC1B,mBAAmB,EAAE,cAAc,CAAC;IACpC,YAAY,EAAE,OAAO,CAAC;IACtB,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,CAAC,EAAE,UAAU,CAAC;CACtB;AAED,MAAM,WAAW,0BAA0B;IAC1C,aAAa,EAAE,UAAU,CAAC;IAC1B,YAAY,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,UAAU,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACpC,aAAa,EAAE,UAAU,CAAC;IAC1B,cAAc,EAAE,WAAW,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IACjC,aAAa,EAAE,UAAU,CAAC;IAC1B,UAAU,EAAE,QAAQ,CAAC;IACrB,cAAc,EAAE,0BAA0B,CAAC;IAC3C,SAAS,EAAE;QACV,QAAQ,EAAE,QAAQ,CAAC;QACnB,MAAM,EAAE,UAAU,CAAC;QAGnB,QAAQ,CAAC,EAAE,WAAW,CAAC;QACvB,UAAU,EAAE,UAAU,CAAC;QACvB,cAAc,EAAE,OAAO,CAAC;KACxB,EAAE,CAAC;IACJ,QAAQ,EAAE,QAAQ,CAAC;IACnB,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC;IACpB,eAAe,EAAE,QAAQ,CAAC;IAC1B,eAAe,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE,WAAW,CAAC;IAC9B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE;QACZ,aAAa,EAAE,UAAU,CAAC;QAC1B,YAAY,EAAE,UAAU,CAAC;KACzB,CAAC;CACF;AAMD,MAAM,WAAW,oBAAoB;IACpC,UAAU,EAAE,QAAQ,CAAC;IACrB,WAAW,EAAE,QAAQ,CAAC;CACtB;AAED,MAAM,WAAW,gCAAgC;IAChD,WAAW,EAAE,QAAQ,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IACjC,OAAO,EAAE,QAAQ,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,oCAAoC;IACpD,aAAa,EAAE,UAAU,CAAC;CAC1B"}
+{"version":3,"file":"poolsTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/pools/poolsTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,OAAO,EACP,KAAK,EACL,MAAM,EACN,QAAQ,EACR,UAAU,EACV,QAAQ,EACR,UAAU,EACV,SAAS,EACT,GAAG,EACH,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAEhC;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AAEpC;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AAEpC;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAEnD;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACxB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,UAAU,EAAE,YAAY,CAAC;IACzB;;OAEG;IACH,WAAW,EAAE,YAAY,CAAC;IAC1B;;OAEG;IACH,UAAU,EAAE,cAAc,CAAC;IAC3B;;OAEG;IACH,WAAW,EAAE,eAAe,CAAC;IAC7B;;;OAGG;IACH,cAAc,EAAE,cAAc,CAAC;IAC/B;;OAEG;IACH,iBAAiB,EAAE,iBAAiB,CAAC;IACrC;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,MAAM;IACzC;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,UAAU,CAAC;IACpB;;OAEG;IACH,UAAU,EAAE,QAAQ,CAAC;IACrB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC;IACvB;;OAEG;IACH,KAAK,EAAE,SAAS,CAAC;IACjB;;OAEG;IACH,cAAc,EAAE,WAAW,CAAC;IAC5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B,UAAU,EAAE,QAAQ,CAAC;IACrB,MAAM,EAAE,QAAQ,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,MAAM;IAC/C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,YAAY,EAAE,UAAU,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,MAAM;IACvD;;OAEG;IACH,YAAY,EAAE,QAAQ,CAAC;CACvB;AAMD;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,KAAK;IAC5C,MAAM,EAAE,QAAQ,CAAC;IACjB,MAAM,EAAE,UAAU,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,QAAQ,EAAE,CAAC;IACpB;;OAEG;IACH,SAAS,EAAE,OAAO,EAAE,CAAC;IACrB;;OAEG;IACH,QAAQ,EAAE,QAAQ,EAAE,CAAC;IACrB;;OAEG;IACH,UAAU,EAAE,OAAO,EAAE,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,KAAK;IAC9C,MAAM,EAAE,QAAQ,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC;IACtB;;OAEG;IACH,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,KAAK;IAC/C,MAAM,EAAE,QAAQ,CAAC;IACjB;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,OAAO,EAAE,CAAC;IACrB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,KAAK;IACpD,YAAY,EAAE,QAAQ,CAAC;IACvB,WAAW,EAAE,QAAQ,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,UAAU,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,KAAK;IAChD,YAAY,EAAE,QAAQ,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,KAAK;IACtD,YAAY,EAAE,QAAQ,CAAC;IACvB,aAAa,EAAE,UAAU,CAAC;IAC1B,aAAa,EAAE,UAAU,CAAC;CAC1B;AAMD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;AAEhF;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACtC,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,EAAE,cAAc,CAAC;CACzB;AAMD;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,UAAU,CAAC;IACnB,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB,UAAU,EAAE,YAAY,CAAC;IACzB,WAAW,EAAE,YAAY,CAAC;IAC1B,UAAU,EAAE,cAAc,CAAC;IAC3B,WAAW,EAAE,eAAe,CAAC;IAC7B,cAAc,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,GAAG,CAAC;CACd;AAMD;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,SAAS,EAAE,QAAQ,CAAC;IACpB,aAAa,EAAE,QAAQ,CAAC;IACxB,eAAe,EAAE,QAAQ,CAAC;IAC1B,OAAO,EAAE,QAAQ,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC5C,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,SAAS,CAAC;IAC3B,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC;CACrB;AAMD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAChC,aAAa,EAAE,UAAU,CAAC;IAC1B,UAAU,EAAE,QAAQ,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,WAAW,EAAE,QAAQ,CAAC;IACtB,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAClC,aAAa,EAAE,UAAU,CAAC;IAC1B,SAAS,EAAE,cAAc,CAAC;IAC1B,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,aAAa,EAAE,UAAU,CAAC;IAC1B,mBAAmB,EAAE,cAAc,CAAC;IACpC,YAAY,EAAE,OAAO,CAAC;IACtB,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,CAAC,EAAE,UAAU,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IAC1C,aAAa,EAAE,UAAU,CAAC;IAC1B,YAAY,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,UAAU,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC,aAAa,EAAE,UAAU,CAAC;IAC1B,cAAc,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IACjC,aAAa,EAAE,UAAU,CAAC;IAC1B,UAAU,EAAE,QAAQ,CAAC;IACrB,cAAc,EAAE,0BAA0B,CAAC;IAC3C,SAAS,EAAE;QACV,QAAQ,EAAE,QAAQ,CAAC;QACnB,MAAM,EAAE,UAAU,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,UAAU,CAAC;QACvB,cAAc,EAAE,OAAO,CAAC;KACxB,EAAE,CAAC;IACJ,QAAQ,EAAE,QAAQ,CAAC;IACnB,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC;IACpB,eAAe,EAAE,QAAQ,CAAC;IAC1B,eAAe,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE,WAAW,CAAC;IAC9B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE;QACZ,aAAa,EAAE,UAAU,CAAC;QAC1B,YAAY,EAAE,UAAU,CAAC;KACzB,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC,UAAU,EAAE,QAAQ,CAAC;IACrB,WAAW,EAAE,QAAQ,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAChD,WAAW,EAAE,QAAQ,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IACjC,OAAO,EAAE,QAAQ,EAAE,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,oCAAoC;IACpD,aAAa,EAAE,UAAU,CAAC;CAC1B"}

package/dist/packages/referralVault/referralVault.d.ts

@@ -1,13 +1,50 @@
 import { AftermathApi } from "../../general/providers";
 import { Caller } from "../../general/utils/caller";
 import { CallerConfig, SuiAddress } from "../../types";
+/**
+ * The `ReferralVault` class provides functionality for querying and managing
+ * referral information within the Aftermath protocol. It allows you to look
+ * up the referrer for a given address.
+ */
 export declare class ReferralVault extends Caller {
     private readonly Provider?;
+    /**
+     * Contains static configuration relevant to the referral system, if any.
+     * Currently empty but can be extended for future needs.
+     */
     static readonly constants: {};
+    /**
+     * Creates a new instance of `ReferralVault` to interact with referral-related
+     * features in the Aftermath protocol.
+     *
+     * @param config - Optional caller configuration, including Sui network and access token.
+     * @param Provider - An optional `AftermathApi` provider instance for referral-specific methods.
+     */
     constructor(config?: CallerConfig, Provider?: AftermathApi | undefined);
+    /**
+     * Retrieves the referrer address for a specified referee (user).
+     *
+     * @param inputs - An object containing the `referee` Sui address.
+     * @returns A promise that resolves to either the referrer's `SuiAddress` or the string `"None"` if no referrer exists.
+     *
+     * @example
+     * ```typescript
+     * const afSdk = new Aftermath("MAINNET");
+     * await afSdk.init(); // initialize provider
+     *
+     * const referralVault = afSdk.ReferralVault();
+     *
+     * const referrer = await referralVault.getReferrer({ referee: "0x<user_address>" });
+     * console.log("Referrer address:", referrer);
+     * ```
+     */
     getReferrer(inputs: {
         referee: SuiAddress;
     }): Promise<SuiAddress | "None">;
+    /**
+     * Internal helper to retrieve the configured `ReferralVault` provider from
+     * `AftermathApi`, throwing an error if not defined.
+     */
     private useProvider;
 }
 //# sourceMappingURL=referralVault.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"referralVault.d.ts","sourceRoot":"","sources":["../../../src/packages/referralVault/referralVault.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,UAAU,EAAmB,MAAM,aAAa,CAAC;AAExE,qBAAa,aAAc,SAAQ,MAAM;IAavC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAR3B,gBAAuB,SAAS,KAAM;gBAOrC,MAAM,CAAC,EAAE,YAAY,EACJ,QAAQ,CAAC,0BAAc;IAS5B,WAAW,CAAC,MAAM,EAAE;QAChC,OAAO,EAAE,UAAU,CAAC;KACpB,GAAG,OAAO,CAAC,UAAU,GAAG,MAAM,CAAC;IAQhC,OAAO,CAAC,WAAW,CAIjB;CACF"}
+{"version":3,"file":"referralVault.d.ts","sourceRoot":"","sources":["../../../src/packages/referralVault/referralVault.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,UAAU,EAAmB,MAAM,aAAa,CAAC;AAExE;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,MAAM;IAwBvC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAnB3B;;;OAGG;IACH,gBAAuB,SAAS,KAAM;IAMtC;;;;;;OAMG;gBAEF,MAAM,CAAC,EAAE,YAAY,EACJ,QAAQ,CAAC,0BAAc;IASzC;;;;;;;;;;;;;;;;OAgBG;IACU,WAAW,CAAC,MAAM,EAAE;QAChC,OAAO,EAAE,UAAU,CAAC;KACpB,GAAG,OAAO,CAAC,UAAU,GAAG,MAAM,CAAC;IAQhC;;;OAGG;IACH,OAAO,CAAC,WAAW,CAIjB;CACF"}

package/dist/packages/referralVault/referralVault.js

@@ -11,16 +11,32 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReferralVault = void 0;
 const caller_1 = require("../../general/utils/caller");
+/**
+ * The `ReferralVault` class provides functionality for querying and managing
+ * referral information within the Aftermath protocol. It allows you to look
+ * up the referrer for a given address.
+ */
 class ReferralVault extends caller_1.Caller {
     // =========================================================================
     //  Constructor
     // =========================================================================
+    /**
+     * Creates a new instance of `ReferralVault` to interact with referral-related
+     * features in the Aftermath protocol.
+     *
+     * @param config - Optional caller configuration, including Sui network and access token.
+     * @param Provider - An optional `AftermathApi` provider instance for referral-specific methods.
+     */
     constructor(config, Provider) {
         super(config, "referral-vault");
         this.Provider = Provider;
         // =========================================================================
         //  Private Helpers
         // =========================================================================
+        /**
+         * Internal helper to retrieve the configured `ReferralVault` provider from
+         * `AftermathApi`, throwing an error if not defined.
+         */
         this.useProvider = () => {
             var _a;
             const provider = (_a = this.Provider) === null || _a === void 0 ? void 0 : _a.ReferralVault();
@@ -32,6 +48,23 @@ class ReferralVault extends caller_1.Caller {
     // =========================================================================
     //  Inspections
     // =========================================================================
+    /**
+     * Retrieves the referrer address for a specified referee (user).
+     *
+     * @param inputs - An object containing the `referee` Sui address.
+     * @returns A promise that resolves to either the referrer's `SuiAddress` or the string `"None"` if no referrer exists.
+     *
+     * @example
+     * ```typescript
+     * const afSdk = new Aftermath("MAINNET");
+     * await afSdk.init(); // initialize provider
+     *
+     * const referralVault = afSdk.ReferralVault();
+     *
+     * const referrer = await referralVault.getReferrer({ referee: "0x<user_address>" });
+     * console.log("Referrer address:", referrer);
+     * ```
+     */
     getReferrer(inputs) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.fetchApi(`${inputs.referee}/referrer`);
@@ -42,4 +75,8 @@ exports.ReferralVault = ReferralVault;
 // =========================================================================
 //  Constants
 // =========================================================================
+/**
+ * Contains static configuration relevant to the referral system, if any.
+ * Currently empty but can be extended for future needs.
+ */
 ReferralVault.constants = {};