IOrderBook

AddLiquidityParams​

  struct AddLiquidityParams(
    address trader
    address baseToken
    uint256 base
    uint256 quote
    int24 lowerTick
    int24 upperTick
    struct Funding.Growth fundingGrowthGlobal
  )

RemoveLiquidityParams​

  struct RemoveLiquidityParams(
    address maker
    address baseToken
    int24 lowerTick
    int24 upperTick
    uint128 liquidity
  )

AddLiquidityResponse​

  struct AddLiquidityResponse(
    uint256 base
    uint256 quote
    uint256 fee
    uint128 liquidity
  )

RemoveLiquidityResponse​

  struct RemoveLiquidityResponse(
    uint256 base
    uint256 quote
    uint256 fee
    int256 takerBase
    int256 takerQuote
  )

ReplaySwapParams​

  struct ReplaySwapParams(
    address baseToken
    bool isBaseToQuote
    bool shouldUpdateState
    int256 amount
    uint160 sqrtPriceLimitX96
    uint24 exchangeFeeRatio
    uint24 uniswapFeeRatio
    struct Funding.Growth globalFundingGrowth
    address pool
    uint24 insuranceFundFeeRatio
  )

ReplaySwapResponse​

  struct ReplaySwapResponse(
    int24 tick
    uint256 fee
    uint256 insuranceFundFee
  )

MintCallbackData​

  struct MintCallbackData(
    address trader
    address pool
  )

Functions​

addLiquidity​

  function addLiquidity(
    struct IOrderBook.AddLiquidityParams params
  ) external returns (struct IOrderBook.AddLiquidityResponse response)

Add liquidity logic

Only used by ClearingHouse contract

Parameters:​

Name	Type	Description
params	struct IOrderBook.AddLiquidityParams	Add liquidity params, detail on IOrderBook.AddLiquidityParams

Return Values:​

Name	Type	Description
response	struct IOrderBook.AddLiquidityResponse	Add liquidity response, detail on IOrderBook.AddLiquidityResponse

removeLiquidity​

  function removeLiquidity(
    struct IOrderBook.RemoveLiquidityParams params
  ) external returns (struct IOrderBook.RemoveLiquidityResponse response)

Remove liquidity logic, only used by ClearingHouse contract

Parameters:​

Name	Type	Description
params	struct IOrderBook.RemoveLiquidityParams	Remove liquidity params, detail on IOrderBook.RemoveLiquidityParams

Return Values:​

Name	Type	Description
response	struct IOrderBook.RemoveLiquidityResponse	Remove liquidity response, detail on IOrderBook.RemoveLiquidityResponse

updateFundingGrowthAndLiquidityCoefficientInFundingPayment​

  function updateFundingGrowthAndLiquidityCoefficientInFundingPayment(
    address trader,
    address baseToken,
    struct Funding.Growth fundingGrowthGlobal
  ) external returns (int256 liquidityCoefficientInFundingPayment)

This is the non-view version of getLiquidityCoefficientInFundingPayment(), only can be called by Exchange contract

Parameters:​

Name	Type	Description
trader	address	The trader address
baseToken	address	The base token address
fundingGrowthGlobal	struct Funding.Growth	The funding growth info, detail on Funding.Growth

Return Values:​

Name	Type	Description
liquidityCoefficientInFundingPayment	int256	the funding payment of all orders/liquidity of a maker

replaySwap​

  function replaySwap(
    struct IOrderBook.ReplaySwapParams params
  ) external returns (struct IOrderBook.ReplaySwapResponse response)

Replay the swap and get the swap result (price impact and swap fee), only can be called by Exchange contract;

ReplaySwapResponse.insuranceFundFee = fee * insuranceFundFeeRatio

Parameters:​

Name	Type	Description
params	struct IOrderBook.ReplaySwapParams	ReplaySwap params, detail on IOrderBook.ReplaySwapParams

Return Values:​

Name	Type	Description
response	struct IOrderBook.ReplaySwapResponse	The swap result encoded in ReplaySwapResponse

updateOrderDebt​

  function updateOrderDebt(
  ) external

getOpenOrderIds​

  function getOpenOrderIds(
    address trader,
    address baseToken
  ) external returns (bytes32[] orderIds)

Get open order ids of a trader in the given market

Parameters:​

Name	Type	Description
trader	address	The trader address
baseToken	address	The base token address

Return Values:​

