mirror of
https://github.com/AtHeartEngineering/lodestar.git
synced 2026-01-08 04:03:51 -05:00
Lodestar Ethereum Consensus Implementation
Lodestar is a TypeScript implementation of the Ethereum Consensus specification developed by ChainSafe Systems.
Get it from the NPM Registry:
npm install -g @chainsafe/lodestar-cli
Get it from the Docker Hub:
docker pull chainsafe/lodestar
Getting started
- ⚙️ Follow the installation guide to install Lodestar.
- 🌐 Run lodestar on the Ethereum beacon chain mainnet or on a public testnet.
- 💻 Quickly try out the whole stack by starting a local testnet.
- 🗒️ View the lodestar CLI commands and options.
- 🤓 View the TypeDoc code documentation.
- ✍️ If you have questions submit an issue or join us on Discord!
- 🚨 Please note our security policy.
- 📬 Sign up to our mailing list for announcements and any critical information about Lodestar.
Prerequisites
Developer Quickstart:
lerna bootstrap
yarn build
./lodestar --help
Architecture Overview
- 📦 This mono-repository contains a suite of Ethereum Consensus packages.
- ⚖️ The mono-repository is released under LGPLv3 license. Note, that the packages contain their own licenses.
| Package | Version | License | Docs | Description |
|---|---|---|---|---|
| @chainsafe/lodestar |  |
 |
 |
🚨 Beacon-chain client |
| @chainsafe/lodestar-validator |  |
|
 |
🏦 Validator client |
| @chainsafe/lodestar-light-client |  |
 |
|
🐦 Ethereum Light client |
| @chainsafe/lodestar-api |  |
|
|
📋 REST Client for the Eth Beacon API |
| @chainsafe/lodestar-cli | |
|
|
💻 Command-line tool for Lodestar |
| @chainsafe/lodestar-beacon-state-transition |  |
|
|
🔎 Eth Consensus beacon-state transition |
| @chainsafe/lodestar-types |  |
|
|
🗒️ Eth Consensus TypeScript and SSZ types |
| @chainsafe/lodestar-params |  |
|
|
🕸️ Eth Consensus network parameters |
| @chainsafe/lodestar-utils |  |
|
|
🧰 Miscellaneous utility functions used across Lodestar |
| @chainsafe/lodestar-config |  |
|
|
🗒️ Eth Consensus types and params bundled together |
| @chainsafe/lodestar-spec-test-util |  |
|
|
🧪 Test harness for Eth Consensus spec tests |
| @chainsafe/lodestar-spec-test-runner | |
🧪 Run all Eth Consensus spec tests | ||
| @chainsafe/lodestar-db |  |
|
|
💾 Read/write persistent Eth Consensus data |
| @chainsafe/lodestar-fork-choice |  |
|
|
🍴 Beacon-chain fork choice |
Contributors
Read our contributors document, submit an issue or talk to us on our Discord!
Meetings
Weekly contributor meetings are public and announced on Discord. Feel free to check out our meeting notes and documents on HackMD. Post-September 2021, meeting notes can be found on the Lodestar Wiki Page.
Donations
We are a local group of Toronto open-source developers. As such, all of our open-source work is funded by grants. We all take the time out of our hectic lives to contribute to the Ethereum ecosystem.
If you want to donate, you can send us ETH at the following address: lodestar.chainsafe.eth