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

    Type Alias ApiPerpetualsVaultPreviewCreateWithdrawRequestResponse

    ApiPerpetualsVaultPreviewCreateWithdrawRequestResponse:
        | { error: string }
        | { collateralAmountOut: Balance; collateralPrice: number }

    Response body for vault withdrawal preview.

    Type Declaration

    • { error: string }
      • error: string

        Error message returned when the operation cannot be completed.

    • { collateralAmountOut: Balance; collateralPrice: number }
      • collateralAmountOut: Balance

        Collateral output in the collateral coin's smallest unit.

      • collateralPrice: number

        Collateral price used by the preview, in USD.