Skip to content

Latest commit

 

History

History
78 lines (60 loc) · 13.3 KB

README.md

File metadata and controls

78 lines (60 loc) · 13.3 KB

Lodestar Ethereum Consensus Implementation

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

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

Getting started

Prerequisites

Developer Quickstart:
yarn install
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 npm License: LGPL v3 documentation 💻 Command-line tool for Lodestar
@lodestar/api npm License documentation 📋 REST Client for the Ethereum Beacon API
@lodestar/beacon-node npm License: LGPL v3 documentation 🚨 Beacon-chain client
@lodestar/config npm License documentation 🗒️ Eth Consensus types and params bundled together
@lodestar/db npm License documentation 💾 Read/write persistent Eth Consensus data
@lodestar/flare npm License documentation 💥 Command tool for triggering non-standard actions
@lodestar/fork-choice npm License documentation 🍴 Beacon-chain fork choice
@lodestar/light-client npm License documentation 🐦 Ethereum Light client
@lodestar/logger npm License documentation 📝 NodeJS logger for Lodestar binaries
@lodestar/params npm License documentation 🕸️ Eth Consensus network parameters
@lodestar/prover npm License documentation ✅ Ethereum Light client verifier for execution JSON-RPC calls
@lodestar/reqresp npm License documentation 📞 Eth Consensus Req/Resp protocol
@lodestar/spec-test-util npm License documentation 🧪 Test harness for Eth Consensus spec tests
@lodestar/state-transition npm License documentation 🔎 Eth Consensus beacon-state transition
@lodestar/types npm License documentation 🗒️ Eth Consensus TypeScript and SSZ types
@lodestar/utils npm License documentation 🧰 Miscellaneous utility functions used across Lodestar
@lodestar/validator npm License: LGPL v3 documentation 🏦 Validator client

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