feat(StakeVault): add withdraw function and improve documentation#144
Open
feat(StakeVault): add withdraw function and improve documentation#144
Conversation
This commit introduces new functions for keeping track of the total amount staked and implements a function to check the available amount of tokens that can be withdrawn. Users are able to withdraw tokens that are not commited to stake by calling the withdraw functions. These changes enhance the overall usability and flexibility of the StakeVault contract.
0x-r4bbit
approved these changes
Oct 2, 2024
| if (_token == STAKED_TOKEN) { | ||
| return STAKED_TOKEN.balanceOf(address(this)) - amountStaked; | ||
| } | ||
| return _token.balanceOf(address(this)); |
Collaborator
There was a problem hiding this comment.
In which case would we not want to get the amount from whatever STAKED_TOKEN is?
Collaborator
There was a problem hiding this comment.
Ah I see.. i think this is for when possibly, accidentially funds where sent to the stakevault?
Collaborator
Author
There was a problem hiding this comment.
Yes, and can also be used as a feature to StakeVault receive rewards from StakeManager.
Collaborator
Author
0x-r4bbit
requested changes
Oct 8, 2024
| */ | ||
| function withdraw(uint256 _amount) external onlyOwner { | ||
| _withdraw(_amount, payable(msg.sender)); | ||
| } |
Collaborator
There was a problem hiding this comment.
I just realized, there's actually very little point in having this here because this contract cannot receive any eth. There's no receive() or fallback implementation here. So we might as well drop this.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Fixes #143
This commit introduces new functions for keeping track of the total amount staked and implements a function to check the available amount of tokens that can be withdrawn. Users are able to withdraw tokens that are not commited to stake by calling the withdraw functions. These changes enhance the overall usability and flexibility of the StakeVault contract.
Checklist
Ensure you completed all of the steps below before submitting your pull request:
pnpm adorno?pnpm verify?