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

    Interface PoolCoin

    Details about a coin in the pool, including the on-chain balance, trade fees (in/out), deposit/withdraw fees, and decimal scaling factors.

    interface PoolCoin {
        balance: bigint;
        decimals?: number;
        decimalsScalar: bigint;
        depositFee: bigint;
        normalizedBalance: bigint;
        tradeFeeIn: bigint;
        tradeFeeOut: bigint;
        weight: bigint;
        withdrawFee: bigint;
    }
    Index
    balance decimals? decimalsScalar depositFee normalizedBalance tradeFeeIn tradeFeeOut weight withdrawFee
    balance: bigint

    The coin balance in the smallest on-chain unit, such as 1_000_000_000n for one 9-decimal coin.

    decimals?: number

    The coin's display precision. It is absent when the API did not return coin metadata for this pool.

    decimalsScalar: bigint

    The scalar that converts balance into normalizedBalance for the invariant calculation.

    depositFee: bigint

    The fixed-point fee applied when a liquidity deposit adds this coin.

    normalizedBalance: bigint

    The normalized balance consumed by the local AMM math.

    tradeFeeIn: bigint

    The fixed-point fee applied when a swap sends this coin into the pool.

    tradeFeeOut: bigint

    The fixed-point fee applied when a swap sends this coin out of the pool.

    weight: bigint

    The coin's fixed-point weight. Divide by 1e18 to read the decimal fraction used by the invariant.

    withdrawFee: bigint

    The fixed-point fee applied when a liquidity withdrawal removes this coin.

    Settings
    Member Visibility

    On This Page
    Properties