Type alias BuySellPanelEstimateQuantity

BuySellPanelEstimateQuantity: {
    baseQuantity: bigint;
    quoteQuantity?: undefined;
    availableCollateralRatio?: undefined;
} | {
    quoteQuantity: bigint;
    baseQuantity?: undefined;
    availableCollateralRatio?: undefined;
} | {
    availableCollateralRatio: bigint;
    baseQuantity?: undefined;
    quoteQuantity?: undefined;
}

The quantity for a buy/sell panel estimate may be expressed in one of three ways: in base asset terms, in quote asset terms, or as a fraction of the wallet's available collateral to be consumed (the panel's slider; 1 (one pip-fraction, i.e. oneInPips) consumes all available collateral).

Exactly one of the three must be provided.

Type declaration

  • baseQuantity: bigint
  • Optional quoteQuantity?: undefined
  • Optional availableCollateralRatio?: undefined

Type declaration

  • quoteQuantity: bigint
  • Optional baseQuantity?: undefined
  • Optional availableCollateralRatio?: undefined

Type declaration

  • availableCollateralRatio: bigint

    Fraction of available collateral to consume, in pips (0 to oneInPips)

  • Optional baseQuantity?: undefined
  • Optional quoteQuantity?: undefined