feat(merkle): Pad single tree leaves to next power of two #876
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
MauroToscano
approved these changes
Jun 21, 2024
PatStiles
force-pushed
the
feat/handle_one_leaf_in_merkle_tree
branch
from
c677e29 to
6dc1df4
Compare
PatStiles
force-pushed
the
feat/handle_one_leaf_in_merkle_tree
branch
from
6dc1df4 to
2977d1a
Compare
Oppen
reviewed
Jun 24, 2024
crypto/src/merkle_tree/utils.rs
Outdated
Comment on lines
32
to
36
| if x == 1 { | ||
| false | ||
| } else { | ||
| (x != 0) && ((x & (x - 1)) == 0) | ||
| } |
There was a problem hiding this comment.
Strictly speaking, this is not true. 1 is 2^0, so it is indeed a power of 2. That said, here's a simpler alternative:
Suggested change
| if x == 1 { | |
| false | |
| } else { | |
| (x != 0) && ((x & (x - 1)) == 0) | |
| } | |
| (x > 1) && ((x & (x - 1)) == 0) |
There was a problem hiding this comment.
Because technically we're lying, I expect a comment clarifying that:
- We need this to keep the smallest tree at two leaves count.
- We couldn't find a better name that wasn't overly verbose to what the function really does.
- The function is private (please make it private as well) and is only used to ensure the tree has a power of 2 number of leaves.
- A little white lie here saves us a lot of edge cases all around the code.
Otherwise, in a few months we will look at this, see it lies, conclude it's a bug, and proceed to "fix" it causing unexplainable bugs elsewhere.
There was a problem hiding this comment.
Thanks @Oppen will address this now.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #876 +/- ##
=======================================
Coverage 72.00% 72.01%
=======================================
Files 149 149
Lines 33373 33377 +4
=======================================
+ Hits 24031 24036 +5
+ Misses 9342 9341 -1 ☔ View full report in Codecov by Sentry. |
MauroToscano
approved these changes
Jul 2, 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.
Pad Single Tree leaves to next power of two
Description
For merkle trees with a single leaf, pads the number of leaves to the next power of two by appending the last element.
Type of change
Please delete options that are not relevant.
Checklist