docs: config chapter

[onbjerg]

Adds a reference on how to configure reth using reth.toml, as well as describing some of the tradeoffs of increasing/decreasing values.

[onbjerg]

cc @mattsse

• what is the threshold for when peers are banned? in reference to [peers.reputation_weights]
• what is peers.refill_slots_interval
• when do we use low/medium/high/max for peer backoffs?
• what is the diff between the session command and event buffer? command are from us, events are from them?

[codecov]

Codecov Report

Merging #3173 (1df3745) into main (a967996) will increase coverage by 0.08%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #3173      +/-   ##
==========================================
+ Coverage   69.74%   69.83%   +0.08%     
==========================================
  Files         527      530       +3     
  Lines       70208    71387    +1179     
==========================================
+ Hits        48970    49853     +883     
- Misses      21238    21534     +296     

Flag	Coverage Δ
integration-tests	16.40% <ø> (-0.19%)	⬇️
unit-tests	64.85% <ø> (+0.02%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 87 files with indirect coverage changes

[shekhirin]

good stuff

[shekhirin]

worth mentioning it also validates the TD according to consensus rules?

[shekhirin]

maybe put same lines here, so you wouldn't need to run the CLI or go elsewhere in the book to find the config?

reth/book/cli/init.md

Lines 9 to 16 in 017c9ce

	--datadir <DATA_DIR>
	The path to the data dir for all reth files and subdirectories.
	Defaults to the OS-specific data directory:
	- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
	- Windows: `{FOLDERID_RoamingAppData}/reth/`
	- macOS: `$HOME/Library/Application Support/reth/`

[mattsse]

what is the threshold for when peers are banned? in reference to [peers.reputation_weights]

all peers start out with 0 reputation and earn reputation over time (simple reward for how long they're connected) but lose reputation on certain errors that are categorized in units via weights. The weights convert error variants into the reputation value via: weight * units

reth/crates/net/network/src/peers/reputation.rs

Lines 5 to 9 in 1049202

	/// The default reputation of a peer
	pub(crate) const DEFAULT_REPUTATION: Reputation = 0;
	/// The minimal unit we're measuring reputation
	const REPUTATION_UNIT: i32 = -1024;

if a peer drops below the BANNED_REPUTATION for example too many disconnects, we ban it (temp or perma, perma for protocol violations)

what is peers.refill_slots_interval

This is a chosen interval at which we try to fill outgoing connections slots by initiating outgoing connections to available peers

when do we use low/medium/high/max for peer backoffs?

This depends on the error kind: ptal at this impl:

reth/crates/net/network/src/error.rs

Line 171 in 1049202

fn should_backoff(&self) -> Option<BackoffKind> {

we convert the error to BackoffKind::{Low,Medium,High}

what is the diff between the session command and event buffer? command are from us, events are from them?

session command buffer is the channel size from the manager (producer) TO the active session (consumer)
event buffer is the channel size of the channel that all sessions (producer) share with the manager (consumer)

[shekhirin]

LGTM