OrderBook
InternalAddLiquidityToOrderParams
InternalRemoveLiquidityParams
InternalSwapStep
Functions
initialize
setExchange
addLiquidity
Add liquidity logic
Only used by ClearingHouse
contract
Parameters:
params
struct IOrderBook.AddLiquidityParams
Add liquidity params, detail on IOrderBook.AddLiquidityParams
Return Values:
response
struct IOrderBook.AddLiquidityResponse
Add liquidity response, detail on IOrderBook.AddLiquidityResponse
removeLiquidity
Remove liquidity logic, only used by ClearingHouse
contract
Parameters:
params
struct IOrderBook.RemoveLiquidityParams
Remove liquidity params, detail on IOrderBook.RemoveLiquidityParams
Return Values:
response
struct IOrderBook.RemoveLiquidityResponse
Remove liquidity response, detail on IOrderBook.RemoveLiquidityResponse
updateFundingGrowthAndLiquidityCoefficientInFundingPayment
This is the non-view version of getLiquidityCoefficientInFundingPayment()
, only can be called by Exchange
contract
Parameters:
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:
liquidityCoefficientInFundingPayment
int256
the funding payment of all orders/liquidity of a maker
updateOrderDebt
uniswapV3MintCallback
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:
amount0Owed
uint256
The amount of token0 due to the pool for the minted liquidity
amount1Owed
uint256
The amount of token1 due to the pool for the minted liquidity
data
bytes
Any data passed through by the caller via the IUniswapV3PoolActions#mint call
replaySwap
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:
params
struct IOrderBook.ReplaySwapParams
ReplaySwap params, detail on IOrderBook.ReplaySwapParams
Return Values:
response
struct IOrderBook.ReplaySwapResponse
The swap result encoded in ReplaySwapResponse
getExchange
Get Exchange
contract address
Return Values:
exchange
address
The Exchange
contract address
getOpenOrderIds
Get open order ids of a trader in the given market
Parameters:
trader
address
The trader address
baseToken
address
The base token address
Return Values:
orderIds
bytes32[]
The open order ids
getOpenOrderById
Get open order info by given order id
Parameters:
orderId
bytes32
The order id
Return Values:
info
struct OpenOrder.Info
The open order info encoded in OpenOrder.Info
getOpenOrder
Get open order info by given base token, upper tick and lower tick
Parameters:
trader
address
The trader address
baseToken
address
The base token address
upperTick
int24
The upper tick
lowerTick
int24
The lower tick
Return Values:
info
struct OpenOrder.Info
he open order info encoded in OpenOrder.Info
hasOrder
Check if the specified trader has order in given markets
Parameters:
trader
address
The trader address
tokens
address[]
The base token addresses
Return Values:
hasOrder
bool
True if the trader has order in given markets
getTotalQuoteBalanceAndPendingFee
Get the total quote token amount and pending fees of all orders in given markets
Parameters:
trader
address
The trader address
baseTokens
address[]
The base token addresses
Return Values:
totalQuoteAmountInPools
int256
The total quote token amount
totalPendingFee
uint256
The total pending fees in the orders
getTotalTokenAmountInPoolAndPendingFee
Get the total token amount (quote or base) and pending fees of all orders in the given market
Parameters:
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:
tokenAmount
uint256
The total quote/base token amount
totalPendingFee
uint256
The total pending fees in the orders
getLiquidityCoefficientInFundingPayment
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:
liquidityCoefficientInFundingPayment
int256
the funding payment of all orders/liquidity of a maker
getPendingFee
Get the pending fees of a order
Parameters:
trader
address
The trader address
baseToken
address
The base token address
lowerTick
int24
The lower tick
upperTick
int24
The upper tick
Return Values:
fee
uint256
The pending fees
getTotalOrderDebt
Get the total debt token amount (base or quote) of all orders in the given market
Parameters:
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:
debtAmount
uint256
The total debt token amount
Last updated