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

feat(book): update CLI section (#4694)

Browse Source
This commit is contained in:
Alexey Shekhirin
2023-09-20 22:51:09 +01:00
committed by GitHub
parent b870a4ef01
commit a52b433e65
13 changed files with 672 additions and 1492 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
book/SUMMARY.md
View File

@ -35,5 +35,6 @@
1. [reth test-vectors](./cli/test-vectors.md) 1. [reth test-vectors](./cli/test-vectors.md)
1. [reth config](./cli/config.md) 1. [reth config](./cli/config.md)
1. [reth debug](./cli/debug.md) 1. [reth debug](./cli/debug.md)
1. [reth recover](./cli/recover.md)
1. [Developers](./developers/developers.md) 1. [Developers](./developers/developers.md)
1. [Contribute](./developers/contribute.md) 1. [Contribute](./developers/contribute.md)

77
book/cli/cli.md
View File

@ -30,28 +30,42 @@ Reth
Usage: reth [OPTIONS] <COMMAND> Usage: reth [OPTIONS] <COMMAND>
Commands: Commands:
node node Start the node
Start the node init Initialize the database from a genesis file
init import This syncs RLP encoded blocks from a file
Initialize the database from a genesis file db Database debugging utilities
import stage Manipulate individual stages
This syncs RLP encoded blocks from a file p2p P2P Debugging utilities
db test-vectors Generate Test Vectors
Database debugging utilities config Write config to stdout
stage debug Various debug routines
Manipulate individual stages recover Scripts for node recovery
p2p help Print this message or the help of the given subcommand(s)
P2P Debugging utilities
test-vectors
Generate Test Vectors
config
Write config to stdout
debug
Various debug routines
help
Print this message or the help of the given subcommand(s)
Options: 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
- goerli
- sepolia
[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 -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')
@ -59,14 +73,21 @@ Options:
Print version Print version
Logging: Logging:
--log.persistent
The flag to enable persistent logs
--log.directory <PATH> --log.directory <PATH>
The path to put log files in The path to put log files in
[default: /reth/logs] [default: /reth/logs]
--log.max-size <SIZE>
The maximum size (in MB) of log files
[default: 200]
--log.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.journald --log.journald
Log events to journald Log events to journald
@ -75,6 +96,16 @@ Logging:
[default: error] [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: Display:
-v, --verbosity... -v, --verbosity...
Set the minimum log level. Set the minimum log level.

8
book/cli/config.json
View File

@ -4,14 +4,17 @@
"db": { "db": {
"stats": [], "stats": [],
"list": [], "list": [],
"diff": [],
"get": [], "get": [],
"drop": [], "drop": [],
"clear": [],
"version": [], "version": [],
"path": [] "path": []
}, },
"debug": { "debug": {
"execution": [], "execution": [],
"merkle": [] "merkle": [],
"in-memory-merkle": []
}, },
"import": [], "import": [],
"init": [], "init": [],
@ -20,6 +23,9 @@
"header": [], "header": [],
"body": [] "body": []
}, },
"recover": {
"storage-tries": []
},
"stage": { "stage": {
"run": [], "run": [],
"drop": [], "drop": [],

46
book/cli/config.md
View File

@ -14,18 +14,48 @@ Options:
--default --default
Show the default config Show the default config
--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]
--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 -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')
Logging: Logging:
--log.persistent
The flag to enable persistent logs
--log.directory <PATH> --log.directory <PATH>
The path to put log files in The path to put log files in
[default: /reth/logs] [default: /reth/logs]
--log.max-size <SIZE>
The maximum size (in MB) of log files
[default: 200]
--log.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.journald --log.journald
Log events to journald Log events to journald
@ -34,6 +64,16 @@ Logging:
[default: error] [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: Display:
-v, --verbosity... -v, --verbosity...
Set the minimum log level. Set the minimum log level.

593
book/cli/db.md
View File

@ -8,22 +8,15 @@ $ reth db --help
Usage: reth db [OPTIONS] <COMMAND> Usage: reth db [OPTIONS] <COMMAND>
Commands: Commands:
stats stats Lists all the tables, their entry count and their size
Lists all the tables, their entry count and their size list Lists the contents of a table
list diff Create a diff between two database tables or two entire databases
Lists the contents of a table get Gets the content of a table for the given key
get drop Deletes all database entries
Gets the content of a table for the given key clear Deletes all table entries
drop version Lists current and local database versions
Deletes all database entries path Returns the full database path
clear help Print this message or the help of the given subcommand(s)
Deletes all table entries
version
Lists current and local database versions
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>
@ -49,6 +42,17 @@ Options:
[default: mainnet] [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 -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')
@ -67,168 +71,21 @@ Database:
- extra: Enables logging for extra debug-level messages - extra: Enables logging for extra debug-level messages
Logging: Logging:
--log.persistent
The flag to enable persistent logs
--log.directory <PATH> --log.directory <PATH>
The path to put log files in The path to put log files in
[default: /reth/logs] [default: /reth/logs]
--log.journald --log.max-size <SIZE>
Log events to journald The maximum size (in MB) of log files
--log.filter <FILTER>
The filter to use for logs written to the log file
[default: error] [default: 200]
Display: --log.max-files <COUNT>
-v, --verbosity... The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
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`
Lists all the tables, their entry count and their size
```bash
$ reth db stats --help
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
- goerli
- sepolia
[default: mainnet]
-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: /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 db list`
Lists the contents of a table
```bash
$ reth db list --help
Usage: reth db list [OPTIONS] <TABLE>
Arguments:
<TABLE>
The 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]
-s, --skip <SKIP>
Skip first N entries
[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
- goerli
- sepolia
[default: mainnet]
-r, --reverse
Reverse the order of the entries. If enabled last table entries are read
-l, --len <LEN>
How many items to take from the walker
[default: 5] [default: 5]
-j, --json
Dump as JSON instead of using TUI
-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: /reth/logs]
--log.journald --log.journald
Log events to journald Log events to journald
@ -237,148 +94,15 @@ Logging:
[default: error] [default: error]
Display: --color <COLOR>
-v, --verbosity... Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
Set the minimum log level.
-v Errors [default: always]
-vv Warnings
-vvv Info
-vvvv Debug
-vvvvv Traces (warning: very verbose!)
-q, --quiet Possible values:
Silence all log output - always: Colors on
``` - auto: Colors on
- never: Colors off
## `reth db get`
Gets the content of a table for the given key
```bash
$ reth db get --help
Usage: reth db get [OPTIONS] <TABLE> <KEY>
Arguments:
<TABLE>
The table name
NOTE: The dupsort tables are not supported now.
<KEY>
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]
--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]
-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: /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 db drop`
Deletes all database entries
```bash
$ reth db drop --help
Usage: reth db drop [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
- goerli
- sepolia
[default: mainnet]
-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: /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: Display:
-v, --verbosity... -v, --verbosity...
@ -406,130 +130,92 @@ 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
- goerli
- sepolia
[default: mainnet]
-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: /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 db version` ## `reth db diff`
Lists current and local database versions Create a diff between two database tables or two entire databases
```bash ```bash
$ reth db version --help $ reth db diff --help
Usage: reth db version [OPTIONS] Usage: reth db diff [OPTIONS] --secondary-datadir <SECONDARY_DATADIR> --output <OUTPUT>
Options: Options:
--datadir <DATA_DIR> --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.
```
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> ## `reth db drop`
The chain this node is running.
Deletes all database entries
```bash
$ reth db drop --help
Usage: reth db drop [OPTIONS]
Options:
-f, --force
Bypasses the interactive confirmation and drops the database directly
```
## `reth db get`
Gets the content of a table for the given key
```bash
$ reth db get --help
Usage: reth db get [OPTIONS] <TABLE> <KEY>
Arguments:
<TABLE>
The table name
Possible values are either a built-in chain or the path to a chain specification file. NOTE: The dupsort tables are not supported now.
<KEY>
The key to get content for
```
## `reth db list`
Lists the contents of a table
```bash
$ reth db list --help
Usage: reth db list [OPTIONS] <TABLE>
Arguments:
<TABLE>
The table name
Options:
-s, --skip <SKIP>
Skip first N entries
Built-in chains: [default: 0]
- mainnet
- goerli -r, --reverse
- sepolia Reverse the order of the entries. If enabled last table entries are read
-l, --len <LEN>
How many items to take from the walker
[default: mainnet] [default: 5]
-h, --help --search <SEARCH>
Print help (see a summary with '-h') Search parameter for both keys and values. Prefix it with `0x` to search for binary data, and text otherwise.
Logging:
--log.persistent
The flag to enable persistent logs
--log.directory <PATH>
The path to put log files in
[default: /reth/logs] ATTENTION! For compressed tables (`Transactions` and `Receipts`), there might be missing results since the search uses the raw uncompressed value from the database.
--log.journald -c, --count
Log events to journald Returns the number of rows found
--log.filter <FILTER> -j, --json
The filter to use for logs written to the log file Dump as JSON instead of using TUI
[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 db path` ## `reth db path`
@ -540,61 +226,24 @@ 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> ## `reth db stats`
The path to the data dir for all reth files and subdirectories.
Lists all the tables, their entry count and their size
Defaults to the OS-specific data directory:
```bash
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/` $ reth db stats --help
- Windows: `{FOLDERID_RoamingAppData}/reth/`
- macOS: `$HOME/Library/Application Support/reth/` Usage: reth db stats [OPTIONS]
```
[default: default]
## `reth db version`
--chain <CHAIN_OR_PATH>
The chain this node is running. Lists current and local database versions
Possible values are either a built-in chain or the path to a chain specification file. ```bash
$ reth db version --help
Built-in chains:
- mainnet Usage: reth db version [OPTIONS]
- goerli
- sepolia
[default: mainnet]
-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: /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
``` ```

288
book/cli/debug.md
View File

@ -8,26 +8,65 @@ $ reth debug --help
Usage: reth debug [OPTIONS] <COMMAND> Usage: reth debug [OPTIONS] <COMMAND>
Commands: Commands:
execution 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
merkle in-memory-merkle Debug in-memory state root calculation
Debug the clean & incremental state root calculations 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>
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]
--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 -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')
Logging: Logging:
--log.persistent
The flag to enable persistent logs
--log.directory <PATH> --log.directory <PATH>
The path to put log files in The path to put log files in
[default: /reth/logs] [default: /reth/logs]
--log.max-size <SIZE>
The maximum size (in MB) of log files
[default: 200]
--log.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.journald --log.journald
Log events to journald Log events to journald
@ -36,6 +75,16 @@ Logging:
[default: error] [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: Display:
-v, --verbosity... -v, --verbosity...
Set the minimum log level. Set the minimum log level.
@ -58,140 +107,6 @@ 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>
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
- goerli
- sepolia
[default: mainnet]
-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.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-only
Connect only to trusted peers
--bootnodes <BOOTNODES>
Bootnodes to connect to initially.
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.1/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]
--port <PORT>
Network listening port. default: 30303
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]
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` ## `reth debug merkle`
@ -202,81 +117,14 @@ Debug the clean & incremental state root calculations
$ reth debug merkle --help $ reth debug merkle --help
Usage: reth debug merkle [OPTIONS] --to <TO> 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
- goerli
- sepolia
[default: mainnet]
-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
--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.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 in-memory-merkle`
Debug in-memory state root calculation
```bash
$ reth debug in-memory-merkle --help
Usage: reth debug in-memory-merkle [OPTIONS]
```

