docs: added Merkle tree use recommendations #315
Conversation
Added FAQ to guide the developers about when and why use a specific type of Merkle tree for their projects The FAQ has a short text answer plus a comparison table with more detailed data Refs: privacy-scaling-explorations#311
There was a problem hiding this comment.
I love the table!
Just a small request for change regarding the formatting.
And make sure to check the formatting to ensure the CI check passes (see code quality and formatting)
What about benchmarks? Would you like tackling that in a later PR too?
Collecting data like this would be amazing (we could easily build nice charts from it):
| Tree Type | size (MB and/or leaves and/or tree depth ) | operation (insert, update ...) | time (ms) |
|---|
|
Sure, I can send it in another PR if you think it is a good idea |
Fix README format (prettier) Fix missing new lines in explanation text Add links to the homepage of the projects re 315
Fix README format (prettier) Fix missing new lines in explanation text Add links to the homepage of the projects re 315
|
I have already made the changes of formatting and the home pages URL for the projects, please help me with the review |
|
Congrats, your important contribution to this open-source project has earned you a GitPOAP! GitPOAP: 2024 ZK-KIT Contributor: Head to gitpoap.io & connect your GitHub account to mint! Learn more about GitPOAPs here. |
|
Thank you very much, I'm happy to start contributing! |
Description
Added FAQ to guide the developers about when and why use a specific type of Merkle tree for their projects
The FAQ has a short text answer plus a comparison table with more detailed data Refs: #311
Related Issue(s)
docs: add section to help choose merkle tree #311
Checklist
It would be helpful to write a comparison of of all them, answering questions like