Name	Type	Description
orderIds	bytes32[]	The open order ids

getOpenOrderById​

  function getOpenOrderById(
    bytes32 orderId
  ) external returns (struct OpenOrder.Info info)

Get open order info by given order id

Parameters:​

Name	Type	Description
orderId	bytes32	The order id

Return Values:​

Name	Type	Description
info	struct OpenOrder.Info	The open order info encoded in OpenOrder.Info

getOpenOrder​

  function getOpenOrder(
    address trader,
    address baseToken,
    int24 upperTick,
    int24 lowerTick
  ) external returns (struct OpenOrder.Info info)

Get open order info by given base token, upper tick and lower tick

Parameters:​

Name	Type	Description
trader	address	The trader address
baseToken	address	The base token address
upperTick	int24	The upper tick
lowerTick	int24	The lower tick

Return Values:​

Name	Type	Description
info	struct OpenOrder.Info	he open order info encoded in OpenOrder.Info

hasOrder​

  function hasOrder(
    address trader,
    address[] tokens
  ) external returns (bool hasOrder)

Check if the specified trader has order in given markets

Parameters:​

Name	Type	Description
trader	address	The trader address
tokens	address[]	The base token addresses

Return Values:​

Name	Type	Description
hasOrder	bool	True if the trader has order in given markets

getTotalQuoteBalanceAndPendingFee​

  function getTotalQuoteBalanceAndPendingFee(
    address trader,
    address[] baseTokens
  ) external returns (int256 totalQuoteAmountInPools, uint256 totalPendingFee)

Get the total quote token amount and pending fees of all orders in given markets

Parameters:​

Name	Type	Description
trader	address	The trader address
baseTokens	address[]	The base token addresses

Return Values:​

Name	Type	Description
totalQuoteAmountInPools	int256	The total quote token amount
totalPendingFee	uint256	The total pending fees in the orders

getTotalTokenAmountInPoolAndPendingFee​

  function getTotalTokenAmountInPoolAndPendingFee(
    address trader,
    address baseToken,
    bool fetchBase
  ) external returns (uint256 tokenAmount, uint256 totalPendingFee)

Get the total token amount (quote or base) and pending fees of all orders in the given market

Parameters:​

Name	Type	Description
trader	address	The trader address
baseToken	address	The base token addresses
fetchBase	bool	True if fetch base token amount, false if fetch quote token amount

Return Values:​

Name	Type	Description
tokenAmount	uint256	The total quote/base token amount
totalPendingFee	uint256	The total pending fees in the orders

getTotalOrderDebt​

  function getTotalOrderDebt(
    address trader,
    address baseToken,
    bool fetchBase
  ) external returns (uint256 debtAmount)

Get the total debt token amount (base or quote) of all orders in the given market

Parameters:​

Name	Type	Description
trader	address	The trader address
baseToken	address	The base token address
fetchBase	bool	True if fetch base token amount, false if fetch quote token amount

Return Values:​

Name	Type	Description
debtAmount	uint256	The total debt token amount

getLiquidityCoefficientInFundingPayment​

  function getLiquidityCoefficientInFundingPayment(
  ) external returns (int256 liquidityCoefficientInFundingPayment)

Get the pending funding payment of all orders in the given market

This is the view version of updateFundingGrowthAndLiquidityCoefficientInFundingPayment(), so only part of the funding payment will be returned. Use it with caution because it does not return all the pending funding payment of orders. Normally you won't need to use this function

Return Values:​

Name	Type	Description
liquidityCoefficientInFundingPayment	int256	the funding payment of all orders/liquidity of a maker

getPendingFee​

  function getPendingFee(
    address trader,
    address baseToken,
    int24 lowerTick,
    int24 upperTick
  ) external returns (uint256 fee)

Get the pending fees of a order

Parameters:​

Name	Type	Description
trader	address	The trader address
baseToken	address	The base token address
lowerTick	int24	The lower tick
upperTick	int24	The upper tick

Return Values:​

Name	Type	Description
fee	uint256	The pending fees

getExchange​

  function getExchange(
  ) external returns (address exchange)

Get Exchange contract address

Return Values:​

Name	Type	Description
exchange	address	The Exchange contract address

Events​

ExchangeChanged​

  event ExchangeChanged(
    address exchange
  )

Emitted when the Exchange contract address changed

Parameters:​

Name	Type	Description
exchange	address	The address of exchange contract