Ethereum consensus client in Rust
Go to file
Paul Hauner cdec3cec18
Implement standard eth2.0 API (#1569)
- Resolves #1550
- Resolves #824
- Resolves #825
- Resolves #1131
- Resolves #1411
- Resolves #1256
- Resolve #1177

- Includes the `ShufflingId` struct initially defined in #1492. That PR is now closed and the changes are included here, with significant bug fixes.
- Implement the https://github.com/ethereum/eth2.0-APIs in a new `http_api` crate using `warp`. This replaces the `rest_api` crate.
- Add a new `common/eth2` crate which provides a wrapper around `reqwest`, providing the HTTP client that is used by the validator client and for testing. This replaces the `common/remote_beacon_node` crate.
- Create a `http_metrics` crate which is a dedicated server for Prometheus metrics (they are no longer served on the same port as the REST API). We now have flags for `--metrics`, `--metrics-address`, etc.
- Allow the `subnet_id` to be an optional parameter for `VerifiedUnaggregatedAttestation::verify`. This means it does not need to be provided unnecessarily by the validator client.
- Move `fn map_attestation_committee` in `mod beacon_chain::attestation_verification` to a new `fn with_committee_cache` on the `BeaconChain` so the same cache can be used for obtaining validator duties.
- Add some other helpers to `BeaconChain` to assist with common API duties (e.g., `block_root_at_slot`, `head_beacon_block_root`).
- Change the `NaiveAggregationPool` so it can index attestations by `hash_tree_root(attestation.data)`. This is a requirement of the API.
- Add functions to `BeaconChainHarness` to allow it to create slashings and exits.
- Allow for `eth1::Eth1NetworkId` to go to/from a `String`.
- Add functions to the `OperationPool` to allow getting all objects in the pool.
- Add function to `BeaconState` to check if a committee cache is initialized.
- Fix bug where `seconds_per_eth1_block` was not transferring over from `YamlConfig` to `ChainSpec`.
- Add the `deposit_contract_address` to `YamlConfig` and `ChainSpec`. We needed to be able to return it in an API response.
- Change some uses of serde `serialize_with` and `deserialize_with` to a single use of `with` (code quality).
- Impl `Display` and `FromStr` for several BLS fields.
- Check for clock discrepancy when VC polls BN for sync state (with +/- 1 slot tolerance). This is not intended to be comprehensive, it was just easy to do.

- See #1434 for a per-endpoint overview.
- Seeking clarity here: https://github.com/ethereum/eth2.0-APIs/issues/75

- [x] Add docs for prom port to close #1256
- [x] Follow up on this #1177
- [x] ~~Follow up with #1424~~ Will fix in future PR.
- [x] Follow up with #1411
- [x] ~~Follow up with  #1260~~ Will fix in future PR.
- [x] Add quotes to all integers.
- [x] Remove `rest_types`
- [x] Address missing beacon block error. (#1629)
- [x] ~~Add tests for lighthouse/peers endpoints~~ Wontfix
- [x] ~~Follow up with validator status proposal~~ Tracked in #1434
- [x] Unify graffiti structs
- [x] ~~Start server when waiting for genesis?~~ Will fix in future PR.
- [x] TODO in http_api tests
- [x] Move lighthouse endpoints off /eth/v1
- [x] Update docs to link to standard

- ~~Blocked on #1586~~

Co-authored-by: Michael Sproul <michael@sigmaprime.io>
2020-10-01 11:12:36 +10:00
.github Remove macos tests (#1687) 2020-09-30 01:27:36 +00:00
account_manager Directory restructure (#1532) 2020-10-01 11:12:35 +10:00
beacon_node Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10:00
book Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10:00
boot_node Version bump and cargo update (#1683) 2020-09-29 18:29:04 +10:00
common Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10:00
consensus Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10:00
crypto Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10:00
hooks Add a flag to make lighthouse portable across machines (#1423) 2020-07-31 05:00:39 +00:00
lcli Directory restructure (#1532) 2020-10-01 11:12:35 +10:00
lighthouse Directory restructure (#1532) 2020-10-01 11:12:35 +10:00
scripts Bump to v0.2.7 (#1561) 2020-08-24 08:25:34 +00:00
testing Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10:00
validator_client Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10: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 Remove macos tests (#1687) 2020-09-30 01:27:36 +00:00
Cargo.lock Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10:00
Cargo.toml Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10: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 Spadina support (v2) (#1670) 2020-09-26 01:58:31 +00:00
README.md Update consensus code and tests to v0.12.3 (#1655) 2020-09-26 01:58:29 +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.3 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).