Lodestar Ethereum Consensus Implementation

Lodestar is a TypeScript implementation of the Ethereum Consensus specification developed by ChainSafe Systems.

Getting started

• :gear: Follow the instructions for build from source, binaries, or Docker to install Lodestar. Or use our Lodestar Quickstart scripts.
• :books: Use Lodestar libraries in your next Ethereum Typescript project.
• :globe_with_meridians: Run a beacon node on mainnet or a public testnet.
• :computer: Utilize the whole stack by starting a local testnet.
• :spiral_notepad: View the Lodestar CLI commands and options.
• :nerd_face: View the Package and dependency structure.
• :memo: Prospective contributors can read the contributing section to understand how we develop and test on Lodestar.
• :writing_hand: If you have questions submit an issue or join us on Discord!
• :rotating_light: Please note our security policy.
• :bird: Follow Lodestar on Twitter for announcements and updates!

Prerequisites

• :gear: NodeJS (LTS)
• :toolbox: pnpm

Developer Quickstart:

pnpm install
pnpm build
./lodestar --help

Architecture Overview

• :package: This mono-repository contains a suite of Ethereum Consensus packages.
• :balance_scale: The mono-repository is released under Apache-2.0 license. Note, that the packages contain their own licenses.

Package	Version	License	Docs	Description
@chainsafe/lodestar				:computer: Command-line tool for Lodestar
@lodestar/api				:clipboard: REST Client for the Ethereum Beacon API
@lodestar/beacon-node				:rotating_light: Beacon-chain client
@lodestar/config				:spiral_notepad: Eth Consensus types and params bundled together
@lodestar/db				:floppy_disk: Read/write persistent Eth Consensus data
@lodestar/era				:file_folder: Era file handling for historical beacon chain data
@lodestar/fork-choice				:fork_and_knife: Beacon-chain fork choice
@lodestar/logger				:memo: NodeJS logger for Lodestar binaries
@lodestar/params				:spider_web: Eth Consensus network parameters
@lodestar/reqresp				:telephone_receiver: Eth Consensus Req/Resp protocol
@lodestar/spec-test-util				:test_tube: Test harness for Eth Consensus spec tests
@lodestar/state-transition				:mag_right: Eth Consensus beacon-state transition
@lodestar/types				:spiral_notepad: Eth Consensus TypeScript and SSZ types
@lodestar/utils				:toolbox: Miscellaneous utility functions used across Lodestar
@lodestar/validator				:bank: Validator client

Contributors

Read our contributors document, submit an issue or talk to us on our Discord!

Meetings

Weekly contributor meetings are posted under Discussions and topics are welcomed by any participant in the relevant meeting thread. 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 find the ETH address under "Sponsor this project" on this repository.