Update manifest.md

This commit is contained in:
Jimmy Debe 2024-10-03 15:23:34 -04:00 committed by GitHub
parent 51fdd99a2e
commit c65e7cc198
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -12,12 +12,11 @@ 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 ## Manifest
The manifest is used to encode datasets with the a Codex client. The manifest is used to encode datasets with the a Codex client node.
The file contains key-value pairs. The file contains key-value pairs.
### Parameters
## Manifest Parameters
```json ```json
@ -42,81 +41,29 @@ The file contains key-value pairs.
} }
``` ```
The structured format used is JSON. The structured format used is JSON.
`treeCid` | attribute | type | description |
|-----------|------|-------------|
- Root of the merkle root | `treeCid` | string | A hash based on [CIDv1](https://github.com/multiformats/cid#cidv1). The root of the merkle tree |
- Hash based on CIDv1 | `datasetSize` | bytes | Total size of all blocks, after data is chunked. |
| `blockSize` | bytes | Size of each contained block. |
`datasetSize` | `codec` | [MultiCodec](https://github.com/multiformats/multicodec) | A dataset codec. |
| `hcodec` | [MultiCodec](https://github.com/multiformats/multicodec) | A multihash codec. |
- Total size of all blocks, after data is chunked | `version` | string | The CID version |
- it SHOULD be in bytes | `protected` | bool | The protected datasets have erasure coded info, If true, `ecK`, `ecM`, `originalTreeCid`, `originalDatasetSize`, and `protectedStrategy` SHOULD be used.|
| `ecK` | int | The number of blocks to encode. |
`blockSize` | `ecM` | int | The number of resulting parity blocks. |
| `originalTreeCid` | string | The original root of the dataset being erasure coded. |
- Size of each contained block | `originalDatasetSize` | bytes | The size of the original dataset. |
| `protectedStrategy` | enum | An indexing strategy used to build the slot roots. |
`codec` | `verifiable` | bool | Verifiable datasets can be used to generate storage proofs. If true, `verifyRoot`, `slotRoots`, `cellSize`, and `verifiableStrategy` SHOULD be used. |
| `verifyRoot` | string | The root of the top level merkle tree built from slot roots. |
- Dataset codec | `slotRoots` | array[string] | Individual slot root built from the original dataset blocks. |
| `cellSize` | bytes | The size of each slot cell. |
`hcodec` | `verifiableStrategy` | enum | Indexing strategy used to build the slot roots. |
- 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
@ -124,3 +71,6 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public
## References ## References
- [MultiCodec](https://github.com/multiformats/multicodec)
- [CIDv1](https://github.com/multiformats/cid#cidv1)