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

docs(book): update CLI (#5730)

Browse Source
This commit is contained in:
Alexey Shekhirin
2023-12-12 11:36:59 +00:00
committed by GitHub
parent c1d7d2bde3
commit 7efd0fd939
11 changed files with 2619 additions and 116 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
book/cli/cli.md
View File

@ -45,14 +45,10 @@ Commands:
Options: Options:
--chain <CHAIN_OR_PATH> --chain <CHAIN_OR_PATH>
The chain this node is running. The chain this node is running.
Possible values are either a built-in chain or the path to a chain specification file. Possible values are either a built-in chain or the path to a chain specification file.
Built-in chains: Built-in chains:
- mainnet mainnet, sepolia, goerli, holesky, dev
- goerli
- sepolia
- holesky
[default: mainnet] [default: mainnet]

6
book/cli/config.md
View File

@ -16,14 +16,10 @@ Options:
--chain <CHAIN_OR_PATH> --chain <CHAIN_OR_PATH>
The chain this node is running. The chain this node is running.
Possible values are either a built-in chain or the path to a chain specification file. Possible values are either a built-in chain or the path to a chain specification file.
Built-in chains: Built-in chains:
- mainnet mainnet, sepolia, goerli, holesky, dev
- goerli
- sepolia
- holesky
[default: mainnet] [default: mainnet]

759
book/cli/db.md
View File

@ -8,15 +8,16 @@ $ reth db --help
Usage: reth db [OPTIONS] <COMMAND> Usage: reth db [OPTIONS] <COMMAND>
Commands: Commands:
stats Lists all the tables, their entry count and their size stats Lists all the tables, their entry count and their size
list Lists the contents of a table list Lists the contents of a table
diff Create a diff between two database tables or two entire databases diff Create a diff between two database tables or two entire databases
get Gets the content of a table for the given key get Gets the content of a table for the given key
drop Deletes all database entries drop Deletes all database entries
clear Deletes all table entries clear Deletes all table entries
version Lists current and local database versions snapshot Snapshots tables from database
path Returns the full database path version Lists current and local database versions
help Print this message or the help of the given subcommand(s) path Returns the full database path
help Print this message or the help of the given subcommand(s)
Options: Options:
--datadir <DATA_DIR> --datadir <DATA_DIR>
@ -32,14 +33,10 @@ Options:
--chain <CHAIN_OR_PATH> --chain <CHAIN_OR_PATH>
The chain this node is running. The chain this node is running.
Possible values are either a built-in chain or the path to a chain specification file. Possible values are either a built-in chain or the path to a chain specification file.
Built-in chains: Built-in chains:
- mainnet mainnet, sepolia, goerli, holesky, dev
- goerli
- sepolia
- holesky
[default: mainnet] [default: mainnet]
@ -136,6 +133,93 @@ Usage: reth db clear [OPTIONS] <TABLE>
Arguments: Arguments:
<TABLE> <TABLE>
Table name Table name
Options:
--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]
--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, sepolia, goerli, holesky, dev
[default: mainnet]
--instance <INSTANCE>
Add a new instance of a node.
Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.
Max number of instances is 200. It is chosen in a way so that it's not possible to have port numbers that conflict with each other.
Changes to the following port numbers: - DISCOVERY_PORT: default + `instance` - 1 - AUTH_PORT: default + `instance` * 100 - 100 - HTTP_RPC_PORT: default - `instance` + 1 - WS_RPC_PORT: default + `instance` * 2 - 2
[default: 1]
-h, --help
Print help (see a summary with '-h')
Logging:
--log.file.directory <PATH>
The path to put log files in
[default: /reth/logs]
--log.file.max-size <SIZE>
The maximum size (in MB) of one log file
[default: 200]
--log.file.max-files <COUNT>
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
[default: 5]
--log.file.filter <FILTER>
The filter to use for logs written to the log file
[default: debug]
--log.journald
Write logs to journald
--log.journald.filter <FILTER>
The filter to use for logs written to journald
[default: error]
--color <COLOR>
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
[default: always]
Possible values:
- always: Colors on
- auto: Colors on
- never: Colors off
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 db diff` ## `reth db diff`
@ -148,8 +232,114 @@ $ reth db diff --help
Usage: reth db diff [OPTIONS] --secondary-datadir <SECONDARY_DATADIR> --output <OUTPUT> Usage: reth db diff [OPTIONS] --secondary-datadir <SECONDARY_DATADIR> --output <OUTPUT>
Options: Options:
--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]
--secondary-datadir <SECONDARY_DATADIR> --secondary-datadir <SECONDARY_DATADIR>
The path to the data dir for all reth files and subdirectories. The path to the data dir for all reth files and subdirectories.
--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, sepolia, goerli, holesky, dev
[default: mainnet]
--instance <INSTANCE>
Add a new instance of a node.
Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.
Max number of instances is 200. It is chosen in a way so that it's not possible to have port numbers that conflict with each other.
Changes to the following port numbers: - DISCOVERY_PORT: default + `instance` - 1 - AUTH_PORT: default + `instance` * 100 - 100 - HTTP_RPC_PORT: default - `instance` + 1 - WS_RPC_PORT: default + `instance` * 2 - 2
[default: 1]
-h, --help
Print help (see a summary with '-h')
Database:
--db.log-level <LOG_LEVEL>
Database logging level. Levels higher than "notice" require a debug build
Possible values:
- fatal: Enables logging for critical conditions, i.e. assertion failures
- error: Enables logging for error conditions
- warn: Enables logging for warning conditions
- notice: Enables logging for normal but significant condition
- verbose: Enables logging for verbose informational
- debug: Enables logging for debug-level messages
- trace: Enables logging for trace debug-level messages
- extra: Enables logging for extra debug-level messages
--table <TABLE>
The table name to diff. If not specified, all tables are diffed.
--output <OUTPUT>
The output directory for the diff report.
Logging:
--log.file.directory <PATH>
The path to put log files in
[default: /reth/logs]
--log.file.max-size <SIZE>
The maximum size (in MB) of one log file
[default: 200]
--log.file.max-files <COUNT>
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
[default: 5]
--log.file.filter <FILTER>
The filter to use for logs written to the log file
[default: debug]
--log.journald
Write logs to journald
--log.journald.filter <FILTER>
The filter to use for logs written to journald
[default: error]
--color <COLOR>
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
[default: always]
Possible values:
- always: Colors on
- auto: Colors on
- never: Colors off
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 db drop` ## `reth db drop`
@ -162,8 +352,94 @@ $ reth db drop --help
Usage: reth db drop [OPTIONS] Usage: reth db drop [OPTIONS]
Options: Options:
--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]
-f, --force -f, --force
Bypasses the interactive confirmation and drops the database directly Bypasses the interactive confirmation and drops the database directly
--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, sepolia, goerli, holesky, dev
[default: mainnet]
--instance <INSTANCE>
Add a new instance of a node.
Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.
Max number of instances is 200. It is chosen in a way so that it's not possible to have port numbers that conflict with each other.
Changes to the following port numbers: - DISCOVERY_PORT: default + `instance` - 1 - AUTH_PORT: default + `instance` * 100 - 100 - HTTP_RPC_PORT: default - `instance` + 1 - WS_RPC_PORT: default + `instance` * 2 - 2
[default: 1]
-h, --help
Print help (see a summary with '-h')
Logging:
--log.file.directory <PATH>
The path to put log files in
[default: /reth/logs]
--log.file.max-size <SIZE>
The maximum size (in MB) of one log file
[default: 200]
--log.file.max-files <COUNT>
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
[default: 5]
--log.file.filter <FILTER>
The filter to use for logs written to the log file
[default: debug]
--log.journald
Write logs to journald
--log.journald.filter <FILTER>
The filter to use for logs written to journald
[default: error]
--color <COLOR>
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
[default: always]
Possible values:
- always: Colors on
- auto: Colors on
- never: Colors off
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 db get` ## `reth db get`
@ -183,6 +459,96 @@ Arguments:
<KEY> <KEY>
The key to get content for The key to get content for
Options:
--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]
--raw
Output bytes instead of human-readable decoded value
--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, sepolia, goerli, holesky, dev
[default: mainnet]
--instance <INSTANCE>
Add a new instance of a node.
Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.
Max number of instances is 200. It is chosen in a way so that it's not possible to have port numbers that conflict with each other.
Changes to the following port numbers: - DISCOVERY_PORT: default + `instance` - 1 - AUTH_PORT: default + `instance` * 100 - 100 - HTTP_RPC_PORT: default - `instance` + 1 - WS_RPC_PORT: default + `instance` * 2 - 2
[default: 1]
-h, --help
Print help (see a summary with '-h')
Logging:
--log.file.directory <PATH>
The path to put log files in
[default: /reth/logs]
--log.file.max-size <SIZE>
The maximum size (in MB) of one log file
[default: 200]
--log.file.max-files <COUNT>
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
[default: 5]
--log.file.filter <FILTER>
The filter to use for logs written to the log file
[default: debug]
--log.journald
Write logs to journald
--log.journald.filter <FILTER>
The filter to use for logs written to journald
[default: error]
--color <COLOR>
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
[default: always]
Possible values:
- always: Colors on
- auto: Colors on
- never: Colors off
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 db list` ## `reth db list`
@ -199,11 +565,31 @@ Arguments:
The table name The table name
Options: Options:
--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]
-s, --skip <SKIP> -s, --skip <SKIP>
Skip first N entries Skip first N entries
[default: 0] [default: 0]
--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, sepolia, goerli, holesky, dev
[default: mainnet]
-r, --reverse -r, --reverse
Reverse the order of the entries. If enabled last table entries are read Reverse the order of the entries. If enabled last table entries are read
@ -217,11 +603,95 @@ Options:
ATTENTION! For compressed tables (`Transactions` and `Receipts`), there might be missing results since the search uses the raw uncompressed value from the database. ATTENTION! For compressed tables (`Transactions` and `Receipts`), there might be missing results since the search uses the raw uncompressed value from the database.
--min-row-size <MIN_ROW_SIZE>
Minimum size of row in bytes
[default: 0]
--min-key-size <MIN_KEY_SIZE>
Minimum size of key in bytes
[default: 0]
--min-value-size <MIN_VALUE_SIZE>
Minimum size of value in bytes
[default: 0]
-c, --count -c, --count
Returns the number of rows found Returns the number of rows found
-j, --json -j, --json
Dump as JSON instead of using TUI Dump as JSON instead of using TUI
--raw
Output bytes instead of human-readable decoded value
--instance <INSTANCE>
Add a new instance of a node.
Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.
Max number of instances is 200. It is chosen in a way so that it's not possible to have port numbers that conflict with each other.
Changes to the following port numbers: - DISCOVERY_PORT: default + `instance` - 1 - AUTH_PORT: default + `instance` * 100 - 100 - HTTP_RPC_PORT: default - `instance` + 1 - WS_RPC_PORT: default + `instance` * 2 - 2
[default: 1]
-h, --help
Print help (see a summary with '-h')
Logging:
--log.file.directory <PATH>
The path to put log files in
[default: /reth/logs]
--log.file.max-size <SIZE>
The maximum size (in MB) of one log file
[default: 200]
--log.file.max-files <COUNT>
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
[default: 5]
--log.file.filter <FILTER>
The filter to use for logs written to the log file
[default: debug]
--log.journald
Write logs to journald
--log.journald.filter <FILTER>
The filter to use for logs written to journald
[default: error]
--color <COLOR>
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
[default: always]
Possible values:
- always: Colors on
- auto: Colors on
- never: Colors off
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 db path` ## `reth db path`
@ -232,6 +702,93 @@ Returns the full database path
$ reth db path --help $ reth db path --help
Usage: reth db path [OPTIONS] Usage: reth db path [OPTIONS]
Options:
--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]
--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, sepolia, goerli, holesky, dev
[default: mainnet]
--instance <INSTANCE>
Add a new instance of a node.
Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.
Max number of instances is 200. It is chosen in a way so that it's not possible to have port numbers that conflict with each other.
Changes to the following port numbers: - DISCOVERY_PORT: default + `instance` - 1 - AUTH_PORT: default + `instance` * 100 - 100 - HTTP_RPC_PORT: default - `instance` + 1 - WS_RPC_PORT: default + `instance` * 2 - 2
[default: 1]
-h, --help
Print help (see a summary with '-h')
Logging:
--log.file.directory <PATH>
The path to put log files in
[default: /reth/logs]
--log.file.max-size <SIZE>
The maximum size (in MB) of one log file
[default: 200]
--log.file.max-files <COUNT>
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
[default: 5]
--log.file.filter <FILTER>
The filter to use for logs written to the log file
[default: debug]
--log.journald
Write logs to journald
--log.journald.filter <FILTER>
The filter to use for logs written to journald
[default: error]
--color <COLOR>
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
[default: always]
Possible values:
- always: Colors on
- auto: Colors on
- never: Colors off
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 db stats` ## `reth db stats`
@ -242,6 +799,93 @@ Lists all the tables, their entry count and their size
$ reth db stats --help $ reth db stats --help
Usage: reth db stats [OPTIONS] Usage: reth db stats [OPTIONS]
Options:
--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]
--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, sepolia, goerli, holesky, dev
[default: mainnet]
--instance <INSTANCE>
Add a new instance of a node.
Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.
Max number of instances is 200. It is chosen in a way so that it's not possible to have port numbers that conflict with each other.
Changes to the following port numbers: - DISCOVERY_PORT: default + `instance` - 1 - AUTH_PORT: default + `instance` * 100 - 100 - HTTP_RPC_PORT: default - `instance` + 1 - WS_RPC_PORT: default + `instance` * 2 - 2
[default: 1]
-h, --help
Print help (see a summary with '-h')
Logging:
--log.file.directory <PATH>
The path to put log files in
[default: /reth/logs]
--log.file.max-size <SIZE>
The maximum size (in MB) of one log file
[default: 200]
--log.file.max-files <COUNT>
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
[default: 5]
--log.file.filter <FILTER>
The filter to use for logs written to the log file
[default: debug]
--log.journald
Write logs to journald
--log.journald.filter <FILTER>
The filter to use for logs written to journald
[default: error]
--color <COLOR>
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
[default: always]
Possible values:
- always: Colors on
- auto: Colors on
- never: Colors off
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 db version` ## `reth db version`
@ -252,4 +896,91 @@ Lists current and local database versions
$ reth db version --help $ reth db version --help
Usage: reth db version [OPTIONS] Usage: reth db version [OPTIONS]
Options:
--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]
--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, sepolia, goerli, holesky, dev
[default: mainnet]
--instance <INSTANCE>
Add a new instance of a node.
Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.
Max number of instances is 200. It is chosen in a way so that it's not possible to have port numbers that conflict with each other.
Changes to the following port numbers: - DISCOVERY_PORT: default + `instance` - 1 - AUTH_PORT: default + `instance` * 100 - 100 - HTTP_RPC_PORT: default - `instance` + 1 - WS_RPC_PORT: default + `instance` * 2 - 2
[default: 1]
-h, --help
Print help (see a summary with '-h')
Logging:
--log.file.directory <PATH>
The path to put log files in
[default: /reth/logs]
--log.file.max-size <SIZE>
The maximum size (in MB) of one log file
[default: 200]
--log.file.max-files <COUNT>
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
[default: 5]
--log.file.filter <FILTER>
The filter to use for logs written to the log file
[default: debug]
--log.journald
Write logs to journald
--log.journald.filter <FILTER>
The filter to use for logs written to journald
[default: error]
--color <COLOR>
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
[default: always]
Possible values:
- always: Colors on
- auto: Colors on
- never: Colors off
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
``` ```

575
book/cli/debug.md
View File

@ -11,30 +11,16 @@ Commands:
execution Debug the roundtrip execution of blocks as well as the generated data execution Debug the roundtrip execution of blocks as well as the generated data
merkle Debug the clean & incremental state root calculations merkle Debug the clean & incremental state root calculations
in-memory-merkle Debug in-memory state root calculation in-memory-merkle Debug in-memory state root calculation
build-block Debug block building
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
Options: Options:
--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]
--chain <CHAIN_OR_PATH> --chain <CHAIN_OR_PATH>
The chain this node is running. The chain this node is running.
Possible values are either a built-in chain or the path to a chain specification file. Possible values are either a built-in chain or the path to a chain specification file.
Built-in chains: Built-in chains:
- mainnet mainnet, sepolia, goerli, holesky, dev
- goerli
- sepolia
- holesky
[default: mainnet] [default: mainnet]
@ -113,16 +99,186 @@ Debug the roundtrip execution of blocks as well as the generated data
$ reth debug execution --help $ reth debug execution --help
Usage: reth debug execution [OPTIONS] --to <TO> Usage: reth debug execution [OPTIONS] --to <TO>
```
## `reth debug merkle` Options:
--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]
Debug the clean & incremental state root calculations --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, sepolia, goerli, holesky, dev
[default: mainnet]
```bash --instance <INSTANCE>
$ reth debug merkle --help Add a new instance of a node.
Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.
Max number of instances is 200. It is chosen in a way so that it's not possible to have port numbers that conflict with each other.
Changes to the following port numbers: - DISCOVERY_PORT: default + `instance` - 1 - AUTH_PORT: default + `instance` * 100 - 100 - HTTP_RPC_PORT: default - `instance` + 1 - WS_RPC_PORT: default + `instance` * 2 - 2
[default: 1]
Usage: reth debug merkle [OPTIONS] --to <TO> -h, --help
Print help (see a summary with '-h')
Networking:
-d, --disable-discovery
Disable the discovery service
--disable-dns-discovery
Disable the DNS discovery
--disable-discv4-discovery
Disable Discv4 discovery
--discovery.addr <DISCOVERY_ADDR>
The UDP address to use for P2P discovery/networking
[default: 0.0.0.0]
--discovery.port <DISCOVERY_PORT>
The UDP port to use for P2P discovery/networking
[default: 30303]
--trusted-peers <TRUSTED_PEERS>
Comma separated enode URLs of trusted peers for P2P connections.
--trusted-peers enode://abcd@192.168.0.1:30303
--trusted-only
Connect only to trusted peers
--bootnodes <BOOTNODES>
Comma separated enode URLs for P2P discovery bootstrap.
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`.
--identity <IDENTITY>
Custom node identity
[default: reth/v0.1.0-alpha.13-10a83e594/aarch64-apple-darwin]
--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.
--no-persist-peers
Do not persist peers.
--nat <NAT>
NAT resolution method (any|none|upnp|publicip|extip:<IP>)
[default: any]
--addr <ADDR>
Network listening address
[default: 0.0.0.0]
--port <PORT>
Network listening port
[default: 30303]
--max-outbound-peers <MAX_OUTBOUND_PEERS>
Maximum number of outbound requests. default: 100
--max-inbound-peers <MAX_INBOUND_PEERS>
Maximum number of inbound requests. default: 30
Database:
--db.log-level <LOG_LEVEL>
Database logging level. Levels higher than "notice" require a debug build
Possible values:
- fatal: Enables logging for critical conditions, i.e. assertion failures
- error: Enables logging for error conditions
- warn: Enables logging for warning conditions
- notice: Enables logging for normal but significant condition
- verbose: Enables logging for verbose informational
- debug: Enables logging for debug-level messages
- trace: Enables logging for trace debug-level messages
- extra: Enables logging for extra debug-level messages
--to <TO>
The maximum block height
--interval <INTERVAL>
The block interval for sync and unwind. Defaults to `1000`
[default: 1000]
Logging:
--log.file.directory <PATH>
The path to put log files in
[default: /reth/logs]
--log.file.max-size <SIZE>
The maximum size (in MB) of one log file
[default: 200]
--log.file.max-files <COUNT>
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
[default: 5]
--log.file.filter <FILTER>
The filter to use for logs written to the log file
[default: debug]
--log.journald
Write logs to journald
--log.journald.filter <FILTER>
The filter to use for logs written to journald
[default: error]
--color <COLOR>
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
[default: always]
Possible values:
- always: Colors on
- auto: Colors on
- never: Colors off
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 in-memory-merkle` ## `reth debug in-memory-merkle`
@ -133,4 +289,377 @@ Debug in-memory state root calculation
$ reth debug in-memory-merkle --help $ reth debug in-memory-merkle --help
Usage: reth debug in-memory-merkle [OPTIONS] Usage: reth debug in-memory-merkle [OPTIONS]
```
Options:
--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]
--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, sepolia, goerli, holesky, dev
[default: mainnet]
--instance <INSTANCE>
Add a new instance of a node.
Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.
Max number of instances is 200. It is chosen in a way so that it's not possible to have port numbers that conflict with each other.
Changes to the following port numbers: - DISCOVERY_PORT: default + `instance` - 1 - AUTH_PORT: default + `instance` * 100 - 100 - HTTP_RPC_PORT: default - `instance` + 1 - WS_RPC_PORT: default + `instance` * 2 - 2
[default: 1]
-h, --help
Print help (see a summary with '-h')
Database:
--db.log-level <LOG_LEVEL>
Database logging level. Levels higher than "notice" require a debug build
Possible values:
- fatal: Enables logging for critical conditions, i.e. assertion failures
- error: Enables logging for error conditions
- warn: Enables logging for warning conditions
- notice: Enables logging for normal but significant condition
- verbose: Enables logging for verbose informational
- debug: Enables logging for debug-level messages
- trace: Enables logging for trace debug-level messages
- extra: Enables logging for extra debug-level messages
Networking:
-d, --disable-discovery
Disable the discovery service
--disable-dns-discovery
Disable the DNS discovery
--disable-discv4-discovery
Disable Discv4 discovery
--discovery.addr <DISCOVERY_ADDR>
The UDP address to use for P2P discovery/networking
[default: 0.0.0.0]
--discovery.port <DISCOVERY_PORT>
The UDP port to use for P2P discovery/networking
[default: 30303]
--trusted-peers <TRUSTED_PEERS>
Comma separated enode URLs of trusted peers for P2P connections.
--trusted-peers enode://abcd@192.168.0.1:30303
--trusted-only
Connect only to trusted peers
--bootnodes <BOOTNODES>
Comma separated enode URLs for P2P discovery bootstrap.
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`.
--identity <IDENTITY>
Custom node identity
[default: reth/v0.1.0-alpha.13-10a83e594/aarch64-apple-darwin]
--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.
--no-persist-peers
Do not persist peers.
--nat <NAT>
NAT resolution method (any|none|upnp|publicip|extip:<IP>)
[default: any]
--addr <ADDR>
Network listening address
[default: 0.0.0.0]
--port <PORT>
Network listening port
[default: 30303]
--max-outbound-peers <MAX_OUTBOUND_PEERS>
Maximum number of outbound requests. default: 100
--max-inbound-peers <MAX_INBOUND_PEERS>
Maximum number of inbound requests. default: 30
--retries <RETRIES>
The number of retries per request
[default: 5]
--skip-node-depth <SKIP_NODE_DEPTH>
The depth after which we should start comparing branch nodes
Logging:
--log.file.directory <PATH>
The path to put log files in
[default: /reth/logs]
--log.file.max-size <SIZE>
The maximum size (in MB) of one log file
[default: 200]
--log.file.max-files <COUNT>
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
[default: 5]
--log.file.filter <FILTER>
The filter to use for logs written to the log file
[default: debug]
--log.journald
Write logs to journald
--log.journald.filter <FILTER>
The filter to use for logs written to journald
[default: error]
--color <COLOR>
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
[default: always]
Possible values:
- always: Colors on
- auto: Colors on
- never: Colors off
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
Usage: reth debug merkle [OPTIONS] --to <TO>
Options:
--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]
--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, sepolia, goerli, holesky, dev
[default: mainnet]
--instance <INSTANCE>
Add a new instance of a node.
Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.
Max number of instances is 200. It is chosen in a way so that it's not possible to have port numbers that conflict with each other.
Changes to the following port numbers: - DISCOVERY_PORT: default + `instance` - 1 - AUTH_PORT: default + `instance` * 100 - 100 - HTTP_RPC_PORT: default - `instance` + 1 - WS_RPC_PORT: default + `instance` * 2 - 2
[default: 1]
-h, --help
Print help (see a summary with '-h')
Database:
--db.log-level <LOG_LEVEL>
Database logging level. Levels higher than "notice" require a debug build
Possible values:
- fatal: Enables logging for critical conditions, i.e. assertion failures
- error: Enables logging for error conditions
- warn: Enables logging for warning conditions
- notice: Enables logging for normal but significant condition
- verbose: Enables logging for verbose informational
- debug: Enables logging for debug-level messages
- trace: Enables logging for trace debug-level messages
- extra: Enables logging for extra debug-level messages
Networking:
-d, --disable-discovery
Disable the discovery service
--disable-dns-discovery
Disable the DNS discovery
--disable-discv4-discovery
Disable Discv4 discovery
--discovery.addr <DISCOVERY_ADDR>
The UDP address to use for P2P discovery/networking
[default: 0.0.0.0]
--discovery.port <DISCOVERY_PORT>
The UDP port to use for P2P discovery/networking
[default: 30303]
--trusted-peers <TRUSTED_PEERS>
Comma separated enode URLs of trusted peers for P2P connections.
--trusted-peers enode://abcd@192.168.0.1:30303
--trusted-only
Connect only to trusted peers
--bootnodes <BOOTNODES>
Comma separated enode URLs for P2P discovery bootstrap.
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`.
--identity <IDENTITY>
Custom node identity
[default: reth/v0.1.0-alpha.13-10a83e594/aarch64-apple-darwin]
--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.
--no-persist-peers
Do not persist peers.
--nat <NAT>
NAT resolution method (any|none|upnp|publicip|extip:<IP>)
[default: any]
--addr <ADDR>
Network listening address
[default: 0.0.0.0]
--port <PORT>
Network listening port
[default: 30303]
--max-outbound-peers <MAX_OUTBOUND_PEERS>
Maximum number of outbound requests. default: 100
--max-inbound-peers <MAX_INBOUND_PEERS>
Maximum number of inbound requests. default: 30
--retries <RETRIES>
The number of retries per request
[default: 5]
--to <TO>
The height to finish at
--skip-node-depth <SKIP_NODE_DEPTH>
The depth after which we should start comparing branch nodes
Logging:
--log.file.directory <PATH>
The path to put log files in
[default: /reth/logs]
--log.file.max-size <SIZE>
The maximum size (in MB) of one log file
[default: 200]
--log.file.max-files <COUNT>
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
[default: 5]
--log.file.filter <FILTER>
The filter to use for logs written to the log file
[default: debug]
--log.journald
Write logs to journald
--log.journald.filter <FILTER>
The filter to use for logs written to journald
[default: error]
--color <COLOR>
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
[default: always]
Possible values:
- always: Colors on
- auto: Colors on
- never: Colors off
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
```

6
book/cli/import.md
View File

@ -24,14 +24,10 @@ Options:
--chain <CHAIN_OR_PATH> --chain <CHAIN_OR_PATH>
The chain this node is running. The chain this node is running.
Possible values are either a built-in chain or the path to a chain specification file. Possible values are either a built-in chain or the path to a chain specification file.
Built-in chains: Built-in chains:
- mainnet mainnet, sepolia, goerli, holesky, dev
- goerli
- sepolia
- holesky
[default: mainnet] [default: mainnet]

6
book/cli/init.md
View File

@ -21,14 +21,10 @@ Options:
--chain <CHAIN_OR_PATH> --chain <CHAIN_OR_PATH>
The chain this node is running. The chain this node is running.
Possible values are either a built-in chain or the path to a chain specification file. Possible values are either a built-in chain or the path to a chain specification file.
Built-in chains: Built-in chains:
- mainnet mainnet, sepolia, goerli, holesky, dev
- goerli
- sepolia
- holesky
[default: mainnet] [default: mainnet]

100
book/cli/node.md
View File

@ -24,15 +24,10 @@ Options:
--chain <CHAIN_OR_PATH> --chain <CHAIN_OR_PATH>
The chain this node is running. The chain this node is running.
Possible values are either a built-in chain or the path to a chain specification file. Possible values are either a built-in chain or the path to a chain specification file.
Built-in chains: Built-in chains:
- mainnet mainnet, sepolia, goerli, holesky, dev
- goerli
- sepolia
- holesky
- dev
[default: mainnet] [default: mainnet]
@ -69,17 +64,26 @@ Networking:
--disable-discv4-discovery --disable-discv4-discovery
Disable Discv4 discovery Disable Discv4 discovery
--discovery.addr <DISCOVERY_ADDR>
The UDP address to use for P2P discovery/networking
[default: 0.0.0.0]
--discovery.port <DISCOVERY_PORT> --discovery.port <DISCOVERY_PORT>
The UDP port to use for P2P discovery/networking. default: 30303 The UDP port to use for P2P discovery/networking
[default: 30303]
--trusted-peers <TRUSTED_PEERS> --trusted-peers <TRUSTED_PEERS>
Target trusted peer enodes --trusted-peers enode://abcd@192.168.0.1:30303 Comma separated enode URLs of trusted peers for P2P connections.
--trusted-peers enode://abcd@192.168.0.1:30303
--trusted-only --trusted-only
Connect only to trusted peers Connect only to trusted peers
--bootnodes <BOOTNODES> --bootnodes <BOOTNODES>
Bootnodes to connect to initially. Comma separated enode URLs for P2P discovery bootstrap.
Will fall back to a network-specific default if not specified. Will fall back to a network-specific default if not specified.
@ -90,7 +94,7 @@ Networking:
--identity <IDENTITY> --identity <IDENTITY>
Custom node identity Custom node identity
[default: reth/VERSION/PLATFORM] [default: reth/v0.1.0-alpha.13-10a83e594/aarch64-apple-darwin]
--p2p-secret-key <PATH> --p2p-secret-key <PATH>
Secret key to use for this node. Secret key to use for this node.
@ -105,8 +109,15 @@ Networking:
[default: any] [default: any]
--addr <ADDR>
Network listening address
[default: 0.0.0.0]
--port <PORT> --port <PORT>
Network listening port. default: 30303 Network listening port
[default: 30303]
--max-outbound-peers <MAX_OUTBOUND_PEERS> --max-outbound-peers <MAX_OUTBOUND_PEERS>
Maximum number of outbound requests. default: 100 Maximum number of outbound requests. default: 100
@ -131,7 +142,7 @@ RPC:
--http.api <HTTP_API> --http.api <HTTP_API>
Rpc Modules to be configured for the HTTP server Rpc Modules to be configured for the HTTP server
[possible values: admin, debug, eth, net, trace, txpool, web3, rpc, reth, ots] [possible values: admin, debug, eth, net, trace, txpool, web3, rpc, reth, ots, eth-call-bundle]
--http.corsdomain <HTTP_CORSDOMAIN> --http.corsdomain <HTTP_CORSDOMAIN>
Http Corsdomain to allow request from Http Corsdomain to allow request from
@ -155,7 +166,7 @@ RPC:
--ws.api <WS_API> --ws.api <WS_API>
Rpc Modules to be configured for the WS server Rpc Modules to be configured for the WS server
[possible values: admin, debug, eth, net, trace, txpool, web3, rpc, reth, ots] [possible values: admin, debug, eth, net, trace, txpool, web3, rpc, reth, ots, eth-call-bundle]
--ipcdisable --ipcdisable
Disable the IPC-RPC server Disable the IPC-RPC server
@ -176,7 +187,16 @@ RPC:
[default: 8551] [default: 8551]
--authrpc.jwtsecret <PATH> --authrpc.jwtsecret <PATH>
Path to a JWT secret to use for authenticated RPC endpoints Path to a JWT secret to use for the authenticated engine-API RPC server.
This will enforce JWT authentication for all requests coming from the consensus layer.
If no path is provided, a secret will be generated and stored in the datadir under `<DIR>/<CHAIN_ID>/jwt.hex`. For mainnet this would be `~/.reth/mainnet/jwt.hex` by default.
--rpc.jwtsecret <HEX>
Hex encoded JWT secret to authenticate the regular RPC server(s), see `--http.api` and `--ws.api`.
This is __not__ used for the authenticated engine-API RPC server, see `--authrpc.jwtsecret`.
--rpc-max-request-size <RPC_MAX_REQUEST_SIZE> --rpc-max-request-size <RPC_MAX_REQUEST_SIZE>
Set the maximum RPC request payload size for both HTTP and WS in megabytes Set the maximum RPC request payload size for both HTTP and WS in megabytes
@ -186,7 +206,7 @@ RPC:
--rpc-max-response-size <RPC_MAX_RESPONSE_SIZE> --rpc-max-response-size <RPC_MAX_RESPONSE_SIZE>
Set the maximum RPC response payload size for both HTTP and WS in megabytes Set the maximum RPC response payload size for both HTTP and WS in megabytes
[default: 115] [default: 150]
[aliases: --rpc.returndata.limit] [aliases: --rpc.returndata.limit]
--rpc-max-subscriptions-per-connection <RPC_MAX_SUBSCRIPTIONS_PER_CONNECTION> --rpc-max-subscriptions-per-connection <RPC_MAX_SUBSCRIPTIONS_PER_CONNECTION>
@ -204,8 +224,13 @@ RPC:
[default: 25] [default: 25]
--rpc-max-blocks-per-filter <COUNT>
Maximum number of blocks that could be scanned per filter request. (0 = entire chain)
[default: 100000]
--rpc-max-logs-per-response <COUNT> --rpc-max-logs-per-response <COUNT>
Maximum number of logs that can be returned in a single response Maximum number of logs that can be returned in a single response. (0 = no limit)
[default: 20000] [default: 20000]
@ -214,6 +239,27 @@ RPC:
[default: 50000000] [default: 50000000]
RPC State Cache:
--rpc-cache.max-blocks <MAX_BLOCKS>
Max number of blocks in cache
[default: 5000]
--rpc-cache.max-receipts <MAX_RECEIPTS>
Max number receipts in cache
[default: 2000]
--rpc-cache.max-envs <MAX_ENVS>
Max number of bytes for cached env data
[default: 1000]
--rpc-cache.max-concurrent-db-requests <MAX_CONCURRENT_DB_REQUESTS>
Max number of concurrent database requests
[default: 512]
Gas Price Oracle: Gas Price Oracle:
--gpo.blocks <BLOCKS> --gpo.blocks <BLOCKS>
Number of recent blocks to check for gas price Number of recent blocks to check for gas price
@ -235,21 +281,6 @@ Gas Price Oracle:
[default: 60] [default: 60]
--block-cache-len <BLOCK_CACHE_LEN>
Maximum number of block cache entries
[default: 5000]
--receipt-cache-len <RECEIPT_CACHE_LEN>
Maximum number of receipt cache entries
[default: 2000]
--env-cache-len <ENV_CACHE_LEN>
Maximum number of env cache entries
[default: 1000]
TxPool: TxPool:
--txpool.pending_max_count <PENDING_MAX_COUNT> --txpool.pending_max_count <PENDING_MAX_COUNT>
Max number of transaction in the pending sub-pool Max number of transaction in the pending sub-pool
@ -296,11 +327,14 @@ TxPool:
[default: 100] [default: 100]
--txpool.nolocals
Flag to disable local transaction exemptions
Builder: Builder:
--builder.extradata <EXTRADATA> --builder.extradata <EXTRADATA>
Block extra data set by the payload builder Block extra data set by the payload builder
[default: reth/VERSION/OS] [default: reth/v0.1.0-alpha.13/macos]
--builder.gaslimit <GAS_LIMIT> --builder.gaslimit <GAS_LIMIT>
Target gas ceiling for built blocks Target gas ceiling for built blocks
@ -386,7 +420,7 @@ Dev testnet:
Pruning: Pruning:
--full --full
Run full node. Only the most recent 10064 block states are stored. This flag takes priority over pruning configuration in reth.toml Run full node. Only the most recent [`MINIMUM_PRUNING_DISTANCE`] block states are stored. This flag takes priority over pruning configuration in reth.toml
Logging: Logging:
--log.file.directory <PATH> --log.file.directory <PATH>

159
book/cli/p2p.md
View File

@ -18,14 +18,10 @@ Options:
--chain <CHAIN_OR_PATH> --chain <CHAIN_OR_PATH>
The chain this node is running. The chain this node is running.
Possible values are either a built-in chain or the path to a chain specification file. Possible values are either a built-in chain or the path to a chain specification file.
Built-in chains: Built-in chains:
- mainnet mainnet, sepolia, goerli, holesky, dev
- goerli
- sepolia
- holesky
[default: mainnet] [default: mainnet]
@ -54,8 +50,15 @@ Options:
--disable-discv4-discovery --disable-discv4-discovery
Disable Discv4 discovery Disable Discv4 discovery
--discovery.addr <DISCOVERY_ADDR>
The UDP address to use for P2P discovery/networking
[default: 0.0.0.0]
--discovery.port <DISCOVERY_PORT> --discovery.port <DISCOVERY_PORT>
The UDP port to use for P2P discovery/networking. default: 30303 The UDP port to use for P2P discovery/networking
[default: 30303]
--trusted-peer <TRUSTED_PEER> --trusted-peer <TRUSTED_PEER>
Target trusted peer Target trusted peer
@ -63,11 +66,6 @@ Options:
--trusted-only --trusted-only
Connect only to trusted peers Connect only to trusted peers
--retries <RETRIES>
The number of retries per request
[default: 5]
--instance <INSTANCE> --instance <INSTANCE>
Add a new instance of a node. Add a new instance of a node.
@ -79,6 +77,11 @@ Options:
[default: 1] [default: 1]
--retries <RETRIES>
The number of retries per request
[default: 5]
--nat <NAT> --nat <NAT>
[default: any] [default: any]
@ -164,6 +167,73 @@ Usage: reth p2p body [OPTIONS] <ID>
Arguments: Arguments:
<ID> <ID>
The block number or hash The block number or hash
Options:
--instance <INSTANCE>
Add a new instance of a node.
Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.
Max number of instances is 200. It is chosen in a way so that it's not possible to have port numbers that conflict with each other.
Changes to the following port numbers: - DISCOVERY_PORT: default + `instance` - 1 - AUTH_PORT: default + `instance` * 100 - 100 - HTTP_RPC_PORT: default - `instance` + 1 - WS_RPC_PORT: default + `instance` * 2 - 2
[default: 1]
-h, --help
Print help (see a summary with '-h')
Logging:
--log.file.directory <PATH>
The path to put log files in
[default: /reth/logs]
--log.file.max-size <SIZE>
The maximum size (in MB) of one log file
[default: 200]
--log.file.max-files <COUNT>
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
[default: 5]
--log.file.filter <FILTER>
The filter to use for logs written to the log file
[default: debug]
--log.journald
Write logs to journald
--log.journald.filter <FILTER>
The filter to use for logs written to journald
[default: error]
--color <COLOR>
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
[default: always]
Possible values:
- always: Colors on
- auto: Colors on
- never: Colors off
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 p2p header` ## `reth p2p header`
@ -178,4 +248,71 @@ Usage: reth p2p header [OPTIONS] <ID>
Arguments: Arguments:
<ID> <ID>
The header number or hash The header number or hash
Options:
--instance <INSTANCE>
Add a new instance of a node.
Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.
Max number of instances is 200. It is chosen in a way so that it's not possible to have port numbers that conflict with each other.
Changes to the following port numbers: - DISCOVERY_PORT: default + `instance` - 1 - AUTH_PORT: default + `instance` * 100 - 100 - HTTP_RPC_PORT: default - `instance` + 1 - WS_RPC_PORT: default + `instance` * 2 - 2
[default: 1]
-h, --help
Print help (see a summary with '-h')
Logging:
--log.file.directory <PATH>
The path to put log files in
[default: /reth/logs]
--log.file.max-size <SIZE>
The maximum size (in MB) of one log file
[default: 200]
--log.file.max-files <COUNT>
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
[default: 5]
--log.file.filter <FILTER>
The filter to use for logs written to the log file
[default: debug]
--log.journald
Write logs to journald
--log.journald.filter <FILTER>
The filter to use for logs written to journald
[default: error]
--color <COLOR>
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
[default: always]
Possible values:
- always: Colors on
- auto: Colors on
- never: Colors off
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
``` ```

