Split node reference vs. index to separate interfaces for API clarity #91
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
Signed-off-by: Jim Zhang <jim.zhang@kaleido.io>
Chengxuan
reviewed
Oct 4, 2024
There was a problem hiding this comment.
@jimthematrix I proposed some suggestions, can you please take a look?
Co-authored-by: Chengxuan Xing <chengxuan.xing@kaleido.io> Signed-off-by: jimthematrix <jim.zhang@kaleido.io>
Co-authored-by: Chengxuan Xing <chengxuan.xing@kaleido.io> Signed-off-by: jimthematrix <jim.zhang@kaleido.io>
Co-authored-by: Chengxuan Xing <chengxuan.xing@kaleido.io> Signed-off-by: jimthematrix <jim.zhang@kaleido.io>
Co-authored-by: Chengxuan Xing <chengxuan.xing@kaleido.io> Signed-off-by: jimthematrix <jim.zhang@kaleido.io>
Co-authored-by: Chengxuan Xing <chengxuan.xing@kaleido.io> Signed-off-by: jimthematrix <jim.zhang@kaleido.io>
Co-authored-by: Chengxuan Xing <chengxuan.xing@kaleido.io> Signed-off-by: jimthematrix <jim.zhang@kaleido.io>
Signed-off-by: Chengxuan Xing <chengxuan.xing@kaleido.io>
Chengxuan
approved these changes
Oct 4, 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.
The node reference is a hash of the index + value + 1, which is used to refer to a node in the sparse merkle tree. The node index is used to position the node in the tree, which determines the path used to traverse from the root to the leaf node (branch nodes do not have an index).
Currently the usage of a reference and an index are mixed, making it confusing in the code, as well as the API surface. This PR splits them into separate interfaces, with the index being a superset of the reference interface.