LoopingHook
Looping Hook contract, which uses the same implementation as MarginTradingHook contract.
View Functions
swapHelper
Get the swap helper contract that this contract swaps between quote and base assets.
lastOrderId
Last running order (take profit or stop loss) id.
getBaseAssetAndQuoteAsset
Get a unique base and quote assets from a pair of tokens.
getMarginPos
Get a looping position.
External Functions
openPos
Open a new looping position by swapping borrPool
's underlying token into collPool
's underlying token via swap data _data
.
The fucntion perform multicall
to InitCore:
borrow tokens
callback (perform swap from borrow token to collateral token)
deposit collateral tokens to lending pool
collateralize inTokens
The swap callback is routed back to this contract's coreCallback
which performs a swap using _data
on swapHelper
contract with slippage control amtOut
.
NOTE: _tokenIn
must be either _borrPool
's underlying token or _collPool
's underlying token.
_mode
uint16
mode to open a looping position
_viewer
address
viewer address that represents the actual position owner
_tokenIn
address
token to take from position owner
_amtIn
uint256
amount of tokenIn
to take from position owner
_borrPool
address
lending pool to borrow
_borrAmt
uint256
amount of _borrPool
's underlying token to borrow
_collPool
address
lending pool to use as collateral
_data
bytes
swap data to be used in InitCore's callback
function
_minAmtOut
uint256
min amount out from swap as slippage control
Returns:
posId
uint256
running position id for position owner
initPosId
uint256
InitCore's position id
amtOut
uint256
amount of token received from swap using _data
increasePos
Increase an existing position's size by taking token from position owner and/or borrow more tokens.
_collPool
and borrPool
are fixed from the existing position.
_posId
uint256
owner's position id on this hook to increase position size
_tokenIn
address
token to take from position owner
_amtIn
uint256
amount of tokenIn
to take from position owner
_borrAmt
uint256
amount of _borrPool
's underlying token to borrow
_data
bytes
swap data to be used in InitCore's callback
function
_minAmtOut
uint256
min amount out from swap as slippage control
Returns:
amtOut
uint256
amount of token received from swap using _data
addCollateral
Decrease position's leverage by adding more collateral token.
Parameters:
_posId
uint256
owner's position id on this hook
_amtIn
uint256
amount of collateral token's underlying token to take from owner
removeCollateral
Increase position's leverage by removing collateral token.
Parameters:
_posId
uint256
owner's position id on this hook
_shares
uint256
amount of shares to remove collateral token
_returnNative
bool
whether to unwrap wrapped native token to native token to return to position owner
repayDebt
Decrease position's leverage by repaying borrow token.
Parameters:
_posId
uint256
owner's position id on this hook
_repayShares
uint256
amount of shares to repay borrow token to borrow lending pool
Returns:
repayAmt
uint256
amount of underlying token of borrow lending pool repaid
reducePos
Reduce an existing position's size by withdrawing collateral and repaying borrow token. The withdrawn collateral token can be swapped to repay borrow token using _data
. The user can specify which token to receive, if there is still left after swap.
Parameters:
_posId
uint256
owner's position id on this hook
_collAmt
uint256
collateral amount to reduce from position
_repayShares
uint256
amount of shares to repay borrow token to borrow lending pool
_tokenOut
address
token to receive from reducing position (either collalteral's underlying token or borrow's underlying token)
_minAmtOut
uint256
min amount out from swap as slippage control
_returnNative
bool
whether to unwrap wrapped native token to native token to return to position owner
_data
bytes
swap data to be used in InitCore's callback
function
Returns:
amtOut
uint256
amount of token received from swap using _data
Last updated