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

    Interface PoolWithdrawEvent

    Represents a withdrawal event where a user removes liquidity from a pool, burning LP tokens and receiving coin amounts in return.

    interface PoolWithdrawEvent {
        lpBurned: bigint;
        poolId: string;
        timestamp: number | undefined;
        txnDigest: string;
        type: string;
        types: string[];
        withdrawer: string;
        withdrawn: bigint[];
    }

    Hierarchy (View Summary)

    Index
    lpBurned poolId timestamp txnDigest type types withdrawer withdrawn
    lpBurned: bigint

    The amount of LP burned in exchange for these outputs.

    poolId: string

    The pool object ID from which liquidity was withdrawn.

    timestamp: number | undefined

    Timestamp of the event, if available.

    txnDigest: string

    The transaction digest associated with the event.

    type: string

    A string identifying the Move event type.

    types: string[]

    The coin types that were returned upon withdrawal.

    withdrawer: string

    The user who withdrew from the pool.

    withdrawn: bigint[]

    The amounts for each returned coin type.

    Settings
    Member Visibility

    On This Page
    Properties