refactor(StakeManager): initialMP -> bonusMP, currentMP -> totalMP #95
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
After discussing this offline, we've decided that the naming of these properties was misleading. This commit performs the following changes: - `account.initialMP` becomes `account.bonusMP` - `account.currentMP` becomes `account.totalMP` Rationale: `initialMP` indicates that this is an immutable field which is not the case as in scenarios where accounts increase the `lock()` time, they'll also increase their bonus multiplier (`initialMP`). `currentMP` was misleading in combination with `initialMP`. Really what it reflects is the total multiplier points of an account **including** its bonus multiplier points.
6 tasks
3esmit
approved these changes
Jun 25, 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.
After discussing this offline, we've decided that the naming of these properties was misleading. This commit performs the following changes:
account.initialMPbecomesaccount.bonusMPaccount.currentMPbecomesaccount.totalMPRationale:
initialMPindicates that this is an immutable field which is not the case as in scenarios where accounts increase thelock()time, they'll also increase their bonus multiplier (initialMP).currentMPwas misleading in combination withinitialMP. Really what it reflects is the total multiplier points of an account including its bonus multiplier points.Checklist
Ensure you completed all of the steps below before submitting your pull request:
forge snapshot?pnpm gas-report?pnpm lint?forge test?pnpm verify?