Lodestar Monorepo

Lodestar is a Typescript implementation of the Ethereum 2.0 specification developed by ChainSafe Systems.

Index

• Prerequisites
• Getting Started
• Contributors
• Meeting Notes
• Donations
• Packages
• Creating Release

Getting started

• Follow the installation guide to install Lodestar.
• Run lodestar on the eth2 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 docs.
• If you have questions submit an issue or join us on discord!

Prerequisites

• Yarn

Architecture Overview

• See architecure docs for Lodestar

Contributors

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

Meeting Notes

Feel free to check out our meeting notes and documents on HackMD.

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

Packages

This monorepo repository contains a suite of Ethereum 2.0 packages.

Package	Version	License	Docs	Description
@chainsafe/lodestar				Beacon chain client
@chainsafe/lodestar-validator				Validator client
@chainsafe/lodestar-cli				Command line tool for lodestar
@chainsafe/lodestar-beacon-state-transition				Eth2 beacon state transition
@chainsafe/lodestar-types				Eth2 typescript and SSZ types
@chainsafe/lodestar-params				Eth2 network parameters
@chainsafe/lodestar-utils				Misc utility functions used across lodestar
@chainsafe/lodestar-config				Eth2 types and params bundled together
@chainsafe/lodestar-spec-test-util				Test harness for Eth2 spec tests
@chainsafe/lodestar-db				Read/write persistent Eth2 data
@chainsafe/lodestar-fork-choice				Beacon chain fork choice

Creating Release

• run yarn run release in project root directory
• choose version increment
• open PR to master