Interface PerpetualsVaultWithdrawRequest

Represents a single pending vault withdrawal request.

interface PerpetualsVaultWithdrawRequest {
    lpAmountIn: bigint;
    lpAmountInUsd: number;
    minCollateralAmountOut: bigint;
    minCollateralAmountOutUsd: number;
    requestTimestamp: number;
    userAddress: string;
    vaultId: string;
}

Properties

lpAmountIn: bigint

The amount of the shares requested for withdrawal.

lpAmountInUsd: number

USD valuation of lpAmountIn at request time (or at query time, depending on backend).

This field is provided for UI convenience and may be computed using the vault's LP share price.

minCollateralAmountOut: bigint

The minimum amount of the collateral balance expected as output for this withdrawal

This acts as a slippage/price-protection bound for the user.

minCollateralAmountOutUsd: number

USD valuation of minCollateralAmountOut, using the vault's collateral oracle.

Provided for display; the on-chain constraint is enforced by minCollateralAmountOut (native units).

requestTimestamp: number

Timestamp of request's creation

userAddress: string

The address of the user that created the withdraw request

vaultId: string

Object id of the vault associated with the withdraw request