From cb65a91ef0745547231908f2dfc2131b957dd03b Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Fri, 28 Nov 2025 11:12:22 +0000 Subject: [PATCH 1/2] standardizes t/f syntax Signed-off-by: m4sterbunny --- docs/public-networks/reference/cli/options.md | 74 ++++++++++--------- 1 file changed, 38 insertions(+), 36 deletions(-) diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md index f40650e8c5..ef65ce9921 100644 --- a/docs/public-networks/reference/cli/options.md +++ b/docs/public-networks/reference/cli/options.md @@ -187,7 +187,7 @@ For [`eth_gasPrice`](../api/index.md#eth_gasprice), to return the: ```bash ---auto-log-bloom-caching-enabled[=] +--auto-log-bloom-caching-enabled= ``` @@ -374,7 +374,7 @@ If you plan on querying historical blocks or state using the [JSON-RPC API](../a ```bash ---bonsai-limit-trie-logs-enabled=[=] +--bonsai-limit-trie-logs-enabled= ``` @@ -556,7 +556,7 @@ The default is `0`. ```bash ---color-enabled[=] +--color-enabled= ``` @@ -740,7 +740,7 @@ The `enrtree` URL of the DNS node list for [node discovery via DNS](https://eips ```bash ---discovery-enabled[=] +--discovery-enabled= ``` @@ -832,7 +832,7 @@ To allow all hostnames, use `"*"`. We don't recommend allowing all hostnames in ```bash ---engine-jwt-disabled[=] +--engine-jwt-disabled= ``` @@ -912,7 +912,7 @@ Shared secret used to authenticate [consensus clients](../../concepts/node-clien ```bash ---engine-rpc-enabled[= +--engine-rpc-enabled= ``` @@ -1335,7 +1335,7 @@ You can't use the [`--genesis-file`](#genesis-file) and [`--network`](#network) ```bash ---genesis-state-hash-cache-enabled=[=] +--genesis-state-hash-cache-enabled= ``` @@ -1421,7 +1421,7 @@ A list of comma-separated origin domain URLs for CORS validation. The default is ```bash ---graphql-http-enabled[=] +--graphql-http-enabled= ``` @@ -1548,7 +1548,7 @@ The port (TCP) on which GraphQL HTTP listens. The default is `8547`. Ports must ```bash ---graphql-mtls-enabled[=] +--graphql-mtls-enabled= ``` @@ -1588,7 +1588,7 @@ The default is `false`. ```bash ---graphql-tls-enabled[=] +--graphql-tls-enabled= ``` @@ -1792,7 +1792,7 @@ Show the help message and exit. ```bash ---history-expiry-prune[=] +--history-expiry-prune= ``` @@ -1935,7 +1935,7 @@ If a name is not specified, the name section is not included in the client ID. F ```bash ---json-pretty-print-enabled[=] +--json-pretty-print-enabled= ``` @@ -2179,7 +2179,7 @@ Other categories are `KVSTORE_ROCKSDB`, `KVSTORE_PRIVATE_ROCKSDB`, `KVSTORE_ROCK ```bash ---metrics-enabled[=] +--metrics-enabled= ``` @@ -2377,6 +2377,7 @@ metrics-push-enabled=true Enables or disables [push gateway integration]. You can't specify `--metrics-push-enabled` with [`--metrics-enabled`](#metrics-enabled). That is, you can enable either Prometheus polling or Prometheus push gateway support, but not both at once. + ### `metrics-push-host` @@ -2751,7 +2752,7 @@ fee recipient, if the consensus layer client doesn't provide any. ```bash ---miner-enabled[=] +--miner-enabled= ``` @@ -3081,7 +3082,7 @@ This option is ignored if [`--security-module`](#security-module) is set to a no ```bash ---p2p-enabled[=] +--p2p-enabled= ``` @@ -3291,7 +3292,7 @@ The default is `50`: limiting plugins to up to 50% of the total block creation t ```bash ---plugin-continue-on-error[=] +--plugin-continue-on-error= ``` @@ -3435,7 +3436,7 @@ The default is `null`. ```bash ---random-peer-priority-enabled[=] +--random-peer-priority-enabled= ``` @@ -3517,7 +3518,7 @@ The default is `false`. ```bash ---remote-connections-limit-enabled[=] +--remote-connections-limit-enabled= ``` @@ -3689,7 +3690,7 @@ Requires a peer with the specified block number to have the specified hash when ```bash ---revert-reason-enabled[=] +--revert-reason-enabled= ``` @@ -3941,7 +3942,8 @@ rpc-http-authentication-enabled=true -Enables or disables [authentication](../../how-to/use-besu-api/authenticate.md) for the JSON-RPC HTTP service. +Enables or disables [authentication](../../how-to/use-besu-api/authenticate.md) for the JSON-RPC HTTP service. + ### `rpc-http-authentication-jwt-algorithm` @@ -4091,7 +4093,7 @@ For testing and development purposes, use `"all"` or `"*"` to accept requests fr ```bash ---rpc-http-enabled[=] +--rpc-http-enabled= ``` @@ -4343,7 +4345,7 @@ The port (TCP) on which JSON-RPC HTTP listens. The default is `8545`. You must [ ```bash ---rpc-http-tls-ca-clients-enabled[=] +--rpc-http-tls-ca-clients-enabled= ``` @@ -4389,7 +4391,7 @@ You must enable client authentication using the [`--rpc-http-tls-client-auth-ena ```bash ---rpc-http-tls-client-auth-enabled[=] +--rpc-http-tls-client-auth-enabled= ``` @@ -4481,7 +4483,7 @@ The singular `--rpc-http-tls-cipher-suite` and plural `--rpc-http-tls-cipher-sui ```bash ---rpc-http-tls-enabled[=] +--rpc-http-tls-enabled= ``` @@ -5083,7 +5085,7 @@ rpc-ws-authentication-enabled=true Enables or disables [authentication](../../how-to/use-besu-api/authenticate.md) for the JSON-RPC WebSocket service. - + :::note `wscat` doesn't support headers. [Authentication](../../how-to/use-besu-api/authenticate.md) requires you to pass an authentication token in the request header. To use authentication with WebSockets, you need an app that supports headers. @@ -5180,7 +5182,7 @@ The [JWT provider's public key file] used for JSON-RPC WebSocket authentication ```bash ---rpc-ws-enabled[=] +--rpc-ws-enabled= ``` @@ -5431,7 +5433,7 @@ Required if [`--rpc-ws-ssl-keystore-type`](#rpc-ws-ssl-keystore-type) is `PEM`. ```bash ---rpc-ws-ssl-client-auth-enabled[=] +--rpc-ws-ssl-client-auth-enabled= ``` @@ -5481,7 +5483,7 @@ If using JKS or PKCS12, specify the truststore password using [`--rpc-ws-ssl-tru ```bash ---rpc-ws-ssl-enabled[=] +--rpc-ws-ssl-enabled= ``` @@ -5994,7 +5996,7 @@ The default is the node's local private key file specified using [`--node-privat ```bash ---snapsync-server-enabled[=] +--snapsync-server-enabled= ``` @@ -6032,7 +6034,7 @@ The default is `false`. ```bash ---snapsync-synchronizer-pre-checkpoint-headers-only-enabled[=] +--snapsync-synchronizer-pre-checkpoint-headers-only-enabled= ``` @@ -6073,7 +6075,7 @@ Setting this option to `false` increases sync time and disk space usage. ```bash ---snapsync-synchronizer-transaction-indexing-enabled[=] +--snapsync-synchronizer-transaction-indexing-enabled= ``` @@ -6159,7 +6161,7 @@ Static nodes JSON file containing the [static nodes](../../how-to/connect/static ```bash ---strict-tx-replay-protection-enabled[=] +--strict-tx-replay-protection-enabled= ``` @@ -6429,7 +6431,7 @@ The default is `100`. ```bash ---tx-pool-enable-balance-check[=] +--tx-pool-enable-balance-check= ``` @@ -6471,7 +6473,7 @@ The default is `false`. ```bash ---tx-pool-enable-save-restore[=] +--tx-pool-enable-save-restore= ``` @@ -6886,7 +6888,7 @@ all other pending transactions. ```bash ---tx-pool-no-local-priority[=] +--tx-pool-no-local-priority= ``` @@ -7120,7 +7122,7 @@ Prints version information and exits. ```bash ---version-compatibility-protection[=] +--version-compatibility-protection= ``` From 6942dcb3a86ae88ecebf75d6b44cfa10ff4694c6 Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Fri, 28 Nov 2025 11:22:03 +0000 Subject: [PATCH 2/2] adds missing defaults Signed-off-by: m4sterbunny --- docs/public-networks/reference/cli/options.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md index ef65ce9921..ddc2c78d9f 100644 --- a/docs/public-networks/reference/cli/options.md +++ b/docs/public-networks/reference/cli/options.md @@ -2374,10 +2374,12 @@ metrics-push-enabled=true -Enables or disables [push gateway integration]. +Enables or disables [push gateway integration]. The default is `false`. + +:::note You can't specify `--metrics-push-enabled` with [`--metrics-enabled`](#metrics-enabled). That is, you can enable either Prometheus polling or Prometheus push gateway support, but not both at once. - +::: ### `metrics-push-host` @@ -2962,7 +2964,7 @@ The predefined network configuration. The default is `mainnet`. Possible values include the following: -| Network | Chain | Type | Default sync mode | Consensus mechanism | Description | +| Network | Chain | Type | Default sync mode | Consensus mechanism | description | |:-----------|:------|:------------|:---------------------|:--------------------|:-------------------------------------------------------------------------------| | `mainnet` | ETH | Production | [`SNAP`](#sync-mode) | A PoS network | The main [Ethereum network](https://ethereum.org/en/developers/docs/networks/) | | `hoodi` | ETH | Test | [`SNAP`](#sync-mode) | A PoS network | Multi-client testnet [Hoodi](https://hoodi.ethpandaops.io/) | @@ -3942,8 +3944,7 @@ rpc-http-authentication-enabled=true -Enables or disables [authentication](../../how-to/use-besu-api/authenticate.md) for the JSON-RPC HTTP service. - +Enables or disables [authentication](../../how-to/use-besu-api/authenticate.md) for the JSON-RPC HTTP service. The default is `false`. ### `rpc-http-authentication-jwt-algorithm` @@ -5084,8 +5085,8 @@ rpc-ws-authentication-enabled=true -Enables or disables [authentication](../../how-to/use-besu-api/authenticate.md) for the JSON-RPC WebSocket service. - +Enables or disables [authentication](../../how-to/use-besu-api/authenticate.md) for the JSON-RPC WebSocket service. The default is `false`. + :::note `wscat` doesn't support headers. [Authentication](../../how-to/use-besu-api/authenticate.md) requires you to pass an authentication token in the request header. To use authentication with WebSockets, you need an app that supports headers.