diff --git a/docs/public-networks/reference/cli/subcommands.md b/docs/public-networks/reference/cli/subcommands.md index 2edad520f93..e6d331d51c6 100644 --- a/docs/public-networks/reference/cli/subcommands.md +++ b/docs/public-networks/reference/cli/subcommands.md @@ -91,67 +91,43 @@ If you omit `--start-block`, the default start block is 0 (the beginning of the If you are not running the command against the default network (Mainnet), specify the `--network` or `--genesis-file` parameter. -## `public-key` - -Provides node public key related actions. - -:::caution - -To get the public key or address of a node, ensure you use the [`--data-path`](options.md#data-path) or [`--node-private-key-file`](options.md#node-private-key-file) option with the `public-key` command. Otherwise, a new [node key](../../concepts/node-keys.md) is silently generated when starting Besu. +## `operator` -::: +Provides operator actions. -### `export` +### `generate-log-bloom-cache` # Syntax ```bash -besu public-key export [--node-private-key-file=] [--to=] [--ec-curve=] -``` - -# Example (to standard output) - -```bash -besu --data-path= public-key export --node-private-key-file=/home/me/me_node/myPrivateKey --ec-curve=secp256k1 +besu operator generate-log-bloom-cache [--start-block=] [--end-block=] ``` -# Example (to file) +# Example ```bash -besu --data-path= public-key export --node-private-key-file=/home/me/me_node/myPrivateKey --to=/home/me/me_project/not_precious_pub_key --ec-curve=secp256k1 +besu --network=goerli --data-path=/project/goerli operator generate-log-bloom-cache --start-block=0 --end-block=100000 ``` -Outputs the node public key to standard output or to the file specified by `--to=`. You can output the public key associated with a specific private key file using the [`--node-private-key-file`](options.md#node-private-key-file) option. The default elliptic curve used for the key is `secp256k1`. Use the `--ec-curve` option to choose between `secp256k1` or `secp256r1`. - -### `export-address` - - - -# Syntax +:::tip -```bash -besu public-key export-address [--node-private-key-file=] [--to=] [--ec-curve=] -``` +Manually executing `generate-log-bloom-cache` is not required unless you set the [`--auto-log-bloom-caching-enabled`](options.md#auto-log-bloom-caching-enabled) command line option to false. -# Example (to standard output) +::: -```bash -besu --data-path= public-key export-address --node-private-key-file=/home/me/me_node/myPrivateKey --ec-curve=secp256k1 -``` +Generates cached log bloom indexes for blocks. APIs use the cached indexes for improved log query performance. -# Example (to file) +:::note -```bash -besu --data-path= public-key export-address --node-private-key-file=/home/me/me_node/myPrivateKey --to=/home/me/me_project/me_node_address --ec-curve=secp256k1 -``` +Each index file contains 100000 blocks. The last fragment of blocks less that 100000 are not indexed. - +::: -Outputs the node address to standard output or to the file specified by `--to=`. You can output the address associated with a specific private key file using the [`--node-private-key-file`](options.md#node-private-key-file) option. The default elliptic curve used for the key is `secp256k1`. Use the `--ec-curve` option to choose between `secp256k1` or `secp256r1`. +To generate cached log bloom indexes while the node is running, use the [`admin_generateLogBloomCache`](../api/index.md#admin_generatelogbloomcache) API. ## `password` @@ -177,43 +153,67 @@ besu password hash --password=myPassword123 Generates the hash of a given password. Include the hash in the [credentials file](../../how-to/use-besu-api/authenticate.md#credentials-file) for JSON-RPC API [authentication](../../how-to/use-besu-api/authenticate.md). -## `operator` +## `public-key` -Provides operator actions. +Provides node public key related actions. -### `generate-log-bloom-cache` +:::caution + +To get the public key or address of a node, ensure you use the [`--data-path`](options.md#data-path) or [`--node-private-key-file`](options.md#node-private-key-file) option with the `public-key` command. Otherwise, a new [node key](../../concepts/node-keys.md) is silently generated when starting Besu. + +::: + +### `export` # Syntax ```bash -besu operator generate-log-bloom-cache [--start-block=] [--end-block=] +besu public-key export [--node-private-key-file=] [--to=] [--ec-curve=] ``` -# Example +# Example (to standard output) ```bash -besu --network=goerli --data-path=/project/goerli operator generate-log-bloom-cache --start-block=0 --end-block=100000 +besu --data-path= public-key export --node-private-key-file=/home/me/me_node/myPrivateKey --ec-curve=secp256k1 +``` + +# Example (to file) + +```bash +besu --data-path= public-key export --node-private-key-file=/home/me/me_node/myPrivateKey --to=/home/me/me_project/not_precious_pub_key --ec-curve=secp256k1 ``` -:::tip +Outputs the node public key to standard output or to the file specified by `--to=`. You can output the public key associated with a specific private key file using the [`--node-private-key-file`](options.md#node-private-key-file) option. The default elliptic curve used for the key is `secp256k1`. Use the `--ec-curve` option to choose between `secp256k1` or `secp256r1`. -Manually executing `generate-log-bloom-cache` is not required unless you set the [`--auto-log-bloom-caching-enabled`](options.md#auto-log-bloom-caching-enabled) command line option to false. +### `export-address` -::: + -Generates cached log bloom indexes for blocks. APIs use the cached indexes for improved log query performance. +# Syntax -:::note +```bash +besu public-key export-address [--node-private-key-file=] [--to=] [--ec-curve=] +``` -Each index file contains 100000 blocks. The last fragment of blocks less that 100000 are not indexed. +# Example (to standard output) -::: +```bash +besu --data-path= public-key export-address --node-private-key-file=/home/me/me_node/myPrivateKey --ec-curve=secp256k1 +``` -To generate cached log bloom indexes while the node is running, use the [`admin_generateLogBloomCache`](../api/index.md#admin_generatelogbloomcache) API. +# Example (to file) + +```bash +besu --data-path= public-key export-address --node-private-key-file=/home/me/me_node/myPrivateKey --to=/home/me/me_project/me_node_address --ec-curve=secp256k1 +``` + + + +Outputs the node address to standard output or to the file specified by `--to=`. You can output the address associated with a specific private key file using the [`--node-private-key-file`](options.md#node-private-key-file) option. The default elliptic curve used for the key is `secp256k1`. Use the `--ec-curve` option to choose between `secp256k1` or `secp256r1`. ## `retesteth` @@ -243,6 +243,33 @@ The command accepts the following command line options: - [`--rpc-http-port`](options.md#rpc-http-port) - [`--logging`](options.md#logging) +## `storage` + +Provides storage related actions. + +### `revert-variables` + + + +# Syntax + +```bash +besu storage revert-variables --config-file +``` + +# Example + +```bash +besu storage revert-variables --config-file ../besu-local-nodes/config/besu/besu1.conf +``` + + + +Reverts the modifications made by the [variables storage feature](https://github.com/hyperledger/besu/pull/5471). +If you need to downgrade Besu, first run this subcommand specifying the path to +the [configuration file](../../how-to/configuration-file.md) normally used to +start Besu. + ## `validate-config` @@ -261,4 +288,4 @@ besu validate-config --config-file ../besu-local-nodes/config/besu/besu1.conf -Performs basic syntax validation of the specified [TOML configuration file](../../how-to/configuration-file.md). Checks TOML syntax (for example, valid format and unmatched quotes) and flags unknown options. Doesn't check data types, and doesn't check dependencies between options (this is done at Besu startup). +Performs basic syntax validation of the specified [configuration file](../../how-to/configuration-file.md). Checks TOML syntax (for example, valid format and unmatched quotes) and flags unknown options. Doesn't check data types, and doesn't check dependencies between options (this is done at Besu startup).