fix: keep structs for storage layout compatability #31
Conversation
This file contains hidden or 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
Signed-off-by: Reinis Martinsons <reinis@umaproject.org>
Merged
md0x
approved these changes
Aug 20, 2025
mrice32
reviewed
Aug 20, 2025
| struct CustomBond { | ||
| uint256 amount; | ||
| // isSet is not used anymore as amount cannot be set to 0, but it is kept for storage layout compatibility. | ||
| bool isSet; |
Member
There was a problem hiding this comment.
Can we name it something distinct so it's clear it should not be used?
DEPRECATED_isSet;, for example.
See here as an example.
Collaborator
Author
There was a problem hiding this comment.
The upgrade verification check would fail and it is not possible to tag renamed struct member. The other alternative is to use @custom:oz-retyped-from, but that would forego storage layout checks for the whole struct.
mrice32
approved these changes
Aug 20, 2025
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.
#27 introduced storage layout changes against the already deployed pre-audit version. In order to maintain safe upgrade flow we should retain the original structs even when
isSetfield is not used anymore.