mirror of
https://github.com/status-im/nimbus-eth2.git
synced 2025-02-04 18:54:56 +00:00
613f4a9a50
When the BN-embedded LC makes sync progress, pass the corresponding execution block hash to the EL via `engine_forkchoiceUpdatedV1`. This allows the EL to sync to wall slot while the chain DAG is behind. Renamed `--light-client` to `--sync-light-client` for clarity, and `--light-client-trusted-block-root` to `--trusted-block-root` for consistency with `nimbus_light_client`. Note that this does not work well in practice at this time: - Geth sticks to the optimistic sync: "Ignoring payload while snap syncing" (when passing the LC head) "Forkchoice requested unknown head" (when updating to LC head) - Nethermind syncs to LC head but does not report ancestors as VALID, so the main forward sync is still stuck in optimistic mode: "Pre-pivot block, ignored and returned Syncing" To aid EL client teams in fixing those issues, having this available as a hidden option is still useful.
Documentation
material for mkdocs
The Nimbus guide is generated using Material for mkdocs, and installed using a python VENV (see Makefile).
mdbook
Some books in this folder were produced using mdBook - see installation guide.
# Install or update tooling (make sure you add "~/.cargo/bin" to PATH):
cargo install mdbook --version 0.4.18
cargo install mdbook-toc --version 0.8.0
cargo install mdbook-open-on-gh --version 2.1.0
cargo install mdbook-admonish --version 1.7.0
# Work on the book locally - open "http://localhost:4000" for live version
cd docs/the_nimbus_book
mdbook serve -p 4000
# Create a local copy of the book
make book
# Publish book using makefile (in the top-level dir)
make publish-book