Skip to content

Commit 8e4e16d

Browse files
committed
README: be bold in clarifying some expected things from the DAG
Signed-off-by: Ignacio Hagopian <jsign.uy@gmail.com>
1 parent f90ad10 commit 8e4e16d

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ The DAG can have different layouts (e.g., balanced, trickle, etc.), chunking (e.
5050
This minimum level of assumptions allows the challenger to only needed to know the _Cid_ and file size to ask and verify the proof.
5151
There's an inherent tradeoff between assumptions and possible optimizations of the proof. See _Proof size and benchmark_ section.
5252

53+
It is important to note that the UnixFS internal nodes should be _well formed_ in the sense that the _FileSize_ values for the protobufs should be correctly populated.
54+
Also, as mentioned in the library description, the Cid of the root should be a UnixFS file, and not other type (e.g: directory). Supporting directories should be doable if some extra walking is accepted.
55+
5356
## Proof format
5457
To avoid inventing any new proof standard or format, the proof is a byte array corresponding to a CAR file format of all the blocks that are part of the proof.
5558
The decision was mainly to avoid friction about defining a new format or standard.
@@ -117,6 +120,7 @@ Possible ideas in the near future:
117120
- [ ] CLI for validation from DealID in Filecoin network; maybe fun, but `Labels` are unverified.
118121
- [ ] Baking assumptions for shorter proofs.
119122
- [ ] godocs
123+
- [ ] Accept directory roots.
120124

121125
This is a side-project made for fun, so a priori is a hand-wavy roadmap.
122126

0 commit comments

Comments
 (0)