2019-10-02 01:04:56 +00:00
|
|
|
# Lighthouse Book
|
2019-09-01 01:31:18 +00:00
|
|
|
|
2019-10-02 01:04:56 +00:00
|
|
|
_Documentation for Lighthouse users and developers._
|
|
|
|
|
|
|
|
|
|
[![Doc Status]][Doc Link] [![Chat Badge]][Chat Link]
|
2019-09-01 01:31:18 +00:00
|
|
|
|
|
|
|
|
[Chat Badge]: https://img.shields.io/badge/chat-discord-%237289da
|
|
|
|
|
[Chat Link]: https://discord.gg/cyAszAh
|
|
|
|
|
[Doc Status]:https://img.shields.io/badge/rust--docs-master-orange
|
|
|
|
|
[Doc Link]: http://lighthouse-docs.sigmaprime.io/
|
|
|
|
|
|
|
|
|
|
Lighthouse is an **Ethereum 2.0 client** that connects to other Ethereum 2.0
|
|
|
|
|
clients to form a resilient and decentralized proof-of-stake blockchain.
|
|
|
|
|
|
2019-10-02 01:04:56 +00:00
|
|
|
We implement the specification as defined in the
|
|
|
|
|
[ethereum/eth2.0-specs](https://github.com/ethereum/eth2.0-specs) repository.
|
2019-09-01 01:31:18 +00:00
|
|
|
|
2019-10-02 01:04:56 +00:00
|
|
|
## Topics
|
2019-09-01 01:31:18 +00:00
|
|
|
|
2019-10-02 01:04:56 +00:00
|
|
|
You may read this book from start to finish, or jump to some of these topics:
|
2019-09-01 01:31:18 +00:00
|
|
|
|
2019-11-25 04:48:24 +00:00
|
|
|
- Follow the [Installation Guide](./installation.md) to install Lighthouse.
|
|
|
|
|
- Get hacking with the [Development Environment Guide](./setup.md).
|
2020-04-17 07:49:29 +00:00
|
|
|
- Utilize the whole stack by starting a [local testnet](./local-testnets.md).
|
2019-10-02 01:04:56 +00:00
|
|
|
- Query the [RESTful HTTP API](./http.md) using `curl`.
|
|
|
|
|
- Listen to events with the [JSON WebSocket API](./websockets.md).
|
|
|
|
|
- View the [Rust code docs](http://lighthouse-docs.sigmaprime.io/).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Prospective contributors can read the [Contributing](./contributing.md) section
|
|
|
|
|
to understand how we develop and test Lighthouse.
|
|
|
|
|
|
|
|
|
|
## About this Book
|
|
|
|
|
|
|
|
|
|
This book is open source, contribute at
|
|
|
|
|
[github.com/sigp/lighthouse/book](https://github.com/sigp/lighthouse/tree/master/book).
|
|
|
|
|
|
|
|
|
|
The Lighthouse CI/CD system maintains a hosted version of the `master` branch
|
|
|
|
|
at [lighthouse-book.sigmaprime.io](http://lighthouse-book.sigmaprime.io).
|
