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

    Interface PerpetualsVaultLpCoin

    Representation of an LP (share) coin position for a specific vault.

    This is typically returned by API endpoints that enumerate a wallet's vault positions. lpAmount is the raw on-chain balance for the vault's LP coin type.

    Notes:

    • lpAmountUsd is a convenience valuation derived from current vault TVL and LP supply.
    • The LP coin itself is an on-chain Coin<T> object, but here we expose the derived, aggregated view needed by UIs.
    interface PerpetualsVaultLpCoin {
        depositedAmountUsd: number;
        lpAmount: bigint;
        lpAmountUsd: number;
        objectId: string;
        vaultId: string;
    }
    Index
    depositedAmountUsd lpAmount lpAmountUsd objectId vaultId
    depositedAmountUsd: number

    USD value of the deposit.

    lpAmount: bigint

    Raw LP token amount (native units; not human-decimal adjusted).

    lpAmountUsd: number

    Estimated USD value of lpAmount at query time.

    objectId: string

    Object ID of the specific LP coin object held by the user.

    vaultId: string

    Vault identifier that minted the LP coin.

    Settings
    Member Visibility

    On This Page
    Properties