cerc-io/lighthouse
16
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
Ethereum consensus client in Rust
2,986 Commits 2 Branches 0 Tags 125 MiB
Rust 99.5%
Shell 0.2%
Makefile 0.1%
9aedb12bfc
Go to file
Paul Hauner 9aedb12bfc
Refactor docs into mdbook (#547) 
* Refactor documentation, ef_tests makefile

* Add makefile to root

* Tidy readme

* Fix readme badges

* Tidy logs

* Add terminalize gif

* Update readme image

* Update readme image

* Tidy logs

* Update readme image

* Update readme

* Update readme

* Fix book link

* Update makefiles

* Update book

* Fix link in book

* Add readme for book

* Remove old docs, move api spec YAML

* Fix eth2/ dir readme

* Add readme for lcli

* Add about this book section

* Minor formatting improvements

* Address mehdi's comments
2019-10-02 11:04:56 +10:00
.github Add PR and issue templates 2018-10-14 14:51:59 +11:00
account_manager Clippy clean (#536) 2019-09-30 13:58:45 +10:00
beacon_node Refactor docs into mdbook (#547) 2019-10-02 11:04:56 +10:00
book Refactor docs into mdbook (#547) 2019-10-02 11:04:56 +10:00
eth2 Refactor docs into mdbook (#547) 2019-10-02 11:04:56 +10:00
lcli Refactor docs into mdbook (#547) 2019-10-02 11:04:56 +10:00
protos Pin protobuf version to 2.8.x 2019-09-30 11:14:35 +10:00
scripts Add whiteblock script, CLI options to support it 2019-09-10 12:13:54 -04:00
tests/ef_tests Refactor docs into mdbook (#547) 2019-10-02 11:04:56 +10:00
validator_client Refactor docs into mdbook (#547) 2019-10-02 11:04:56 +10:00
.editorconfig Add editorconfig template 2019-03-11 15:09:57 +11:00
.gitignore Add benches, examples for cached hashing. 2019-04-28 11:38:32 +10:00
.gitlab-ci.yml ci: run EF tests that require fake crypto 2019-06-17 17:22:37 +10:00
.gitmodules Replace EF tests submodule with a makefile 2019-09-08 04:19:54 +10:00
.travis.yml Allow travis failures on beta (see desc) 2019-08-14 12:03:03 +10:00
Cargo.toml Add basic, not-useful websocket server 2019-09-14 10:34:03 -04:00
CONTRIBUTING.md Revert "Merge pull request #200 from sigp/new-structure" 2019-02-14 12:09:18 +11:00
Dockerfile Updated docker file to include the git-lfs installation. 2019-06-17 15:25:25 +10:00
LICENSE Update License to Apache 2.0 2019-04-15 16:47:35 +10:00
Makefile Refactor docs into mdbook (#547) 2019-10-02 11:04:56 +10:00
README.md Refactor docs into mdbook (#547) 2019-10-02 11:04:56 +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 Swagger Badge

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.8.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.
  • Early-October 2019: lighthouse-0.0.1 release: All major phase 0 features implemented.
  • Q4 2019: Public, multi-client testnet with user-facing functionality.
  • Q4 2019: Third-party security review.
  • Q1 2020: Production Beacon Chain testnet (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).