AlphaProVault
The contract that manages liquidity, and processes deposits and withdrawals.
deposit
Deposit tokens in proportion to the vault's current holdings. These tokens will remain in the vault, and are not used for liquidity until the next rebalance.
Parameters:
Returns:
withdraw
Withdraws tokens in proportion to the vault's current holdings and the fees earned by the vault.
Parameters:
Returns:
rebalance
Updates the vault's positions. Anyone can call rebalance, unless the vault manager calls setRebalanceDelegate
to nominate a specific wallet to rebalance.
checkCanRebalance
Check whether the vault can rebalance. Revert with an error code if it cannot.
getTwap
Fetches the time-weighted average price in ticks from Uniswap pool.
Returns:
getTotalAmounts
Calculates the vault's total holdings of token0 and token1 - ie how much of each token the vault would hold if it withdrew all its liquidity from Uniswap. Includes owed fees but excludes the proportion of fees that will be paid to the protocol and vault manager.
Returns:
getBalance0
The amount of unused token0 held by the vault.
Returns:
getBalance1
The amount of unused token1 held by the vault.
Returns:
collectProtocol
Collects all the uncollected protocol fees accrued by the vault. Can only be called by Charm Governance.
Parameters:
collectManager
Collects all the uncollected manager fees accrued by the vault. Can only be called by the vault manager.
Parameters:
sweep
Removes tokens accidentally sent to this vault. Can only be called by the vault manager.
Parameters:
setBaseThreshold
Setting the baseThreshold
. Can only be called by the vault manager.
Parameters:
setLimitThreshold
Setting the limitThreshold
. Can only be called by the vault manager.
Parameters:
setFullRangeWeight
Setting the fullRangeWeight
. Can only be called by the vault manager.
Parameters:
setPeriod
Setting the rebalancing period
. Can only be called by the vault manager.
Parameters:
setMinTickMove
Setting the minimum tick movement between rebalance. Can only be called by the vault manager.
Parameters:
setTwapDuration
Setting the Security Parameter to calculate the TWAP. Can only be called by the vault manager.
Parameters:
setMaxTwapDeviation
Setting the Security Parameter that determines the maximum TWAP deviation. Can only be called by the vault manager.
Parameters:
setMaxTotalSupply
Setting the Information Parameter that determines a vault's maximum capacity. Can only be called by the vault manager.
Parameters:
emergencyBurn
Removes the vault's liquidity in a given range. Can only be called by the vault manager.
Parameters:
setManager
The first step to change a vault's manager. Can only called by the vault manager.
Parameters:
acceptManager
The second step to change a vault manager. Can only be called by the address assigned to _manager.
State Changes:
setManagerFee
Setting a fee for the vault manager, as a % of fees received from Uniswap. Can only be called by the vault manager.
Parameters:
setRebalanceDelegate
Switch on/off private rebalancing. Can only be called by the vault manager.
Parameters:
Getter functions for public variables
Getter functions are automatically generated for the following public variables:
Pool Variables
Vault Variables
Protocol Variables
Strategy Variables
Security Variables
Gas Optimization Variables
Vault Manager Variables
Last updated