Update manifest.md

This commit is contained in:
Jimmy Debe 2024-08-28 00:04:53 -04:00 committed by GitHub
parent 03300f8ea5
commit 51fdd99a2e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -13,9 +13,9 @@ contributors:
This specification describes the parameters used in the manifest for a Codex client application.
## Background
The manifest is the default configuration for a Codex client.
The file contains key-value pairs that are configuirable.
The structured format used is JSON.
The manifest is used to encode datasets with the a Codex client.
The file contains key-value pairs.
## Manifest Parameters
@ -24,6 +24,7 @@ The structured format used is JSON.
"manifest" : {
"treeCid" : "string"
"datasetSize" : ,
"blockSize" : ,
"codec" : ,
"hcodec" : ,
"version" : ,
@ -33,7 +34,7 @@ The structured format used is JSON.
"originalTreeCid" : ,
"originalDatasetSize" :
"protectedStrategy" :
"verifiable" : ,
"verifiable" : "bool" ,
"verifyRoot" : ,
"slotRoots" : ,
"cellSize" : ,
@ -44,6 +45,82 @@ The structured format used is JSON.
```
The structured format used is JSON.
`treeCid`
-
- Root of the merkle root
- Hash based on CIDv1
`datasetSize`
- Total size of all blocks, after data is chunked
- it SHOULD be in bytes
`blockSize`
- Size of each contained block
`codec`
- Dataset codec
`hcodec`
- Multihash codec
`version`
- CID version
`protected`
- Protected datasets have erasure coded info
- Only if `true`
`ecK`
- Number of blocks to encode
`ecM`
- Number of resulting parity blocks
`originalTreeCid`
- The original root of the dataset being erasure coded
`originalDatasetSize`
- The size of the original dataset
`protectedStrategy`
- Indexing strategy used to build the slot roots
`verifiable`
- Verifiable datasets can be used to generate storage proofs
`verifyRoot`
- Root of the top level merkle tree built from slot roots
`slotRoots`
- Individual slot root built from the original dataset blocks
`cellSize`
- Size of each slot cell
`verifiableStrategy`
- Indexing strategy used to build the slot roots
## Copyright
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
## References