Revise documentation for Ethereum consensus clients #310
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Karrenbelt
commented
Aug 20, 2024
| | [Prysm](https://github.com/prysmaticlabs/prysm) | Go | Prysmatic Labs | Production | | ||
| | [Teku](https://github.com/ConsenSys/teku) | Java | ConsenSys | Production | | ||
| | [Grandine](https://github.com/grandinetech/grandine) | Rust | Grandine Developers | Production | | ||
| | [Caplin](https://github.com/ledgerwatch/erigon) | N/A | Erigon | Development | |
There was a problem hiding this comment.
I suppose this should say "Go" under Language for Caplin
|
|
||
| There are multiple Consensus Layer clients developed to participate in the Ethereum Proof-of-Stake (PoS) mechanism. The most popular, FOSS and production ready are [Lighthouse](https://lighthouse-book.sigmaprime.io/), [Lodestar](https://lodestar.chainsafe.io/), [Nimbus](https://nimbus.team/index.html), [Prysm](https://prysmaticlabs.com/) and [Teku](https://consensys.io/teku). These clients are developed in different programming languages, provide have unique features and offer different performance profiles. All clients support Ethereum mainnet out of the box along with active testnets. Variety of implementations allows the network to benefit from client diversity. If you are choosing a client to use, current client diversity should be one of the main factors. | ||
| ## Overview Table |
There was a problem hiding this comment.
It's great to have a proper table instead of just a text! Still I would provide more context from the deleted paragraph e.g. the part on client diversity
These clients are developed in different programming languages, provide have unique features and offer different performance profiles. All clients support Ethereum mainnet out of the box along with active testnets. Variety of implementations allows the network to benefit from client diversity. If you are choosing a client to use, current client diversity should be one of the main factors.
| - [Slashing Protection](https://lighthouse-book.sigmaprime.io/faq.html#what-is-slashing-protection) | ||
| - [Doppelganger Protection](https://lighthouse-book.sigmaprime.io/validator-doppelganger.html#doppelganger-protection) | ||
| Noteworthy Features: | ||
| - [Become a staked Validator](https://lighthouse-book.sigmaprime.io/mainnet-validator.html) |
There was a problem hiding this comment.
It's ok to be more succinct here but some paragraphs of the original text are still useful. For example I like adding hints for installation, having here fingerprint of gpg key for binaries
|
|
||
| ### LambdaClass Client | ||
| ### Caplin and LambdaClass |
There was a problem hiding this comment.
I would still split these and provide some context. Caplin is basically usable in production, it is integrated in erigon so it is easiest to setup just by enabling a flag. Lambda also deserves it's own paragraph with links to their repo
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Refined the documentation for consensus clients to improve readability and consistency. Replaced outdated content with links to official documentation for up-to-date information. Aligns with updates in PR #309 regarding the execution clients section for a uniform presentation.
Please review @ABresting, as I replaced a lot of your previous writing