mirror of
https://github.com/logos-storage/logos-storage-spec.git
synced 2026-01-05 23:13:09 +00:00
Update manifest.md
This commit is contained in:
parent
03300f8ea5
commit
51fdd99a2e
87
manifest.md
87
manifest.md
@ -13,9 +13,9 @@ contributors:
|
|||||||
This specification describes the parameters used in the manifest for a Codex client application.
|
This specification describes the parameters used in the manifest for a Codex client application.
|
||||||
|
|
||||||
## Background
|
## Background
|
||||||
The manifest is the default configuration for a Codex client.
|
The manifest is used to encode datasets with the a Codex client.
|
||||||
The file contains key-value pairs that are configuirable.
|
The file contains key-value pairs.
|
||||||
The structured format used is JSON.
|
|
||||||
|
|
||||||
## Manifest Parameters
|
## Manifest Parameters
|
||||||
|
|
||||||
@ -24,6 +24,7 @@ The structured format used is JSON.
|
|||||||
"manifest" : {
|
"manifest" : {
|
||||||
"treeCid" : "string"
|
"treeCid" : "string"
|
||||||
"datasetSize" : ,
|
"datasetSize" : ,
|
||||||
|
"blockSize" : ,
|
||||||
"codec" : ,
|
"codec" : ,
|
||||||
"hcodec" : ,
|
"hcodec" : ,
|
||||||
"version" : ,
|
"version" : ,
|
||||||
@ -33,7 +34,7 @@ The structured format used is JSON.
|
|||||||
"originalTreeCid" : ,
|
"originalTreeCid" : ,
|
||||||
"originalDatasetSize" :
|
"originalDatasetSize" :
|
||||||
"protectedStrategy" :
|
"protectedStrategy" :
|
||||||
"verifiable" : ,
|
"verifiable" : "bool" ,
|
||||||
"verifyRoot" : ,
|
"verifyRoot" : ,
|
||||||
"slotRoots" : ,
|
"slotRoots" : ,
|
||||||
"cellSize" : ,
|
"cellSize" : ,
|
||||||
@ -44,6 +45,82 @@ The structured format used is JSON.
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The structured format used is JSON.
|
||||||
|
|
||||||
`treeCid`
|
`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
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user