-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: introduce StakeVault and IStakeManager
#61
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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
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 |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| pragma solidity ^0.8.26; | ||
|
|
||
| import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol"; | ||
| import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; | ||
| import { IStakeManager } from "./interfaces/IStakeManager.sol"; | ||
|
|
||
| /** | ||
| * @title StakeVault | ||
| * @author Ricardo Guilherme Schmidt <ricardo3@status.im> | ||
| * @notice A contract to secure user stakes and manage staking with IStakeManager. | ||
| * @dev This contract is owned by the user and allows staking, unstaking, and withdrawing tokens. | ||
| */ | ||
| contract StakeVault is Ownable { | ||
| error StakeVault__NoEnoughAvailableBalance(); | ||
| error StakeVault__InvalidDestinationAddress(); | ||
| error StakeVault__UpdateNotAvailable(); | ||
| error StakeVault__StakingFailed(); | ||
| error StakeVault__UnstakingFailed(); | ||
|
|
||
| //STAKING_TOKEN must be kept as an immutable, otherwise, StakeManager would accept StakeVaults with any token | ||
| //if is needed that STAKING_TOKEN to be a variable, StakeManager should be changed to check codehash and | ||
| //StakeVault(msg.sender).STAKING_TOKEN() | ||
| IERC20 public immutable STAKING_TOKEN; | ||
| IStakeManager private stakeManager; | ||
|
|
||
| /** | ||
| * @dev Emitted when tokens are staked. | ||
| * @param from The address from which tokens are transferred. | ||
| * @param to The address receiving the staked tokens (this contract). | ||
| * @param amount The amount of tokens staked. | ||
| * @param time The time period for which tokens are staked. | ||
| */ | ||
| event Staked(address indexed from, address indexed to, uint256 amount, uint256 time); | ||
|
|
||
| modifier validDestination(address _destination) { | ||
| if (_destination == address(0)) { | ||
| revert StakeVault__InvalidDestinationAddress(); | ||
| } | ||
| _; | ||
| } | ||
|
|
||
| /** | ||
| * @notice Initializes the contract with the owner, staked token, and stake manager. | ||
| * @param _owner The address of the owner. | ||
| * @param _stakeManager The address of the StakeManager contract. | ||
| */ | ||
| constructor(address _owner, IStakeManager _stakeManager) Ownable(_owner) { | ||
| STAKING_TOKEN = _stakeManager.STAKING_TOKEN(); | ||
| stakeManager = _stakeManager; | ||
| } | ||
|
|
||
| /** | ||
| * @notice Stake tokens for a specified time. | ||
| * @param _amount The amount of tokens to stake. | ||
| * @param _seconds The time period to stake for. | ||
| */ | ||
| function stake(uint256 _amount, uint256 _seconds) external onlyOwner { | ||
| _stake(_amount, _seconds, msg.sender); | ||
| } | ||
|
|
||
| /** | ||
| * @notice Stake tokens from a specified address for a specified time. | ||
| * @param _amount The amount of tokens to stake. | ||
| * @param _seconds The time period to stake for. | ||
| * @param _from The address from which tokens will be transferred. | ||
| */ | ||
| function stake(uint256 _amount, uint256 _seconds, address _from) external onlyOwner { | ||
| _stake(_amount, _seconds, _from); | ||
| } | ||
|
|
||
| /** | ||
| * @notice Unstake a specified amount of tokens and send to the owner. | ||
| * @param _amount The amount of tokens to unstake. | ||
| */ | ||
| function unstake(uint256 _amount) external onlyOwner { | ||
| _unstake(_amount, msg.sender); | ||
| } | ||
|
|
||
| /** | ||
| * @notice Unstake a specified amount of tokens and send to a destination address. | ||
| * @param _amount The amount of tokens to unstake. | ||
| * @param _destination The address to receive the unstaked tokens. | ||
| */ | ||
| function unstake(uint256 _amount, address _destination) external onlyOwner validDestination(_destination) { | ||
| _unstake(_amount, _destination); | ||
| } | ||
|
|
||
| /** | ||
| * @notice Withdraw tokens from the contract. | ||
| * @param _token The IERC20 token to withdraw. | ||
| * @param _amount The amount of tokens to withdraw. | ||
| */ | ||
| function withdraw(IERC20 _token, uint256 _amount) external onlyOwner { | ||
| _withdraw(_token, _amount, msg.sender); | ||
| } | ||
|
|
||
| /** | ||
| * @notice Withdraw tokens from the contract to a destination address. | ||
| * @param _token The IERC20 token to withdraw. | ||
| * @param _amount The amount of tokens to withdraw. | ||
| * @param _destination The address to receive the tokens. | ||
| */ | ||
| function withdraw( | ||
| IERC20 _token, | ||
| uint256 _amount, | ||
| address _destination | ||
| ) | ||
| external | ||
| onlyOwner | ||
| validDestination(_destination) | ||
| { | ||
| _withdraw(_token, _amount, _destination); | ||
| } | ||
|
|
||
| /** | ||
| * @notice Returns the available amount of a token that can be withdrawn. | ||
| * @param _token The IERC20 token to check. | ||
| * @return The amount of token available for withdrawal. | ||
| */ | ||
| function availableWithdraw(IERC20 _token) external view returns (uint256) { | ||
| if (_token == STAKING_TOKEN) { | ||
| return STAKING_TOKEN.balanceOf(address(this)) - amountStaked(); | ||
| } | ||
| return _token.balanceOf(address(this)); | ||
| } | ||
|
|
||
| function _stake(uint256 _amount, uint256 _seconds, address _source) internal { | ||
| bool success = STAKING_TOKEN.transferFrom(_source, address(this), _amount); | ||
| if (!success) { | ||
| revert StakeVault__StakingFailed(); | ||
| } | ||
|
|
||
| stakeManager.stake(_amount, _seconds); | ||
|
|
||
| emit Staked(_source, address(this), _amount, _seconds); | ||
| } | ||
|
|
||
| function _unstake(uint256 _amount, address _destination) internal { | ||
| stakeManager.unstake(_amount); | ||
| bool success = STAKING_TOKEN.transfer(_destination, _amount); | ||
| if (!success) { | ||
| revert StakeVault__UnstakingFailed(); | ||
| } | ||
| } | ||
|
|
||
| function _withdraw(IERC20 _token, uint256 _amount, address _destination) internal { | ||
| if (_token == STAKING_TOKEN && STAKING_TOKEN.balanceOf(address(this)) - amountStaked() < _amount) { | ||
| revert StakeVault__NoEnoughAvailableBalance(); | ||
| } | ||
| _token.transfer(_destination, _amount); | ||
| } | ||
|
|
||
| function amountStaked() public view returns (uint256) { | ||
| return stakeManager.getStakedBalance(address(this)); | ||
| } | ||
| } | ||
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.
@3esmit In this vault implementation I remove the functions to withdraw ETH.
The reason being is that this contract doesn't have any
payablefunctions orfallback/receiveimplementations, so it can't receive any ETH anyways.