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

    Type Alias ApiPerpetualsVaultPreviewDepositResponse

    ApiPerpetualsVaultPreviewDepositResponse:
        | { error: string }
        | {
            collateralPrice: number;
            depositedAmountUsd: number;
            lpAmountOut: Balance;
        }

    Response body for vault deposit preview.

    Type Declaration

    • { error: string }
      • error: string

        Error message returned when the operation cannot be completed.

    • { collateralPrice: number; depositedAmountUsd: number; lpAmountOut: Balance }
      • collateralPrice: number

        Collateral price used by the preview, in USD.

      • depositedAmountUsd: number

        Deposit value converted to USD.

      • lpAmountOut: Balance

        LP output in the LP coin's smallest unit.