refactor: cliarify a few names and add some docs to the wrapper #1418
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
MSevey
requested review from
a team,
staheri14 and
rach-id
and removed request for
a team
rootulp
previously approved these changes
Feb 22, 2023
pkg/wrapper/nmt_wrapper.go
Outdated
Comment on lines
118
to
122
| // isQuadrant0 returns true if the current share index and axis index are both | ||
| // in the original data square. | ||
| func (w *ErasuredNamespacedMerkleTree) isQuadrant0() bool { | ||
| return !(uint64(w.shareIndex)+1 > w.squareSize || uint64(w.axisIndex)+1 > w.squareSize) | ||
| } |
There was a problem hiding this comment.
[very optional] removed a negation because this may be clearer for readers
Suggested change
| // isQuadrant0 returns true if the current share index and axis index are both | |
| // in the original data square. | |
| func (w *ErasuredNamespacedMerkleTree) isQuadrant0() bool { | |
| return !(uint64(w.shareIndex)+1 > w.squareSize || uint64(w.axisIndex)+1 > w.squareSize) | |
| } | |
| // isQuadrantZero returns true if the current share index and axis index are both | |
| // in the original data square. | |
| func (w *ErasuredNamespacedMerkleTree) isQuadrantZero() bool { | |
| return w.shareIndex < w.squareSize && w.axisIndex < w.squareSize | |
| } |
There was a problem hiding this comment.
yes good idea, I just copy pasta'd
There was a problem hiding this comment.
couldn't accept here as we had to update the usage to the new name
Co-authored-by: Rootul P <rootulp@gmail.com>
Co-authored-by: Rootul P <rootulp@gmail.com>
Codecov Report
@@ Coverage Diff @@
## main #1418 +/- ##
==========================================
+ Coverage 48.39% 49.25% +0.85%
==========================================
Files 79 79
Lines 4465 4467 +2
==========================================
+ Hits 2161 2200 +39
+ Misses 2121 2085 -36
+ Partials 183 182 -1
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
rootulp
previously approved these changes
Feb 22, 2023
rach-id
reviewed
Feb 22, 2023
staheri14
previously approved these changes
Feb 22, 2023
| // pushed to the tree. It is expected to be in the range: 0 <= shareIndex < | ||
| // 2*squareSize. shareIndex is used to help determine which quadrant each | ||
| // leaf belongs to. | ||
| shareIndex uint64 |
There was a problem hiding this comment.
It is worth mentioning that the shareIndex also keeps track of the number of shares (i.e., the total number of leaves) that have been added to the tree so far.
Co-authored-by: Sanaz Taheri <35961250+staheri14@users.noreply.github.com>
rootulp
approved these changes
Feb 23, 2023
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.
Overview
some non-breaking refactors to hopefully make the wrapper slightly clearer
Checklist