IntersectMBO / IntersectMBO/ouroboros-consensus

Improve documentation of ledger-based validation options in db-analyser

Open
#35 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Haskell
Stars
67
Forks
43
Avg merge
5d 13h
Merged PRs (30d)
43

Description

Flags `--validate-all-blocks` and `--minimum-block-validation` can cause confusion among `db-analyser` users who might think that they refer to /Ledger-based/ validation. In addition, this tool's documentation does not mention which option to use to only validate blocks in the ChainDB. We should therefore:

- [ ] Document the `--trace-ledger` option, which performs ledger-based validation of blocks.
- [ ] Add an example showing the usage of `--trace-ledger`, since this is a common enough use case.
- [x] Document `--validate-all-blocks` and `--minimum-block-validation` options to avoid confusion with `--trace-ledger` option. #1155
- [ ] Add progress tracing to the `--trace-ledger` analysis.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.