Code Cleanup: MsgLiquidStake #651
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
asalzmann
requested changes
Mar 9, 2023
asalzmann
reviewed
Mar 10, 2023
shellvish
approved these changes
Mar 10, 2023
riley-stride
approved these changes
Mar 10, 2023
asalzmann
approved these changes
Mar 11, 2023
sontrinh16
pushed a commit
to notional-labs/stride
that referenced
this pull request
Mar 27, 2023
Closes: #XXX
## Context and purpose of the change
Cleaned up MsgLiquidStake
## Brief Changelog
* Cleaned up variable naming, commenting, logging, and errors
* Moved validation checks as upstream as possible so that they occur before any state changes (relevant to protocol directed liquid stakes)
* Added filter to GetDepositRecordsByEpochAndChain to only grab transfer records
* Added event emission after LS
* Added check to error if the LS would result in 0 stTokens
## Author's Checklist
I have...
- [ ] Run and PASSED locally all GAIA integration tests
- [ ] If the change is contentful, I either:
- [ ] Added a new unit test OR
- [ ] Added test cases to existing unit tests
- [ ] OR this change is a trivial rework / code cleanup without any test coverage
If skipped any of the tests above, explain.
## Reviewers Checklist
*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*
I have...
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] manually tested (if applicable)
- [ ] confirmed the author wrote unit tests for new logic
- [ ] reviewed documentation exists and is accurate
## Documentation and Release Note
- [ ] Does this pull request introduce a new feature or user-facing behavior changes?
- [ ] Is a relevant changelog entry added to the `Unreleased` section in `CHANGELOG.md`?
- [ ] This pull request updates existing proto field values (and require a backend and frontend migration)?
- [ ] Does this pull request change existing proto field names (and require a frontend migration)?
How is the feature or change documented?
- [ ] not applicable
- [ ] jira ticket `XXX`
- [ ] specification (`x/<module>/spec/`)
- [ ] README.md
- [ ] not documented
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.
Closes: #XXX
Context and purpose of the change
Cleaned up MsgLiquidStake
Brief Changelog
Author's Checklist
I have...
If skipped any of the tests above, explain.
Reviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
Documentation and Release Note
Unreleasedsection inCHANGELOG.md?How is the feature or change documented?
XXXx/<module>/spec/)