README
Lodestar Eth2 Implementation
Lodestar is a TypeScript implementation of the Ethereum 2.0 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
- :gear: Follow the installation guide to install Lodestar.
- :globe_with_meridians: Run lodestar on the Eth2 mainnet or on a public testnet.
- :computer: Quickly try out the whole stack by starting a local testnet.
- :spiral_notepad: View the lodestar CLI commands and options.
- :nerd_face: View the TypeDoc code documentation.
- :writing_hand: If you have questions submit an issue or join us on Discord!
- :rotating_light: Please note our security policy.
- :mailbox_with_mail: 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
- :package: This mono-repository contains a suite of Ethereum 2.0 packages.
- :balance_scale: The mono-repository is released under LGPLv3 license. Note, that the packages contain their own licenses.
| Package | Version | License | Docs | Description |
|---|---|---|---|---|
| @chainsafe/lodestar |  |
 |
 |
:rotating_light: Beacon-chain client |
| @chainsafe/lodestar-validator |  |
|
 |
:bank: Validator client |
| @chainsafe/lodestar-light-client |  |
 |
|
:bird: Eth2 Light client |
| @chainsafe/lodestar-api |  |
|
|
:clipboard: REST Client for the Eth2 API |
| @chainsafe/lodestar-cli | |
|
|
:computer: Command-line tool for Lodestar |
| @chainsafe/lodestar-beacon-state-transition |  |
|
|
:mag_right: Eth2 beacon-state transition |
| @chainsafe/lodestar-types |  |
|
|
:spiral_notepad: Eth2 TypeScript and SSZ types |
| @chainsafe/lodestar-params |  |
|
|
:spider_web: Eth2 network parameters |
| @chainsafe/lodestar-utils |  |
|
|
:toolbox: Miscellaneous utility functions used across Lodestar |
| @chainsafe/lodestar-config |  |
|
|
:spiral_notepad: Eth2 types and params bundled together |
| @chainsafe/lodestar-spec-test-util |  |
|
|
:test_tube: Test harness for Eth2 spec tests |
| @chainsafe/lodestar-spec-test-runner | |
:test_tube: Run all Eth2 spec tests | ||
| @chainsafe/lodestar-db |  |
|
|
:floppy_disk: Read/write persistent Eth2 data |
| @chainsafe/lodestar-fork-choice |  |
|
|
:fork_and_knife: 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