mirror of
https://github.com/ChainSafe/lodestar.git
synced 2026-01-09 15:48:08 -05:00
9e57b7d320
* Check docs spelling * Add config * Fix docs spelling * Lint docs format * docs(flamegraph): remove note about script that was removed * sort wordlist * Set sort algo * Fix CI pipeline * hope to fix CI ordering * Disable wordlist sort check * docs(CONTRIBUTING): remove merge conflict marker and add codeblock types * refactor: change to pyspelling.yml for local runs * docs: make spell-checking wordlist case insensitive * fix: sort .wordlist.txt * refactor: alphabetize script order * fix: add docs/reference to gitignore * docs: add codeblocks to pyspelling ignore and clear all errors * docs: ignore possessive endings in spellcheck * docs: clear spelling errors in package readmes * docs: pyspelling fix generated cli.md * feat(workflows): lint generated docs * feat(workflows): add word sort to docs-check * test: unsort wordlist * fix: sort wordlist * refactor(workflow): remove unused comments --------- Co-authored-by: matthewkeil <me@matthewkeil.com> Co-authored-by: Cayman <caymannava@gmail.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.
- 📬 Sign up to our mailing list for announcements and any critical information about Lodestar.
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