[SI][Vaults] feat: Dashboard UX updates #915
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
There was a problem hiding this comment.
folkyatina marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. Please update following comment: There was a problem hiding this comment. votingCommittee -> multiConfirmationRoles There was a problem hiding this comment. reserveRatio() -> reserveRatioBP() or at least comment that this is the BP convention There was a problem hiding this comment. let's document whether already minted are included or not |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,23 +1,23 @@ | ||||||
| // SPDX-FileCopyrightText: 2025 Lido <[email protected]> | ||||||
| // SPDX-License-Identifier: GPL-3.0 | ||||||
|
|
||||||
| // See contracts/COMPILERS.md | ||||||
| pragma solidity 0.8.25; | ||||||
|
|
||||||
| import {AccessControlEnumerable} from "@openzeppelin/contracts-v5.0.2/access/extensions/AccessControlEnumerable.sol"; | ||||||
| import {OwnableUpgradeable} from "contracts/openzeppelin/5.0.2/upgradeable/access/OwnableUpgradeable.sol"; | ||||||
|
|
||||||
| import {Math256} from "contracts/common/lib/Math256.sol"; | ||||||
| import {VaultHub} from "./VaultHub.sol"; | ||||||
|
|
||||||
| import {IERC20} from "@openzeppelin/contracts-v5.0.2/token/ERC20/IERC20.sol"; | ||||||
| import {IERC20Permit} from "@openzeppelin/contracts-v5.0.2/token/ERC20/extensions/IERC20Permit.sol"; | ||||||
| import {ILido as IStETH} from "contracts/0.8.25/interfaces/ILido.sol"; | ||||||
| import {ILidoLocator} from "contracts/common/interfaces/ILidoLocator.sol"; | ||||||
| import {IStakingVault} from "contracts/0.8.25/vaults/interfaces/IStakingVault.sol"; | ||||||
|
|
||||||
|
|
||||||
| interface IWETH9 is IERC20 { | ||||||
| function withdraw(uint256) external; | ||||||
|
|
||||||
| function deposit() external payable; | ||||||
| } | ||||||
|
|
@@ -54,7 +54,7 @@ | |||||
| IWstETH public immutable WSTETH; | ||||||
|
|
||||||
| /// @notice The wrapped ether token contract | ||||||
| IWETH9 public immutable WETH; | ||||||
|
|
||||||
| /// @notice The underlying `StakingVault` contract | ||||||
| IStakingVault public stakingVault; | ||||||
|
|
@@ -71,20 +71,18 @@ | |||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * @notice Constructor sets the stETH, WETH, and WSTETH token addresses. | ||||||
| * @param _weth Address of the weth token contract. | ||||||
| * @param _lidoLocator Address of the Lido locator contract. | ||||||
| */ | ||||||
| constructor(address _weth, address _lidoLocator) { | ||||||
| if (_weth == address(0)) revert ZeroArgument("_WETH"); | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| if (_lidoLocator == address(0)) revert ZeroArgument("_lidoLocator"); | ||||||
|
|
||||||
| _SELF = address(this); | ||||||
| WETH = IWETH9(_weth); | ||||||
| STETH = IStETH(ILidoLocator(_lidoLocator).lido()); | ||||||
| WSTETH = IWstETH(ILidoLocator(_lidoLocator).wstETH()); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
|
|
@@ -109,6 +107,12 @@ | |||||
| vaultHub = VaultHub(stakingVault.vaultHub()); | ||||||
| _grantRole(DEFAULT_ADMIN_ROLE, msg.sender); | ||||||
|
There was a problem hiding this comment. let's add an admin argument to avoid using There was a problem hiding this comment. maybe a bit later will be done by @failingtwice |
||||||
|
|
||||||
| // reduces gas cost for `burnWsteth` | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| // dashboard will hold STETH during this tx | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| STETH.approve(address(WSTETH), type(uint256).max); | ||||||
| // allows to uncondinitialy use transferFrom in _burn | ||||||
| STETH.approve(address(this), type(uint256).max); | ||||||
|
|
||||||
| emit Initialized(); | ||||||
|
There was a problem hiding this comment. should we emit args of the init? |
||||||
| } | ||||||
|
|
||||||
|
|
@@ -180,11 +184,11 @@ | |||||
|
|
||||||
| /** | ||||||
| * @notice Returns the maximum number of shares that can be minted with deposited ether. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| * @param _etherToFund the amount of ether to be funded, can be zero | ||||||
| * @return the maximum number of shares that can be minted by ether | ||||||
| */ | ||||||
| function projectedMintableShares(uint256 _etherToFund) external view returns (uint256) { | ||||||
|
There was a problem hiding this comment.
Suggested change
not a strong opinion though, just to disambiguate with |
||||||
| uint256 _totalShares = _totalMintableShares(stakingVault.valuation() + _etherToFund); | ||||||
| uint256 _sharesMinted = vaultSocket().sharesMinted; | ||||||
|
|
||||||
| if (_totalShares < _sharesMinted) return 0; | ||||||
|
|
@@ -199,14 +203,11 @@ | |||||
| return Math256.min(address(stakingVault).balance, stakingVault.unlocked()); | ||||||
| } | ||||||
|
|
||||||
| // ==================== Vault Management Functions ==================== | ||||||
|
|
||||||
| /** | ||||||
| * @dev Receive function to accept ether | ||||||
| */ | ||||||
| receive() external payable { | ||||||
| if (msg.value == 0) revert ZeroArgument("msg.value"); | ||||||
|
There was a problem hiding this comment.
Suggested change
why do we need this though? |
||||||
| } | ||||||
|
|
@@ -230,7 +231,7 @@ | |||||
| * @notice Funds the staking vault with ether | ||||||
| */ | ||||||
| function fund() external payable virtual onlyRole(DEFAULT_ADMIN_ROLE) { | ||||||
| _fund(msg.value); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
|
|
@@ -243,8 +244,7 @@ | |||||
| WETH.transferFrom(msg.sender, address(this), _wethAmount); | ||||||
| WETH.withdraw(_wethAmount); | ||||||
|
|
||||||
| _fund(_wethAmount); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
|
|
@@ -280,7 +280,7 @@ | |||||
| * @param _recipient Address of the recipient | ||||||
| * @param _amountOfShares Amount of shares to mint | ||||||
| */ | ||||||
| function mintShares( | ||||||
folkyatina marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| address _recipient, | ||||||
| uint256 _amountOfShares | ||||||
| ) external payable virtual onlyRole(DEFAULT_ADMIN_ROLE) fundAndProceed { | ||||||
|
There was a problem hiding this comment. Do we still need |
||||||
|
|
@@ -290,42 +290,39 @@ | |||||
| /** | ||||||
| * @notice Mints wstETH tokens backed by the vault to a recipient. Approvals for the passed amounts should be done before. | ||||||
Jeday marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| * @param _recipient Address of the recipient | ||||||
| * @param _amountOfWstETH Amount of tokens to mint | ||||||
| */ | ||||||
| function mintWstETH( | ||||||
| address _recipient, | ||||||
| uint256 _amountOfWstETH | ||||||
|
There was a problem hiding this comment. amountX vs Xamount is a bit incosistent |
||||||
| ) external payable virtual onlyRole(DEFAULT_ADMIN_ROLE) fundAndProceed { | ||||||
| _mint(address(this), _amountOfWstETH); | ||||||
|
|
||||||
| uint256 stETHAmount = STETH.getPooledEthByShares(_amountOfWstETH); | ||||||
Jeday marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| uint256 wstETHAmount = WSTETH.wrap(stETHAmount); | ||||||
| WSTETH.transfer(_recipient, wstETHAmount); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * @notice Burns stETH shares from the sender backed by the vault | ||||||
| * @param _amountOfShares Amount of shares to burn | ||||||
| */ | ||||||
| function burnShares(uint256 _amountOfShares) external virtual onlyRole(DEFAULT_ADMIN_ROLE) { | ||||||
| _burn(msg.sender, _amountOfShares); | ||||||
Jeday marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * @notice Burns wstETH tokens from the sender backed by the vault. Approvals for the passed amounts should be done before. | ||||||
| * @param _amountOfWstETH Amount of wstETH tokens to burn | ||||||
| * @dev The _amountOfWstETH = _amountOfShares by design | ||||||
| */ | ||||||
| function burnWstETH(uint256 _amountOfWstETH) external virtual onlyRole(DEFAULT_ADMIN_ROLE) { | ||||||
folkyatina marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| WSTETH.transferFrom(msg.sender, address(this), _amountOfWstETH); | ||||||
| WSTETH.unwrap(_amountOfWstETH); | ||||||
|
|
||||||
| _burn(address(this), _amountOfWstETH); | ||||||
| } | ||||||
|
Check warning Code scanning / Slither Unused return Medium |
||||||
|
|
||||||
| /** | ||||||
| * @dev Modifier to check if the permit is successful, and if not, check if the allowance is sufficient | ||||||
|
|
@@ -362,43 +359,40 @@ | |||||
|
|
||||||
| /** | ||||||
| * @notice Burns stETH tokens from the sender backed by the vault using EIP-2612 Permit. | ||||||
| * @param _amountOfShares Amount of shares to burn | ||||||
| * @param _permit data required for the stETH.permit() method to set the allowance | ||||||
| */ | ||||||
| function burnSharesWithPermit( | ||||||
folkyatina marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| uint256 _amountOfShares, | ||||||
| PermitInput calldata _permit | ||||||
| ) | ||||||
| external | ||||||
| virtual | ||||||
| onlyRole(DEFAULT_ADMIN_ROLE) | ||||||
| trustlessPermit(address(STETH), msg.sender, address(this), _permit) | ||||||
Jeday marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| { | ||||||
| _burn(msg.sender, _amountOfShares); | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * @notice Burns wstETH tokens from the sender backed by the vault using EIP-2612 Permit. | ||||||
| * @param _amountOfWstETH Amount of wstETH tokens to burn | ||||||
| * @param _permit data required for the wstETH.permit() method to set the allowance | ||||||
| */ | ||||||
| function burnWstETHWithPermit( | ||||||
| uint256 _amountOfWstETH, | ||||||
| PermitInput calldata _permit | ||||||
| ) | ||||||
| external | ||||||
| virtual | ||||||
| onlyRole(DEFAULT_ADMIN_ROLE) | ||||||
| trustlessPermit(address(WSTETH), msg.sender, address(this), _permit) | ||||||
| { | ||||||
| WSTETH.transferFrom(msg.sender, address(this), _amountOfWstETH); | ||||||
| uint256 stETHAmount = WSTETH.unwrap(_amountOfWstETH); | ||||||
| uint256 sharesAmount = STETH.getSharesByPooledEth(stETHAmount); | ||||||
|
|
||||||
| _burn(address(this), sharesAmount); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
|
|
@@ -416,7 +410,7 @@ | |||||
| */ | ||||||
| modifier fundAndProceed() { | ||||||
| if (msg.value > 0) { | ||||||
| _fund(msg.value); | ||||||
| } | ||||||
| _; | ||||||
| } | ||||||
|
|
@@ -444,8 +438,8 @@ | |||||
| /** | ||||||
| * @dev Funds the staking vault with the ether sent in the transaction | ||||||
| */ | ||||||
| function _fund(uint256 _value) internal { | ||||||
| stakingVault.fund{value: _value}(); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
|
|
@@ -465,20 +459,6 @@ | |||||
| stakingVault.requestValidatorExit(_validatorPublicKey); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * @dev Mints stETH tokens backed by the vault to a recipient | ||||||
| * @param _recipient Address of the recipient | ||||||
|
|
@@ -492,17 +472,19 @@ | |||||
| * @dev Burns stETH tokens from the sender backed by the vault | ||||||
| * @param _amountOfShares Amount of tokens to burn | ||||||
| */ | ||||||
| function _burn(address _sender, uint256 _amountOfShares) internal { | ||||||
| STETH.transferSharesFrom(_sender, address(vaultHub), _amountOfShares); | ||||||
|
|
||||||
| vaultHub.burnSharesBackedByVault(address(stakingVault), _amountOfShares); | ||||||
| } | ||||||
|
Check warning Code scanning / Slither Unused return Medium |
||||||
|
|
||||||
| /** | ||||||
| * @dev calculates total shares vault can mint | ||||||
| * @param _valuation custom vault valuation | ||||||
| */ | ||||||
| function _totalMintableShares(uint256 _valuation) internal view returns (uint256) { | ||||||
| uint256 maxMintableStETH = (_valuation * (TOTAL_BASIS_POINTS - vaultSocket().reserveRatioBP)) / | ||||||
| TOTAL_BASIS_POINTS; | ||||||
| return Math256.min(STETH.getSharesByPooledEth(maxMintableStETH), vaultSocket().shareLimit); | ||||||
| } | ||||||
|
|
||||||
|
|
||||||
|
There was a problem hiding this comment. keccak256("Vault.Delegation.CuratorRole") ⇒ keccak256("vaults.Delegation.CuratorRole") and so on There was a problem hiding this comment. let's remove There was a problem hiding this comment. vote -> multiConfirmationRole (everywhere) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thresholdReserveRatio vs reserveRatioThreshold is a bit weird