aftermath-ts-sdk - v6.1.0
    Preparing search index...

    Interface ApiPublishLpCoinBody

    Request body for publishing a new LP coin on-chain, typically specifying the coin's decimals.

    interface ApiPublishLpCoinBody {
        coinsInfo: { coinType: string; decimals?: number; weight: number }[];
        lpCoinMetadata: PoolCreationLpCoinMetadata;
        poolFlatness: 0 | 1;
        respectDecimals: boolean;
        walletAddress: string;
    }
    Index
    coinsInfo lpCoinMetadata poolFlatness respectDecimals walletAddress
    coinsInfo: { coinType: string; decimals?: number; weight: number }[]

    Per-coin type, weight, and decimals templated into the LP coin package.

    Type Declaration

    • coinType: string

      The fully qualified coin type deposited into the pool.

    • Optionaldecimals?: number

      Optional display precision stored for this coin.

    • weight: number

      The decimal weight for this coin. Weights must sum to 1.

    lpCoinMetadata: PoolCreationLpCoinMetadata

    Name, symbol, optional icon, and optional description templated into the LP coin.

    poolFlatness: 0 | 1

    The pool curve mode passed to Move as a flatness value.

    respectDecimals: boolean

    Whether the supplied coin decimals are preserved for the LP coin.

    walletAddress: string

    The wallet that publishes the LP coin package and receives the pool-creation cap.

    Settings
    Member Visibility

    On This Page
    Properties