-
Notifications
You must be signed in to change notification settings - Fork 106
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
change(state): Refactor the naming of note commitment subtrees #7855
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
I'm not actually sure about the solution in this PR. Do others have suggestions for better solutions? |
arya2
previously approved these changes
Oct 27, 2023
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.
Looks good, thank you!
arya2
reviewed
Oct 27, 2023
arya2
approved these changes
Oct 30, 2023
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.
Thank you!
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.
Motivation
Close #7463.
Solution
#7463 mentions that "We are storing subtree roots and end heights in the subtree indexes, not the subtree trees themselves." I thought of renaming
NoteCommitmentSubtree
toSubtreeRoot
, but there were at least two problems with that:NoteCommitmentSubtreeData
, which I wasn't sure how to rename.NoteCommitmentSubtree
has a fieldnode
, which I had renamed toroot
, so we would end up with something likesubtree_root.root
.Given the issues above, I decided to do a simpler refactor:
Node
inNoteCommitmentSubtree
toRoot
.node
inNoteCommitmentSubtree
toroot
.end
inNoteCommitmentSubtree
toend_height
to match the name in the RPC so that the field doesn't need to be renamed for the RPC.After this refactor, I didn't find any docs that would require changes.
Also, if we ever need to store whole subtrees instead of only roots, we can use the already existing struct
NoteCommitmentSubtree
, but keep the RPC that currently uses this struct intact because it actually usesNoteCommitmentSubtreeData
.Reviewer Checklist