9180f09641
The optimistic sync spec was updated since the LC based optsync module was introduced. It is no longer necessary to wait for the justified checkpoint to have execution enabled; instead, any block is okay to be optimistically imported to the EL client, as long as its parent block has execution enabled. Complex syncing logic has been removed, and the LC optsync module will now follow gossip directly, reducing the latency when using this module. Note that because this is now based on gossip instead of using sync manager / request manager, that individual blocks may be missed. However, EL clients should recover from this by fetching missing blocks themselves. |
||
---|---|---|
.. | ||
nbc_audit_2020 | ||
the_auditors_handbook | ||
the_nimbus_book | ||
.gitignore | ||
Makefile | ||
README.md | ||
attestation_flow.dot | ||
attestation_flow.md | ||
attestation_flow.png | ||
block_flow.dot | ||
block_flow.md | ||
block_flow.png | ||
cpu_features.md | ||
e2store.md | ||
kiln_geth_local_testnet.md | ||
kiln_geth_logs.png | ||
logging.md | ||
nimbus_localhost_run.png | ||
requirements.in | ||
requirements.txt |
README.md
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