cerc-io/lighthouse
15
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
Ethereum consensus client in Rust
3,638 Commits 2 Branches 0 Tags 125 MiB
Rust 99.5%
Shell 0.2%
Makefile 0.1%
6ea3bc5e52
Go to file
Paul Hauner 6ea3bc5e52 Implement VC API (#1657) 
## Issue Addressed

NA

## Proposed Changes

- Implements a HTTP API for the validator client.
- Creates EIP-2335 keystores with an empty `description` field, instead of a missing `description` field. Adds option to set name.
- Be more graceful with setups without any validators (yet)
    - Remove an error log when there are no validators.
    - Create the `validator` dir if it doesn't exist.
- Allow building a `ValidatorDir` without a withdrawal keystore (required for the API method where we only post a voting keystore).
- Add optional `description` field to `validator_definitions.yml`

## TODO

- [x] Signature header, as per https://github.com/sigp/lighthouse/issues/1269#issuecomment-649879855
- [x] Return validator descriptions
- [x] Return deposit data
- [x] Respect the mnemonic offset
- [x] Check that mnemonic can derive returned keys
- [x] Be strict about non-localhost
- [x] Allow graceful start without any validators (+ create validator dir)
- [x] Docs final pass
- [x] Swap to EIP-2335 description field. 
- [x] Fix Zerioze TODO in VC api types.
- [x] Zeroize secp256k1 key

## Endpoints

- [x] `GET /lighthouse/version`
- [x] `GET /lighthouse/health`
- [x] `GET /lighthouse/validators` 
- [x] `POST /lighthouse/validators/hd`
- [x] `POST /lighthouse/validators/keystore`
- [x] `PATCH /lighthouse/validators/:validator_pubkey`
- [ ] ~~`POST /lighthouse/validators/:validator_pubkey/exit/:epoch`~~ Future works


## Additional Info

TBC
2020-10-02 09:42:19 +00:00
.github Remove macos tests (#1687) 2020-09-30 01:27:36 +00:00
account_manager Implement VC API (#1657) 2020-10-02 09:42:19 +00:00
beacon_node Implement VC API (#1657) 2020-10-02 09:42:19 +00:00
book Implement VC API (#1657) 2020-10-02 09:42:19 +00:00
boot_node Version bump and cargo update (#1683) 2020-09-29 18:29:04 +10:00
common Implement VC API (#1657) 2020-10-02 09:42:19 +00:00
consensus Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10:00
crypto Implement VC API (#1657) 2020-10-02 09:42:19 +00:00
hooks Add a flag to make lighthouse portable across machines (#1423) 2020-07-31 05:00:39 +00:00
lcli Implement VC API (#1657) 2020-10-02 09:42:19 +00:00
lighthouse Implement VC API (#1657) 2020-10-02 09:42:19 +00:00
scripts Bump to v0.2.7 (#1561) 2020-08-24 08:25:34 +00:00
testing Implement VC API (#1657) 2020-10-02 09:42:19 +00:00
validator_client Implement VC API (#1657) 2020-10-02 09:42:19 +00:00
.dockerignore Ensure .git is copied into docker (#1462) 2020-08-05 03:05:36 +00:00
.editorconfig Add editorconfig template 2019-03-11 15:09:57 +11:00
.gitignore Implement slashing protection interchange format (#1544) 2020-10-02 01:42:27 +00:00
.gitmodules Replace EF tests submodule with a makefile 2019-09-08 04:19:54 +10:00
bors.toml Remove macos tests (#1687) 2020-09-30 01:27:36 +00:00
Cargo.lock Implement VC API (#1657) 2020-10-02 09:42:19 +00:00
Cargo.toml Implement standard eth2.0 API (#1569) 2020-10-01 11:12:36 +10:00
CONTRIBUTING.md Update CONTRIBUTING.md (#751) 2020-01-03 10:45:53 +11:00
Cross.toml Ensure RUSTFLAGS is passed through on cross compile (#1529) 2020-08-17 10:06:06 +00:00
Dockerfile Revert 1502 - Switching docker user to lighthouse (#1578) 2020-09-01 01:32:02 +00:00
LICENSE Update License to Apache 2.0 2019-04-15 16:47:35 +10:00
Makefile Spadina support (v2) (#1670) 2020-09-26 01:58:31 +00:00
README.md Update consensus code and tests to v0.12.3 (#1655) 2020-09-26 01:58:29 +00: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 Chat Badge

Documentation

terminalize

Overview

Lighthouse is:

  • Fully open-source, licensed under Apache 2.0.
  • Security-focused. Fuzzing has begun and security reviews are underway.
  • 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.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.
  • 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.

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