93
book/cli/recover.md
View File

@ -14,14 +14,10 @@ Commands:
Options: Options:
--chain <CHAIN_OR_PATH> --chain <CHAIN_OR_PATH>
The chain this node is running. The chain this node is running.
Possible values are either a built-in chain or the path to a chain specification file. Possible values are either a built-in chain or the path to a chain specification file.
Built-in chains: Built-in chains:
- mainnet mainnet, sepolia, goerli, holesky, dev
- goerli
- sepolia
- holesky
[default: mainnet] [default: mainnet]
@ -100,4 +96,91 @@ Recover the node by deleting dangling storage tries
$ reth recover storage-tries --help $ reth recover storage-tries --help
Usage: reth recover storage-tries [OPTIONS] Usage: reth recover storage-tries [OPTIONS]
Options:
--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]
--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, sepolia, goerli, holesky, dev
[default: mainnet]
--instance <INSTANCE>
Add a new instance of a node.
Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.
Max number of instances is 200. It is chosen in a way so that it's not possible to have port numbers that conflict with each other.
Changes to the following port numbers: - DISCOVERY_PORT: default + `instance` - 1 - AUTH_PORT: default + `instance` * 100 - 100 - HTTP_RPC_PORT: default - `instance` + 1 - WS_RPC_PORT: default + `instance` * 2 - 2
[default: 1]
-h, --help
Print help (see a summary with '-h')
Logging:
--log.file.directory <PATH>
The path to put log files in
[default: /reth/logs]
--log.file.max-size <SIZE>
The maximum size (in MB) of one log file
[default: 200]
--log.file.max-files <COUNT>
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
[default: 5]
--log.file.filter <FILTER>
The filter to use for logs written to the log file
[default: debug]
--log.journald
Write logs to journald
--log.journald.filter <FILTER>
The filter to use for logs written to journald
[default: error]
--color <COLOR>
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
[default: always]
Possible values:
- always: Colors on
- auto: Colors on
- never: Colors off
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
``` ```

