Skip to content

Commit c11d9d0

Browse files
committed
README: a picture is worth a thousand words
Signed-off-by: Ignacio Hagopian <jsign.uy@gmail.com>
1 parent d995745 commit c11d9d0

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,16 @@ The challenger knows the _Cid_ of a UnixFS DAG and the maximum size of the under
2323

2424
The proof is a sub-DAG of the original, which contains the path to the targeted block, plus each level of intermediate nodes.
2525

26+
Consider the following UnixFS DAG file with a fanout factor of 3:
27+
![image](https://user-images.githubusercontent.com/6136245/139512869-5135649f-dc34-4ef1-9862-5c47860ec581.png)
28+
([excalidraw link](https://excalidraw.com/#json=5662906028916736,qzS2x9JgfY30Vy2tbzWwiA)
29+
30+
Considering a verifer is asking a prover to provide a proof that it contains the corresponding block at the _file level offset_ X, the prover generates the subdag inside the green zone:
31+
- RoundIndigo nodes are internal DAG nodes that are somewhat small-ish and don't contain file data.
32+
- Square blocks are leaves that contain part of the original file data.
33+
- The indigo colored nodes are necessary nodes to make the proof verify that the target block (red) is at the specified offset.
34+
35+
2636
## Assumptions of the UnixFS DAG file
2737
This library works with any file UnixFS DAG. It doesn't assume any particular layout (e.g., balanced, trickle, etc.), chunking (e.g., fixed size, etc.), or other particular DAG builder configuration.
2838

0 commit comments

Comments
 (0)