Calculate Reward Earnings For Stakers #10
Merged
Conversation
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
alexkeating
reviewed
Jan 5, 2024
alexkeating
reviewed
Jan 5, 2024
alexkeating
reviewed
Jan 5, 2024
alexkeating
approved these changes
Jan 10, 2024
This commit implements the basic reward calculation mechanics associated with staking. The mechanics are largely modeled off the Synthetix StakingRewards contract. This commit also adds numerous tests, and related testing infrastructure for assesing whether the calucations for earned rewards is being done correctly.
Since we have (intentionally) left a full test suite of the reward earning functionality out of this PR for now, we lower the coverage threshold a bit. In the near future we will implement comprehensive tests and turn it back to 100.
|
Coverage after merging stake-earn into main will be
Coverage Report
|
|||||||||||||||||||||||||
wildmolasses
approved these changes
Jan 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR implements the calculation of reward earnings and adds some tests for these calculations as well. Note that reward earning calculations are a port of the battle tested Synthetix Staking Rewards contract.
This PR is not as exhaustive as it could be, to prevent it from becoming too large. Purposely omitted from this PR are:
Making the notify rewards method permissionedEDIT: with the merger of Add and test privileged rewards notifier role #12 this functionality is now includedEach of these will be tackled in future PRs. While these tasks are already documented in the spec issues, several "TODO" statements have also been left in the code for now as reminders. There are also comments left intentionally as reminders to revisit possible areas for better naming, refactoring and gas savings.