cerc-io/lighthouse
15
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
Ethereum consensus client in Rust
3,457 Commits 2 Branches 0 Tags 125 MiB
Rust 99.5%
Shell 0.2%
Makefile 0.1%
e26da35cbf
Go to file
Paul Hauner e26da35cbf Introduce validator definition file for VC (#1357) 
## Issue Addressed

NA

## Proposed Changes

- Introduces the `valdiator_definitions.yml` file which serves as an explicit list of validators that should be run by the validator client.
  - Removes `--strict` flag, split into `--strict-lockfiles` and `--disable-auto-discover`  
  - Adds a "Validator Management" page to the book.
- Adds the `common/account_utils` crate which contains some logic that was starting to duplicate across the codebase.

The new docs for this feature are the best description of it (apart from the code, I guess): 9cb87e93ce/book/src/validator-management.md

## API Changes

This change should be transparent for *most* existing users. If the `valdiator_definitions.yml` doesn't exist then it will be automatically generated using a method that will detect all the validators in their `validators_dir`.

Users will have issues if they are:

1. Using `--strict`.
1. Have keystores in their `~/.lighthouse/validators` directory that weren't being detected by the current keystore discovery method.

For users with (1), the VC will refuse to start because the `--strict` flag has been removed. They will be forced to review `--help` and choose an equivalent flag.

For users with (2), this seems fairly unlikely and since we're only in testnets there's no *real* value on the line here. I'm happy to take the risk, it would be a different case for mainnet.

## Additional Info

This PR adds functionality we will need for #1347.

## TODO

- [x] Reconsider flags
- [x] Move doc into a more reasonable chapter.
- [x] Check for compile warnings.
2020-07-22 09:34:55 +00:00
.github Prefer viable nightly Rust builds for CI (#1379) 2020-07-22 07:34:30 +00:00
account_manager Introduce validator definition file for VC (#1357) 2020-07-22 09:34:55 +00:00
beacon_node Do not send regular status updates during syncing (#1375) 2020-07-22 15:39:56 +10:00
book Introduce validator definition file for VC (#1357) 2020-07-22 09:34:55 +00:00
boot_node Tweak for appearance (#1351) 2020-07-13 03:48:20 +00:00
common Introduce validator definition file for VC (#1357) 2020-07-22 09:34:55 +00:00
consensus Deny warnings on CI (#1372) 2020-07-21 05:51:33 +00:00
crypto Update deps (#1322) 2020-07-06 11:55:56 +10:00
lcli Cache deposit signature verification (#1298) 2020-06-26 11:43:06 +10:00
lighthouse Update discv5 and remove discovery retries (#1373) 2020-07-21 14:19:55 +10:00
scripts Update local testnet scripts, fix eth1 sim (#1184) 2020-05-26 18:30:44 +10:00
testing Introduce validator definition file for VC (#1357) 2020-07-22 09:34:55 +00:00
validator_client Introduce validator definition file for VC (#1357) 2020-07-22 09:34:55 +00:00
.dockerignore Bump docker rust version (#794) 2020-01-10 16:49:16 +11:00
.editorconfig Add editorconfig template 2019-03-11 15:09:57 +11:00
.gitignore Add Cargo.lock (#684) 2019-12-09 22:39:44 +11: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 Introduce validator definition file for VC (#1357) 2020-07-22 09:34:55 +00:00
Cargo.toml Introduce validator definition file for VC (#1357) 2020-07-22 09:34:55 +00:00
CONTRIBUTING.md Update CONTRIBUTING.md (#751) 2020-01-03 10:45:53 +11:00
Dockerfile Update deps (#1322) 2020-07-06 11:55:56 +10:00
LICENSE Update License to Apache 2.0 2019-04-15 16:47:35 +10:00
Makefile Fix clippy's performance lints (#1286) 2020-06-26 00:04:08 +10:00
README.md Bump all spec tags to v0.12.1 (#1275) 2020-06-19 11:18:27 +10:00

README.md

Lighthouse: Ethereum 2.0

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

Build Status Book Status RustDoc 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 planned for late-2019.
  • 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.

Code documentation is generated via cargo doc and hosted at lighthouse-docs.sigmaprime.io.

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