Controller contract implementation
1. Functions
1.1. constructor
function constructor(
address _hotpot,
address _governance,
address _uniV3Router,
address _uniV3Factory,
address _weth9
) public
Parameters:
| Name | Type | Description |
|---|---|---|
_hotpot |
address | The governance token HPT address |
_governance |
address | The governance address |
_uniV3Router |
address | The Uniswap V3 Factory address |
_uniV3Factory |
address | The Uniswap V3 Router address |
_weth9 |
address | The weth9 address |
1.2. maxPriceImpact
function maxPriceImpact() external returns (uint32 priceImpact)
Returns the maximum price impact during swap, the value range is 0-1e4
1.3. maxSqrtSlippage
function maxSqrtSlippage() external returns (uint32 sqrtSlippage)
Returns the maximum slippage when swap, the value range is 0-1e4, the calculation formula is: MaxSwapSlippage = (1-(sqrtSlippage/1e4)^2) 100%, If the maximum slippage is set to 0.5%, then sqrtSlippage should be set to 9974, at this time MaxSwapSlippage = (1-(9974/1e4)^2)100% = 0.5%
1.4. setHarvestPath
function setHarvestPath(
address token,
bytes path
) external
Set the swap path for harvest
This function can only be called by governance.
Parameters:
| Name | Type | Description |
|---|---|---|
token |
address | Target token |
path |
bytes | Harvest path for HPT token |
1.5. setMaxPriceImpact
function setMaxPriceImpact(
uint32 priceImpact
) external
Set the max price impact for swap
This function can only be called by governance.
Parameters:
| Name | Type | Description |
|---|---|---|
priceImpact |
uint32 | Price impact value: 0-1e4 |
1.6. setMaxSqrtSlippage
function setMaxSqrtSlippage(
uint32 sqrtSlippage
) external
Set the maximum slippage when swap, the value range is 0-1e4, the calculation formula is: MaxSwapSlippage = (1 - (sqrtSlippage/1e4)^2) 100% If the maximum slippage is set to 0.5%, then sqrtSlippage should be set to 9974, at this time MaxSwapSlippage = (1-(9974/1e4)^2)100% = 0.5%
This function can only be called by governance.
Parameters:
| Name | Type | Description |
|---|---|---|
sqrtSlippage |
uint32 | Sqrt slippage value: 0-1e4 |
1.7. harvest
function harvest(
address token,
uint256 amount
) external returns (uint256 burned)
All the fund share is used to burn HPT
Anyone can call this function
Parameters:
| Name | Type | Description |
|---|---|---|
token |
address | Types of tokens used to purchase HPT when burning |
amount |
uint256 | Amount of tokens |
Return Values:
| Name | Type | Description |
|---|---|---|
burned |
address | Quantity burned |
1.8. setGovernance
function setGovernance(
address account
) external
Change governance
This function can only be called by governance.
Parameters:
| Name | Type | Description |
|---|---|---|
account |
address | New governance address |
1.9. setVerifiedToken
function setVerifiedToken(
address token,
bool isVerified
) external
Set the token to be verified for all fund, vice versa
This function can only be called by governance.
Parameters:
| Name | Type | Description |
|---|---|---|
token |
address | Target token |
isVerified |
bool | Verified or unverified |
1.10. setDescriptor
function setDescriptor(
address _descriptor
) external
Set fund description information
This function can only be called by manager
Parameters:
| Name | Type | Description |
|---|---|---|
_descriptor |
address | The fund description information |
1.11. setDepositDeadline
function setDepositDeadline(
address fund,
uint256 deadline
) external
Set countdown timestamp for fund deposit
This function can only be called by manager
Parameters:
| Name | Type | Description |
|---|---|---|
fund |
address | Fund address |
deadline |
uint256 | The Countdown timestamp for fund deposit |
1.12. setPath
function setPath(
address fund,
address distToken,
bytes path
) external
Set the token swap path
This function can only be called by manager When setting the path, it cannot be modified to address 0, and the token in the path must be verified whether it is trusted
Parameters:
| Name | Type | Description |
|---|---|---|
fund |
address | Fund address |
distToken |
address | Target token address |
path |
bytes | A swap path that complies with uniswap v3 swap format |
1.13. init
function init(
address fund,
address token0,
address token1,
uint24 fee,
int24 tickLower,
int24 tickUpper,
uint256 amount,
uint256 deadline
) external returns (uint128 liquidity)
Initialize the position and allow the investment amount to be 0.
This function can only be called by manager
Parameters:
| Name | Type | Description |
|---|---|---|
fund |
address | Fund address |
token0 |
address | The pool's token0 address |
token1 |
address | The pool's token1 address |
fee |
uint24 | The pool's fee |
tickLower |
int24 | The posotion's tickLower |
tickUpper |
int24 | The posotion's tickUpper |
amount |
uint256 | The initial investment amount is allowed to be 0, and 0 means that only positions are initialized and no substantial investment is made |
deadline |
uint256 | A timestamp, the current blocktime must be less than or equal to this timestamp |
Return Values:
| Name | Type | Description |
|---|---|---|
liquidity |
address | Number of liquidity added |
1.14. add
function add(
address fund,
uint256 poolIndex,
uint256 positionIndex,
uint256 amount,
bool collect,
uint256 deadline
) external returns (uint128 liquidity)
Investment in designated positions, optional reinvestment fee
This function can only be called by manager
Parameters:
| Name | Type | Description |
|---|---|---|
fund |
address | Fund address |
poolIndex |
uint256 | Pool index number |
positionIndex |
uint256 | Position index number |
amount |
uint256 | Investment amount |
collect |
bool | Whether to collect the fees that have been incurred and reinvest |
deadline |
uint256 | A timestamp, the current blocktime must be less than or equal to this timestamp |
Return Values:
| Name | Type | Description |
|---|---|---|
liquidity |
address | Number of liquidity added |
1.15. sub
function sub(
address fund,
uint256 poolIndex,
uint256 positionIndex,
uint256 proportionX128,
uint256 deadline
) external returns (uint256 amount)
Divestment of designated positions
This function can only be called by manager
Parameters:
| Name | Type | Description |
|---|---|---|
fund |
address | Fund address |
poolIndex |
uint256 | Pool index number |
positionIndex |
uint256 | Position index number |
proportionX128 |
uint256 | The percentage of divestment, shifted to the left by 128 bits; 0 is allowed, and 0 means that only handling fees are collected |
deadline |
uint256 | A timestamp, the current blocktime must be less than or equal to this timestamp |
Return Values:
| Name | Type | Description |
|---|---|---|
amount |
address | The amount of fund's local currency obtained from the divestment |
1.16. move
function move(
address fund,
uint256 poolIndex,
uint256 subIndex,
uint256 addIndex,
uint256 proportionX128,
uint256 deadline
) external returns (uint128 liquidity)
Move position investment
This function can only be called by manager
Parameters:
| Name | Type | Description |
|---|---|---|
fund |
address | Fund address |
poolIndex |
uint256 | Pool index number |
subIndex |
uint256 | The index number of the position to be subtracted |
addIndex |
uint256 | The index number of the position to be added |
proportionX128 |
uint256 | Adjust the ratio, move 128 bits to the left |
deadline |
uint256 | A timestamp, the current blocktime must be less than or equal to this timestamp |
Return Values:
| Name | Type | Description |
|---|---|---|
liquidity |
address | Number of liquidity added after completion |