Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
typos
markdown formatting
line breaks at sentences for easier PR reviewing & editing
some style editing (we = DataTrails), although there was too much to do without losing the personal connection Robin is making with this article.

Signed-off-by: Steve Lasker <stevenlasker@hotmail.com>
  • Loading branch information
SteveLasker committed Apr 17, 2024
1 parent ee0f09e commit cca632a
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 40 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@
toc: true
---

This page provides lookup tables for navigating the dynamic, but computable, offsets into the Merkle log binary format. The algorithms to reproduce this are relatively simple, we provide open source implementations, but in many contexts it is simpler to use these pre-calculations. These tables can be made for any log configuration at any time, in part or in whole, without access to any specific log.
This page provides lookup tables for navigating the dynamic, but computable, offsets into the Merkle log binary format.
The algorithms to reproduce this are relatively simple.
We provide open-source implementations, but in many contexts, it is simpler to use these pre-calculations.
These tables can be made for any log configuration at any time, in part or in whole, without access to any specific log.

This is a fast review of the log format. We explain this in more detail at [Navigating the Merkle Log](/developers/developer-patterns/navigating-merklelogs)

Expand Down Expand Up @@ -54,7 +57,8 @@ Using the `veracity` tool with the following command line we can reproduce our c



In the following table *Stack Start* and *mmr Start* are byte offsets from the start of the file. The leaf values are indices into the trie fields (not considered further in this page) and the node values are indices into the array of 32 byte nodes starting at *mmr Start*
In the following table *Stack Start* and *mmr Start* are byte offsets from the start of the file.
The leaf values are indices into the trie fields (not considered further in this page) and the node values are indices into the array of 32-byte nodes starting at *mmr Start*

| Massif | Stack Start| mmr Start | First leaf | Last Leaf | First Node | Last Node | Peak Stack |
| -------| ---------- | --------- | ---------- | ---------- | ----------- | --------- | --------- |
Expand Down Expand Up @@ -138,8 +142,8 @@ Stack Start needs details from [Navigating the Merkle Log](/developers/developer

## The algorithms backing the table generation

In combination with the format inforation at [Navigating the Merkle Log](/developers/developer-patterns/navigating-merklelogs)
the pre-computed tables above can be generated using these examples. We provide open source, go-lang based, tooling to do this.
In combination with the format information at [Navigating the Merkle Log](/developers/developer-patterns/navigating-merklelogs) the pre-computed tables above can be generated using these examples.
DataTrails provides open source, go-lang based, tooling at [URL] (_[__]__ )

{{< tabs name="convert idtimestamp" >}}
{{< tab name="Leaf Count and Massif Index" >}}
Expand Down
Loading

0 comments on commit cca632a

Please sign in to comment.