aftermath-ts-sdk - v3.3.3
    Preparing search index...

    Interface PoolObject

    The primary pool object structure stored on-chain. lpCoinType is the minted LP token, coins is a record of coin data.

    interface PoolObject {
        coins: PoolCoins;
        creator: string;
        daoFeePoolObject?: DaoFeePoolObject;
        flatness: bigint;
        illiquidLpCoinSupply: bigint;
        lpCoinDecimals: number;
        lpCoinSupply: bigint;
        lpCoinType: string;
        name: string;
        objectId: string;
        objectType: string;
    }

    Hierarchy (View Summary)

    Index
    coins creator daoFeePoolObject? flatness illiquidLpCoinSupply lpCoinDecimals lpCoinSupply lpCoinType name objectId objectType
    coins: PoolCoins

    A record of coin data for each coin type in the pool.

    creator: string

    The address of the pool's creator.

    daoFeePoolObject?: DaoFeePoolObject

    The optional DAO fee configuration layered around this pool.

    flatness: bigint

    The fixed-point curve parameter used by the pool invariant.

    illiquidLpCoinSupply: bigint

    The LP supply that cannot be withdrawn as liquid liquidity.

    lpCoinDecimals: number

    The decimals used by the LP coin.

    lpCoinSupply: bigint

    The total LP supply in the LP coin's smallest unit.

    lpCoinType: string

    The LP coin type for this pool, e.g., "0x<...>::af_lp::AF_LP_xyz".

    name: string

    The human-readable name of the pool (e.g., "My Weighted Pool").

    objectId: string

    The on-chain object ID.

    objectType: string

    The Move type of the object.

    Settings
    Member Visibility

    On This Page
    Properties