cerc-io/lighthouse
16
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
d87c84b5c5
lighthouse/README.md
Paul Hauner d87c84b5c5
Update readme
2019-06-25 14:02:19 +10:00

6.5 KiB
Raw Blame History

Lighthouse: Ethereum 2.0

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

Build Status Doc Status Gitter Badge

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, 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/: 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/: connects to a beacon_node and performs the role of a proof-of-stake validator.
  • 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.

First, clone this repository, setup a development environment and navigate to the root directory of this repository.

Then, run $ cargo build --all --release and navigate to the target/release directory.

1. Generate Validator Keys

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

If you'd like some background on Sigma Prime, please see the Lighthouse Update #00 blog post or the company website.

Directory Structure

  • beacon_node/: the "Beacon Node" binary and crates exclusively associated with it.
  • docs/: documentation related to the repository. This includes contributor guides, etc. (It does not include code documentation, which can be produced with cargo doc).
  • eth2/: Crates containing common logic across the Lighthouse project. For example: Ethereum 2.0 types (BeaconBlock, BeaconState, etc) and SimpleSerialize (SSZ).
  • protos/: protobuf/gRPC definitions that are common across the Lighthouse project.
  • validator_client/: the "Validator Client" binary and crates exclusively associated with it.

Contributing

Lighthouse welcomes contributors.

If you are looking to contribute, please head to our onboarding documentation.

If you'd like to contribute, try having a look through the open issues (tip: look for the good first issue tag) and ping us on the gitter channel. We need your support!

Contact

The best place for discussion is the sigp/lighthouse gitter.

Donations

If you support the cause, we accept donations to help fund development:

0x25c4a76E7d118705e7Ea2e9b7d8C59930d8aCD3b (donation.sigmaprime.eth)