/lodestar

🌟 TypeScript Implementation of Ethereum Consensus

Primary LanguageTypeScriptGNU Lesser General Public License v3.0LGPL-3.0

Lodestar Ethereum Consensus Implementation

GitHub release (latest by date) npm Docker Image Version (latest by date) Eth Consensus Spec v1.1.10 codecov ES Version Node Version gitpoap badge

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

Getting started

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
@lodestar/beacon-node npm License: LGPL v3 documentation 🚨 Beacon-chain client
@lodestar/validator npm License: LGPL v3 documentation 🏦 Validator client
@lodestar/light-client npm License documentation 🐦 Ethereum Light client
@lodestar/api npm License documentation πŸ“‹ REST Client for the Eth Beacon API
@chainsafe/lodestar npm License: LGPL v3 documentation πŸ’» Command-line tool for Lodestar
@lodestar/state-transition npm License: LGPL v3 documentation πŸ”Ž Eth Consensus beacon-state transition
@lodestar/types npm License documentation πŸ—’οΈ Eth Consensus TypeScript and SSZ types
@lodestar/params npm License documentation πŸ•ΈοΈ Eth Consensus network parameters
@lodestar/utils npm License documentation 🧰 Miscellaneous utility functions used across Lodestar
@lodestar/config npm License documentation πŸ—’οΈ Eth Consensus types and params bundled together
@lodestar/spec-test-util npm License documentation πŸ§ͺ Test harness for Eth Consensus spec tests
@lodestar/db npm License documentation πŸ’Ύ Read/write persistent Eth Consensus data
@lodestar/fork-choice npm License documentation 🍴 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