docs: Data model for append-only Merkle trees #25
Conversation
Codecov Report
@@ Coverage Diff @@
## main #25 +/- ##
=======================================
Coverage 88.93% 88.93%
=======================================
Files 7 7
Lines 497 497
=======================================
Hits 442 442
Misses 50 50
Partials 5 5 Continue to review full report at Codecov.
|
pav-kv
force-pushed
the
document_merkle_data_model
branch
3 times, most recently
from
3c5046d to
9bf44c8
Compare
|
Hi team. I am clearing my github backlog. Please merge this PR, or let me know how I can improve it. |
docs/data_model.md
Outdated
| The data structure evolves dynamically. Initially, the log is empty, and all the | ||
| nodes of the tree have no data. When new entries are appended to the log, some | ||
| nodes that recursively depend on these entries, are updated. While the nodes can | ||
| be updated, they are in **ephemeral** state. Eventually, when the log grows past |
There was a problem hiding this comment.
A gentle suggestion for rephrasing the last sentence in here, I don't feel super strongly about it though, and it's more wordy than yours, so feel free to take to leave as you think best.
Nodes on the right-hand side of the tree which do not yet cover a perfect subtree (i.e. those nodes with fewer than 2level entries beneath them) are termed ephemeral.
Ephemeral nodes will continue to be updated as new entries are added to the log until the node's subtree becomes perfect, at which point that node (and all those below it) will never be modified again.
|
|
||
| ### Tree state | ||
|
|
||
| To represent the state of the entire log, often a single ephemeral node is used |
There was a problem hiding this comment.
How about rearranging slightly to something like:
To represent the state of the entire log the single node which covers all leaves in the log is used. For example, in a tree with 21 ... node
5.0.
pav-kv
force-pushed
the
document_merkle_data_model
branch
from
9bf44c8 to
f860f71
Compare
|
I did not address all rewording comments, was going to do it later. But anyway, this doc needs further work, so can be addressed in follow-ups. |
I noticed, but interpreted it as declining the suggestions - follow up(s) are, of course, more than welcome, though :) |
This change adds some terminology to the docs.