OrderBook

InternalAddLiquidityToOrderParams​

  struct InternalAddLiquidityToOrderParams(
    address maker
    address baseToken
    address pool
    int24 lowerTick
    int24 upperTick
    uint256 feeGrowthGlobalX128
    uint128 liquidity
    uint256 base
    uint256 quote
    struct Funding.Growth globalFundingGrowth
  )

InternalRemoveLiquidityParams​

  struct InternalRemoveLiquidityParams(
    address maker
    address baseToken
    address pool
    bytes32 orderId
    int24 lowerTick
    int24 upperTick
    uint128 liquidity
  )

InternalSwapStep​

  struct InternalSwapStep(
    uint160 initialSqrtPriceX96
    int24 nextTick
    bool isNextTickInitialized
    uint160 nextSqrtPriceX96
    uint256 amountIn
    uint256 amountOut
    uint256 fee
  )

Functions​

initialize​

  function initialize(
  ) external

setExchange​

  function setExchange(
  ) external

addLiquidity​

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

Add liquidity logic

Only used by ClearingHouse contract

Parameters:​

Return Values:​

removeLiquidity​

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

Remove liquidity logic, only used by ClearingHouse contract

Parameters:​

Return Values:​

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:​

Return Values:​

updateOrderDebt​

  function updateOrderDebt(
  ) external

uniswapV3MintCallback​

  function uniswapV3MintCallback(
    uint256 amount0Owed,
    uint256 amount1Owed,
    bytes data
  ) external

Called to msg.sender after minting liquidity to a position from IUniswapV3Pool#mint.

In the implementation you must pay the pool tokens owed for the minted liquidity. The caller of this method must be checked to be a UniswapV3Pool deployed by the canonical UniswapV3Factory.

Parameters:​

replaySwap​

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

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:​

Return Values:​

getExchange​

  function getExchange(
  ) external returns (address)

Get Exchange contract address

Return Values:​

getOpenOrderIds​

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

Get open order ids of a trader in the given market

Parameters:​

Return Values:​

getOpenOrderById​

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

Get open order info by given order id

Parameters:​

Return Values:​

getOpenOrder​

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

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

Parameters:​

Return Values:​

hasOrder​

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

Check if the specified trader has order in given markets

Parameters:​

Return Values:​

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:​

Return Values:​

getTotalTokenAmountInPoolAndPendingFee​

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

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

Parameters:​

Return Values:​

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:​

getPendingFee​

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

Get the pending fees of a order

Parameters:​

Return Values:​

getTotalOrderDebt​

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

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

Parameters:​

Return Values:​

Last updated