Deposit into the Vault
While there is only 1 underlying LP token per vault, Alluo enables you to deposit and withdraw in any token supported by the Alluo Exchange
There are two ways you can Deposit:
You can either use the standard ERC4626 Deposit and Mint functions
Alluo Vault
1
/// @notice Deposits an amount of LP underlying and mints shares in the vault.
2
/// @dev Read the difference between deposit and mint at the start of the contract. Makes sure to distribute rewards before any actions occur
3
/// @param assets Amount of assets deposited
4
/// @param receiver Recipient of shares
5
/// @return New amount of shares minted
6
function deposit(uint256 assets, address receiver) public override returns(uint256) {
7
////
8
// Rewards are distributed BEFORE new shares are minted to ensure that correct reward distribution is achieved
9
//
10
_distributeReward(_msgSender());
11
require(assets <= maxDeposit(receiver), "ERC4626: deposit more than max");
12
uint256 shares = previewDeposit(assets);
13
_deposit(_msgSender(), receiver, assets, shares);
14
return shares;
15
}
Deposit is adding an exact amount of underlying LP tokens for a certain amount of shares in the Vault.
Mint is adding enough underlying LP tokens to mint an exact amount of shares in the vault.
You can use the function below to deposit a quantity of your ERC20 token for shares in the Vault.
For this specific StEth-Eth example, there are extra steps to be compatible with native ETH but all Vaults follow this fundamental logic when depositing ERC20 tokens that are not the underlying LP token.
- 1.Swap the entryToken to one of the poolTokens supported by the Curve Pool.
- 2.Get the LP and mint the correct amount of shares
AlluoStEthEthVault.sol
1
/// @notice Deposits an amount of any ERC20 and mints shares in the vault.
2
/// @dev Read the difference between deposit and mint at the start of the contract. Makes sure to distribute rewards before any actions occur
3
/// Converts all the entry tokens to a token eligible for adding liquidity. Then carry out same deposit procedure
4
/// @param assets Amount of assets deposited
5
/// @param entryToken Recipient of shares
6
/// @return New amount of shares minted
7
function depositWithoutLP(uint256 assets, address entryToken) public returns(uint256) {
8
_distributeReward(_msgSender());
9
IERC20MetadataUpgradeable(entryToken).safeTransferFrom(_msgSender(), address(this), assets);
10
IERC20MetadataUpgradeable(entryToken).safeIncreaseAllowance(address(exchange), assets);
11
assets = exchange.exchange(entryToken,asset(),assets,0);
12
require(assets <= _nonLpMaxDeposit(assets), "ERC4626: deposit more than max");
13
uint256 shares = _nonLpPreviewDeposit(assets);
14
_mint(_msgSender(), shares);
15
emit Deposit(_msgSender(), _msgSender(), assets, shares);
16
return shares;
17
}
18