Ethereum consensus client in Rust
Go to file
Jimmy Chen 75aea7054c Enshrine head state shuffling in the shuffling_cache (#4296)
## Issue Addressed

#4281 

## Proposed Changes

- Change `ShufflingCache` implementation from using `LruCache` to a custom cache that removes entry with lowest epoch instead of oldest insertion time.
- Protect the "enshrined" head shufflings when inserting new committee cache entries. The shuffling ids matching the head's previous, current, and future epochs will never be ejected from the cache during `Self::insert_cache_item`.

## Additional Info

There is a bonus point on shuffling preferences in the issue description that hasn't been implemented yet, as I haven't figured out a good way to do this:

> However I'm not convinced since there are some complexities around tie-breaking when two entries have the same epoch. Perhaps preferring entries in the canonical chain is best? 

We should be able to check if a block is on the canonical chain by:

```rust
canonical_head
        .fork_choice_read_lock()
        .contains_block(root)
```

However we need to interleave the shuffling and fork choice locks, which may cause deadlocks if we're not careful (mentioned by @paulhauner). Alternatively, we could use the `state.block_roots` field of the `chain.canonical_head.snapshot.beacon_state`, which avoids deadlock but requires more work.

I'd like to get some feedback on review & testing before I dig deeper into the preferences stuff, as having the canonical head preference may already be quite useful in preventing the issue raised.


Co-authored-by: Jimmy Chen <jimmy@sigmaprime.io>
2023-05-19 05:13:05 +00:00
.cargo Switch allocator to jemalloc (#3697) 2023-01-20 04:19:29 +00:00
.github Post merge local testnets (#3807) 2023-05-17 05:51:54 +00:00
account_manager remove withdrawal warning (#4207) 2023-05-01 08:22:40 +00:00
beacon_node Enshrine head state shuffling in the shuffling_cache (#4296) 2023-05-19 05:13:05 +00:00
book Replace ganache-cli with anvil (#3555) 2023-05-15 07:22:02 +00:00
boot_node Split common crates out into their own repos (#3890) 2023-04-28 01:15:40 +00:00
common Implement el_offline and use it in the VC (#4295) 2023-05-17 05:51:56 +00:00
consensus Implement el_offline and use it in the VC (#4295) 2023-05-17 05:51:56 +00:00
crypto Split common crates out into their own repos (#3890) 2023-04-28 01:15:40 +00:00
database_manager Super small improvement: Remove unnecessary mut (#3736) 2022-11-21 03:15:54 +00:00
lcli Post merge local testnets (#3807) 2023-05-17 05:51:54 +00:00
lighthouse Implement el_offline and use it in the VC (#4295) 2023-05-17 05:51:56 +00:00
scripts Post merge local testnets (#3807) 2023-05-17 05:51:54 +00:00
slasher Split common crates out into their own repos (#3890) 2023-04-28 01:15:40 +00:00
testing Replace ganache-cli with anvil (#3555) 2023-05-15 07:22:02 +00:00
validator_client Implement el_offline and use it in the VC (#4295) 2023-05-17 05:51:56 +00:00
watch Add beacon.watch (#3362) 2023-04-03 05:35:11 +00:00
.dockerignore Exclude EE build dirs from Docker context (#3174) 2022-05-09 23:43:31 +00:00
.editorconfig Add editorconfig template 2019-03-11 15:09:57 +11:00
.gitignore Docs for Siren (#4023) 2023-02-28 02:20:52 +00:00
.gitmodules Replace EF tests submodule with a makefile 2019-09-08 04:19:54 +10:00
bors.toml Switch allocator to jemalloc (#3697) 2023-01-20 04:19:29 +00:00
Cargo.lock Post merge local testnets (#3807) 2023-05-17 05:51:54 +00:00
Cargo.toml Split common crates out into their own repos (#3890) 2023-04-28 01:15:40 +00:00
CONTRIBUTING.md Add branching instructions to the contribution guide (#4272) 2023-05-08 12:20:19 +00:00
Cross.toml Ensure protoc is installed for release CI (#3621) 2022-10-03 23:09:25 +00:00
Dockerfile Enable build profiles for Docker source builds (#4237) 2023-05-03 04:12:11 +00:00
Dockerfile.cross Use a stable tag for ubuntu in dockerfile (#3231) 2022-05-31 06:09:12 +00:00
LICENSE Update License to Apache 2.0 2019-04-15 16:47:35 +10:00
Makefile Allow compilation with no slasher backend (#3888) 2023-02-28 02:20:49 +00:00
README.md Fix some dead links in markdown files (#3885) 2023-01-17 05:13:49 +00:00
SECURITY.md Add how users should report security vulnerabilities for this repository (#2562) 2021-09-07 01:54:05 +00:00

Lighthouse: Ethereum consensus client

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

Book Status Chat Badge

Documentation

Banner

Overview

Lighthouse is:

  • Ready for use on Ethereum consensus mainnet.
  • Fully open-source, licensed under Apache 2.0.
  • Security-focused. Fuzzing techniques have been continuously applied and several external security reviews have been performed.
  • 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, the Decentralization Foundation and private individuals.
  • Actively involved in the specification and security analysis of the Ethereum proof-of-stake consensus specification.

Staking Deposit Contract

The Lighthouse team acknowledges 0x00000000219ab540356cBB839Cbe05303d7705Fa as the canonical staking deposit contract address.

Documentation

The Lighthouse Book contains information for users and developers.

The Lighthouse team maintains a blog at lighthouse-blog.sigmaprime.io which contains periodical progress updates, roadmap insights and interesting findings.

Branches

Lighthouse maintains two permanent branches:

  • stable: Always points to the latest stable release.
    • This is ideal for most users.
  • unstable: Used for development, contains the latest PRs.
    • Developers should base their PRs on this branch.

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.

Sign up to the Lighthouse Development Updates mailing list for email notifications about releases, network status and other important information.

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).