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-06-12 10:38:09 +00:00
|
|
|
[![Build Status]][Build Link] [![Book Status]][Book Link] [![RustDoc Status]][RustDoc 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
|
|
|
|
|
[Book Link]: http://lighthouse-book.sigmaprime.io/
|
|
|
|
|
[RustDoc Status]:https://img.shields.io/badge/code--docs-master-orange
|
|
|
|
|
[RustDoc Link]: http://lighthouse-docs.sigmaprime.io/
|
|
|
|
|
|
2019-12-09 11:42:36 +00:00
|
|
|
[Documentation](http://lighthouse-book.sigmaprime.io/)
|
|
|
|
|
|
Eth1 Integration (#542)
* Refactor to cache Eth1Data
* Fix merge conflicts and minor refactorings
* Rename Eth1Cache to Eth1DataCache
* Refactor events subscription
* Add deposits module to interface with BeaconChain deposits
* Remove utils
* Rename to types.rs and add trait constraints to Eth1DataFetcher
* Confirm to trait constraints. Make Web3DataFetcher cloneable
* Make fetcher object member of deposit and eth1_data cache and other fixes
* Fix update_cache function
* Move fetch_eth1_data to impl block
* Fix deposit tests
* Create Eth1 object for interfacing with Beacon chain
* Add `run` function for running update_cache and subscribe_deposit_logs tasks
* Add logging
* Run `cargo fmt` and make tests pass
* Convert sync functions to async
* Add timeouts to web3 functions
* Return futures from cache functions
* Add failed chaining of futures
* Working cache updation
* Clean up tests and `update_cache` function
* Refactor `get_eth1_data` functions to work with future returning functions
* Refactor eth1 `run` function to work with modified `update_cache` api
* Minor changes
* Add distance parameter to `update_cache`
* Fix tests and other minor fixes
* Working integration with cache and deposits
* Add merkle_tree construction, proof generation and verification code
* Add function to construct and fetch Deposits for BeaconNode
* Add error handling
* Import ssz
* Add error handling to eth1 cache and fix minor errors
* Run rustfmt
* Fix minor bug
* Rename Eth1Error and change to Result<T>
* Change deposit fetching mechanism from notification based to poll based
* Add deposits from eth1 chain in a given range every `x` blocks
* Modify `run` function to accommodate changes
* Minor fixes
* Fix formatting
* Initial commit. web3 api working.
* Tidied up lib. Add function for fetching logs.
* Refactor with `Eth1DataFetcher` trait
* Add parsing for deposit contract logs and get_eth1_data function
* Add `get_eth1_votes` function
* Refactor to cache Eth1Data
* Fix merge conflicts and minor refactorings
* Rename Eth1Cache to Eth1DataCache
* Refactor events subscription
* Add deposits module to interface with BeaconChain deposits
* Remove utils
* Rename to types.rs and add trait constraints to Eth1DataFetcher
* Confirm to trait constraints. Make Web3DataFetcher cloneable
* Make fetcher object member of deposit and eth1_data cache and other fixes
* Fix update_cache function
* Move fetch_eth1_data to impl block
* Fix deposit tests
* Create Eth1 object for interfacing with Beacon chain
* Add `run` function for running update_cache and subscribe_deposit_logs tasks
* Add logging
* Run `cargo fmt` and make tests pass
* Convert sync functions to async
* Add timeouts to web3 functions
* Return futures from cache functions
* Add failed chaining of futures
* Working cache updation
* Clean up tests and `update_cache` function
* Refactor `get_eth1_data` functions to work with future returning functions
* Refactor eth1 `run` function to work with modified `update_cache` api
* Minor changes
* Add distance parameter to `update_cache`
* Fix tests and other minor fixes
* Working integration with cache and deposits
* Add merkle_tree construction, proof generation and verification code
* Add function to construct and fetch Deposits for BeaconNode
* Add error handling
* Import ssz
* Add error handling to eth1 cache and fix minor errors
* Run rustfmt
* Fix minor bug
* Rename Eth1Error and change to Result<T>
* Change deposit fetching mechanism from notification based to poll based
* Add deposits from eth1 chain in a given range every `x` blocks
* Modify `run` function to accommodate changes
* Minor fixes
* Fix formatting
* Fix merge issue
* Refactor with `Config` struct. Remote `ContractConfig`
* Rename eth1_chain crate to eth1
* Rename files and read abi file using `fs::read`
* Move eth1 to lib
* Remove unnecessary mutability constraint
* Add `Web3Backend` for returning actual eth1 data
* Refactor `get_eth1_votes` to return a Result
* Delete `eth1_chain` crate
* Return `Result` from `get_deposits`
* Fix range of deposits to return to beacon chain
* Add `get_block_height_by_hash` trait function
* Add naive method for getting `previous_eth1_distance`
* Add eth1 config params to main config
* Add instructions for setting up eth1 testing environment
* Add build script to fetch deposit contract abi
* Contract ABI is part of compiled binary
* Fix minor bugs
* Move docs to lib
* Add timeout to config
* Remove print statements
* Change warn to error
* Fix typos
* Removed prints in test and get timeout value from config
* Fixed error types
* Added logging to web3_fetcher
* Refactor for modified web3 api
* Fix minor stuff
* Add build script
* Tidy, hide eth1 integration tests behind flag
* Add http crate
* Add first stages of eth1_test_rig
* Fix deposits on test rig
* Fix bug with deposit count method
* Add block hash getter to http eth1
* Clean eth1 http crate and tests
* Add script to start ganache
* Adds deposit tree to eth1-http
* Extend deposit tree tests
* Tidy tests in eth1-http
* Add more detail to get block request
* Add block cache to eth1-http
* Rename deposit tree to deposit cache
* Add inital updating to eth1-http
* Tidy updater
* Fix compile bugs in tests
* Adds an Eth1DataCache builder
* Reorg eth1-http files
* Add (failing) tests for eth1 updater
* Rename files, fix bug in eth1-http
* Ensure that ganache timestamps are increasing
* Fix bugs with getting eth1data ancestors
* Improve eth1 testing, fix bugs
* Add truncate method to block cache
* Add pruning to block cache update process
* Add tests for block pruning
* Allow for dropping an expired cache.
* Add more comments
* Add first compiling version of deposit updater
* Add common fn for getting range of required blocks
* Add passing deposit update test
* Improve tests
* Fix block pruning bug
* Add tests for running two updates at once
* Add updater services to eth1
* Add deposit collection to beacon chain
* Add incomplete builder experiments
* Add first working version of beacon chain builder
* Update test harness to new beacon chain type
* Rename builder file, tidy
* Add first working client builder
* Progress further on client builder
* Update becaon node binary to use client builder
* Ensure release tests compile
* Remove old eth1 crate
* Add first pass of new lighthouse binary
* Fix websocket server startup
* Remove old binary code from beacon_node crate
* Add first working beacon node tests
* Add genesis crate, new eth1 cache_2
* Add Serivce to Eth1Cache
* Refactor with general eth1 improvements
* Add passing genesis test
* Tidy, add comments
* Add more comments to eth1 service
* Add further eth1 progress
* Fix some bugs with genesis
* Fix eth1 bugs, make eth1 linking more efficient
* Shift logic in genesis service
* Add more comments to genesis service
* Add gzip, max request values, timeouts to http
* Update testnet parameters to suit goerli testnet
* Add ability to vary Fork, fix custom spec
* Be more explicit about deposit fork version
* Start adding beacon chain eth1 option
* Add more flexibility to prod client
* Further runtime refactoring
* Allow for starting from store
* Add bootstrapping to client config
* Add remote_beacon_node crate
* Update eth1 service for more configurability
* Update eth1 tests to use less runtimes
* Patch issues with tests using too many files
* Move dummy eth1 backend flag
* Ensure all tests pass
* Add ganache-cli to Dockerfile
* Use a special docker hub image for testing
* Appease clippy
* Move validator client into lighthouse binary
* Allow starting with dummy eth1 backend
* Improve logging
* Fix dummy eth1 backend from cli
* Add extra testnet command
* Ensure consistent spec in beacon node
* Update eth1 rig to work on goerli
* Tidy lcli, start adding support for yaml config
* Add incomplete YamlConfig struct
* Remove efforts at YamlConfig
* Add incomplete eth1 voting. Blocked on spec issues
* Add (untested) first pass at eth1 vote algo
* Add tests for winning vote
* Add more tests for eth1 chain
* Add more eth1 voting tests
* Added more eth1 voting testing
* Change test name
* Add more tests to eth1 chain
* Tidy eth1 generics, add more tests
* Improve comments
* Tidy beacon_node tests
* Tidy, rename JsonRpc.. to Caching..
* Tidy voting logic
* Tidy builder docs
* Add comments, tidy eth1
* Add more comments to eth1
* Fix bug with winning_vote
* Add doc comments to the `ClientBuilder`
* Remove commented-out code
* Improve `ClientBuilder` docs
* Add comments to client config
* Add decoding test for `ClientConfig`
* Remove unused `DepositSet` struct
* Tidy `block_cache`
* Remove commented out lines
* Remove unused code in `eth1` crate
* Remove old validator binary `main.rs`
* Tidy, fix tests compile error
* Add initial tests for get_deposits
* Remove dead code in eth1_test_rig
* Update TestingDepositBuilder
* Add testing for getting eth1 deposits
* Fix duplicate rand dep
* Remove dead code
* Remove accidentally-added files
* Fix comment in eth1_genesis_service
* Add .gitignore for eth1_test_rig
* Fix bug in eth1_genesis_service
* Remove dead code from eth2_config
* Fix tabs/spaces in root Cargo.toml
* Tidy eth1 crate
* Allow for re-use of eth1 service after genesis
* Update docs for new CLI
* Change README gif
* Tidy eth1 http module
* Tidy eth1 service
* Tidy environment crate
* Remove unused file
* Tidy, add comments
* Remove commented-out code
* Address majority of Michael's comments
* Address other PR comments
* Add link to issue alongside TODO
2019-11-15 03:47:51 +00:00
|
|
|
|
2018-07-12 05:01:28 +00:00
|
|
|
|
2019-06-25 04:02:19 +00:00
|
|
|
## Overview
|
|
|
|
|
|
|
|
|
|
Lighthouse is:
|
|
|
|
|
|
|
|
|
|
- Fully open-source, licensed under Apache 2.0.
|
2019-10-02 01:04:56 +00:00
|
|
|
- Security-focused. Fuzzing has begun and security reviews are planned
|
2019-06-25 04:02:19 +00:00
|
|
|
for late-2019.
|
|
|
|
|
- Built in [Rust](https://www.rust-lang.org/), a modern language providing unique safety guarantees and
|
|
|
|
|
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.
|
2019-10-02 01:04:56 +00:00
|
|
|
- Actively involved in the specification and security analysis of the emerging
|
|
|
|
|
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
|
|
|
|
|
|
|
|
## Development Status
|
|
|
|
|
|
|
|
|
|
Current development overview:
|
|
|
|
|
|
2020-06-19 01:18:27 +00:00
|
|
|
- Specification `v0.12.1` 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.~~
|
|
|
|
|
- **Q3 2020**: Additional third-party security reviews.
|
|
|
|
|
- **Q3 2020**: Long-lived, multi-client Beacon Chain testnet
|
|
|
|
|
- **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
|
|
|
|
2019-10-02 01:04:56 +00:00
|
|
|
The [Lighthouse Book](http://lighthouse-book.sigmaprime.io/) contains information
|
|
|
|
|
for testnet users and developers.
|
2019-06-25 04:02:19 +00:00
|
|
|
|
2019-10-02 01:04:56 +00:00
|
|
|
Code documentation is generated via `cargo doc` and hosted at
|
|
|
|
|
[lighthouse-docs.sigmaprime.io](http://lighthouse-docs.sigmaprime.io/).
|
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
|
|
|
|
|
[Contributing](http://lighthouse-book.sigmaprime.io/contributing.html) section
|
|
|
|
|
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).
|