Type Alias ApiPerpetualsVaultPreviewProcessForceWithdrawRequestResponse

Type Declaration

• { error: string }

  • error: string

    Error message returned when the operation cannot be completed.

• {
      collateralAmountOut: Balance;
      collateralPrice: number;
      isWithinWithdrawRequestSlippage: boolean;
      minCollateralAmountOut: Balance;
      performanceFeesChargedUsd: number;
      priceImpact: Percentage;
      sizesToClose: Record<PerpetualsMarketId, bigint>;
  }

  • collateralAmountOut: Balance

    Collateral output in the collateral coin's smallest unit.

  • collateralPrice: number

    Collateral price used by the preview, in USD.

  • isWithinWithdrawRequestSlippage: boolean

    Whether the result remains within the withdrawal request's slippage tolerance.

  • minCollateralAmountOut: Balance

    Minimum collateral amount that must be received to satisfy the request.

  • performanceFeesChargedUsd: number

    Performance fees charged by the operation, denominated in USD.

  • priceImpact: Percentage

    Estimated price impact of processing the force-withdraw request.

  • sizesToClose: Record<PerpetualsMarketId, bigint>

    Position sizes that must be closed to process the force-withdraw request.