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
|
|
|
|
2019-05-10 01:49:28 +00:00
|
|
|
[![Build Status]][Build Link] [![Doc Status]][Doc Link] [![Gitter Badge]][Gitter Link]
|
|
|
|
|
|
|
|
[Build Status]: https://gitlab.sigmaprime.io/sigp/lighthouse/badges/master/build.svg
|
|
|
|
[Build Link]: https://gitlab.sigmaprime.io/sigp/lighthouse/pipelines
|
|
|
|
[Gitter Badge]: https://badges.gitter.im/Join%20Chat.svg
|
|
|
|
[Gitter Link]: https://gitter.im/sigp/lighthouse
|
|
|
|
[Doc Status]: https://img.shields.io/badge/docs-master-blue.svg
|
|
|
|
[Doc Link]: http://lighthouse-docs.sigmaprime.io/
|
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.
|
|
|
|
- Security-focussed, fuzzing has begun and security reviews are planned
|
|
|
|
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
|
|
|
|
Ethereum Foundation, Consensys and private individuals.
|
|
|
|
- Actively working to promote an inter-operable, multi-client Ethereum 2.0.
|
|
|
|
|
|
|
|
|
|
|
|
## Development Status
|
|
|
|
|
|
|
|
Lighthouse, like all Ethereum 2.0 clients, is a work-in-progress. Instructions
|
|
|
|
are provided for running the client, however these instructions are designed
|
|
|
|
for developers and researchers working on the project. We do not (yet) provide
|
|
|
|
user-facing functionality.
|
|
|
|
|
|
|
|
Current development overview:
|
|
|
|
|
|
|
|
- Specification `v0.6.3` implemented, optimized and passing test vectors.
|
|
|
|
- Rust-native libp2p integrated, with Gossipsub.
|
|
|
|
- Discv5 (P2P discovery mechanism) integration started.
|
|
|
|
- Metrics via Prometheus.
|
|
|
|
- Basic gRPC API, soon to be replaced with RESTful HTTP/JSON.
|
|
|
|
|
|
|
|
### Roadmap
|
|
|
|
|
|
|
|
- **July 2019**: `lighthouse-0.0.1` release: A stable testnet for developers with a useful
|
|
|
|
HTTP API.
|
|
|
|
- **September 2019**: Inter-operability with other Ethereum 2.0 clients.
|
|
|
|
- **October 2019**: Public, multi-client testnet with user-facing functionality.
|
|
|
|
- **January 2020**: Production Beacon Chain testnet.
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
Lighthouse consists of multiple binaries:
|
|
|
|
|
|
|
|
- [`beacon_node/`](beacon_node/): produces and verifies blocks from the P2P
|
|
|
|
connected validators and the P2P network. Provides an API for external services to
|
|
|
|
interact with Ethereum 2.0.
|
|
|
|
- [`validator_client/`](validator_client/): connects to a `beacon_node` and
|
|
|
|
performs the role of a proof-of-stake validator.
|
|
|
|
- [`account_manager/`](account_manager/): a stand-alone component providing key
|
|
|
|
management and creation for validators.
|
|
|
|
|
|
|
|
### Simple Local Testnet
|
|
|
|
|
|
|
|
**Note: these instructions are intended for developers and researchers. We do
|
|
|
|
not yet support end-users.**
|
|
|
|
|
|
|
|
In this example we use the `account_manager` to create some keys, launch two
|
|
|
|
`beacon_node` instances and connect a `validator_client` to one. The two
|
|
|
|
`beacon_nodes` should stay in sync and build a Beacon Chain.
|
2018-10-03 08:37:28 +00:00
|
|
|
|
2019-06-25 04:02:19 +00:00
|
|
|
First, clone this repository, [setup a development
|
|
|
|
environment](docs/installation.md) and navigate to the root directory of this repository.
|
2018-10-31 11:37:23 +00:00
|
|
|
|
2019-06-25 04:02:19 +00:00
|
|
|
Then, run `$ cargo build --all --release` and navigate to the `target/release`
|
|
|
|
directory.
|
2018-10-03 08:37:28 +00:00
|
|
|
|
2019-06-25 04:02:19 +00:00
|
|
|
#### 1. Generate Validator Keys
|
2018-10-03 08:37:28 +00:00
|
|
|
|
2019-06-25 04:02:19 +00:00
|
|
|
Generate 16 validator keys and store them in `~/.lighthouse-validator`:
|
|
|
|
|
|
|
|
```
|
|
|
|
$ ./account_manager -d ~/.lighthouse-validator generate_deterministic -i 0 -n 16
|
|
|
|
```
|
|
|
|
|
|
|
|
_Note: these keys are for development only. The secret keys are
|
|
|
|
deterministically generated from low integers. Assume they are public
|
|
|
|
knowledge._
|
|
|
|
|
|
|
|
#### 2. Start a Beacon Node
|
|
|
|
|
|
|
|
This node will act as the boot node and provide an API for the
|
|
|
|
`validator_client`.
|
|
|
|
|
|
|
|
```
|
|
|
|
$ ./beacon_node --recent-genesis --rpc
|
|
|
|
```
|
|
|
|
|
|
|
|
_Note: `--recent-genesis` defines the genesis time as either the start of the
|
|
|
|
current hour, or half-way through the current hour (whichever is most recent).
|
|
|
|
This makes it very easy to create a testnet, but does not allow nodes to
|
|
|
|
connect if they were started in separate 30-minute windows._
|
|
|
|
|
|
|
|
#### 3. Start Another Beacon Node
|
|
|
|
|
|
|
|
In another terminal window, start another boot node that will connect to the
|
|
|
|
running node.
|
|
|
|
|
|
|
|
```
|
|
|
|
$ ./beacon_node -r --boot-nodes /ip4/127.0.0.1/tcp/9000 --listen-address /ip4/127.0.0.1/tcp/9001
|
|
|
|
```
|
|
|
|
|
|
|
|
#### 4. Start a Validator Client
|
|
|
|
|
|
|
|
In a third terminal window, start a validator client:
|
|
|
|
|
|
|
|
```
|
|
|
|
$ ./validator-client
|
|
|
|
```
|
|
|
|
|
|
|
|
You should be able to observe the validator signing blocks, the boot node
|
|
|
|
processing these blocks and publishing them to the other node. If you have
|
|
|
|
issues, try restarting the beacon nodes to ensure they have the same genesis
|
|
|
|
time. Alternatively, raise an issue and include your terminal output.
|
|
|
|
|
|
|
|
## Further Reading
|
2019-02-14 01:09:18 +00:00
|
|
|
|
|
|
|
- [About Lighthouse](docs/lighthouse.md): Goals, Ideology and Ethos surrounding
|
|
|
|
this implementation.
|
|
|
|
- [What is Ethereum Serenity](docs/serenity.md): an introduction to Ethereum Serenity.
|
2019-05-01 05:14:51 +00:00
|
|
|
- [Lighthouse Technical Documentation](http://lighthouse-docs.sigmaprime.io/): The Rust generated documentation, updated regularly.
|
2019-02-14 01:09:18 +00:00
|
|
|
|
|
|
|
If you'd like some background on Sigma Prime, please see the [Lighthouse Update
|
|
|
|
\#00](https://lighthouse.sigmaprime.io/update-00.html) blog post or the
|
|
|
|
[company website](https://sigmaprime.io).
|
2018-10-03 08:37:28 +00:00
|
|
|
|
2019-06-25 04:02:19 +00:00
|
|
|
## Directory Structure
|
2019-02-28 13:18:53 +00:00
|
|
|
|
2019-02-28 13:25:11 +00:00
|
|
|
- [`beacon_node/`](beacon_node/): the "Beacon Node" binary and crates exclusively
|
2019-02-28 13:18:53 +00:00
|
|
|
associated with it.
|
2019-03-01 02:10:50 +00:00
|
|
|
- [`docs/`](docs/): documentation related to the repository. This includes contributor
|
|
|
|
guides, etc. (It does not include code documentation, which can be produced with `cargo doc`).
|
2019-02-28 13:25:11 +00:00
|
|
|
- [`eth2/`](eth2/): Crates containing common logic across the Lighthouse project. For
|
2019-03-01 02:10:50 +00:00
|
|
|
example: Ethereum 2.0 types ([`BeaconBlock`](eth2/types/src/beacon_block.rs), [`BeaconState`](eth2/types/src/beacon_state.rs), etc) and
|
2019-02-28 13:18:53 +00:00
|
|
|
SimpleSerialize (SSZ).
|
2019-03-01 02:10:50 +00:00
|
|
|
- [`protos/`](protos/): protobuf/gRPC definitions that are common across the Lighthouse project.
|
2019-02-28 13:25:11 +00:00
|
|
|
- [`validator_client/`](validator_client/): the "Validator Client" binary and crates exclusively
|
2019-02-28 13:18:53 +00:00
|
|
|
associated with it.
|
|
|
|
|
2019-06-25 04:02:19 +00:00
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
**Lighthouse welcomes contributors.**
|
2019-02-14 01:09:18 +00:00
|
|
|
|
|
|
|
If you are looking to contribute, please head to our
|
|
|
|
[onboarding documentation](https://github.com/sigp/lighthouse/blob/master/docs/onboarding.md).
|
|
|
|
|
|
|
|
If you'd like to contribute, try having a look through the [open
|
|
|
|
issues](https://github.com/sigp/lighthouse/issues) (tip: look for the [good
|
|
|
|
first
|
|
|
|
issue](https://github.com/sigp/lighthouse/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
|
|
|
|
tag) and ping us on the [gitter](https://gitter.im/sigp/lighthouse) channel. We need
|
|
|
|
your support!
|
2018-07-06 07:54:07 +00:00
|
|
|
|
|
|
|
## Contact
|
|
|
|
|
2018-10-09 07:16:19 +00:00
|
|
|
The best place for discussion is the [sigp/lighthouse gitter](https://gitter.im/sigp/lighthouse).
|
2018-10-03 08:37:28 +00:00
|
|
|
|
2019-06-25 04:02:19 +00:00
|
|
|
## Donations
|
2018-12-19 01:54:31 +00:00
|
|
|
|
2019-06-25 04:02:19 +00:00
|
|
|
If you support the cause, we accept donations to help fund development:
|
2018-12-19 01:54:31 +00:00
|
|
|
|
2019-05-27 00:24:44 +00:00
|
|
|
`0x25c4a76E7d118705e7Ea2e9b7d8C59930d8aCD3b` (donation.sigmaprime.eth)
|