docs: update documentation Oct 2024 #7178
Open
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## unstable #7178 +/- ##
=========================================
Coverage 49.21% 49.21%
=========================================
Files 598 598
Lines 39726 39794 +68
Branches 2092 2097 +5
=========================================
+ Hits 19550 19585 +35
- Misses 20136 20169 +33
Partials 40 40 |
Performance Report✔️ no performance regression detected Full benchmark results
|
ensi321
reviewed
Oct 21, 2024
docs/pages/index.md
Outdated
|
|
||
| This documentation is open source, contribute at [Github Lodestar repository /docs](https://github.com/ChainSafe/lodestar/tree/unstable/docs). | ||
| If you run the [execution client](https://ethereum.org/en/developers/docs/nodes-and-clients/#execution-clients) on the same host, you will need to check their requirements and add them to the above requirements. |
There was a problem hiding this comment.
Shall we also add a hardware expectation for running EL+CL like what Nimbus does here?
Broadly, to run both an execution and a consensus client on the same machine, we recommend a 2 TB SSD and 16 GB RAM.
There was a problem hiding this comment.
I opted not to only because of the variations of the different EL clients. Will be easier IMO to just have the user figure out their recommendations and add it to our recommendations.
There was a problem hiding this comment.
Broadly, to run both an execution and a consensus client on the same machine, we recommend a 2 TB SSD and 16 GB RAM.
I am not sure this is even a good recommendation anymore, I generally recommend people to go for 4TB nowadays since it's unknown when we will ship the verge + blob count increase adds further storage burden.
16GB is also bit tight for Lodestar with most other ELs, it's not sufficient with Nethermind for example, my server is sitting at 17.2GB
nflaig
reviewed
Oct 22, 2024
docs/pages/index.md
Outdated
|
|
||
| This documentation is open source, contribute at [Github Lodestar repository /docs](https://github.com/ChainSafe/lodestar/tree/unstable/docs). | ||
| If you run the [execution client](https://ethereum.org/en/developers/docs/nodes-and-clients/#execution-clients) on the same host, you will need to check their requirements and add them to the above requirements. |
There was a problem hiding this comment.
Broadly, to run both an execution and a consensus client on the same machine, we recommend a 2 TB SSD and 16 GB RAM.
I am not sure this is even a good recommendation anymore, I generally recommend people to go for 4TB nowadays since it's unknown when we will ship the verge + blob count increase adds further storage burden.
16GB is also bit tight for Lodestar with most other ELs, it's not sufficient with Nethermind for example, my server is sitting at 17.2GB
nflaig
reviewed
Oct 30, 2024
| strict_fee_recipient_check: false | ||
| fee_recipient: "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" | ||
| builder: | ||
| enabled: true |
There was a problem hiding this comment.
enabled is not part of file config, this is configured based on builder.selection now, ie. to disable builder it has to be to set executiononly
lodestar/packages/cli/src/util/proposerConfig.ts
Lines 12 to 23 in 558ec2f
nflaig
reviewed
Oct 30, 2024
|
|
||
| ### Enable Proposer Configuration | ||
|
|
||
| After you have configured your proposer configuration YAML file, you can start Lodestar with an additional CLI flag option pointing to the file: `--proposerSettingsFile /path/to/proposer_config.yaml`. |
There was a problem hiding this comment.
should the flag be called --proposerConfigFile instead? we could keep the old name as an alias
nflaig
reviewed
Oct 30, 2024
There was a problem hiding this comment.
should probably document that it can be retrieved via api which was recently added in #7210
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.
Motivation
Our documentation has been undergoing incremental improvements to remove old content, update for relevance and add new content that hasn't been documented yet. This is one PR in a series of future PRs to improve docs for better user/developer experiences.
Related to #5961
Description
This PR addresses the following in our documentation:
More to come in future updates that were not included.