mirror of
https://github.com/ChainSafe/lodestar.git
synced 2026-05-02 03:01:08 -04:00
02e28cf7ca
* Reorganize the code so it is accessible from one package * Add support for browser build for lightclient * Update the build config * Improve the bls vite plugin * Restructure the vite and vitest scripts * Simplify vite config * Remove unused polyfill * Fix the doc lint error * Add support for bundle test * Update the package json files * Add dist build to default build task * Fix spelling in the docs * Fix the lint error * Fix type error * Disable eslint errors * Increase the timeout for bundle test * Fix eslint bundle * Fix lint warning * Remove the unused config * Add the default export to bundle * Enable compression on th build * Update packages/light-client/README.md Co-authored-by: Nico Flaig <nflaig@protonmail.com> * Increase timeout for one test * Optimize package build task * Update the readme --------- Co-authored-by: Nico Flaig <nflaig@protonmail.com>
Lodestar Ethereum Consensus Implementation
Lodestar is a TypeScript implementation of the Ethereum Consensus specification developed by ChainSafe Systems.
Getting started
- ⚙️ Follow the installation method for source install, NPM install, or Docker install to install Lodestar. Or use our Lodestar Quickstart scripts.
- 📚 Use Lodestar libraries in your next Ethereum Typescript project.
- 🌐 Run a beacon node on mainnet or a public testnet.
- 💻 Utilize the whole stack by starting a local testnet.
- 🗒️ View the Lodestar CLI commands and options.
- 🤓 View the Package and dependency structure.
- 📝 Prospective contributors can read the contributing section to understand how we develop and test on Lodestar.
- ✍️ If you have questions submit an issue or join us on Discord!
- 🚨 Please note our security policy.
- 🐦 Follow Lodestar on Twitter for announcements and updates!
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 |
|---|---|---|---|---|
@lodestar/beacon-node |
 |
 |
 |
🚨 Beacon-chain client |
@lodestar/validator |
 |
|
|
🏦 Validator client |
@lodestar/light-client |
 |
 |
|
🐦 Ethereum Light client |
@lodestar/api |
 |
|
|
📋 REST Client for the Ethereum Beacon API |
@chainsafe/lodestar |
 |
|
|
💻 Command-line tool for Lodestar |
@lodestar/state-transition |
 |
|
|
🔎 Eth Consensus beacon-state transition |
@lodestar/types |
 |
|
|
🗒️ Eth Consensus TypeScript and SSZ types |
@lodestar/params |
 |
|
|
🕸️ Eth Consensus network parameters |
@lodestar/utils |
 |
|
|
🧰 Miscellaneous utility functions used across Lodestar |
@lodestar/config |
 |
|
|
🗒️ Eth Consensus types and params bundled together |
@lodestar/spec-test-util |
 |
|
|
🧪 Test harness for Eth Consensus spec tests |
@lodestar/db |
 |
|
|
💾 Read/write persistent Eth Consensus data |
@lodestar/fork-choice |
 |
|
|
🍴 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