Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Separate out memory-backed tree #3

Merged
merged 24 commits into from
Nov 21, 2024
Merged

Separate out memory-backed tree #3

merged 24 commits into from
Nov 21, 2024

Conversation

rozbb
Copy link
Owner

@rozbb rozbb commented Nov 11, 2024 •
edited
Loading

Pasting changelog below. There are breaking changes. The key items here are the additions.

Additions

  • Added indices_for_inclusion_proof() and indices_for_consistency_proof() methods. These allow the construction of inclusion proofs for trees which do not fit into memory.
  • Relatedly, added InclusionProof::from_digests() and ConsistencyProof::from_digests()

Removals

  • Removed SimpleWriter trait in favor of the pre-existing digest::Update
  • Removed serde trait impls from InclusionProof and ConsistencyProof

Changes

  • Renamed the CtMerkleTree struct to MemoryBackedTree
  • Renamed the CanonicalSerialize trait to HashableLeaf
  • Changed argument to MemoryBackedTree::prove_consistency to be the number of additions, rather than the size of the prefix
  • Made all verification methods panic-free

Michael Rosenberg added 18 commits November 6, 2024 23:32
Renamed CtMerkleTree -> MemoryBackedTree
3a45486
Added internal functions to collect necessary indices for inclusion a…
9e5c8ca 
…nd consistency proofs
Changed index type to be u64
1f05d19
Renamed mod merkle_tree to mem_backed_tree
63af22d
Increased sample size of unit tests
61a8b71
Removed dead method
453a375
Fixed #internalnodes calculation bug when #leaves = 1
82b43df
Publicized new *_indices methods
ffe5e1b
Added CHANGELOG
0d08164
Improved documentation
879e775
Moved defs around; removed SimpleWriter; renamed CanonicalSerialize t…
cd2ffcc 
…o HashableLeaf
Renamed tree_math -> tree_util; moved HashableLeaf to tree_util
14fe1dd
Updated changelog
99e051a
Removed serde autoderives for inclusion and consistency proofs.
d1c89e0 
IMO, visible types with canonical byte representations should not
offer alternative representations. We leave it to the user.
Updated changelog
4566ab9
Also removed serde from RootHash for same reasons
fa9fec0
Added example to readme
d414179
Improved doc comments and errors
3362da7
lukevalenta
lukevalenta approved these changes Nov 12, 2024
View reviewed changes
Copy link

@lukevalenta lukevalenta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few minor nits, but looks great overall!

src/lib.rs Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
src/mem_backed_tree.rs Outdated Show resolved Hide resolved
src/mem_backed_tree.rs Outdated Show resolved Hide resolved
src/lib.rs Show resolved Hide resolved
src/mem_backed_tree.rs Outdated Show resolved Hide resolved
src/mem_backed_tree.rs Outdated Show resolved Hide resolved
src/tree_util.rs Show resolved Hide resolved
src/tree_util.rs Outdated Show resolved Hide resolved
@rozbb rozbb merged commit c51e6c3 into main Nov 21, 2024
11 checks passed
@rozbb rozbb deleted the separate-out-mem-backed-tree branch November 21, 2024 23:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lukevalenta lukevalenta lukevalenta approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rozbb @lukevalenta