34
book/cli/import.md
View File

@ -34,6 +34,17 @@ Options:
[default: mainnet] [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 -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')
@ -58,14 +69,21 @@ Database:
remaining stages are executed. remaining stages are executed.
Logging: Logging:
--log.persistent
The flag to enable persistent logs
--log.directory <PATH> --log.directory <PATH>
The path to put log files in The path to put log files in
[default: /reth/logs] [default: /reth/logs]
--log.max-size <SIZE>
The maximum size (in MB) of log files
[default: 200]
--log.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.journald --log.journald
Log events to journald Log events to journald
@ -74,6 +92,16 @@ Logging:
[default: error] [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: Display:
-v, --verbosity... -v, --verbosity...
Set the minimum log level. Set the minimum log level.

34
book/cli/init.md
View File

@ -31,6 +31,17 @@ Options:
[default: mainnet] [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 -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')
@ -49,14 +60,21 @@ Database:
- extra: Enables logging for extra debug-level messages - extra: Enables logging for extra debug-level messages
Logging: Logging:
--log.persistent
The flag to enable persistent logs
--log.directory <PATH> --log.directory <PATH>
The path to put log files in The path to put log files in
[default: /reth/logs] [default: /reth/logs]
--log.max-size <SIZE>
The maximum size (in MB) of log files
[default: 200]
--log.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.journald --log.journald
Log events to journald Log events to journald
@ -65,6 +83,16 @@ Logging:
[default: error] [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: Display:
-v, --verbosity... -v, --verbosity...
Set the minimum log level. Set the minimum log level.

105
book/cli/node.md
View File

@ -31,9 +31,24 @@ Options:
- mainnet - mainnet
- goerli - goerli
- sepolia - sepolia
- dev
[default: mainnet] [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]
--trusted-setup-file <PATH>
Overrides the KZG trusted setup by reading from the supplied file
-h, --help -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')
@ -57,7 +72,7 @@ Networking:
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,enode://cdef@192.168.0.2:30303 Target trusted peer enodes --trusted-peers enode://abcd@192.168.0.1:30303
--trusted-only --trusted-only
Connect only to trusted peers Connect only to trusted peers
@ -74,7 +89,7 @@ Networking:
--identity <IDENTITY> --identity <IDENTITY>
Custom node identity Custom node identity
[default: reth/v0.1.0-alpha.1/aarch64-apple-darwin] [default: reth/v0.1.0-alpha.8-6016da7a1/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.
@ -92,20 +107,30 @@ Networking:
--port <PORT> --port <PORT>
Network listening port. default: 30303 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
RPC: RPC:
--http --http
Enable the HTTP-RPC server Enable the HTTP-RPC server
--http.addr <HTTP_ADDR> --http.addr <HTTP_ADDR>
Http server address to listen on Http server address to listen on
[default: 127.0.0.1]
--http.port <HTTP_PORT> --http.port <HTTP_PORT>
Http server port to listen on Http server port to listen on
[default: 8545]
--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] [possible values: admin, debug, eth, net, trace, txpool, web3, rpc, reth, ots]
--http.corsdomain <HTTP_CORSDOMAIN> --http.corsdomain <HTTP_CORSDOMAIN>
Http Corsdomain to allow request from Http Corsdomain to allow request from
@ -115,9 +140,13 @@ RPC:
--ws.addr <WS_ADDR> --ws.addr <WS_ADDR>
Ws server address to listen on Ws server address to listen on
[default: 127.0.0.1]
--ws.port <WS_PORT> --ws.port <WS_PORT>
Ws server port to listen on Ws server port to listen on
[default: 8546]
--ws.origins <ws.origins> --ws.origins <ws.origins>
Origins from which to accept WebSocket requests Origins from which to accept WebSocket requests
@ -125,19 +154,25 @@ 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] [possible values: admin, debug, eth, net, trace, txpool, web3, rpc, reth, ots]
--ipcdisable --ipcdisable
Disable the IPC-RPC server Disable the IPC-RPC server
--ipcpath <IPCPATH> --ipcpath <IPCPATH>
Filename for IPC socket/pipe within the datadir Filename for IPC socket/pipe within the datadir
[default: /tmp/reth.ipc]
--authrpc.addr <AUTH_ADDR> --authrpc.addr <AUTH_ADDR>
Auth server address to listen on Auth server address to listen on
[default: 127.0.0.1]
--authrpc.port <AUTH_PORT> --authrpc.port <AUTH_PORT>
Auth server port to listen on Auth server port to listen on
[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 authenticated RPC endpoints
@ -150,10 +185,11 @@ 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: 100] [default: 115]
[aliases: --rpc.returndata.limit]
--rpc-max-subscriptions-per-connection <RPC_MAX_SUBSCRIPTIONS_PER_CONNECTION> --rpc-max-subscriptions-per-connection <RPC_MAX_SUBSCRIPTIONS_PER_CONNECTION>
Set the maximum concurrent subscriptions per connection Set the the maximum concurrent subscriptions per connection
[default: 1024] [default: 1024]
@ -167,6 +203,16 @@ RPC:
[default: 25] [default: 25]
--rpc-max-logs-per-response <COUNT>
Maximum number of logs that can be returned in a single response
[default: 20000]
--rpc-gas-cap <GAS_CAP>
Maximum gas limit for `eth_call` and call tracing RPC methods
[default: 50000000]
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
@ -187,9 +233,6 @@ Gas Price Oracle:
The percentile of gas prices to use for the estimate The percentile of gas prices to use for the estimate
[default: 60] [default: 60]
--rpc.gascap
Maximum gas limit for `eth_call` and call tracing RPC methods
--block-cache-len <BLOCK_CACHE_LEN> --block-cache-len <BLOCK_CACHE_LEN>
Maximum number of block cache entries Maximum number of block cache entries
@ -242,11 +285,21 @@ TxPool:
[default: 16] [default: 16]
--txpool.pricebump <PRICE_BUMP>
Price bump (in %) for the transaction pool underpriced check
[default: 10]
--blobpool.pricebump <BLOB_TRANSACTION_PRICE_BUMP>
Price bump percentage to replace an already existing blob transaction
[default: 100]
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/v0.1.0-alpha.1/macos] [default: reth/v0.1.0-alpha.8/macos]
--builder.gaslimit <GAS_LIMIT> --builder.gaslimit <GAS_LIMIT>
Target gas ceiling for built blocks Target gas ceiling for built blocks
@ -311,13 +364,10 @@ Database:
- trace: Enables logging for trace debug-level messages - trace: Enables logging for trace debug-level messages
- extra: Enables logging for extra debug-level messages - extra: Enables logging for extra debug-level messages
--auto-mine
Automatically mine blocks for new transactions
Dev testnet: Dev testnet:
--dev --dev
Start the node in dev mode Start the node in dev mode
This mode uses a local proof-of-authority consensus engine with either fixed block times This mode uses a local proof-of-authority consensus engine with either fixed block times
or automatically mined blocks. or automatically mined blocks.
Disables network discovery and enables local http server. Disables network discovery and enables local http server.
@ -331,21 +381,28 @@ Dev testnet:
Interval between blocks. Interval between blocks.
Parses strings using [humantime::parse_duration] Parses strings using [humantime::parse_duration]
--dev.block-time 12s --dev.block_time 12s
Pruning: Pruning:
--full --full
Run full node. Only the most recent 128 block states are stored. This flag takes priority over pruning configuration in reth.toml Run full node. Only the most recent 128 block states are stored. This flag takes priority over pruning configuration in reth.toml
Logging: Logging:
--log.persistent
The flag to enable persistent logs
--log.directory <PATH> --log.directory <PATH>
The path to put log files in The path to put log files in
[default: /reth/logs] [default: /reth/logs]
--log.max-size <SIZE>
The maximum size (in MB) of log files
[default: 200]
--log.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.journald --log.journald
Log events to journald Log events to journald
@ -354,6 +411,16 @@ Logging:
[default: error] [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: Display:
-v, --verbosity... -v, --verbosity...
Set the minimum log level. Set the minimum log level.

111
book/cli/p2p.md
View File

@ -8,12 +8,9 @@ $ reth p2p --help
Usage: reth p2p [OPTIONS] <COMMAND> Usage: reth p2p [OPTIONS] <COMMAND>
Commands: Commands:
header header Download block header
Download block header body Download block body
body help Print this message or the help of the given subcommand(s)
Download block body
help
Print this message or the help of the given subcommand(s)
Options: Options:
--config <FILE> --config <FILE>
@ -70,6 +67,17 @@ Options:
[default: 5] [default: 5]
--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]
--nat <NAT> --nat <NAT>
[default: any] [default: any]
@ -91,14 +99,21 @@ Database:
- extra: Enables logging for extra debug-level messages - extra: Enables logging for extra debug-level messages
Logging: Logging:
--log.persistent
The flag to enable persistent logs
--log.directory <PATH> --log.directory <PATH>
The path to put log files in The path to put log files in
[default: /reth/logs] [default: /reth/logs]
--log.max-size <SIZE>
The maximum size (in MB) of log files
[default: 200]
--log.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.journald --log.journald
Log events to journald Log events to journald
@ -107,6 +122,16 @@ Logging:
[default: error] [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: Display:
-v, --verbosity... -v, --verbosity...
Set the minimum log level. Set the minimum log level.
@ -133,40 +158,6 @@ Usage: reth p2p body [OPTIONS] <ID>
Arguments: Arguments:
<ID> <ID>
The block number or hash The block number or hash
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: /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 p2p header` ## `reth p2p header`
@ -181,38 +172,4 @@ Usage: reth p2p header [OPTIONS] <ID>
Arguments: Arguments:
<ID> <ID>
The header number or hash The header number or hash
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: /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
``` ```

97
book/cli/recover.md Normal file
View File

@ -0,0 +1,97 @@
# `reth recover`
Scripts for node recovery
```bash
$ reth recover --help
Usage: reth recover [OPTIONS] <COMMAND>
Commands:
storage-tries Recover the node by deleting dangling storage tries
help Print this message or the help of the given subcommand(s)
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
- goerli
- sepolia
[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.directory <PATH>
The path to put log files in
[default: /reth/logs]
--log.max-size <SIZE>
The maximum size (in MB) of log files
[default: 200]
--log.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.journald
Log events to journald
--log.filter <FILTER>
The filter to use for logs written to the log file
[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 recover storage-tries`
Recover the node by deleting dangling storage tries
```bash
$ reth recover storage-tries --help
Usage: reth recover storage-tries [OPTIONS]
```

684
book/cli/stage.md
View File

@ -8,30 +8,55 @@ $ reth stage --help
Usage: reth stage [OPTIONS] <COMMAND> Usage: reth stage [OPTIONS] <COMMAND>
Commands: Commands:
run run Run a single stage
Run a single stage drop Drop a stage's tables from the database
drop dump Dumps a stage from a range into a new database
Drop a stage's tables from the database unwind Unwinds a certain block range, deleting it from the database
dump help Print this message or the help of the given subcommand(s)
Dumps a stage from a range into a new database
unwind
Unwinds a certain block range, deleting it from the database
help
Print this message or the help of the given subcommand(s)
Options: 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
- goerli
- sepolia
[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 -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')
Logging: Logging:
--log.persistent
The flag to enable persistent logs
--log.directory <PATH> --log.directory <PATH>
The path to put log files in The path to put log files in
[default: /reth/logs] [default: /reth/logs]
--log.max-size <SIZE>
The maximum size (in MB) of log files
[default: 200]
--log.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.journald --log.journald
Log events to journald Log events to journald
@ -40,6 +65,16 @@ Logging:
[default: error] [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: Display:
-v, --verbosity... -v, --verbosity...
Set the minimum log level. Set the minimum log level.
@ -62,80 +97,6 @@ Drop a stage's tables from the database
$ reth stage drop --help $ reth stage drop --help
Usage: reth stage drop [OPTIONS] <STAGE> Usage: reth stage drop [OPTIONS] <STAGE>
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
- goerli
- sepolia
[default: mainnet]
-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
<STAGE>
[possible values: headers, bodies, senders, execution, account-hashing, storage-hashing, hashing, merkle, tx-lookup, history, account-history, storage-history, total-difficulty]
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 stage dump` ## `reth stage dump`
@ -148,87 +109,11 @@ $ reth stage dump --help
Usage: reth stage dump [OPTIONS] <COMMAND> Usage: reth stage dump [OPTIONS] <COMMAND>
Commands: Commands:
execution execution Execution stage
Execution stage storage-hashing StorageHashing stage
storage-hashing account-hashing AccountHashing stage
StorageHashing stage merkle Merkle stage
account-hashing help Print this message or the help of the given subcommand(s)
AccountHashing stage
merkle
Merkle stage
help
Print this message or the help of the given subcommand(s)
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
- goerli
- sepolia
[default: mainnet]
-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
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 stage dump execution` ### `reth stage dump execution`
@ -252,39 +137,6 @@ Options:
-d, --dry-run -d, --dry-run
If passed, it will dry-run a stage execution from the newly created database right after dumping If passed, it will dry-run a stage execution from the newly created database right after dumping
-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: /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 stage dump storage-hashing` ### `reth stage dump storage-hashing`
@ -308,39 +160,6 @@ Options:
-d, --dry-run -d, --dry-run
If passed, it will dry-run a stage execution from the newly created database right after dumping If passed, it will dry-run a stage execution from the newly created database right after dumping
-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: /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 stage dump account-hashing` ### `reth stage dump account-hashing`
@ -364,39 +183,6 @@ Options:
-d, --dry-run -d, --dry-run
If passed, it will dry-run a stage execution from the newly created database right after dumping If passed, it will dry-run a stage execution from the newly created database right after dumping
-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: /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 stage dump merkle` ### `reth stage dump merkle`
@ -420,39 +206,6 @@ Options:
-d, --dry-run -d, --dry-run
If passed, it will dry-run a stage execution from the newly created database right after dumping If passed, it will dry-run a stage execution from the newly created database right after dumping
-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: /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 stage run` ## `reth stage run`
@ -470,35 +223,12 @@ Arguments:
<STAGE> <STAGE>
The name of the stage to run The name of the stage to run
[possible values: headers, bodies, senders, execution, account-hashing, storage-hashing, hashing, merkle, tx-lookup, history, account-history, storage-history, total-difficulty] [possible values: headers, bodies, senders, execution, account-hashing, storage-hashing, hashing, merkle, tx-lookup, account-history, storage-history, total-difficulty]
Options: Options:
--config <FILE> --config <FILE>
The path to the configuration file to use. The path to the configuration file to use.
--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
- goerli
- sepolia
[default: mainnet]
--metrics <SOCKET> --metrics <SOCKET>
Enable Prometheus metrics. Enable Prometheus metrics.
@ -517,196 +247,6 @@ Options:
Normally, running the stage requires unwinding for stages that already have been run, in order to not rewrite to the same database slots. Normally, running the stage requires unwinding for stages that already have been run, in order to not rewrite to the same database slots.
You can optionally skip the unwinding phase if you're syncing a block range that has not been synced before. You can optionally skip the unwinding phase if you're syncing a block range that has not been synced before.
-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.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-only
Connect only to trusted peers
--bootnodes <BOOTNODES>
Bootnodes to connect to initially.
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.1/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]
--port <PORT>
Network listening port. default: 30303
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
-c, --commit
Commits the changes in the database. WARNING: potentially destructive.
Useful when you want to run diagnostics on the database.
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 stage unwind`
Unwinds a certain block range, deleting it from the database
```bash
$ reth stage unwind --help
Usage: reth stage unwind [OPTIONS] <COMMAND>
Commands:
to-block
Unwinds the database until the given block number (range is inclusive)
num-blocks
Unwinds the given number of blocks from the database
help
Print this message or the help of the given subcommand(s)
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
- goerli
- sepolia
[default: mainnet]
-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
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 stage unwind to-block` ### `reth stage unwind to-block`
@ -720,64 +260,6 @@ Usage: reth stage unwind to-block [OPTIONS] <TARGET>
Arguments: Arguments:
<TARGET> <TARGET>
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
- goerli
- sepolia
[default: mainnet]
-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: /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 stage unwind num-blocks` ### `reth stage unwind num-blocks`
@ -791,62 +273,4 @@ Usage: reth stage unwind num-blocks [OPTIONS] <AMOUNT>
Arguments: Arguments:
<AMOUNT> <AMOUNT>
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
- goerli
- sepolia
[default: mainnet]
-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: /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
``` ```

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

@ -8,24 +8,52 @@ $ reth test-vectors --help
Usage: reth test-vectors [OPTIONS] <COMMAND> Usage: reth test-vectors [OPTIONS] <COMMAND>
Commands: Commands:
tables tables Generates test vectors for specified tables. If no table is specified, generate for all
Generates test vectors for specified tables. If no table is specified, generate for all 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:
--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]
--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 -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')
Logging: Logging:
--log.persistent
The flag to enable persistent logs
--log.directory <PATH> --log.directory <PATH>
The path to put log files in The path to put log files in
[default: /reth/logs] [default: /reth/logs]
--log.max-size <SIZE>
The maximum size (in MB) of log files
[default: 200]
--log.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.journald --log.journald
Log events to journald Log events to journald
@ -34,6 +62,16 @@ Logging:
[default: error] [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: Display:
-v, --verbosity... -v, --verbosity...
Set the minimum log level. Set the minimum log level.
@ -60,38 +98,4 @@ Usage: reth test-vectors tables [OPTIONS] [NAMES]...
Arguments: Arguments:
[NAMES]... [NAMES]...
List of table names. Case-sensitive List of table names. Case-sensitive
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: /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
``` ```