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

    Interface ApiCreatePoolBody

    Request body for creating a new pool, specifying coin information, the LP coin metadata, and optional DAO fee info.

    interface ApiCreatePoolBody {
        burnLpCoin?: boolean;
        coinsInfo: {
            coinType: string;
            decimals?: number;
            initialDeposit: bigint;
            tradeFeeIn: number;
            weight: number;
        }[];
        createPoolCapId: string;
        daoFeeInfo?: { feePercentage: number; feeRecipient: string };
        forceLpDecimals?: number;
        isSponsoredTx?: boolean;
        lpCoinMetadata: PoolCreationLpCoinMetadata;
        lpCoinType: string;
        poolFlatness: 0 | 1;
        poolName: string;
        respectDecimals: boolean;
        walletAddress: string;
    }
    Index
    burnLpCoin? coinsInfo createPoolCapId daoFeeInfo? forceLpDecimals? isSponsoredTx? lpCoinMetadata lpCoinType poolFlatness poolName respectDecimals walletAddress
    burnLpCoin?: boolean

    Whether the LP coin is burned as part of the creation flow.

    coinsInfo: {
        coinType: string;
        decimals?: number;
        initialDeposit: bigint;
        tradeFeeIn: number;
        weight: number;
    }[]

    Per-coin weights, fees, decimal metadata, and initial deposits.

    Type Declaration

    • coinType: string

      The fully qualified coin type deposited into the pool.

    • Optionaldecimals?: number

      Optional display precision stored for this coin.

    • initialDeposit: bigint

      The initial amount in the coin's smallest unit.

    • tradeFeeIn: number

      The decimal fraction charged when this coin enters a swap.

    • weight: number

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

    createPoolCapId: string

    The capability object that authorizes pool creation.

    daoFeeInfo?: { feePercentage: number; feeRecipient: string }

    Optional DAO fee configuration for the new pool.

    Type Declaration

    • feePercentage: number

      The DAO fee as a decimal fraction. 0.01 is 1%.

    • feeRecipient: string

      The Sui address that receives the DAO fee.

    forceLpDecimals?: number

    Optional decimal precision forced for the LP coin.

    isSponsoredTx?: boolean

    Whether coin selection is prepared for a sponsored transaction.

    lpCoinMetadata: PoolCreationLpCoinMetadata

    Metadata for the LP coin published for the pool.

    lpCoinType: string

    The fully qualified LP coin type used by the new pool.

    poolFlatness: 0 | 1

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

    poolName: string

    The display name assigned to the pool object.

    respectDecimals: boolean

    Whether the transaction should preserve the supplied coin decimals.

    walletAddress: string

    The wallet that owns the pool-creation capability and initial coins.

    Settings
    Member Visibility

    On This Page
    Properties