-
Notifications
You must be signed in to change notification settings - Fork 312
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enforce string limits for deserialization #4567
Merged
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
erwanor
reviewed
Jun 10, 2024
erwanor
requested changes
Jun 10, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Relative to the proposed migration structure, the limits lgtm
cronokirby
approved these changes
Jun 10, 2024
erwanor
approved these changes
Jun 12, 2024
This was referenced Jun 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
A-governance
Area: Governance
A-staking
Area: Design and implementation of staking and delegation
consensus-breaking
breaking change to execution of on-chain data
migration
A pull request that contains a migration
_P-V1
Priority: slated for V1 release
state-breaking
breaking change to on-chain data
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.
Describe your changes
This follows the suggestion from @hdevalence in #3620 (comment) to add validation of user-supplied
String
lengths to the variousTryFrom
protobuf deserialization implementations.The user-supplied
String
values concerned are found within the governance and staking crates, concerning governance proposals and validator definitions.This is consensus breaking as historic data may not comply with the new limitations. Thus there may be unexpected panics when trying to retrieve and deserialize data from storage.
An additional migration has been included to truncate any existing data that does not adhere to the new limits.
The strings are configured to use byte length limits rather than character length limits. This seems favorable because values will be guaranteed to fit into fixed-size buffers of the byte length limit for the field. Code based on rust-lang/rust#93743 was pulled in to perform the truncation at UTF-8 character boundaries.
Issue ticket number and link
Closes #3620
Checklist before requesting a review