Vault Contract
Last Update: February 2023
The Beefy Vault Contract is the central user-facing implementation of the Beefy protocol, which accepts and manages user deposits and mints mooTokens as a proof of receipt to facilitate withdrawals. It follows the ERC-20 standard for fungible, transferrable tokens.
Besides handling deposits and withdrawals, the primary function of the vault is to direct deposited funds to the relevant autocompounding Strategy Contract. The vault and strategy contracts are kept separate to isolate any risks in the strategy from user deposits.
Returns the address of the underlying farm token (e.g. the LP token) used in both the Beefy Vault and Strategy contracts. Note that this is not the same as the underlying assets used for the farm.
function want() public view returns (IERC20Upgradeable) {
return IERC20Upgradeable(strategy.want());
}
Returns the amount of "want" (i.e. underlying farm token) stored in the vault and strategy and yield source as an integer.
function balance() public view returns (uint) {
return want().balanceOf(address(this)) + IStrategyV7(strategy).balanceOf();
}
Returns the amount of "want" (i.e. underlying farm token) stored in the vault alone as an integer.
function available() public view returns (uint256) {
return want().balanceOf(address(this));
}
Returns the total amount of mooTokens minted as an integer, which are always displayed as 18 decimal token. This is a standard method inherited from the ERC-20 standard. SeeWhat are mooTokens? for more details.
function totalSupply() public view virtual override returns (uint256) {
return _totalSupply;
}
Returns the current price per share of the vault (i.e. per mooToken) as an integer denominated in the "want" (i.e. underlying farm token). This is calculated as Price per Full Share = balance() / totalSupply().
function getPricePerFullShare() public view returns (uint256) {
return totalSupply() == 0 ? 1e18 : balance() * 1e18 / totalSupply();
}
Returns the address current underlying strategy contract that the vault is using to generate yield.
function strategy() external view returns (address);
Executes a transfer of a specified _amount of "want" (i.e. underlying farm token) from the depositor to the vault, and then mints a proportional quantity of mooTokens to the depositor in return.
function deposit(uint _amount) public nonReentrant {
strategy.beforeDeposit();
uint256 _pool = balance();
want().safeTransferFrom(msg.sender, address(this), _amount);
earn();
uint256 _after = balance();
_amount = _after - _pool; // Additional check for deflationary tokens
uint256 shares = 0;
if (totalSupply() == 0) {
shares = _amount;
} else {
shares = (_amount * totalSupply()) / _pool;
}
_mint(msg.sender, shares);
}
Additionally, there is a helper function depositAll() that deposits the entire balance of "want" in the user's wallet at the time of the transaction.
Executes a burn of a specified _amount of mooTokens from the depositor, and then transfers a proportional quantity of "want" (i.e. underlying farm token) to the depositor in return.
function withdraw(uint256 _shares) public {
uint256 r = (balance() * _shares) / totalSupply();
_burn(msg.sender, _shares);
uint b = want().balanceOf(address(this));
if (b < r) {
uint _withdraw = r - b;
strategy.withdraw(_withdraw);
uint _after = want().balanceOf(address(this));
uint _diff = _after - b;
if (_diff < _withdraw) {
r = b + _diff;
}
}
want().safeTransfer(msg.sender, r);
}
Similarly to deposit(), there is a helper function withdrawAll() that withdraw the entire balance of mooTokens in the user's wallet at the time of the transaction.
Executes a transfer of available() "want" (i.e. underlying farm token) from the Vault Contract to the strategy contract and triggers the strategy's deposit() function to deploy the funds and begin earning.
function earn() public {
uint _bal = available();
want().safeTransfer(address(strategy), _bal);
strategy.deposit();
}
Writes the address of an alternate strategy to the Vault Contract's memory, in anticipation of upgrade the current strategy to the alternate using upgradeStrat().
function proposeStrat(address _implementation) public onlyOwner {
require(address(this) == IStrategyV7(_implementation).vault(), "Proposal not valid for this Vault");
require(want() == IStrategyV7(_implementation).want(), "Different want");
stratCandidate = StratCandidate({
implementation: _implementation,
proposedTime: block.timestamp
});
emit NewStratCandidate(_implementation);
}
Replaces the address of the current strategy with an alternate strategy specified by proposeStrat().
function upgradeStrat() public onlyOwner {
require(stratCandidate.implementation != address(0), "There is no candidate");
require(stratCandidate.proposedTime + approvalDelay < block.timestamp, "Delay has not passed");
emit UpgradeStrat(stratCandidate.implementation);
strategy.retireStrat();
strategy = IStrategyV7(stratCandidate.implementation);
stratCandidate.implementation = address(0);
stratCandidate.proposedTime = 5000000000;
earn();
}
The current release of our standard Beefy Vault Contract is BeefyVaultV7.sol, which was released in August 2022. The V7 release improved on the previous version in a few keys ways:
- Introduced vault upgradeability through proxy patterns, to facilitate updates and changes to live Beefy vaults without needing to deprecate and re-deploy;
- Updated the strategy interface to allow for upgradeable strategies; and
- Amended all contracts to remove reliance on the SafeMath library, which has been generally retired following incorporation of its features into Solidity v0.8.
Separately, a ERC-4646-compliant wrapper contract was released for the V7 vault in November 2022, which allows developers to incorporate Beefy Vaults into their projects with standardised vault functionality and interfaces. See BeefyWrapper Contract for more information.