2019-06-25 04:02:19 +00:00
|
|
|
# Lighthouse: Ethereum 2.0
|
|
|
|
|
|
|
|
|
|
An open-source Ethereum 2.0 client, written in Rust and maintained by Sigma Prime.
|
2018-07-06 07:54:07 +00:00
|
|
|
|
2020-09-10 00:24:41 +00:00
|
|
|
[![Build Status]][Build Link] [![Book Status]][Book Link] [![Chat Badge]][Chat Link]
|
2019-05-10 01:49:28 +00:00
|
|
|
|
2019-12-01 02:08:26 +00:00
|
|
|
[Build Status]: https://github.com/sigp/lighthouse/workflows/test-suite/badge.svg?branch=master
|
2019-11-25 04:48:24 +00:00
|
|
|
[Build Link]: https://github.com/sigp/lighthouse/actions
|
2019-07-31 21:53:30 +00:00
|
|
|
[Chat Badge]: https://img.shields.io/badge/chat-discord-%237289da
|
|
|
|
|
[Chat Link]: https://discord.gg/cyAszAh
|
2019-10-02 01:04:56 +00:00
|
|
|
[Book Status]:https://img.shields.io/badge/user--docs-master-informational
|
2020-11-09 01:28:39 +00:00
|
|
|
[Book Link]: https://lighthouse-book.sigmaprime.io
|
2019-10-02 01:04:56 +00:00
|
|
|
|
2020-11-09 01:28:39 +00:00
|
|
|
[Documentation](https://lighthouse-book.sigmaprime.io)
|
2019-12-09 11:42:36 +00:00
|
|
|
|
2020-10-23 04:16:38 +00:00
|
|
|
|
2018-07-12 05:01:28 +00:00
|
|
|
|
2020-11-04 19:46:42 +00:00
|
|
|
**🚨🚨🚨 Note: Lighthouse is not *yet* ready to produce mainnet deposits. The developers will require some
|
|
|
|
|
time to test against the mainnet deposit contract, once it is released. DO NOT SUBMIT VALIDATOR
|
|
|
|
|
DEPOSITS WITH LIGHTHOUSE. 🚨🚨🚨**
|
|
|
|
|
|
2019-06-25 04:02:19 +00:00
|
|
|
## Overview
|
|
|
|
|
|
|
|
|
|
Lighthouse is:
|
|
|
|
|
|
|
|
|
|
- Fully open-source, licensed under Apache 2.0.
|
2020-08-04 09:19:14 +00:00
|
|
|
- Security-focused. Fuzzing has begun and security reviews are underway.
|
2020-11-09 01:28:39 +00:00
|
|
|
- Built in [Rust](https://www.rust-lang.org), a modern language providing unique safety guarantees and
|
2019-06-25 04:02:19 +00:00
|
|
|
excellent performance (comparable to C++).
|
|
|
|
|
- Funded by various organisations, including Sigma Prime, the
|
2019-07-26 19:26:06 +00:00
|
|
|
Ethereum Foundation, ConsenSys and private individuals.
|
2020-10-23 04:16:38 +00:00
|
|
|
- Actively involved in the specification and security analysis of the
|
|
|
|
|
Ethereum 2.0 specification.
|
2019-06-25 04:02:19 +00:00
|
|
|
|
2019-10-02 01:04:56 +00:00
|
|
|
Like all Ethereum 2.0 clients, Lighthouse is a work-in-progress.
|
2019-06-25 04:02:19 +00:00
|
|
|
|
2020-11-04 19:46:42 +00:00
|
|
|
## Eth2 Deposit Contract
|
|
|
|
|
|
|
|
|
|
The Lighthouse team acknowledges
|
|
|
|
|
[`0x00000000219ab540356cBB839Cbe05303d7705Fa`](https://etherscan.io/address/0x00000000219ab540356cbb839cbe05303d7705fa)
|
|
|
|
|
as the canonical Eth2 deposit contract address.
|
|
|
|
|
|
2019-06-25 04:02:19 +00:00
|
|
|
## Development Status
|
|
|
|
|
|
|
|
|
|
Current development overview:
|
|
|
|
|
|
2020-10-23 04:16:38 +00:00
|
|
|
- Specification `v1.0.0` implemented, optimized and passing test vectors.
|
Update to frozen spec ❄️ (v0.8.1) (#444)
* types: first updates for v0.8
* state_processing: epoch processing v0.8.0
* state_processing: block processing v0.8.0
* tree_hash_derive: support generics in SignedRoot
* types v0.8: update to use ssz_types
* state_processing v0.8: use ssz_types
* ssz_types: add bitwise methods and from_elem
* types: fix v0.8 FIXMEs
* ssz_types: add bitfield shift_up
* ssz_types: iterators and DerefMut for VariableList
* types,state_processing: use VariableList
* ssz_types: fix BitVector Decode impl
Fixed a typo in the implementation of ssz::Decode for BitVector, which caused it
to be considered variable length!
* types: fix test modules for v0.8 update
* types: remove slow type-level arithmetic
* state_processing: fix tests for v0.8
* op_pool: update for v0.8
* ssz_types: Bitfield difference length-independent
Allow computing the difference of two bitfields of different lengths.
* Implement compact committee support
* epoch_processing: committee & active index roots
* state_processing: genesis state builder v0.8
* state_processing: implement v0.8.1
* Further improve tree_hash
* Strip examples, tests from cached_tree_hash
* Update TreeHash, un-impl CachedTreeHash
* Update bitfield TreeHash, un-impl CachedTreeHash
* Update FixedLenVec TreeHash, unimpl CachedTreeHash
* Update update tree_hash_derive for new TreeHash
* Fix TreeHash, un-impl CachedTreeHash for ssz_types
* Remove fixed_len_vec, ssz benches
SSZ benches relied upon fixed_len_vec -- it is easier to just delete
them and rebuild them later (when necessary)
* Remove boolean_bitfield crate
* Fix fake_crypto BLS compile errors
* Update ef_tests for new v.8 type params
* Update ef_tests submodule to v0.8.1 tag
* Make fixes to support parsing ssz ef_tests
* `compact_committee...` to `compact_committees...`
* Derive more traits for `CompactCommittee`
* Flip bitfield byte-endianness
* Fix tree_hash for bitfields
* Modify CLI output for ef_tests
* Bump ssz crate version
* Update ssz_types doc comment
* Del cached tree hash tests from ssz_static tests
* Tidy SSZ dependencies
* Rename ssz_types crate to eth2_ssz_types
* validator_client: update for v0.8
* ssz_types: update union/difference for bit order swap
* beacon_node: update for v0.8, EthSpec
* types: disable cached tree hash, update min spec
* state_processing: fix slot bug in committee update
* tests: temporarily disable fork choice harness test
See #447
* committee cache: prevent out-of-bounds access
In the case where we tried to access the committee of a shard that didn't have a committee in the
current epoch, we were accessing elements beyond the end of the shuffling vector and panicking! This
commit adds a check to make the failure safe and explicit.
* fix bug in get_indexed_attestation and simplify
There was a bug in our implementation of get_indexed_attestation whereby
incorrect "committee indices" were used to index into the custody bitfield. The
bug was only observable in the case where some bits of the custody bitfield were
set to 1. The implementation has been simplified to remove the bug, and a test
added.
* state_proc: workaround for compact committees bug
https://github.com/ethereum/eth2.0-specs/issues/1315
* v0.8: updates to make the EF tests pass
* Remove redundant max operation checks.
* Always supply both messages when checking attestation signatures -- allowing
verification of an attestation with no signatures.
* Swap the order of the fork and domain constant in `get_domain`, to match
the spec.
* rustfmt
* ef_tests: add new epoch processing tests
* Integrate v0.8 into master (compiles)
* Remove unused crates, fix clippy lints
* Replace v0.6.3 tags w/ v0.8.1
* Remove old comment
* Ensure lmd ghost tests only run in release
* Update readme
2019-07-30 02:44:51 +00:00
|
|
|
- Rust-native libp2p with Gossipsub and Discv5.
|
2019-10-02 01:04:56 +00:00
|
|
|
- RESTful JSON API via HTTP server.
|
|
|
|
|
- Events via WebSocket.
|
2019-06-25 04:02:19 +00:00
|
|
|
- Metrics via Prometheus.
|
|
|
|
|
|
|
|
|
|
### Roadmap
|
|
|
|
|
|
2019-10-02 01:04:56 +00:00
|
|
|
- ~~**April 2019**: Inital single-client testnets.~~
|
|
|
|
|
- ~~**September 2019**: Inter-operability with other Ethereum 2.0 clients.~~
|
2020-04-27 10:21:02 +00:00
|
|
|
- ~~**Q1 2020**: `lighthouse-0.1.0` release: All major phase 0 features implemented.~~
|
2020-06-12 10:38:09 +00:00
|
|
|
- ~~**Q2 2020**: Public, multi-client testnet with user-facing functionality.~~
|
|
|
|
|
- ~~**Q2 2020**: Third-party security review.~~
|
2020-10-23 04:16:38 +00:00
|
|
|
- ~~**Q4 2020**: Long-lived, multi-client Beacon Chain testnet~~
|
|
|
|
|
- **Q4 2020**: Additional third-party security reviews.
|
2020-06-12 10:38:09 +00:00
|
|
|
- **Q4 2020**: Production Beacon Chain (tentative).
|
2019-06-25 04:02:19 +00:00
|
|
|
|
|
|
|
|
|
2019-10-02 01:04:56 +00:00
|
|
|
## Documentation
|
2019-06-25 04:02:19 +00:00
|
|
|
|
2020-11-09 01:28:39 +00:00
|
|
|
The [Lighthouse Book](https://lighthouse-book.sigmaprime.io) contains information
|
2019-10-02 01:04:56 +00:00
|
|
|
for testnet users and developers.
|
2019-06-25 04:02:19 +00:00
|
|
|
|
2019-02-14 01:09:18 +00:00
|
|
|
If you'd like some background on Sigma Prime, please see the [Lighthouse Update
|
2019-10-02 01:04:56 +00:00
|
|
|
\#00](https://lighthouse.sigmaprime.io/update-00.html) blog post or
|
|
|
|
|
[sigmaprime.io](https://sigmaprime.io).
|
2019-02-28 13:18:53 +00:00
|
|
|
|
2019-06-25 04:02:19 +00:00
|
|
|
## Contributing
|
|
|
|
|
|
2019-10-02 01:04:56 +00:00
|
|
|
Lighthouse welcomes contributors.
|
2019-02-14 01:09:18 +00:00
|
|
|
|
2019-10-02 01:04:56 +00:00
|
|
|
If you are looking to contribute, please head to the
|
2020-11-09 01:28:39 +00:00
|
|
|
[Contributing](https://lighthouse-book.sigmaprime.io/contributing.html) section
|
2019-10-02 01:04:56 +00:00
|
|
|
of the Lighthouse book.
|
2018-07-06 07:54:07 +00:00
|
|
|
|
|
|
|
|
## Contact
|
|
|
|
|
|
2019-07-31 21:53:30 +00:00
|
|
|
The best place for discussion is the [Lighthouse Discord
|
|
|
|
|
server](https://discord.gg/cyAszAh). Alternatively, you may use the
|
|
|
|
|
[sigp/lighthouse gitter](https://gitter.im/sigp/lighthouse).
|
2018-10-03 08:37:28 +00:00
|
|
|
|
2019-10-02 01:04:56 +00:00
|
|
|
Encrypt sensitive messages using our [PGP
|
|
|
|
|
key](https://keybase.io/sigp/pgp_keys.asc?fingerprint=dcf37e025d6c9d42ea795b119e7c6cf9988604be).
|
|
|
|
|
|
2019-06-25 04:02:19 +00:00
|
|
|
## Donations
|
2018-12-19 01:54:31 +00:00
|
|
|
|
2019-10-02 01:04:56 +00:00
|
|
|
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:
|
2018-12-19 01:54:31 +00:00
|
|
|
|
2019-10-02 01:04:56 +00:00
|
|
|
- [Gitcoin Grants](https://gitcoin.co/grants/25/lighthouse-ethereum-20-client).
|
|
|
|
|
- Ethereum address: `0x25c4a76E7d118705e7Ea2e9b7d8C59930d8aCD3b` (donation.sigmaprime.eth).
|
