Last update: October 8, 2021
BaseRouter
Functions
constructor
function constructor(
) public
setRegistry
function setRegistry(
address _registry
) external
@notice
Used to update the yearn registry.
Parameters:
Name |
Type |
Description |
_registry |
address |
The new _registry address. |
bestVault
function bestVault(
) public returns (contract VaultAPI)
@notice
Used to get the most revent vault for the token using the registry.
Return Values:
Name |
Type |
Description |
An |
address |
instance of a VaultAPI |
### allVaults |
|
|
function allVaults(
) public returns (contract VaultAPI[])
|
|
|
@notice |
|
|
Used to get all vaults from the registery for the token |
|
|
Return Values:
Name |
Type |
Description |
An |
address |
array containing instances of VaultAPI |
### _updateVaultCache |
|
|
function _updateVaultCache(
) internal
|
|
|
totalVaultBalance
function totalVaultBalance(
) public returns (uint256 balance)
@notice
Used to get the balance of an account accross all the vaults for a token.
@dev will be used to get the router balance using totalVaultBalance(address(this)).
@param account The address of the account.
@return balance of token for the account accross all the vaults.
totalAssets
function totalAssets(
) public returns (uint256 assets)
@notice
Used to get the TVL on the underlying vaults.
@return assets the sum of all the assets managed by the underlying vaults.
_deposit
function _deposit(
) internal returns (uint256 deposited)
_withdraw
function _withdraw(
) internal returns (uint256 withdrawn)