mirror of
https://github.com/hl-archive-node/nanoreth.git
synced 2025-12-06 10:59:55 +00:00
docs(book): trim any white space at the line right ending (#8242)
Signed-off-by: jsvisa <delweng@gmail.com>
This commit is contained in:
2
Makefile
2
Makefile
@ -472,5 +472,5 @@ cfg-check:
|
|||||||
pr:
|
pr:
|
||||||
make cfg-check && \
|
make cfg-check && \
|
||||||
make lint && \
|
make lint && \
|
||||||
make docs && \
|
make update-book-cli && \
|
||||||
make test
|
make test
|
||||||
|
|||||||
@ -32,6 +32,7 @@
|
|||||||
- [`reth init`](./cli/reth/init.md)
|
- [`reth init`](./cli/reth/init.md)
|
||||||
- [`reth init-state`](./cli/reth/init-state.md)
|
- [`reth init-state`](./cli/reth/init-state.md)
|
||||||
- [`reth import`](./cli/reth/import.md)
|
- [`reth import`](./cli/reth/import.md)
|
||||||
|
- [`reth import-receipts`](./cli/reth/import-receipts.md)
|
||||||
- [`reth dump-genesis`](./cli/reth/dump-genesis.md)
|
- [`reth dump-genesis`](./cli/reth/dump-genesis.md)
|
||||||
- [`reth db`](./cli/reth/db.md)
|
- [`reth db`](./cli/reth/db.md)
|
||||||
- [`reth db stats`](./cli/reth/db/stats.md)
|
- [`reth db stats`](./cli/reth/db/stats.md)
|
||||||
|
|||||||
1
book/cli/SUMMARY.md
vendored
1
book/cli/SUMMARY.md
vendored
@ -3,6 +3,7 @@
|
|||||||
- [`reth init`](./reth/init.md)
|
- [`reth init`](./reth/init.md)
|
||||||
- [`reth init-state`](./reth/init-state.md)
|
- [`reth init-state`](./reth/init-state.md)
|
||||||
- [`reth import`](./reth/import.md)
|
- [`reth import`](./reth/import.md)
|
||||||
|
- [`reth import-receipts`](./reth/import-receipts.md)
|
||||||
- [`reth dump-genesis`](./reth/dump-genesis.md)
|
- [`reth dump-genesis`](./reth/dump-genesis.md)
|
||||||
- [`reth db`](./reth/db.md)
|
- [`reth db`](./reth/db.md)
|
||||||
- [`reth db stats`](./reth/db/stats.md)
|
- [`reth db stats`](./reth/db/stats.md)
|
||||||
|
|||||||
@ -23,6 +23,12 @@ Automatically-generated CLI reference from `--help` output.
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
def write_file(file_path, content):
|
||||||
|
content = "\n".join([line.rstrip() for line in content.split("\n")])
|
||||||
|
with open(file_path, "w") as f:
|
||||||
|
f.write(content)
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
args = parse_args(sys.argv[1:])
|
args = parse_args(sys.argv[1:])
|
||||||
for cmd in args.commands:
|
for cmd in args.commands:
|
||||||
@ -65,13 +71,11 @@ def main():
|
|||||||
|
|
||||||
root_summary += cmd_summary(root_path, cmd, obj, args.root_indentation)
|
root_summary += cmd_summary(root_path, cmd, obj, args.root_indentation)
|
||||||
root_summary += "\n"
|
root_summary += "\n"
|
||||||
with open(path.join(args.out_dir, "SUMMARY.md"), "w") as f:
|
write_file(path.join(args.out_dir, "SUMMARY.md"), summary)
|
||||||
f.write(summary)
|
|
||||||
|
|
||||||
# Generate README.md.
|
# Generate README.md.
|
||||||
if args.readme:
|
if args.readme:
|
||||||
with open(path.join(args.out_dir, "README.md"), "w") as f:
|
write_file(path.join(args.out_dir, "README.md"), README)
|
||||||
f.write(README)
|
|
||||||
|
|
||||||
if args.root_summary:
|
if args.root_summary:
|
||||||
update_root_summary(args.root_dir, root_summary)
|
update_root_summary(args.root_dir, root_summary)
|
||||||
@ -162,8 +166,7 @@ def cmd_markdown(out_dir: str, cmd: str, obj: object):
|
|||||||
for arg in cmd:
|
for arg in cmd:
|
||||||
out_path = path.join(out_path, arg)
|
out_path = path.join(out_path, arg)
|
||||||
makedirs(path.dirname(out_path), exist_ok=True)
|
makedirs(path.dirname(out_path), exist_ok=True)
|
||||||
with open(f"{out_path}.md", "w") as f:
|
write_file(f"{out_path}.md", out)
|
||||||
f.write(out)
|
|
||||||
|
|
||||||
for k, v in obj.items():
|
for k, v in obj.items():
|
||||||
if k == HELP_KEY:
|
if k == HELP_KEY:
|
||||||
@ -250,14 +253,27 @@ def command_name(cmd: str):
|
|||||||
"""Returns the name of a command."""
|
"""Returns the name of a command."""
|
||||||
return cmd.split("/")[-1]
|
return cmd.split("/")[-1]
|
||||||
|
|
||||||
|
|
||||||
def preprocess_help(s: str):
|
def preprocess_help(s: str):
|
||||||
"""Preprocesses the help output of a command."""
|
"""Preprocesses the help output of a command."""
|
||||||
# Remove the user-specific paths.
|
# Remove the user-specific paths.
|
||||||
s = re.sub(r"default: /.*/reth", "default: <CACHE_DIR>", s)
|
s = re.sub(
|
||||||
|
r"default: /.*/reth",
|
||||||
|
"default: <CACHE_DIR>",
|
||||||
|
s,
|
||||||
|
)
|
||||||
# Remove the commit SHA and target architecture triple
|
# Remove the commit SHA and target architecture triple
|
||||||
s = re.sub(r"default: reth/.*-[0-9A-Fa-f]{6,10}/\w+-\w*-\w+", "default: reth/<VERSION>-<SHA>/<ARCH>", s)
|
s = re.sub(
|
||||||
|
r"default: reth/.*-[0-9A-Fa-f]{6,10}/\w+-\w*-\w+",
|
||||||
|
"default: reth/<VERSION>-<SHA>/<ARCH>",
|
||||||
|
s,
|
||||||
|
)
|
||||||
# Remove the OS
|
# Remove the OS
|
||||||
s = re.sub(r"default: reth/.*/\w+", "default: reth/<VERSION>/<OS>", s)
|
s = re.sub(
|
||||||
|
r"default: reth/.*/\w+",
|
||||||
|
"default: reth/<VERSION>/<OS>",
|
||||||
|
s,
|
||||||
|
)
|
||||||
|
|
||||||
return s
|
return s
|
||||||
|
|
||||||
|
|||||||
59
book/cli/reth.md
vendored
59
book/cli/reth.md
vendored
@ -7,39 +7,40 @@ $ reth --help
|
|||||||
Usage: reth [OPTIONS] <COMMAND>
|
Usage: reth [OPTIONS] <COMMAND>
|
||||||
|
|
||||||
Commands:
|
Commands:
|
||||||
node Start the node
|
node Start the node
|
||||||
init Initialize the database from a genesis file
|
init Initialize the database from a genesis file
|
||||||
init-state Initialize the database from a state dump file
|
init-state Initialize the database from a state dump file
|
||||||
import This syncs RLP encoded blocks from a file
|
import This syncs RLP encoded blocks from a file
|
||||||
dump-genesis Dumps genesis block JSON configuration to stdout
|
import-receipts This imports RLP encoded receipts from a file
|
||||||
db Database debugging utilities
|
dump-genesis Dumps genesis block JSON configuration to stdout
|
||||||
stage Manipulate individual stages
|
db Database debugging utilities
|
||||||
p2p P2P Debugging utilities
|
stage Manipulate individual stages
|
||||||
test-vectors Generate Test Vectors
|
p2p P2P Debugging utilities
|
||||||
config Write config to stdout
|
test-vectors Generate Test Vectors
|
||||||
debug Various debug routines
|
config Write config to stdout
|
||||||
recover Scripts for node recovery
|
debug Various debug routines
|
||||||
help Print this message or the help of the given subcommand(s)
|
recover Scripts for node recovery
|
||||||
|
help Print this message or the help of the given subcommand(s)
|
||||||
|
|
||||||
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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -51,7 +52,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -61,12 +62,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -76,22 +77,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -99,12 +100,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -115,7 +116,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
32
book/cli/reth/config.md
vendored
32
book/cli/reth/config.md
vendored
@ -16,21 +16,21 @@ 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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -39,7 +39,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -49,12 +49,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -64,22 +64,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -87,12 +87,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -103,7 +103,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
40
book/cli/reth/db.md
vendored
40
book/cli/reth/db.md
vendored
@ -22,33 +22,33 @@ Commands:
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -70,13 +70,13 @@ Database:
|
|||||||
|
|
||||||
--db.exclusive <EXCLUSIVE>
|
--db.exclusive <EXCLUSIVE>
|
||||||
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
||||||
|
|
||||||
[possible values: true, false]
|
[possible values: true, false]
|
||||||
|
|
||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -86,12 +86,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -101,22 +101,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -124,12 +124,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -140,7 +140,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
38
book/cli/reth/db/checksum.md
vendored
38
book/cli/reth/db/checksum.md
vendored
@ -13,33 +13,33 @@ Arguments:
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -48,7 +48,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -58,12 +58,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -73,22 +73,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -96,12 +96,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -112,7 +112,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
38
book/cli/reth/db/clear.md
vendored
38
book/cli/reth/db/clear.md
vendored
@ -14,33 +14,33 @@ Commands:
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -49,7 +49,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -59,12 +59,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -74,22 +74,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -97,12 +97,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -113,7 +113,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
40
book/cli/reth/db/clear/mdbx.md
vendored
40
book/cli/reth/db/clear/mdbx.md
vendored
@ -8,38 +8,38 @@ Usage: reth db clear mdbx [OPTIONS] <TABLE>
|
|||||||
|
|
||||||
Arguments:
|
Arguments:
|
||||||
<TABLE>
|
<TABLE>
|
||||||
|
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -48,7 +48,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -58,12 +58,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -73,22 +73,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -96,12 +96,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -112,7 +112,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
38
book/cli/reth/db/clear/static-file.md
vendored
38
book/cli/reth/db/clear/static-file.md
vendored
@ -16,33 +16,33 @@ Arguments:
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -51,7 +51,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -61,12 +61,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -76,22 +76,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -99,12 +99,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -115,7 +115,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
46
book/cli/reth/db/create-static-files.md
vendored
46
book/cli/reth/db/create-static-files.md
vendored
@ -18,37 +18,37 @@ Arguments:
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[default: default]
|
||||||
|
|
||||||
-f, --from <FROM>
|
-f, --from <FROM>
|
||||||
Starting block for the static file
|
Starting block for the static file
|
||||||
|
|
||||||
[default: 0]
|
[default: 0]
|
||||||
|
|
||||||
-b, --block-interval <BLOCK_INTERVAL>
|
-b, --block-interval <BLOCK_INTERVAL>
|
||||||
Number of blocks in the static file
|
Number of blocks in the static file
|
||||||
|
|
||||||
[default: 500000]
|
[default: 500000]
|
||||||
|
|
||||||
--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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
-p, --parallel <PARALLEL>
|
-p, --parallel <PARALLEL>
|
||||||
Sets the number of static files built in parallel. Note: Each parallel build is memory-intensive
|
Sets the number of static files built in parallel. Note: Each parallel build is memory-intensive
|
||||||
|
|
||||||
[default: 1]
|
[default: 1]
|
||||||
|
|
||||||
--only-stats
|
--only-stats
|
||||||
@ -62,7 +62,7 @@ Options:
|
|||||||
|
|
||||||
-c, --compression <COMPRESSION>
|
-c, --compression <COMPRESSION>
|
||||||
Compression algorithms to use
|
Compression algorithms to use
|
||||||
|
|
||||||
[default: uncompressed]
|
[default: uncompressed]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -83,13 +83,13 @@ Options:
|
|||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -98,7 +98,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -108,12 +108,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -123,22 +123,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -146,12 +146,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -162,7 +162,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
40
book/cli/reth/db/diff.md
vendored
40
book/cli/reth/db/diff.md
vendored
@ -9,13 +9,13 @@ Usage: reth db diff [OPTIONS] --secondary-datadir <SECONDARY_DATADIR> --output <
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[default: default]
|
||||||
|
|
||||||
--secondary-datadir <SECONDARY_DATADIR>
|
--secondary-datadir <SECONDARY_DATADIR>
|
||||||
@ -24,21 +24,21 @@ 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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -60,7 +60,7 @@ Database:
|
|||||||
|
|
||||||
--db.exclusive <EXCLUSIVE>
|
--db.exclusive <EXCLUSIVE>
|
||||||
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
||||||
|
|
||||||
[possible values: true, false]
|
[possible values: true, false]
|
||||||
|
|
||||||
--table <TABLE>
|
--table <TABLE>
|
||||||
@ -72,7 +72,7 @@ Database:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -82,12 +82,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -97,22 +97,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -120,12 +120,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -136,7 +136,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
38
book/cli/reth/db/drop.md
vendored
38
book/cli/reth/db/drop.md
vendored
@ -9,13 +9,13 @@ Usage: reth db drop [OPTIONS]
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[default: default]
|
||||||
|
|
||||||
-f, --force
|
-f, --force
|
||||||
@ -24,21 +24,21 @@ 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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -47,7 +47,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -57,12 +57,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -72,22 +72,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -95,12 +95,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -111,7 +111,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
38
book/cli/reth/db/get.md
vendored
38
book/cli/reth/db/get.md
vendored
@ -14,33 +14,33 @@ Commands:
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -49,7 +49,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -59,12 +59,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -74,22 +74,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -97,12 +97,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -113,7 +113,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
40
book/cli/reth/db/get/mdbx.md
vendored
40
book/cli/reth/db/get/mdbx.md
vendored
@ -8,7 +8,7 @@ Usage: reth db get mdbx [OPTIONS] <TABLE> <KEY> [SUBKEY]
|
|||||||
|
|
||||||
Arguments:
|
Arguments:
|
||||||
<TABLE>
|
<TABLE>
|
||||||
|
|
||||||
|
|
||||||
<KEY>
|
<KEY>
|
||||||
The key to get content for
|
The key to get content for
|
||||||
@ -19,13 +19,13 @@ Arguments:
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[default: default]
|
||||||
|
|
||||||
--raw
|
--raw
|
||||||
@ -34,21 +34,21 @@ 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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -57,7 +57,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -67,12 +67,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -82,22 +82,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -105,12 +105,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -121,7 +121,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
38
book/cli/reth/db/get/static-file.md
vendored
38
book/cli/reth/db/get/static-file.md
vendored
@ -19,13 +19,13 @@ Arguments:
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[default: default]
|
||||||
|
|
||||||
--raw
|
--raw
|
||||||
@ -34,21 +34,21 @@ 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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -57,7 +57,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -67,12 +67,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -82,22 +82,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -105,12 +105,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -121,7 +121,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
50
book/cli/reth/db/list.md
vendored
50
book/cli/reth/db/list.md
vendored
@ -13,27 +13,27 @@ Arguments:
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[default: default]
|
||||||
|
|
||||||
-s, --skip <SKIP>
|
-s, --skip <SKIP>
|
||||||
Skip first N entries
|
Skip first N entries
|
||||||
|
|
||||||
[default: 0]
|
[default: 0]
|
||||||
|
|
||||||
--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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
-r, --reverse
|
-r, --reverse
|
||||||
@ -41,27 +41,27 @@ Options:
|
|||||||
|
|
||||||
-l, --len <LEN>
|
-l, --len <LEN>
|
||||||
How many items to take from the walker
|
How many items to take from the walker
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--search <SEARCH>
|
--search <SEARCH>
|
||||||
Search parameter for both keys and values. Prefix it with `0x` to search for binary data, and text otherwise.
|
Search parameter for both keys and values. Prefix it with `0x` to search for binary data, and text otherwise.
|
||||||
|
|
||||||
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>
|
--min-row-size <MIN_ROW_SIZE>
|
||||||
Minimum size of row in bytes
|
Minimum size of row in bytes
|
||||||
|
|
||||||
[default: 0]
|
[default: 0]
|
||||||
|
|
||||||
--min-key-size <MIN_KEY_SIZE>
|
--min-key-size <MIN_KEY_SIZE>
|
||||||
Minimum size of key in bytes
|
Minimum size of key in bytes
|
||||||
|
|
||||||
[default: 0]
|
[default: 0]
|
||||||
|
|
||||||
--min-value-size <MIN_VALUE_SIZE>
|
--min-value-size <MIN_VALUE_SIZE>
|
||||||
Minimum size of value in bytes
|
Minimum size of value in bytes
|
||||||
|
|
||||||
[default: 0]
|
[default: 0]
|
||||||
|
|
||||||
-c, --count
|
-c, --count
|
||||||
@ -75,13 +75,13 @@ Options:
|
|||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -90,7 +90,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -100,12 +100,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -115,22 +115,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -138,12 +138,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -154,7 +154,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
38
book/cli/reth/db/path.md
vendored
38
book/cli/reth/db/path.md
vendored
@ -9,33 +9,33 @@ Usage: reth db path [OPTIONS]
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -44,7 +44,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -54,12 +54,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -69,22 +69,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -92,12 +92,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -108,7 +108,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
42
book/cli/reth/db/stats.md
vendored
42
book/cli/reth/db/stats.md
vendored
@ -9,13 +9,13 @@ Usage: reth db stats [OPTIONS]
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[default: default]
|
||||||
|
|
||||||
--detailed-sizes
|
--detailed-sizes
|
||||||
@ -24,10 +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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--detailed-segments
|
--detailed-segments
|
||||||
@ -35,20 +35,20 @@ Options:
|
|||||||
|
|
||||||
--checksum
|
--checksum
|
||||||
Show a checksum of each table in the database.
|
Show a checksum of each table in the database.
|
||||||
|
|
||||||
WARNING: this option will take a long time to run, as it needs to traverse and hash the entire database.
|
WARNING: this option will take a long time to run, as it needs to traverse and hash the entire database.
|
||||||
|
|
||||||
For individual table checksums, use the `reth db checksum` command.
|
For individual table checksums, use the `reth db checksum` command.
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -57,7 +57,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -67,12 +67,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -82,22 +82,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -105,12 +105,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -121,7 +121,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
38
book/cli/reth/db/version.md
vendored
38
book/cli/reth/db/version.md
vendored
@ -9,33 +9,33 @@ Usage: reth db version [OPTIONS]
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -44,7 +44,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -54,12 +54,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -69,22 +69,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -92,12 +92,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -108,7 +108,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
32
book/cli/reth/debug.md
vendored
32
book/cli/reth/debug.md
vendored
@ -18,21 +18,21 @@ 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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -41,7 +41,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -51,12 +51,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -66,22 +66,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -89,12 +89,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -105,7 +105,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
32
book/cli/reth/dump-genesis.md
vendored
32
book/cli/reth/dump-genesis.md
vendored
@ -10,21 +10,21 @@ 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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -33,7 +33,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -43,12 +43,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -58,22 +58,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -81,12 +81,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -97,7 +97,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
148
book/cli/reth/import-receipts.md
vendored
Normal file
148
book/cli/reth/import-receipts.md
vendored
Normal file
@ -0,0 +1,148 @@
|
|||||||
|
# reth import-receipts
|
||||||
|
|
||||||
|
This imports RLP encoded receipts from a file
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ reth import-receipts --help
|
||||||
|
Usage: reth import-receipts [OPTIONS] <IMPORT_PATH>
|
||||||
|
|
||||||
|
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]
|
||||||
|
|
||||||
|
--chunk-len <CHUNK_LEN>
|
||||||
|
Chunk byte length.
|
||||||
|
|
||||||
|
--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
|
||||||
|
|
||||||
|
--db.exclusive <EXCLUSIVE>
|
||||||
|
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
||||||
|
|
||||||
|
[possible values: true, false]
|
||||||
|
|
||||||
|
<IMPORT_PATH>
|
||||||
|
The path to a receipts file for import. File must use `HackReceiptCodec` (used for
|
||||||
|
exporting OP chain segment below Bedrock block via testinprod/op-geth).
|
||||||
|
|
||||||
|
<https://github.com/testinprod-io/op-geth/pull/1>
|
||||||
|
|
||||||
|
Logging:
|
||||||
|
--log.stdout.format <FORMAT>
|
||||||
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
|
[default: terminal]
|
||||||
|
|
||||||
|
Possible values:
|
||||||
|
- json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging
|
||||||
|
- log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications
|
||||||
|
- terminal: Represents terminal-friendly formatting for logs
|
||||||
|
|
||||||
|
--log.stdout.filter <FILTER>
|
||||||
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
|
[default: ]
|
||||||
|
|
||||||
|
--log.file.format <FORMAT>
|
||||||
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
|
[default: terminal]
|
||||||
|
|
||||||
|
Possible values:
|
||||||
|
- json: Represents JSON formatting for logs. This format outputs log records as JSON objects, making it suitable for structured logging
|
||||||
|
- log-fmt: Represents logfmt (key=value) formatting for logs. This format is concise and human-readable, typically used in command-line applications
|
||||||
|
- terminal: Represents terminal-friendly formatting for logs
|
||||||
|
|
||||||
|
--log.file.filter <FILTER>
|
||||||
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
|
[default: debug]
|
||||||
|
|
||||||
|
--log.file.directory <PATH>
|
||||||
|
The path to put log files in
|
||||||
|
|
||||||
|
[default: <CACHE_DIR>/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.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
|
||||||
|
```
|
||||||
42
book/cli/reth/import.md
vendored
42
book/cli/reth/import.md
vendored
@ -12,22 +12,22 @@ Options:
|
|||||||
|
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--no-state
|
--no-state
|
||||||
@ -38,13 +38,13 @@ Options:
|
|||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -66,19 +66,19 @@ Database:
|
|||||||
|
|
||||||
--db.exclusive <EXCLUSIVE>
|
--db.exclusive <EXCLUSIVE>
|
||||||
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
||||||
|
|
||||||
[possible values: true, false]
|
[possible values: true, false]
|
||||||
|
|
||||||
<IMPORT_PATH>
|
<IMPORT_PATH>
|
||||||
The path to a block file for import.
|
The path to a block file for import.
|
||||||
|
|
||||||
The online stages (headers and bodies) are replaced by a file import, after which the
|
The online stages (headers and bodies) are replaced by a file import, after which the
|
||||||
remaining stages are executed.
|
remaining stages are executed.
|
||||||
|
|
||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -88,12 +88,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -103,22 +103,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -126,12 +126,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -142,7 +142,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
83
book/cli/reth/init-state.md
vendored
83
book/cli/reth/init-state.md
vendored
@ -4,33 +4,13 @@ Initialize the database from a state dump file
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ reth init-state --help
|
$ reth init-state --help
|
||||||
Usage: reth init-state [OPTIONS]
|
Usage: reth init-state [OPTIONS] <STATE_DUMP_FILE>
|
||||||
|
|
||||||
Options:
|
Arguments:
|
||||||
--datadir <DATA_DIR>
|
<STATE_DUMP_FILE>
|
||||||
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]
|
|
||||||
|
|
||||||
--state <STATE_DUMP_FILE>
|
|
||||||
JSONL file with state dump.
|
JSONL file with state dump.
|
||||||
|
|
||||||
Must contain accounts in following format, additional account fields are ignored. Can
|
Must contain accounts in following format, additional account fields are ignored. Must
|
||||||
also contain { "root": \<state-root\> } as first line.
|
also contain { "root": \<state-root\> } as first line.
|
||||||
{
|
{
|
||||||
"balance": "\<balance\>",
|
"balance": "\<balance\>",
|
||||||
@ -42,19 +22,40 @@ Options:
|
|||||||
},
|
},
|
||||||
"address": "\<address\>",
|
"address": "\<address\>",
|
||||||
}
|
}
|
||||||
|
|
||||||
Allows init at a non-genesis block. Caution! Blocks must be manually imported up until
|
Allows init at a non-genesis block. Caution! Blocks must be manually imported up until
|
||||||
and including the non-genesis block to init chain at. See 'import' command.
|
and including the non-genesis block to init chain at. See 'import' command.
|
||||||
|
|
||||||
|
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>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -76,13 +77,13 @@ Database:
|
|||||||
|
|
||||||
--db.exclusive <EXCLUSIVE>
|
--db.exclusive <EXCLUSIVE>
|
||||||
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
||||||
|
|
||||||
[possible values: true, false]
|
[possible values: true, false]
|
||||||
|
|
||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -92,12 +93,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -107,22 +108,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -130,12 +131,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -146,7 +147,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
40
book/cli/reth/init.md
vendored
40
book/cli/reth/init.md
vendored
@ -9,33 +9,33 @@ Usage: reth init [OPTIONS]
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -57,13 +57,13 @@ Database:
|
|||||||
|
|
||||||
--db.exclusive <EXCLUSIVE>
|
--db.exclusive <EXCLUSIVE>
|
||||||
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
||||||
|
|
||||||
[possible values: true, false]
|
[possible values: true, false]
|
||||||
|
|
||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -73,12 +73,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -88,22 +88,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -111,12 +111,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -127,7 +127,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
208
book/cli/reth/node.md
vendored
208
book/cli/reth/node.md
vendored
@ -9,13 +9,13 @@ Usage: reth node [OPTIONS]
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[default: default]
|
||||||
|
|
||||||
--config <FILE>
|
--config <FILE>
|
||||||
@ -24,26 +24,26 @@ 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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
--with-unused-ports
|
--with-unused-ports
|
||||||
Sets all ports to unused, allowing the OS to choose random unused ports when sockets are bound.
|
Sets all ports to unused, allowing the OS to choose random unused ports when sockets are bound.
|
||||||
|
|
||||||
Mutually exclusive with `--instance`.
|
Mutually exclusive with `--instance`.
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -52,7 +52,7 @@ Options:
|
|||||||
Metrics:
|
Metrics:
|
||||||
--metrics <SOCKET>
|
--metrics <SOCKET>
|
||||||
Enable Prometheus metrics.
|
Enable Prometheus metrics.
|
||||||
|
|
||||||
The metrics will be served at the given interface and port.
|
The metrics will be served at the given interface and port.
|
||||||
|
|
||||||
Networking:
|
Networking:
|
||||||
@ -70,50 +70,56 @@ Networking:
|
|||||||
|
|
||||||
--discovery.addr <DISCOVERY_ADDR>
|
--discovery.addr <DISCOVERY_ADDR>
|
||||||
The UDP address to use for devp2p peer discovery version 4
|
The UDP address to use for devp2p peer discovery version 4
|
||||||
|
|
||||||
[default: 0.0.0.0]
|
[default: 0.0.0.0]
|
||||||
|
|
||||||
--discovery.port <DISCOVERY_PORT>
|
--discovery.port <DISCOVERY_PORT>
|
||||||
The UDP port to use for devp2p peer discovery version 4
|
The UDP port to use for devp2p peer discovery version 4
|
||||||
|
|
||||||
[default: 30303]
|
[default: 30303]
|
||||||
|
|
||||||
--discovery.v5.addr <DISCOVERY_V5_ADDR>
|
--discovery.v5.addr <DISCOVERY_V5_ADDR>
|
||||||
The UDP address to use for devp2p peer discovery version 5
|
The UDP IPv4 address to use for devp2p peer discovery version 5. Overwritten by RLPx address, if it's also IPv4
|
||||||
|
|
||||||
[default: 0.0.0.0]
|
--discovery.v5.addr.ipv6 <DISCOVERY_V5_ADDR_IPV6>
|
||||||
|
The UDP IPv6 address to use for devp2p peer discovery version 5. Overwritten by RLPx address, if it's also IPv6
|
||||||
|
|
||||||
--discovery.v5.port <DISCOVERY_V5_PORT>
|
--discovery.v5.port <DISCOVERY_V5_PORT>
|
||||||
The UDP port to use for devp2p peer discovery version 5
|
The UDP IPv4 port to use for devp2p peer discovery version 5. Not used unless `--addr` is IPv4, or `--discv5.addr` is set
|
||||||
|
|
||||||
|
[default: 9000]
|
||||||
|
|
||||||
|
--discovery.v5.port.ipv6 <DISCOVERY_V5_PORT_IPV6>
|
||||||
|
The UDP IPv6 port to use for devp2p peer discovery version 5. Not used unless `--addr` is IPv6, or `--discv5.addr.ipv6` is set
|
||||||
|
|
||||||
[default: 9000]
|
[default: 9000]
|
||||||
|
|
||||||
--discovery.v5.lookup-interval <DISCOVERY_V5_LOOKUP_INTERVAL>
|
--discovery.v5.lookup-interval <DISCOVERY_V5_LOOKUP_INTERVAL>
|
||||||
The interval in seconds at which to carry out periodic lookup queries, for the whole run of the program
|
The interval in seconds at which to carry out periodic lookup queries, for the whole run of the program
|
||||||
|
|
||||||
[default: 60]
|
[default: 60]
|
||||||
|
|
||||||
--discovery.v5.bootstrap.lookup-interval <DISCOVERY_V5_bootstrap_lookup_interval>
|
--discovery.v5.bootstrap.lookup-interval <DISCOVERY_V5_bootstrap_lookup_interval>
|
||||||
The interval in seconds at which to carry out boost lookup queries, for a fixed number of times, at bootstrap
|
The interval in seconds at which to carry out boost lookup queries, for a fixed number of times, at bootstrap
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--discovery.v5.bootstrap.lookup-countdown <DISCOVERY_V5_bootstrap_lookup_countdown>
|
--discovery.v5.bootstrap.lookup-countdown <DISCOVERY_V5_bootstrap_lookup_countdown>
|
||||||
The number of times to carry out boost lookup queries at bootstrap
|
The number of times to carry out boost lookup queries at bootstrap
|
||||||
|
|
||||||
[default: 100]
|
[default: 100]
|
||||||
|
|
||||||
--trusted-peers <TRUSTED_PEERS>
|
--trusted-peers <TRUSTED_PEERS>
|
||||||
Comma separated enode URLs of trusted peers for P2P connections.
|
Comma separated enode URLs of trusted peers for P2P connections.
|
||||||
|
|
||||||
--trusted-peers enode://abcd@192.168.0.1:30303
|
--trusted-peers enode://abcd@192.168.0.1:30303
|
||||||
|
|
||||||
--trusted-only
|
--trusted-only
|
||||||
Connect only to trusted peers
|
Connect to or accept from trusted peers only
|
||||||
|
|
||||||
--bootnodes <BOOTNODES>
|
--bootnodes <BOOTNODES>
|
||||||
Comma separated enode URLs for P2P discovery bootstrap.
|
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.
|
||||||
|
|
||||||
--peers-file <FILE>
|
--peers-file <FILE>
|
||||||
@ -122,12 +128,12 @@ Networking:
|
|||||||
|
|
||||||
--identity <IDENTITY>
|
--identity <IDENTITY>
|
||||||
Custom node identity
|
Custom node identity
|
||||||
|
|
||||||
[default: reth/<VERSION>-<SHA>/<ARCH>]
|
[default: reth/<VERSION>-<SHA>/<ARCH>]
|
||||||
|
|
||||||
--p2p-secret-key <PATH>
|
--p2p-secret-key <PATH>
|
||||||
Secret key to use for this node.
|
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.
|
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
|
--no-persist-peers
|
||||||
@ -135,17 +141,17 @@ Networking:
|
|||||||
|
|
||||||
--nat <NAT>
|
--nat <NAT>
|
||||||
NAT resolution method (any|none|upnp|publicip|extip:\<IP\>)
|
NAT resolution method (any|none|upnp|publicip|extip:\<IP\>)
|
||||||
|
|
||||||
[default: any]
|
[default: any]
|
||||||
|
|
||||||
--addr <ADDR>
|
--addr <ADDR>
|
||||||
Network listening address
|
Network listening address
|
||||||
|
|
||||||
[default: 0.0.0.0]
|
[default: 0.0.0.0]
|
||||||
|
|
||||||
--port <PORT>
|
--port <PORT>
|
||||||
Network listening port
|
Network listening port
|
||||||
|
|
||||||
[default: 30303]
|
[default: 30303]
|
||||||
|
|
||||||
--max-outbound-peers <MAX_OUTBOUND_PEERS>
|
--max-outbound-peers <MAX_OUTBOUND_PEERS>
|
||||||
@ -155,15 +161,25 @@ Networking:
|
|||||||
Maximum number of inbound requests. default: 30
|
Maximum number of inbound requests. default: 30
|
||||||
|
|
||||||
--pooled-tx-response-soft-limit <BYTES>
|
--pooled-tx-response-soft-limit <BYTES>
|
||||||
Soft limit for the byte size of a `PooledTransactions` response on assembling a `GetPooledTransactions` request. Spec'd at 2 MiB.
|
Experimental, for usage in research. Sets the max accumulated byte size of transactions
|
||||||
|
to pack in one response.
|
||||||
<https://github.com/ethereum/devp2p/blob/master/caps/eth.md#protocol-messages>.
|
Spec'd at 2MiB.
|
||||||
|
|
||||||
[default: 2097152]
|
[default: 2097152]
|
||||||
|
|
||||||
--pooled-tx-pack-soft-limit <BYTES>
|
--pooled-tx-pack-soft-limit <BYTES>
|
||||||
Default soft limit for the byte size of a `PooledTransactions` response on assembling a `GetPooledTransactions` request. This defaults to less than the [`SOFT_LIMIT_BYTE_SIZE_POOLED_TRANSACTIONS_RESPONSE`], at 2 MiB, used when assembling a `PooledTransactions` response. Default is 128 KiB
|
Experimental, for usage in research. Sets the max accumulated byte size of transactions to
|
||||||
|
request in one request.
|
||||||
|
|
||||||
|
Since RLPx protocol version 68, the byte size of a transaction is shared as metadata in a
|
||||||
|
transaction announcement (see RLPx specs). This allows a node to request a specific size
|
||||||
|
response.
|
||||||
|
|
||||||
|
By default, nodes request only 128 KiB worth of transactions, but should a peer request
|
||||||
|
more, up to 2 MiB, a node will answer with more than 128 KiB.
|
||||||
|
|
||||||
|
Default is 128 KiB.
|
||||||
|
|
||||||
[default: 131072]
|
[default: 131072]
|
||||||
|
|
||||||
RPC:
|
RPC:
|
||||||
@ -172,17 +188,17 @@ RPC:
|
|||||||
|
|
||||||
--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]
|
[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]
|
[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, reth, ots, eth-call-bundle]
|
[possible values: admin, debug, eth, net, trace, txpool, web3, rpc, reth, ots, eth-call-bundle]
|
||||||
|
|
||||||
--http.corsdomain <HTTP_CORSDOMAIN>
|
--http.corsdomain <HTTP_CORSDOMAIN>
|
||||||
@ -193,12 +209,12 @@ 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]
|
[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]
|
[default: 8546]
|
||||||
|
|
||||||
--ws.origins <ws.origins>
|
--ws.origins <ws.origins>
|
||||||
@ -206,7 +222,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, eth-call-bundle]
|
[possible values: admin, debug, eth, net, trace, txpool, web3, rpc, reth, ots, eth-call-bundle]
|
||||||
|
|
||||||
--ipcdisable
|
--ipcdisable
|
||||||
@ -214,24 +230,24 @@ RPC:
|
|||||||
|
|
||||||
--ipcpath <IPCPATH>
|
--ipcpath <IPCPATH>
|
||||||
Filename for IPC socket/pipe within the datadir
|
Filename for IPC socket/pipe within the datadir
|
||||||
|
|
||||||
[default: <CACHE_DIR>.ipc]
|
[default: <CACHE_DIR>.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]
|
[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]
|
[default: 8551]
|
||||||
|
|
||||||
--authrpc.jwtsecret <PATH>
|
--authrpc.jwtsecret <PATH>
|
||||||
Path to a JWT secret to use for the authenticated engine-API RPC server.
|
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.
|
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.
|
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.
|
||||||
|
|
||||||
--auth-ipc
|
--auth-ipc
|
||||||
@ -239,151 +255,151 @@ RPC:
|
|||||||
|
|
||||||
--auth-ipc.path <AUTH_IPC_PATH>
|
--auth-ipc.path <AUTH_IPC_PATH>
|
||||||
Filename for auth IPC socket/pipe within the datadir
|
Filename for auth IPC socket/pipe within the datadir
|
||||||
|
|
||||||
[default: <CACHE_DIR>_engine_api.ipc]
|
[default: <CACHE_DIR>_engine_api.ipc]
|
||||||
|
|
||||||
--rpc.jwtsecret <HEX>
|
--rpc.jwtsecret <HEX>
|
||||||
Hex encoded JWT secret to authenticate the regular RPC server(s), see `--http.api` and `--ws.api`.
|
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`.
|
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
|
||||||
|
|
||||||
[default: 15]
|
[default: 15]
|
||||||
|
|
||||||
--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: 160]
|
[default: 160]
|
||||||
[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>
|
||||||
Set the maximum concurrent subscriptions per connection
|
Set the maximum concurrent subscriptions per connection
|
||||||
|
|
||||||
[default: 1024]
|
[default: 1024]
|
||||||
|
|
||||||
--rpc.max-connections <COUNT>
|
--rpc.max-connections <COUNT>
|
||||||
Maximum number of RPC server connections
|
Maximum number of RPC server connections
|
||||||
|
|
||||||
[default: 500]
|
[default: 500]
|
||||||
|
|
||||||
--rpc.max-tracing-requests <COUNT>
|
--rpc.max-tracing-requests <COUNT>
|
||||||
Maximum number of concurrent tracing requests
|
Maximum number of concurrent tracing requests
|
||||||
|
|
||||||
[default: 8]
|
[default: 6]
|
||||||
|
|
||||||
--rpc.max-blocks-per-filter <COUNT>
|
--rpc.max-blocks-per-filter <COUNT>
|
||||||
Maximum number of blocks that could be scanned per filter request. (0 = entire chain)
|
Maximum number of blocks that could be scanned per filter request. (0 = entire chain)
|
||||||
|
|
||||||
[default: 100000]
|
[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. (0 = no limit)
|
Maximum number of logs that can be returned in a single response. (0 = no limit)
|
||||||
|
|
||||||
[default: 20000]
|
[default: 20000]
|
||||||
|
|
||||||
--rpc.gascap <GAS_CAP>
|
--rpc.gascap <GAS_CAP>
|
||||||
Maximum gas limit for `eth_call` and call tracing RPC methods
|
Maximum gas limit for `eth_call` and call tracing RPC methods
|
||||||
|
|
||||||
[default: 50000000]
|
[default: 50000000]
|
||||||
|
|
||||||
RPC State Cache:
|
RPC State Cache:
|
||||||
--rpc-cache.max-blocks <MAX_BLOCKS>
|
--rpc-cache.max-blocks <MAX_BLOCKS>
|
||||||
Max number of blocks in cache
|
Max number of blocks in cache
|
||||||
|
|
||||||
[default: 5000]
|
[default: 5000]
|
||||||
|
|
||||||
--rpc-cache.max-receipts <MAX_RECEIPTS>
|
--rpc-cache.max-receipts <MAX_RECEIPTS>
|
||||||
Max number receipts in cache
|
Max number receipts in cache
|
||||||
|
|
||||||
[default: 2000]
|
[default: 2000]
|
||||||
|
|
||||||
--rpc-cache.max-envs <MAX_ENVS>
|
--rpc-cache.max-envs <MAX_ENVS>
|
||||||
Max number of bytes for cached env data
|
Max number of bytes for cached env data
|
||||||
|
|
||||||
[default: 1000]
|
[default: 1000]
|
||||||
|
|
||||||
--rpc-cache.max-concurrent-db-requests <MAX_CONCURRENT_DB_REQUESTS>
|
--rpc-cache.max-concurrent-db-requests <MAX_CONCURRENT_DB_REQUESTS>
|
||||||
Max number of concurrent database requests
|
Max number of concurrent database requests
|
||||||
|
|
||||||
[default: 512]
|
[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
|
||||||
|
|
||||||
[default: 20]
|
[default: 20]
|
||||||
|
|
||||||
--gpo.ignoreprice <IGNORE_PRICE>
|
--gpo.ignoreprice <IGNORE_PRICE>
|
||||||
Gas Price below which gpo will ignore transactions
|
Gas Price below which gpo will ignore transactions
|
||||||
|
|
||||||
[default: 2]
|
[default: 2]
|
||||||
|
|
||||||
--gpo.maxprice <MAX_PRICE>
|
--gpo.maxprice <MAX_PRICE>
|
||||||
Maximum transaction priority fee(or gasprice before London Fork) to be recommended by gpo
|
Maximum transaction priority fee(or gasprice before London Fork) to be recommended by gpo
|
||||||
|
|
||||||
[default: 500000000000]
|
[default: 500000000000]
|
||||||
|
|
||||||
--gpo.percentile <PERCENTILE>
|
--gpo.percentile <PERCENTILE>
|
||||||
The percentile of gas prices to use for the estimate
|
The percentile of gas prices to use for the estimate
|
||||||
|
|
||||||
[default: 60]
|
[default: 60]
|
||||||
|
|
||||||
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
|
||||||
|
|
||||||
[default: 10000]
|
[default: 10000]
|
||||||
|
|
||||||
--txpool.pending-max-size <PENDING_MAX_SIZE>
|
--txpool.pending-max-size <PENDING_MAX_SIZE>
|
||||||
Max size of the pending sub-pool in megabytes
|
Max size of the pending sub-pool in megabytes
|
||||||
|
|
||||||
[default: 20]
|
[default: 20]
|
||||||
|
|
||||||
--txpool.basefee-max-count <BASEFEE_MAX_COUNT>
|
--txpool.basefee-max-count <BASEFEE_MAX_COUNT>
|
||||||
Max number of transaction in the basefee sub-pool
|
Max number of transaction in the basefee sub-pool
|
||||||
|
|
||||||
[default: 10000]
|
[default: 10000]
|
||||||
|
|
||||||
--txpool.basefee-max-size <BASEFEE_MAX_SIZE>
|
--txpool.basefee-max-size <BASEFEE_MAX_SIZE>
|
||||||
Max size of the basefee sub-pool in megabytes
|
Max size of the basefee sub-pool in megabytes
|
||||||
|
|
||||||
[default: 20]
|
[default: 20]
|
||||||
|
|
||||||
--txpool.queued-max-count <QUEUED_MAX_COUNT>
|
--txpool.queued-max-count <QUEUED_MAX_COUNT>
|
||||||
Max number of transaction in the queued sub-pool
|
Max number of transaction in the queued sub-pool
|
||||||
|
|
||||||
[default: 10000]
|
[default: 10000]
|
||||||
|
|
||||||
--txpool.queued-max-size <QUEUED_MAX_SIZE>
|
--txpool.queued-max-size <QUEUED_MAX_SIZE>
|
||||||
Max size of the queued sub-pool in megabytes
|
Max size of the queued sub-pool in megabytes
|
||||||
|
|
||||||
[default: 20]
|
[default: 20]
|
||||||
|
|
||||||
--txpool.max-account-slots <MAX_ACCOUNT_SLOTS>
|
--txpool.max-account-slots <MAX_ACCOUNT_SLOTS>
|
||||||
Max number of executable transaction slots guaranteed per account
|
Max number of executable transaction slots guaranteed per account
|
||||||
|
|
||||||
[default: 16]
|
[default: 16]
|
||||||
|
|
||||||
--txpool.pricebump <PRICE_BUMP>
|
--txpool.pricebump <PRICE_BUMP>
|
||||||
Price bump (in %) for the transaction pool underpriced check
|
Price bump (in %) for the transaction pool underpriced check
|
||||||
|
|
||||||
[default: 10]
|
[default: 10]
|
||||||
|
|
||||||
--blobpool.pricebump <BLOB_TRANSACTION_PRICE_BUMP>
|
--blobpool.pricebump <BLOB_TRANSACTION_PRICE_BUMP>
|
||||||
Price bump percentage to replace an already existing blob transaction
|
Price bump percentage to replace an already existing blob transaction
|
||||||
|
|
||||||
[default: 100]
|
[default: 100]
|
||||||
|
|
||||||
--txpool.max-tx-input-bytes <MAX_TX_INPUT_BYTES>
|
--txpool.max-tx-input-bytes <MAX_TX_INPUT_BYTES>
|
||||||
Max size in bytes of a single transaction allowed to enter the pool
|
Max size in bytes of a single transaction allowed to enter the pool
|
||||||
|
|
||||||
[default: 131072]
|
[default: 131072]
|
||||||
|
|
||||||
--txpool.max-cached-entries <MAX_CACHED_ENTRIES>
|
--txpool.max-cached-entries <MAX_CACHED_ENTRIES>
|
||||||
The maximum number of blobs to keep in the in memory blob cache
|
The maximum number of blobs to keep in the in memory blob cache
|
||||||
|
|
||||||
[default: 100]
|
[default: 100]
|
||||||
|
|
||||||
--txpool.nolocals
|
--txpool.nolocals
|
||||||
@ -398,33 +414,33 @@ TxPool:
|
|||||||
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/<VERSION>/<OS>]
|
||||||
|
|
||||||
--builder.gaslimit <GAS_LIMIT>
|
--builder.gaslimit <GAS_LIMIT>
|
||||||
Target gas ceiling for built blocks
|
Target gas ceiling for built blocks
|
||||||
|
|
||||||
[default: 30000000]
|
[default: 30000000]
|
||||||
|
|
||||||
--builder.interval <SECONDS>
|
--builder.interval <SECONDS>
|
||||||
The interval at which the job should build a new payload after the last (in seconds)
|
The interval at which the job should build a new payload after the last (in seconds)
|
||||||
|
|
||||||
[default: 1]
|
[default: 1]
|
||||||
|
|
||||||
--builder.deadline <SECONDS>
|
--builder.deadline <SECONDS>
|
||||||
The deadline for when the payload builder job should resolve
|
The deadline for when the payload builder job should resolve
|
||||||
|
|
||||||
[default: 12]
|
[default: 12]
|
||||||
|
|
||||||
--builder.max-tasks <MAX_PAYLOAD_TASKS>
|
--builder.max-tasks <MAX_PAYLOAD_TASKS>
|
||||||
Maximum number of tasks to spawn for building a payload
|
Maximum number of tasks to spawn for building a payload
|
||||||
|
|
||||||
[default: 3]
|
[default: 3]
|
||||||
|
|
||||||
Debug:
|
Debug:
|
||||||
--debug.continuous
|
--debug.continuous
|
||||||
Prompt the downloader to download blocks one at a time.
|
Prompt the downloader to download blocks one at a time.
|
||||||
|
|
||||||
NOTE: This is for testing purposes only.
|
NOTE: This is for testing purposes only.
|
||||||
|
|
||||||
--debug.terminate
|
--debug.terminate
|
||||||
@ -432,7 +448,7 @@ Debug:
|
|||||||
|
|
||||||
--debug.tip <TIP>
|
--debug.tip <TIP>
|
||||||
Set the chain tip manually for testing purposes.
|
Set the chain tip manually for testing purposes.
|
||||||
|
|
||||||
NOTE: This is a temporary flag
|
NOTE: This is a temporary flag
|
||||||
|
|
||||||
--debug.max-block <MAX_BLOCK>
|
--debug.max-block <MAX_BLOCK>
|
||||||
@ -463,13 +479,13 @@ Database:
|
|||||||
|
|
||||||
--db.exclusive <EXCLUSIVE>
|
--db.exclusive <EXCLUSIVE>
|
||||||
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
||||||
|
|
||||||
[possible values: true, false]
|
[possible values: true, false]
|
||||||
|
|
||||||
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.
|
||||||
@ -481,7 +497,7 @@ Dev testnet:
|
|||||||
|
|
||||||
--dev.block-time <BLOCK_TIME>
|
--dev.block-time <BLOCK_TIME>
|
||||||
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
|
||||||
|
|
||||||
@ -492,7 +508,7 @@ Pruning:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -502,12 +518,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -517,22 +533,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -540,12 +556,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -556,7 +572,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
168
book/cli/reth/p2p.md
vendored
168
book/cli/reth/p2p.md
vendored
@ -18,28 +18,38 @@ 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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[default: default]
|
||||||
|
|
||||||
--p2p-secret-key <PATH>
|
--instance <INSTANCE>
|
||||||
Secret key to use for this node.
|
Add a new instance of a node.
|
||||||
|
|
||||||
This also will deterministically set the peer ID.
|
|
||||||
|
|
||||||
|
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')
|
||||||
|
|
||||||
|
Networking:
|
||||||
-d, --disable-discovery
|
-d, --disable-discovery
|
||||||
Disable the discovery service
|
Disable the discovery service
|
||||||
|
|
||||||
@ -54,67 +64,123 @@ Options:
|
|||||||
|
|
||||||
--discovery.addr <DISCOVERY_ADDR>
|
--discovery.addr <DISCOVERY_ADDR>
|
||||||
The UDP address to use for devp2p peer discovery version 4
|
The UDP address to use for devp2p peer discovery version 4
|
||||||
|
|
||||||
[default: 0.0.0.0]
|
[default: 0.0.0.0]
|
||||||
|
|
||||||
--discovery.port <DISCOVERY_PORT>
|
--discovery.port <DISCOVERY_PORT>
|
||||||
The UDP port to use for devp2p peer discovery version 4
|
The UDP port to use for devp2p peer discovery version 4
|
||||||
|
|
||||||
[default: 30303]
|
[default: 30303]
|
||||||
|
|
||||||
--discovery.v5.addr <DISCOVERY_V5_ADDR>
|
--discovery.v5.addr <DISCOVERY_V5_ADDR>
|
||||||
The UDP address to use for devp2p peer discovery version 5
|
The UDP IPv4 address to use for devp2p peer discovery version 5. Overwritten by RLPx address, if it's also IPv4
|
||||||
|
|
||||||
[default: 0.0.0.0]
|
--discovery.v5.addr.ipv6 <DISCOVERY_V5_ADDR_IPV6>
|
||||||
|
The UDP IPv6 address to use for devp2p peer discovery version 5. Overwritten by RLPx address, if it's also IPv6
|
||||||
|
|
||||||
--discovery.v5.port <DISCOVERY_V5_PORT>
|
--discovery.v5.port <DISCOVERY_V5_PORT>
|
||||||
The UDP port to use for devp2p peer discovery version 5
|
The UDP IPv4 port to use for devp2p peer discovery version 5. Not used unless `--addr` is IPv4, or `--discv5.addr` is set
|
||||||
|
|
||||||
|
[default: 9000]
|
||||||
|
|
||||||
|
--discovery.v5.port.ipv6 <DISCOVERY_V5_PORT_IPV6>
|
||||||
|
The UDP IPv6 port to use for devp2p peer discovery version 5. Not used unless `--addr` is IPv6, or `--discv5.addr.ipv6` is set
|
||||||
|
|
||||||
[default: 9000]
|
[default: 9000]
|
||||||
|
|
||||||
--discovery.v5.lookup-interval <DISCOVERY_V5_LOOKUP_INTERVAL>
|
--discovery.v5.lookup-interval <DISCOVERY_V5_LOOKUP_INTERVAL>
|
||||||
The interval in seconds at which to carry out periodic lookup queries, for the whole run of the program
|
The interval in seconds at which to carry out periodic lookup queries, for the whole run of the program
|
||||||
|
|
||||||
[default: 60]
|
[default: 60]
|
||||||
|
|
||||||
--discovery.v5.bootstrap.lookup-interval <DISCOVERY_V5_bootstrap_lookup_interval>
|
--discovery.v5.bootstrap.lookup-interval <DISCOVERY_V5_bootstrap_lookup_interval>
|
||||||
The interval in seconds at which to carry out boost lookup queries, for a fixed number of times, at bootstrap
|
The interval in seconds at which to carry out boost lookup queries, for a fixed number of times, at bootstrap
|
||||||
|
|
||||||
[default: 5]
|
|
||||||
|
|
||||||
--instance <INSTANCE>
|
[default: 5]
|
||||||
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]
|
|
||||||
|
|
||||||
--discovery.v5.bootstrap.lookup-countdown <DISCOVERY_V5_bootstrap_lookup_countdown>
|
--discovery.v5.bootstrap.lookup-countdown <DISCOVERY_V5_bootstrap_lookup_countdown>
|
||||||
The number of times to carry out boost lookup queries at bootstrap
|
The number of times to carry out boost lookup queries at bootstrap
|
||||||
|
|
||||||
[default: 100]
|
[default: 100]
|
||||||
|
|
||||||
--trusted-peer <TRUSTED_PEER>
|
--trusted-peers <TRUSTED_PEERS>
|
||||||
Target trusted peer
|
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 to or accept from trusted peers only
|
||||||
|
|
||||||
|
--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/<VERSION>-<SHA>/<ARCH>]
|
||||||
|
|
||||||
|
--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
|
||||||
|
|
||||||
|
--pooled-tx-response-soft-limit <BYTES>
|
||||||
|
Experimental, for usage in research. Sets the max accumulated byte size of transactions
|
||||||
|
to pack in one response.
|
||||||
|
Spec'd at 2MiB.
|
||||||
|
|
||||||
|
[default: 2097152]
|
||||||
|
|
||||||
|
--pooled-tx-pack-soft-limit <BYTES>
|
||||||
|
Experimental, for usage in research. Sets the max accumulated byte size of transactions to
|
||||||
|
request in one request.
|
||||||
|
|
||||||
|
Since RLPx protocol version 68, the byte size of a transaction is shared as metadata in a
|
||||||
|
transaction announcement (see RLPx specs). This allows a node to request a specific size
|
||||||
|
response.
|
||||||
|
|
||||||
|
By default, nodes request only 128 KiB worth of transactions, but should a peer request
|
||||||
|
more, up to 2 MiB, a node will answer with more than 128 KiB.
|
||||||
|
|
||||||
|
Default is 128 KiB.
|
||||||
|
|
||||||
|
[default: 131072]
|
||||||
|
|
||||||
--retries <RETRIES>
|
--retries <RETRIES>
|
||||||
The number of retries per request
|
The number of retries per request
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--nat <NAT>
|
|
||||||
[default: any]
|
|
||||||
|
|
||||||
-h, --help
|
|
||||||
Print help (see a summary with '-h')
|
|
||||||
|
|
||||||
Database:
|
Database:
|
||||||
--db.log-level <LOG_LEVEL>
|
--db.log-level <LOG_LEVEL>
|
||||||
Database logging level. Levels higher than "notice" require a debug build
|
Database logging level. Levels higher than "notice" require a debug build
|
||||||
@ -131,13 +197,13 @@ Database:
|
|||||||
|
|
||||||
--db.exclusive <EXCLUSIVE>
|
--db.exclusive <EXCLUSIVE>
|
||||||
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
||||||
|
|
||||||
[possible values: true, false]
|
[possible values: true, false]
|
||||||
|
|
||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -147,12 +213,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -162,22 +228,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -185,12 +251,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -201,7 +267,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
28
book/cli/reth/p2p/body.md
vendored
28
book/cli/reth/p2p/body.md
vendored
@ -13,13 +13,13 @@ Arguments:
|
|||||||
Options:
|
Options:
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -28,7 +28,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -38,12 +38,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -53,22 +53,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -76,12 +76,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -92,7 +92,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
28
book/cli/reth/p2p/header.md
vendored
28
book/cli/reth/p2p/header.md
vendored
@ -13,13 +13,13 @@ Arguments:
|
|||||||
Options:
|
Options:
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -28,7 +28,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -38,12 +38,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -53,22 +53,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -76,12 +76,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -92,7 +92,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
32
book/cli/reth/recover.md
vendored
32
book/cli/reth/recover.md
vendored
@ -14,21 +14,21 @@ 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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -37,7 +37,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -47,12 +47,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -62,22 +62,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -85,12 +85,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -101,7 +101,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
40
book/cli/reth/recover/storage-tries.md
vendored
40
book/cli/reth/recover/storage-tries.md
vendored
@ -9,33 +9,33 @@ Usage: reth recover storage-tries [OPTIONS]
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -57,13 +57,13 @@ Database:
|
|||||||
|
|
||||||
--db.exclusive <EXCLUSIVE>
|
--db.exclusive <EXCLUSIVE>
|
||||||
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
||||||
|
|
||||||
[possible values: true, false]
|
[possible values: true, false]
|
||||||
|
|
||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -73,12 +73,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -88,22 +88,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -111,12 +111,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -127,7 +127,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
32
book/cli/reth/stage.md
vendored
32
book/cli/reth/stage.md
vendored
@ -17,21 +17,21 @@ 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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -40,7 +40,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -50,12 +50,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -65,22 +65,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -88,12 +88,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -104,7 +104,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
40
book/cli/reth/stage/drop.md
vendored
40
book/cli/reth/stage/drop.md
vendored
@ -9,33 +9,33 @@ Usage: reth stage drop [OPTIONS] <STAGE>
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -57,7 +57,7 @@ Database:
|
|||||||
|
|
||||||
--db.exclusive <EXCLUSIVE>
|
--db.exclusive <EXCLUSIVE>
|
||||||
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
||||||
|
|
||||||
[possible values: true, false]
|
[possible values: true, false]
|
||||||
|
|
||||||
<STAGE>
|
<STAGE>
|
||||||
@ -77,7 +77,7 @@ Database:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -87,12 +87,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -102,22 +102,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -125,12 +125,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -141,7 +141,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
40
book/cli/reth/stage/dump.md
vendored
40
book/cli/reth/stage/dump.md
vendored
@ -16,33 +16,33 @@ Commands:
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -64,13 +64,13 @@ Database:
|
|||||||
|
|
||||||
--db.exclusive <EXCLUSIVE>
|
--db.exclusive <EXCLUSIVE>
|
||||||
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
||||||
|
|
||||||
[possible values: true, false]
|
[possible values: true, false]
|
||||||
|
|
||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -80,12 +80,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -95,22 +95,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -118,12 +118,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -134,7 +134,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
28
book/cli/reth/stage/dump/account-hashing.md
vendored
28
book/cli/reth/stage/dump/account-hashing.md
vendored
@ -21,13 +21,13 @@ Options:
|
|||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -36,7 +36,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -46,12 +46,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -61,22 +61,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -84,12 +84,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -100,7 +100,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
28
book/cli/reth/stage/dump/execution.md
vendored
28
book/cli/reth/stage/dump/execution.md
vendored
@ -21,13 +21,13 @@ Options:
|
|||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -36,7 +36,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -46,12 +46,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -61,22 +61,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -84,12 +84,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -100,7 +100,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
28
book/cli/reth/stage/dump/merkle.md
vendored
28
book/cli/reth/stage/dump/merkle.md
vendored
@ -21,13 +21,13 @@ Options:
|
|||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -36,7 +36,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -46,12 +46,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -61,22 +61,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -84,12 +84,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -100,7 +100,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
28
book/cli/reth/stage/dump/storage-hashing.md
vendored
28
book/cli/reth/stage/dump/storage-hashing.md
vendored
@ -21,13 +21,13 @@ Options:
|
|||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -36,7 +36,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -46,12 +46,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -61,22 +61,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -84,12 +84,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -100,7 +100,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
110
book/cli/reth/stage/run.md
vendored
110
book/cli/reth/stage/run.md
vendored
@ -29,27 +29,27 @@ Options:
|
|||||||
|
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--metrics <SOCKET>
|
--metrics <SOCKET>
|
||||||
Enable Prometheus metrics.
|
Enable Prometheus metrics.
|
||||||
|
|
||||||
The metrics will be served at the given interface and port.
|
The metrics will be served at the given interface and port.
|
||||||
|
|
||||||
--from <FROM>
|
--from <FROM>
|
||||||
@ -69,18 +69,18 @@ Options:
|
|||||||
|
|
||||||
-s, --skip-unwind
|
-s, --skip-unwind
|
||||||
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.
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -101,50 +101,56 @@ Networking:
|
|||||||
|
|
||||||
--discovery.addr <DISCOVERY_ADDR>
|
--discovery.addr <DISCOVERY_ADDR>
|
||||||
The UDP address to use for devp2p peer discovery version 4
|
The UDP address to use for devp2p peer discovery version 4
|
||||||
|
|
||||||
[default: 0.0.0.0]
|
[default: 0.0.0.0]
|
||||||
|
|
||||||
--discovery.port <DISCOVERY_PORT>
|
--discovery.port <DISCOVERY_PORT>
|
||||||
The UDP port to use for devp2p peer discovery version 4
|
The UDP port to use for devp2p peer discovery version 4
|
||||||
|
|
||||||
[default: 30303]
|
[default: 30303]
|
||||||
|
|
||||||
--discovery.v5.addr <DISCOVERY_V5_ADDR>
|
--discovery.v5.addr <DISCOVERY_V5_ADDR>
|
||||||
The UDP address to use for devp2p peer discovery version 5
|
The UDP IPv4 address to use for devp2p peer discovery version 5. Overwritten by RLPx address, if it's also IPv4
|
||||||
|
|
||||||
[default: 0.0.0.0]
|
--discovery.v5.addr.ipv6 <DISCOVERY_V5_ADDR_IPV6>
|
||||||
|
The UDP IPv6 address to use for devp2p peer discovery version 5. Overwritten by RLPx address, if it's also IPv6
|
||||||
|
|
||||||
--discovery.v5.port <DISCOVERY_V5_PORT>
|
--discovery.v5.port <DISCOVERY_V5_PORT>
|
||||||
The UDP port to use for devp2p peer discovery version 5
|
The UDP IPv4 port to use for devp2p peer discovery version 5. Not used unless `--addr` is IPv4, or `--discv5.addr` is set
|
||||||
|
|
||||||
|
[default: 9000]
|
||||||
|
|
||||||
|
--discovery.v5.port.ipv6 <DISCOVERY_V5_PORT_IPV6>
|
||||||
|
The UDP IPv6 port to use for devp2p peer discovery version 5. Not used unless `--addr` is IPv6, or `--discv5.addr.ipv6` is set
|
||||||
|
|
||||||
[default: 9000]
|
[default: 9000]
|
||||||
|
|
||||||
--discovery.v5.lookup-interval <DISCOVERY_V5_LOOKUP_INTERVAL>
|
--discovery.v5.lookup-interval <DISCOVERY_V5_LOOKUP_INTERVAL>
|
||||||
The interval in seconds at which to carry out periodic lookup queries, for the whole run of the program
|
The interval in seconds at which to carry out periodic lookup queries, for the whole run of the program
|
||||||
|
|
||||||
[default: 60]
|
[default: 60]
|
||||||
|
|
||||||
--discovery.v5.bootstrap.lookup-interval <DISCOVERY_V5_bootstrap_lookup_interval>
|
--discovery.v5.bootstrap.lookup-interval <DISCOVERY_V5_bootstrap_lookup_interval>
|
||||||
The interval in seconds at which to carry out boost lookup queries, for a fixed number of times, at bootstrap
|
The interval in seconds at which to carry out boost lookup queries, for a fixed number of times, at bootstrap
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--discovery.v5.bootstrap.lookup-countdown <DISCOVERY_V5_bootstrap_lookup_countdown>
|
--discovery.v5.bootstrap.lookup-countdown <DISCOVERY_V5_bootstrap_lookup_countdown>
|
||||||
The number of times to carry out boost lookup queries at bootstrap
|
The number of times to carry out boost lookup queries at bootstrap
|
||||||
|
|
||||||
[default: 100]
|
[default: 100]
|
||||||
|
|
||||||
--trusted-peers <TRUSTED_PEERS>
|
--trusted-peers <TRUSTED_PEERS>
|
||||||
Comma separated enode URLs of trusted peers for P2P connections.
|
Comma separated enode URLs of trusted peers for P2P connections.
|
||||||
|
|
||||||
--trusted-peers enode://abcd@192.168.0.1:30303
|
--trusted-peers enode://abcd@192.168.0.1:30303
|
||||||
|
|
||||||
--trusted-only
|
--trusted-only
|
||||||
Connect only to trusted peers
|
Connect to or accept from trusted peers only
|
||||||
|
|
||||||
--bootnodes <BOOTNODES>
|
--bootnodes <BOOTNODES>
|
||||||
Comma separated enode URLs for P2P discovery bootstrap.
|
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.
|
||||||
|
|
||||||
--peers-file <FILE>
|
--peers-file <FILE>
|
||||||
@ -153,12 +159,12 @@ Networking:
|
|||||||
|
|
||||||
--identity <IDENTITY>
|
--identity <IDENTITY>
|
||||||
Custom node identity
|
Custom node identity
|
||||||
|
|
||||||
[default: reth/<VERSION>-<SHA>/<ARCH>]
|
[default: reth/<VERSION>-<SHA>/<ARCH>]
|
||||||
|
|
||||||
--p2p-secret-key <PATH>
|
--p2p-secret-key <PATH>
|
||||||
Secret key to use for this node.
|
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.
|
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
|
--no-persist-peers
|
||||||
@ -166,17 +172,17 @@ Networking:
|
|||||||
|
|
||||||
--nat <NAT>
|
--nat <NAT>
|
||||||
NAT resolution method (any|none|upnp|publicip|extip:\<IP\>)
|
NAT resolution method (any|none|upnp|publicip|extip:\<IP\>)
|
||||||
|
|
||||||
[default: any]
|
[default: any]
|
||||||
|
|
||||||
--addr <ADDR>
|
--addr <ADDR>
|
||||||
Network listening address
|
Network listening address
|
||||||
|
|
||||||
[default: 0.0.0.0]
|
[default: 0.0.0.0]
|
||||||
|
|
||||||
--port <PORT>
|
--port <PORT>
|
||||||
Network listening port
|
Network listening port
|
||||||
|
|
||||||
[default: 30303]
|
[default: 30303]
|
||||||
|
|
||||||
--max-outbound-peers <MAX_OUTBOUND_PEERS>
|
--max-outbound-peers <MAX_OUTBOUND_PEERS>
|
||||||
@ -186,15 +192,25 @@ Networking:
|
|||||||
Maximum number of inbound requests. default: 30
|
Maximum number of inbound requests. default: 30
|
||||||
|
|
||||||
--pooled-tx-response-soft-limit <BYTES>
|
--pooled-tx-response-soft-limit <BYTES>
|
||||||
Soft limit for the byte size of a `PooledTransactions` response on assembling a `GetPooledTransactions` request. Spec'd at 2 MiB.
|
Experimental, for usage in research. Sets the max accumulated byte size of transactions
|
||||||
|
to pack in one response.
|
||||||
<https://github.com/ethereum/devp2p/blob/master/caps/eth.md#protocol-messages>.
|
Spec'd at 2MiB.
|
||||||
|
|
||||||
[default: 2097152]
|
[default: 2097152]
|
||||||
|
|
||||||
--pooled-tx-pack-soft-limit <BYTES>
|
--pooled-tx-pack-soft-limit <BYTES>
|
||||||
Default soft limit for the byte size of a `PooledTransactions` response on assembling a `GetPooledTransactions` request. This defaults to less than the [`SOFT_LIMIT_BYTE_SIZE_POOLED_TRANSACTIONS_RESPONSE`], at 2 MiB, used when assembling a `PooledTransactions` response. Default is 128 KiB
|
Experimental, for usage in research. Sets the max accumulated byte size of transactions to
|
||||||
|
request in one request.
|
||||||
|
|
||||||
|
Since RLPx protocol version 68, the byte size of a transaction is shared as metadata in a
|
||||||
|
transaction announcement (see RLPx specs). This allows a node to request a specific size
|
||||||
|
response.
|
||||||
|
|
||||||
|
By default, nodes request only 128 KiB worth of transactions, but should a peer request
|
||||||
|
more, up to 2 MiB, a node will answer with more than 128 KiB.
|
||||||
|
|
||||||
|
Default is 128 KiB.
|
||||||
|
|
||||||
[default: 131072]
|
[default: 131072]
|
||||||
|
|
||||||
Database:
|
Database:
|
||||||
@ -213,12 +229,12 @@ Database:
|
|||||||
|
|
||||||
--db.exclusive <EXCLUSIVE>
|
--db.exclusive <EXCLUSIVE>
|
||||||
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
||||||
|
|
||||||
[possible values: true, false]
|
[possible values: true, false]
|
||||||
|
|
||||||
-c, --commit
|
-c, --commit
|
||||||
Commits the changes in the database. WARNING: potentially destructive.
|
Commits the changes in the database. WARNING: potentially destructive.
|
||||||
|
|
||||||
Useful when you want to run diagnostics on the database.
|
Useful when you want to run diagnostics on the database.
|
||||||
|
|
||||||
--checkpoints
|
--checkpoints
|
||||||
@ -227,7 +243,7 @@ Database:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -237,12 +253,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -252,22 +268,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -275,12 +291,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -291,7 +307,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
104
book/cli/reth/stage/unwind.md
vendored
104
book/cli/reth/stage/unwind.md
vendored
@ -14,33 +14,33 @@ Commands:
|
|||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -62,7 +62,7 @@ Database:
|
|||||||
|
|
||||||
--db.exclusive <EXCLUSIVE>
|
--db.exclusive <EXCLUSIVE>
|
||||||
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
Open environment in exclusive/monopolistic mode. Makes it possible to open a database on an NFS volume
|
||||||
|
|
||||||
[possible values: true, false]
|
[possible values: true, false]
|
||||||
|
|
||||||
Networking:
|
Networking:
|
||||||
@ -80,50 +80,56 @@ Networking:
|
|||||||
|
|
||||||
--discovery.addr <DISCOVERY_ADDR>
|
--discovery.addr <DISCOVERY_ADDR>
|
||||||
The UDP address to use for devp2p peer discovery version 4
|
The UDP address to use for devp2p peer discovery version 4
|
||||||
|
|
||||||
[default: 0.0.0.0]
|
[default: 0.0.0.0]
|
||||||
|
|
||||||
--discovery.port <DISCOVERY_PORT>
|
--discovery.port <DISCOVERY_PORT>
|
||||||
The UDP port to use for devp2p peer discovery version 4
|
The UDP port to use for devp2p peer discovery version 4
|
||||||
|
|
||||||
[default: 30303]
|
[default: 30303]
|
||||||
|
|
||||||
--discovery.v5.addr <DISCOVERY_V5_ADDR>
|
--discovery.v5.addr <DISCOVERY_V5_ADDR>
|
||||||
The UDP address to use for devp2p peer discovery version 5
|
The UDP IPv4 address to use for devp2p peer discovery version 5. Overwritten by RLPx address, if it's also IPv4
|
||||||
|
|
||||||
[default: 0.0.0.0]
|
--discovery.v5.addr.ipv6 <DISCOVERY_V5_ADDR_IPV6>
|
||||||
|
The UDP IPv6 address to use for devp2p peer discovery version 5. Overwritten by RLPx address, if it's also IPv6
|
||||||
|
|
||||||
--discovery.v5.port <DISCOVERY_V5_PORT>
|
--discovery.v5.port <DISCOVERY_V5_PORT>
|
||||||
The UDP port to use for devp2p peer discovery version 5
|
The UDP IPv4 port to use for devp2p peer discovery version 5. Not used unless `--addr` is IPv4, or `--discv5.addr` is set
|
||||||
|
|
||||||
|
[default: 9000]
|
||||||
|
|
||||||
|
--discovery.v5.port.ipv6 <DISCOVERY_V5_PORT_IPV6>
|
||||||
|
The UDP IPv6 port to use for devp2p peer discovery version 5. Not used unless `--addr` is IPv6, or `--discv5.addr.ipv6` is set
|
||||||
|
|
||||||
[default: 9000]
|
[default: 9000]
|
||||||
|
|
||||||
--discovery.v5.lookup-interval <DISCOVERY_V5_LOOKUP_INTERVAL>
|
--discovery.v5.lookup-interval <DISCOVERY_V5_LOOKUP_INTERVAL>
|
||||||
The interval in seconds at which to carry out periodic lookup queries, for the whole run of the program
|
The interval in seconds at which to carry out periodic lookup queries, for the whole run of the program
|
||||||
|
|
||||||
[default: 60]
|
[default: 60]
|
||||||
|
|
||||||
--discovery.v5.bootstrap.lookup-interval <DISCOVERY_V5_bootstrap_lookup_interval>
|
--discovery.v5.bootstrap.lookup-interval <DISCOVERY_V5_bootstrap_lookup_interval>
|
||||||
The interval in seconds at which to carry out boost lookup queries, for a fixed number of times, at bootstrap
|
The interval in seconds at which to carry out boost lookup queries, for a fixed number of times, at bootstrap
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--discovery.v5.bootstrap.lookup-countdown <DISCOVERY_V5_bootstrap_lookup_countdown>
|
--discovery.v5.bootstrap.lookup-countdown <DISCOVERY_V5_bootstrap_lookup_countdown>
|
||||||
The number of times to carry out boost lookup queries at bootstrap
|
The number of times to carry out boost lookup queries at bootstrap
|
||||||
|
|
||||||
[default: 100]
|
[default: 100]
|
||||||
|
|
||||||
--trusted-peers <TRUSTED_PEERS>
|
--trusted-peers <TRUSTED_PEERS>
|
||||||
Comma separated enode URLs of trusted peers for P2P connections.
|
Comma separated enode URLs of trusted peers for P2P connections.
|
||||||
|
|
||||||
--trusted-peers enode://abcd@192.168.0.1:30303
|
--trusted-peers enode://abcd@192.168.0.1:30303
|
||||||
|
|
||||||
--trusted-only
|
--trusted-only
|
||||||
Connect only to trusted peers
|
Connect to or accept from trusted peers only
|
||||||
|
|
||||||
--bootnodes <BOOTNODES>
|
--bootnodes <BOOTNODES>
|
||||||
Comma separated enode URLs for P2P discovery bootstrap.
|
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.
|
||||||
|
|
||||||
--peers-file <FILE>
|
--peers-file <FILE>
|
||||||
@ -132,12 +138,12 @@ Networking:
|
|||||||
|
|
||||||
--identity <IDENTITY>
|
--identity <IDENTITY>
|
||||||
Custom node identity
|
Custom node identity
|
||||||
|
|
||||||
[default: reth/<VERSION>-<SHA>/<ARCH>]
|
[default: reth/<VERSION>-<SHA>/<ARCH>]
|
||||||
|
|
||||||
--p2p-secret-key <PATH>
|
--p2p-secret-key <PATH>
|
||||||
Secret key to use for this node.
|
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.
|
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
|
--no-persist-peers
|
||||||
@ -145,17 +151,17 @@ Networking:
|
|||||||
|
|
||||||
--nat <NAT>
|
--nat <NAT>
|
||||||
NAT resolution method (any|none|upnp|publicip|extip:\<IP\>)
|
NAT resolution method (any|none|upnp|publicip|extip:\<IP\>)
|
||||||
|
|
||||||
[default: any]
|
[default: any]
|
||||||
|
|
||||||
--addr <ADDR>
|
--addr <ADDR>
|
||||||
Network listening address
|
Network listening address
|
||||||
|
|
||||||
[default: 0.0.0.0]
|
[default: 0.0.0.0]
|
||||||
|
|
||||||
--port <PORT>
|
--port <PORT>
|
||||||
Network listening port
|
Network listening port
|
||||||
|
|
||||||
[default: 30303]
|
[default: 30303]
|
||||||
|
|
||||||
--max-outbound-peers <MAX_OUTBOUND_PEERS>
|
--max-outbound-peers <MAX_OUTBOUND_PEERS>
|
||||||
@ -165,21 +171,31 @@ Networking:
|
|||||||
Maximum number of inbound requests. default: 30
|
Maximum number of inbound requests. default: 30
|
||||||
|
|
||||||
--pooled-tx-response-soft-limit <BYTES>
|
--pooled-tx-response-soft-limit <BYTES>
|
||||||
Soft limit for the byte size of a `PooledTransactions` response on assembling a `GetPooledTransactions` request. Spec'd at 2 MiB.
|
Experimental, for usage in research. Sets the max accumulated byte size of transactions
|
||||||
|
to pack in one response.
|
||||||
<https://github.com/ethereum/devp2p/blob/master/caps/eth.md#protocol-messages>.
|
Spec'd at 2MiB.
|
||||||
|
|
||||||
[default: 2097152]
|
[default: 2097152]
|
||||||
|
|
||||||
--pooled-tx-pack-soft-limit <BYTES>
|
--pooled-tx-pack-soft-limit <BYTES>
|
||||||
Default soft limit for the byte size of a `PooledTransactions` response on assembling a `GetPooledTransactions` request. This defaults to less than the [`SOFT_LIMIT_BYTE_SIZE_POOLED_TRANSACTIONS_RESPONSE`], at 2 MiB, used when assembling a `PooledTransactions` response. Default is 128 KiB
|
Experimental, for usage in research. Sets the max accumulated byte size of transactions to
|
||||||
|
request in one request.
|
||||||
|
|
||||||
|
Since RLPx protocol version 68, the byte size of a transaction is shared as metadata in a
|
||||||
|
transaction announcement (see RLPx specs). This allows a node to request a specific size
|
||||||
|
response.
|
||||||
|
|
||||||
|
By default, nodes request only 128 KiB worth of transactions, but should a peer request
|
||||||
|
more, up to 2 MiB, a node will answer with more than 128 KiB.
|
||||||
|
|
||||||
|
Default is 128 KiB.
|
||||||
|
|
||||||
[default: 131072]
|
[default: 131072]
|
||||||
|
|
||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -189,12 +205,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -204,22 +220,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -227,12 +243,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -243,7 +259,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
40
book/cli/reth/stage/unwind/num-blocks.md
vendored
40
book/cli/reth/stage/unwind/num-blocks.md
vendored
@ -8,38 +8,38 @@ Usage: reth stage unwind num-blocks [OPTIONS] <AMOUNT>
|
|||||||
|
|
||||||
Arguments:
|
Arguments:
|
||||||
<AMOUNT>
|
<AMOUNT>
|
||||||
|
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -48,7 +48,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -58,12 +58,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -73,22 +73,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -96,12 +96,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -112,7 +112,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
40
book/cli/reth/stage/unwind/to-block.md
vendored
40
book/cli/reth/stage/unwind/to-block.md
vendored
@ -8,38 +8,38 @@ Usage: reth stage unwind to-block [OPTIONS] <TARGET>
|
|||||||
|
|
||||||
Arguments:
|
Arguments:
|
||||||
<TARGET>
|
<TARGET>
|
||||||
|
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
--datadir <DATA_DIR>
|
--datadir <DATA_DIR>
|
||||||
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:
|
Defaults to the OS-specific data directory:
|
||||||
|
|
||||||
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
- Linux: `$XDG_DATA_HOME/reth/` or `$HOME/.local/share/reth/`
|
||||||
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
- Windows: `{FOLDERID_RoamingAppData}/reth/`
|
||||||
- macOS: `$HOME/Library/Application Support/reth/`
|
- macOS: `$HOME/Library/Application Support/reth/`
|
||||||
|
|
||||||
[default: default]
|
[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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -48,7 +48,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -58,12 +58,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -73,22 +73,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -96,12 +96,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -112,7 +112,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
32
book/cli/reth/test-vectors.md
vendored
32
book/cli/reth/test-vectors.md
vendored
@ -14,21 +14,21 @@ 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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -37,7 +37,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -47,12 +47,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -62,22 +62,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -85,12 +85,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -101,7 +101,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
32
book/cli/reth/test-vectors/tables.md
vendored
32
book/cli/reth/test-vectors/tables.md
vendored
@ -14,21 +14,21 @@ 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, sepolia, goerli, holesky, dev
|
mainnet, sepolia, goerli, holesky, dev
|
||||||
|
|
||||||
[default: mainnet]
|
[default: mainnet]
|
||||||
|
|
||||||
--instance <INSTANCE>
|
--instance <INSTANCE>
|
||||||
Add a new instance of a node.
|
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.
|
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.
|
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
|
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]
|
[default: 1]
|
||||||
|
|
||||||
-h, --help
|
-h, --help
|
||||||
@ -37,7 +37,7 @@ Options:
|
|||||||
Logging:
|
Logging:
|
||||||
--log.stdout.format <FORMAT>
|
--log.stdout.format <FORMAT>
|
||||||
The format to use for logs written to stdout
|
The format to use for logs written to stdout
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -47,12 +47,12 @@ Logging:
|
|||||||
|
|
||||||
--log.stdout.filter <FILTER>
|
--log.stdout.filter <FILTER>
|
||||||
The filter to use for logs written to stdout
|
The filter to use for logs written to stdout
|
||||||
|
|
||||||
[default: ]
|
[default: ]
|
||||||
|
|
||||||
--log.file.format <FORMAT>
|
--log.file.format <FORMAT>
|
||||||
The format to use for logs written to the log file
|
The format to use for logs written to the log file
|
||||||
|
|
||||||
[default: terminal]
|
[default: terminal]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -62,22 +62,22 @@ Logging:
|
|||||||
|
|
||||||
--log.file.filter <FILTER>
|
--log.file.filter <FILTER>
|
||||||
The filter to use for logs written to the log file
|
The filter to use for logs written to the log file
|
||||||
|
|
||||||
[default: debug]
|
[default: debug]
|
||||||
|
|
||||||
--log.file.directory <PATH>
|
--log.file.directory <PATH>
|
||||||
The path to put log files in
|
The path to put log files in
|
||||||
|
|
||||||
[default: <CACHE_DIR>/logs]
|
[default: <CACHE_DIR>/logs]
|
||||||
|
|
||||||
--log.file.max-size <SIZE>
|
--log.file.max-size <SIZE>
|
||||||
The maximum size (in MB) of one log file
|
The maximum size (in MB) of one log file
|
||||||
|
|
||||||
[default: 200]
|
[default: 200]
|
||||||
|
|
||||||
--log.file.max-files <COUNT>
|
--log.file.max-files <COUNT>
|
||||||
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
The maximum amount of log files that will be stored. If set to 0, background file logging is disabled
|
||||||
|
|
||||||
[default: 5]
|
[default: 5]
|
||||||
|
|
||||||
--log.journald
|
--log.journald
|
||||||
@ -85,12 +85,12 @@ Logging:
|
|||||||
|
|
||||||
--log.journald.filter <FILTER>
|
--log.journald.filter <FILTER>
|
||||||
The filter to use for logs written to journald
|
The filter to use for logs written to journald
|
||||||
|
|
||||||
[default: error]
|
[default: error]
|
||||||
|
|
||||||
--color <COLOR>
|
--color <COLOR>
|
||||||
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
Sets whether or not the formatter emits ANSI terminal escape codes for colors and other text formatting
|
||||||
|
|
||||||
[default: always]
|
[default: always]
|
||||||
|
|
||||||
Possible values:
|
Possible values:
|
||||||
@ -101,7 +101,7 @@ Logging:
|
|||||||
Display:
|
Display:
|
||||||
-v, --verbosity...
|
-v, --verbosity...
|
||||||
Set the minimum log level.
|
Set the minimum log level.
|
||||||
|
|
||||||
-v Errors
|
-v Errors
|
||||||
-vv Warnings
|
-vv Warnings
|
||||||
-vvv Info
|
-vvv Info
|
||||||
|
|||||||
Reference in New Issue
Block a user