cerc-io/lighthouse
16
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
Ethereum consensus client in Rust
3,345 Commits 2 Branches 0 Tags 125 MiB
Rust 99.5%
Shell 0.2%
Makefile 0.1%
cb26ddebb1
Go to file
Age Manning cb26ddebb1
Doc updates (#1226) 
* Keep wallet name and password file in sync with commands

* Fix create validator example to include required param --count

The current example fails with v0.1.2 fails with "Must supply either --count or --at-most"  This change proposes passing count=1, esp'ly since "Creating another validator is easy" a couple of paragraphs down.

* Fix broken links to wallet-create

Wallet links result in file not found.  May be caused by the lack of `.md`?

* Include node/health in TOC

* Remove unnecessary book files

Co-authored-by: J Burnett <jburnett@users.noreply.github.com>
2020-06-01 11:34:16 +10:00
.github Update local testnet scripts, fix eth1 sim (#1184) 2020-05-26 18:30:44 +10:00
account_manager Strip new lines in validator create (#1214) 2020-05-28 11:26:24 +10:00
beacon_node Clean up database abstractions (#1200) 2020-06-01 08:13:49 +10:00
book Doc updates (#1226) 2020-06-01 11:34:16 +10:00
common Add /node/health endpoint (#1197) 2020-05-28 11:24:24 +10:00
consensus Clean up database abstractions (#1200) 2020-06-01 08:13:49 +10:00
crypto Update local testnet scripts, fix eth1 sim (#1184) 2020-05-26 18:30:44 +10:00
lcli Allow discovery to be more lenient in enr eth2 fields (#1201) 2020-05-27 06:34:15 +10:00
lighthouse Revert runtime drop (#1198) 2020-05-27 06:38:12 +10:00
scripts Update local testnet scripts, fix eth1 sim (#1184) 2020-05-26 18:30:44 +10:00
testing Allow discovery to be more lenient in enr eth2 fields (#1201) 2020-05-27 06:34:15 +10:00
validator_client Allow discovery to be more lenient in enr eth2 fields (#1201) 2020-05-27 06:34:15 +10: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
Cargo.lock Upgrade to spec compliant noise protocol (#1221) 2020-05-29 12:03:30 +10:00
Cargo.toml Directory Restructure (#1163) 2020-05-18 21:24:23 +10:00
CONTRIBUTING.md Update CONTRIBUTING.md (#751) 2020-01-03 10:45:53 +11:00
Dockerfile Upgrade docker rust version (#1207) 2020-05-28 11:17:29 +10:00
LICENSE Update License to Apache 2.0 2019-04-15 16:47:35 +10:00
Makefile Add cargo audit to CI (#1192) 2020-05-26 17:04:39 +10:00
README.md Update README.md (#1062) 2020-04-27 20:21:02 +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

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.11.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.
  • Q4 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).