943
book/cli/stage.md
View File

File diff suppressed because it is too large Load Diff

82
book/cli/test-vectors.md
View File

@ -14,14 +14,10 @@ Commands:
Options: Options:
--chain <CHAIN_OR_PATH> --chain <CHAIN_OR_PATH>
The chain this node is running. The chain this node is running.
Possible values are either a built-in chain or the path to a chain specification file. Possible values are either a built-in chain or the path to a chain specification file.
Built-in chains: Built-in chains:
- mainnet mainnet, sepolia, goerli, holesky, dev
- goerli
- sepolia
- holesky
[default: mainnet] [default: mainnet]
@ -104,4 +100,80 @@ Usage: reth test-vectors tables [OPTIONS] [NAMES]...
Arguments: Arguments:
[NAMES]... [NAMES]...
List of table names. Case-sensitive List of table names. Case-sensitive
Options:
--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, sepolia, goerli, holesky, dev
[default: mainnet]
--instance <INSTANCE>
Add a new instance of a node.
Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.
Max number of instances is 200. It is chosen in a way so that it's not possible to have port numbers that conflict with each other.
Changes to the following port numbers: - DISCOVERY_PORT: default + `instance` - 1 - AUTH_PORT: default + `instance` * 100 - 100 - HTTP_RPC_PORT: default - `instance` + 1 - WS_RPC_PORT: default + `instance` * 2 - 2
[default: 1]
-h, --help
Print help (see a summary with '-h')
Logging:
--log.file.directory <PATH>
The path to put log files in
[default: /reth/logs]
--log.file.max-size <SIZE>
The maximum size (in MB) of one log file
[default: 200]
--log.file.max-files <COUNT>
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
[default: 5]
--log.file.filter <FILTER>
The filter to use for logs written to the log file
[default: debug]
--log.journald
Write logs to journald
--log.journald.filter <FILTER>
The filter to use for logs written to journald
[default: error]
--color <COLOR>
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
[default: always]
Possible values:
- always: Colors on
- auto: Colors on
- never: Colors off
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
``` ```