Feat/Add Events and Natspec to Staking Contract #3
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
This helps to calculate the user rewards off-chain
Helper functions were added to calcualte alpha and rewards in tests. However these are not meant to test the implementation of the test calculation. Rather they are intended to help check whether the stored values such as in events are same as the calculated values.
- The Unstake event was added, along with associated tests - The test for events in staking was modified to include a time variable as well
Earlier alpha was being updated in its own function `_updateAlpha`. This was made a view function `_calculateAccruedAlpha`, and the actual updating of alpha was done within the `_updateReward` function. This makes the logic within it clean - It calls other view functions for the calculation, and handles the events and storage variable updates within itself.
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.
What?
This PR adds events to the Staking Contract. It also adds Natspec documentation to the same file.
Why?
This helps us to access historical data to conduct analytics off-chain.
How?
We have added Solidity Events as well as associated tests. The Natspec was added next to every code symbol.