jleony/nanoreth
1
0
Fork 0
mirror of https://github.com/hl-archive-node/nanoreth.git synced 2025-12-06 10:59:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: book cli updater (#3576)

Browse Source
This commit is contained in:
Léo Vincent
2023-07-05 17:03:30 +02:00
committed by GitHub
parent 64ca521458
commit 9309279a2a
14 changed files with 1721 additions and 510 deletions
Download Patch File Download Diff File Expand all files Collapse all files

261
book/cli/debug.md
View File

@ -1,40 +1,45 @@
# `reth debug`
Various debug routines
```bash
$ reth debug --help
Various debug routines
Usage: reth debug <COMMAND>
Usage: reth debug [OPTIONS] <COMMAND>
Commands:
execution
Debug the roundtrip execution of blocks as well as the generated data.
Debug the roundtrip execution of blocks as well as the generated data
merkle
Debug the clean & incremental state root calculations.
Debug the clean & incremental state root calculations
help
Print this message or the help of the given subcommand(s)
Options:
-h, --help
Print help (see a summary with '-h')
Logging:
--log.persistent
The flag to enable persistent logs
--log.directory <PATH>
The path to put log files in
[default: /Users/georgios/Library/Caches/reth/logs]
[default: /reth/logs]
--log.journald
Log events to journald
--log.filter <FILTER>
The filter to use for logs written to the log file
[default: debug]
[default: error]
Display:
-v, --verbosity...
Set the minimum log level.
-v Errors
-vv Warnings
-vvv Info
@ -47,127 +52,203 @@ Display:
## `reth debug execution`
Debug the roundtrip execution of blocks as well as the generated data
```bash
$ reth debug execution --help
Debug the roundtrip execution of blocks as well as the generated data.
Usage: reth debug execution [OPTIONS]
Usage: reth debug execution [OPTIONS] --to <TO>
Options:
--datadir <DATA_DIR>
The path to the data dir for all reth files and subdirectories.
--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/`
[default: default]
Defaults to the OS-specific data directory:
--chain <CHAIN_OR_PATH>
The chain this node is running.
Possible values are either a built-in chain or the path to a chain specification file.
Built-in chains:
- mainnet
- goerli
- sepolia
[default: mainnet]
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
- Windows: `{FOLDERID_RoamingAppData}/reth/`
- macOS: `$HOME/Library/Application Support/reth/`
--chain <CHAIN_OR_PATH>
The chain this node is running.
Possible values are either a built-in chain or the path to a chain specification file.
Built-in chains:
- mainnet
- goerli
- sepolia
[default: mainnet]
--debug.tip
Set the chain tip manually for testing purposes.
--to
The maximum block height.
--interval
The block interval for sync and unwind.
[default: 1000]
-h, --help
Print help (see a summary with '-h')
Networking:
-d, --disable-discovery
Disable the discovery service
-d, --disable-discovery
Disable the discovery service
--disable-dns-discovery
Disable the DNS discovery
--disable-dns-discovery
Disable the DNS discovery
--disable-discv4-discovery
Disable Discv4 discovery
--disable-discv4-discovery
Disable Discv4 discovery
--discovery.port <DISCOVERY_PORT>
The UDP port to use for P2P discovery/networking. default: 30303
--discovery.port <DISCOVERY_PORT>
The UDP port to use for P2P discovery/networking. default: 30303
--trusted-peers <TRUSTED_PEERS>
Target trusted peer enodes --trusted-peers enode://abcd@192.168.0.1:30303
--trusted-peers <TRUSTED_PEERS>
Target trusted peer enodes --trusted-peers enode://abcd@192.168.0.1:30303
--trusted-only
Connect only to trusted peers
--trusted-only
Connect only to trusted peers
--bootnodes <BOOTNODES>
Bootnodes to connect to initially.
--bootnodes <BOOTNODES>
Bootnodes to connect to initially.
Will fall back to a network-specific default if not specified.
Will fall back to a network-specific default if not specified.
--peers-file <FILE>
The path to the known peers file. Connected peers are dumped to this file on nodes
shutdown, and read on startup. Cannot be used with `--no-persist-peers`.
--peers-file <FILE>
The path to the known peers file. Connected peers are dumped to this file on nodes
shutdown, and read on startup. Cannot be used with `--no-persist-peers`.
--identity <IDENTITY>
Custom node identity
[default: reth/v0.1.0-alpha.1/aarch64-apple-darwin]
--identity <IDENTITY>
Custom node identity
--p2p-secret-key <PATH>
Secret key to use for this node.
This will also deterministically set the peer ID. If not specified, it will be set in the data dir for the chain being used.
--p2p-secret-key <PATH>
Secret key to use for this node.
--no-persist-peers
Do not persist peers.
This will also deterministically set the peer ID. If not specified, it will be set in the data dir for the chain being used.
--nat <NAT>
NAT resolution method (any|none|upnp|publicip|extip:<IP>)
[default: any]
--no-persist-peers
Do not persist peers.
--port <PORT>
Network listening port. default: 30303
--nat <NAT>
NAT resolution method
--to <TO>
The maximum block height
[default: any]
--interval <INTERVAL>
The block interval for sync and unwind. Defaults to `1000`
[default: 1000]
--port <PORT>
Network listening port. default: 30303
Debug:
--debug.tip <TIP>
Set the chain tip manually for testing purposes.
NOTE: This is a temporary flag
Logging:
--log.persistent
The flag to enable persistent logs
--log.directory <PATH>
The path to put log files in
[default: /reth/logs]
--log.journald
Log events to journald
--log.filter <FILTER>
The filter to use for logs written to the log file
[default: error]
Display:
-v, --verbosity...
Set the minimum log level.
-v Errors
-vv Warnings
-vvv Info
-vvvv Debug
-vvvvv Traces (warning: very verbose!)
-q, --quiet
Silence all log output
```
## `reth debug merkle`
Debug the clean & incremental state root calculations
```bash
$ reth debug merkle --help
Debug the clean & incremental state root calculations.
Usage: reth debug merkle [OPTIONS]
Usage: reth debug merkle [OPTIONS] --to <TO>
Options:
--datadir <DATA_DIR>
The path to the data dir for all reth files and subdirectories.
--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/`
[default: default]
Defaults to the OS-specific data directory:
--chain <CHAIN_OR_PATH>
The chain this node is running.
Possible values are either a built-in chain or the path to a chain specification file.
Built-in chains:
- mainnet
- goerli
- sepolia
[default: mainnet]
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
- Windows: `{FOLDERID_RoamingAppData}/reth/`
- macOS: `$HOME/Library/Application Support/reth/`
--to <TO>
The height to finish at
--chain <CHAIN_OR_PATH>
The chain this node is running.
--skip-node-depth <SKIP_NODE_DEPTH>
The depth after which we should start comparing branch nodes
Possible values are either a built-in chain or the path to a chain specification file.
-h, --help
Print help (see a summary with '-h')
Built-in chains:
- mainnet
- goerli
- sepolia
Logging:
--log.persistent
The flag to enable persistent logs
[default: mainnet]
--log.directory <PATH>
The path to put log files in
[default: /reth/logs]
--to
The height to finish at
--log.journald
Log events to journald
--skip-node-depth
The depth after which we should start comparing branch nodes
--log.filter <FILTER>
The filter to use for logs written to the log file
[default: error]
Display:
-v, --verbosity...
Set the minimum log level.
-v Errors
-vv Warnings
-vvv Info
-vvvv Debug
-vvvvv Traces (warning: very verbose!)
-q, --quiet
Silence all log output
```