Ethereum consensus client in Rust
Go to file
divma b8013b7b2c Super Silky Smooth Syncs, like a Sir (#1628)
## Issue Addressed
In principle.. closes #1551 but in general are improvements for performance, maintainability and readability. The logic for the optimistic sync in actually simple

## Proposed Changes
There are miscellaneous things here:
- Remove unnecessary `BatchProcessResult::Partial` to simplify the batch validation logic
- Make batches a state machine. This is done to ensure batch state transitions respect our logic (this was previously done by moving batches between `Vec`s) and to ease the cognitive load of the `SyncingChain` struct
- Move most batch-related logic to the batch
- Remove `PendingBatches` in favor of a map of peers to their batches. This is to avoid duplicating peers inside the chain (peer_pool and pending_batches)
- Add `must_use` decoration to the `ProcessingResult` so that chains that request to be removed are handled accordingly. This also means that chains are now removed in more places than before to account for unhandled cases
- Store batches in a sorted map (`BTreeMap`) access is not O(1) but since the number of _active_ batches is bounded this should be fast, and saves performing hashing ops. Batches are indexed by the epoch they start. Sorted, to easily handle chain advancements (range logic)
- Produce the chain Id from the identifying fields: target root and target slot. This, to guarantee there can't be duplicated chains and be able to consistently search chains by either Id or checkpoint
- Fix chain_id not being present in all chain loggers
- Handle mega-edge case where the processor's work queue is full and the batch can't be sent. In this case the chain would lose the blocks, remain in a "syncing" state and waiting for a result that won't arrive, effectively stalling sync.
- When a batch imports blocks or the chain starts syncing with a local finalized epoch greater that the chain's start epoch, the chain is advanced instead of reset. This is to avoid losing download progress and validate batches faster. This also means that the old `start_epoch` now means "current first unvalidated batch", so it represents more accurately the progress of the chain.
- Batch status peers from the same chain to reduce Arc access.
- Handle a couple of cases where the retry counters for a batch were not updated/checked are now handled via the batch state machine. Basically now if we forget to do it, we will know.
- Do not send back the blocks from the processor to the batch. Instead register the attempt before sending the blocks (does not count as failed)
- When re-requesting a batch, try to avoid not only the last failed peer, but all previous failed peers.
- Optimize requesting batches ahead in the buffer by shuffling idle peers just once (this is just addressing a couple of old TODOs in the code)
- In chain_collection, store chains by their id in a map
- Include a mapping from request_ids to (chain, batch) that requested the batch to avoid the double O(n) search on block responses
- Other stuff:
  - impl `slog::KV` for batches
  - impl `slog::KV` for syncing chains
  - PSA: when logging, we can use `%thing` if `thing` implements `Display`. Same for `?` and `Debug`

### Optimistic syncing:
Try first the batch that contains the current head, if the batch imports any block, advance the chain. If not, if this optimistic batch is inside the current processing window leave it there for future use, if not drop it. The tolerance for this block is the same for downloading, but just once for processing



Co-authored-by: Age Manning <Age@AgeManning.com>
2020-09-23 06:29:55 +00:00
.github Revert "add a github action for build multi-arch docker images (#1574)" (#1591) 2020-09-06 04:46:25 +00:00
account_manager Interactive account passwords (#1623) 2020-09-23 01:19:54 +00:00
beacon_node Super Silky Smooth Syncs, like a Sir (#1628) 2020-09-23 06:29:55 +00:00
book Add --staking flag (#1641) 2020-09-23 01:19:58 +00:00
boot_node Bump to v0.2.11 (#1645) 2020-09-22 04:45:15 +00:00
common Interactive account passwords (#1623) 2020-09-23 01:19:54 +00:00
consensus minimize the number of places we are calling update_pubkey_cache (#1626) 2020-09-23 01:19:56 +00:00
crypto Revert "Update BLST, add force-adx support (#1595)" (#1649) 2020-09-23 00:25:56 +00:00
hooks Add a flag to make lighthouse portable across machines (#1423) 2020-07-31 05:00:39 +00:00
lcli Bump to v0.2.11 (#1645) 2020-09-22 04:45:15 +00:00
lighthouse Interactive account passwords (#1623) 2020-09-23 01:19:54 +00:00
scripts Bump to v0.2.7 (#1561) 2020-08-24 08:25:34 +00:00
testing Eth1 network exit on wrong network id (#1563) 2020-08-31 02:36:17 +00:00
validator_client Bump to v0.2.11 (#1645) 2020-09-22 04:45:15 +00:00
.dockerignore Ensure .git is copied into docker (#1462) 2020-08-05 03:05:36 +00:00
.editorconfig Add editorconfig template 2019-03-11 15:09:57 +11:00
.gitignore Commit Cargo.lock changes, add build scripts (#1521) 2020-08-14 22:24:27 +00:00
.gitmodules Replace EF tests submodule with a makefile 2019-09-08 04:19:54 +10:00
bors.toml Fix bors timeouts (#1341) 2020-07-07 13:44:35 +00:00
Cargo.lock Revert "Update BLST, add force-adx support (#1595)" (#1649) 2020-09-23 00:25:56 +00:00
Cargo.toml Update LevelDB to v0.8.6, removing patch (#1636) 2020-09-21 11:53:53 +00:00
CONTRIBUTING.md Update CONTRIBUTING.md (#751) 2020-01-03 10:45:53 +11:00
Cross.toml Ensure RUSTFLAGS is passed through on cross compile (#1529) 2020-08-17 10:06:06 +00:00
Dockerfile Revert 1502 - Switching docker user to lighthouse (#1578) 2020-09-01 01:32:02 +00:00
LICENSE Update License to Apache 2.0 2019-04-15 16:47:35 +10:00
Makefile Commit Cargo.lock changes, add build scripts (#1521) 2020-08-14 22:24:27 +00:00
README.md Remove references to rust-docs (#1601) 2020-09-10 00:24:41 +00:00

Lighthouse: Ethereum 2.0

An open-source Ethereum 2.0 client, written in Rust and maintained by Sigma Prime.

Build Status Book Status Chat Badge

Documentation

terminalize

Overview

Lighthouse is:

  • Fully open-source, licensed under Apache 2.0.
  • Security-focused. Fuzzing has begun and security reviews are underway.
  • Built in Rust, a modern language providing unique safety guarantees and excellent performance (comparable to C++).
  • Funded by various organisations, including Sigma Prime, the Ethereum Foundation, ConsenSys and private individuals.
  • Actively involved in the specification and security analysis of the emerging Ethereum 2.0 specification.

Like all Ethereum 2.0 clients, Lighthouse is a work-in-progress.

Development Status

Current development overview:

  • Specification v0.12.1 implemented, optimized and passing test vectors.
  • Rust-native libp2p with Gossipsub and Discv5.
  • RESTful JSON API via HTTP server.
  • Events via WebSocket.
  • Metrics via Prometheus.

Roadmap

  • April 2019: Inital single-client testnets.
  • September 2019: Inter-operability with other Ethereum 2.0 clients.
  • Q1 2020: lighthouse-0.1.0 release: All major phase 0 features implemented.
  • Q2 2020: Public, multi-client testnet with user-facing functionality.
  • Q2 2020: Third-party security review.
  • Q3 2020: Additional third-party security reviews.
  • Q3 2020: Long-lived, multi-client Beacon Chain testnet
  • Q4 2020: Production Beacon Chain (tentative).

Documentation

The Lighthouse Book contains information for testnet users and developers.

If you'd like some background on Sigma Prime, please see the Lighthouse Update #00 blog post or sigmaprime.io.

Contributing

Lighthouse welcomes contributors.

If you are looking to contribute, please head to the Contributing section of the Lighthouse book.

Contact

The best place for discussion is the Lighthouse Discord server. Alternatively, you may use the sigp/lighthouse gitter.

Encrypt sensitive messages using our PGP key.

Donations

Lighthouse is an open-source project and a public good. Funding public goods is hard and we're grateful for the donations we receive from the community via:

  • Gitcoin Grants.
  • Ethereum address: 0x25c4a76E7d118705e7Ea2e9b7d8C59930d8aCD3b (donation.sigmaprime.eth).