diff --git a/docs/private-networks/get-started/install/run-docker-image.md b/docs/private-networks/get-started/install/run-docker-image.md index af55a7e358..1f57a70dfc 100644 --- a/docs/private-networks/get-started/install/run-docker-image.md +++ b/docs/private-networks/get-started/install/run-docker-image.md @@ -101,6 +101,8 @@ This happens when the IPv6 support in Docker is disabled while connecting to an ### Run a node for testing + + To run a node that mines blocks at a rate suitable for testing purposes with WebSocket enabled: ```bash diff --git a/docs/private-networks/get-started/start-node.md b/docs/private-networks/get-started/start-node.md index e03b5126bb..014e95f42a 100644 --- a/docs/private-networks/get-started/start-node.md +++ b/docs/private-networks/get-started/start-node.md @@ -60,6 +60,8 @@ If you started Besu with the [`--rpc-http-enabled`](../../public-networks/refere ## Run a node for testing + + To run a node that mines blocks at a rate suitable for testing purposes: ```bash diff --git a/docs/private-networks/how-to/configure/consensus/clique.md b/docs/private-networks/how-to/configure/consensus/clique.md index d6d2cd4d56..70d70772bb 100644 --- a/docs/private-networks/how-to/configure/consensus/clique.md +++ b/docs/private-networks/how-to/configure/consensus/clique.md @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem'; # Configure Clique consensus -Besu implements the [Clique](https://eips.ethereum.org/EIPS/eip-225) proof of authority (PoA) [consensus protocol](index.md). Private networks can use Clique. +Besu implements the [Clique](https://eips.ethereum.org/EIPS/eip-225) proof of authority (PoA) [consensus protocol](index.md). You can [create a private network using Clique](../../../tutorials/clique.md). :::danger @@ -23,8 +23,6 @@ Clique is not suitable for production environments. Use only in development envi In Clique networks, approved accounts, known as signers, validate transactions and blocks. Signers take turns to create the next block. Existing signers propose and vote to [add or remove signers](#add-and-remove-signers). -You can [create a private network using Clique](../../../tutorials/clique.md). - ## Genesis file To use Clique in a private network, Besu requires a Clique [genesis file](../../../../public-networks/concepts/genesis-file.md). diff --git a/docs/private-networks/how-to/monitor/opentelemetry.md b/docs/private-networks/how-to/monitor/opentelemetry.md index 292655c7a1..7e73dcfdb4 100644 --- a/docs/private-networks/how-to/monitor/opentelemetry.md +++ b/docs/private-networks/how-to/monitor/opentelemetry.md @@ -147,6 +147,8 @@ You can also install exporters that send system metrics to OpenTelemetry to moni 2. Start Besu with the [`--metrics-enabled`](../../../public-networks/reference/cli/options.md#metrics-enabled) and [`--metrics-protocol=opentelemetry`](../../../public-networks/reference/cli/options.md#metrics-protocol) options. For example, run the following command to start a single node: + + diff --git a/docs/private-networks/how-to/monitor/splunk.md b/docs/private-networks/how-to/monitor/splunk.md index cffe6d4c74..efd9ea28b4 100644 --- a/docs/private-networks/how-to/monitor/splunk.md +++ b/docs/private-networks/how-to/monitor/splunk.md @@ -83,6 +83,8 @@ If running [Besu as a Docker container](../../get-started/install/run-docker-ima 3. Run Besu. To start a Besu node running in development mode, run the following command: + + ```bash LOGGER=Splunk \ SPLUNK_URL=https://localhost:8088 \ diff --git a/docs/private-networks/reference/cli/options.md b/docs/private-networks/reference/cli/options.md index ab41cf2fbd..d354547350 100644 --- a/docs/private-networks/reference/cli/options.md +++ b/docs/private-networks/reference/cli/options.md @@ -35,7 +35,7 @@ You can specify Besu options: - `_` replaces `-`. - Has a `BESU_` prefix. - For example, set `--miner-coinbase` using the `BESU_MINER_COINBASE` environment variable. +For example, set `--rpc-http-enabled` using the `BESU_RPC_HTTP_ENABLED` environment variable. - In a [configuration file](../../../public-networks/how-to/configure-besu/index.md). diff --git a/docs/public-networks/get-started/install/run-docker-image.md b/docs/public-networks/get-started/install/run-docker-image.md index 4348b0cf41..83ef2b0950 100644 --- a/docs/public-networks/get-started/install/run-docker-image.md +++ b/docs/public-networks/get-started/install/run-docker-image.md @@ -104,6 +104,8 @@ This happens when the IPv6 support in Docker is disabled while connecting to an ### Run a node for testing + + To run a node that mines blocks at a rate suitable for testing purposes with WebSocket enabled: ```bash diff --git a/docs/public-networks/get-started/start-node.md b/docs/public-networks/get-started/start-node.md index 4d9d5adfd4..d283d7aa6e 100644 --- a/docs/public-networks/get-started/start-node.md +++ b/docs/public-networks/get-started/start-node.md @@ -54,6 +54,7 @@ By default, Besu stores data in the [Bonsai Tries format](../concepts/data-stora ## Run a node for testing + To run a node that mines blocks at a rate suitable for testing purposes: ```bash diff --git a/docs/public-networks/how-to/monitor/metrics.md b/docs/public-networks/how-to/monitor/metrics.md index ad7795f885..df8838e782 100644 --- a/docs/public-networks/how-to/monitor/metrics.md +++ b/docs/public-networks/how-to/monitor/metrics.md @@ -87,18 +87,20 @@ To configure Prometheus and run with Besu: 2. Start Besu with the [`--metrics-enabled`](../../reference/cli/options.md#metrics-enabled) option. To start a single node for testing with metrics enabled, run the following command: + + ```bash - besu --network=dev --miner-enabled --miner-coinbase --rpc-http-cors-origins="all" --rpc-http-enabled --metrics-enabled + besu --network=dev --rpc-http-cors-origins="all" --rpc-http-enabled --metrics-enabled ``` ```bash - besu --network=dev --miner-enabled --miner-coinbase fe3b557e8fb62b89f4916b721be55ceb828dbd73 --rpc-http-cors-origins="all" --rpc-http-enabled --metrics-enabled + besu --network=dev --rpc-http-cors-origins="all" --rpc-http-enabled --metrics-enabled ``` diff --git a/docs/public-networks/reference/api/index.md b/docs/public-networks/reference/api/index.md index 9ab55b46d2..e189931102 100644 --- a/docs/public-networks/reference/api/index.md +++ b/docs/public-networks/reference/api/index.md @@ -2601,56 +2601,6 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_config","params":[],"id":1}' -### `eth_coinbase` - -Returns the client coinbase address. The coinbase address is the account to pay mining rewards to. - -To set a coinbase address, start Besu with the `--miner-coinbase` option set to a valid Ethereum account address. You can get the Ethereum account address from a client such as MetaMask or Etherscan. For example: - -```bash title="Example" -besu --miner-coinbase="0xfe3b557e8fb62b89f4916b721be55ceb828dbd73" --rpc-http-enabled -``` - -#### Parameters - -None - -#### Returns - -`result`: _string_ - coinbase address - - - - - -```bash -curl -X POST --data '{"jsonrpc":"2.0","method":"eth_coinbase","params":[],"id":53}' http://127.0.0.1:8545/ -H "Content-Type: application/json" -``` - - - - - -```json -{ "jsonrpc": "2.0", "method": "eth_coinbase", "params": [], "id": 53 } -``` - - - - - -```json -{ - "jsonrpc": "2.0", - "id": 53, - "result": "0xfe3b557e8fb62b89f4916b721be55ceb828dbd73" -} -``` - - - - - ### `eth_createAccessList` Creates an [EIP-2930](https://eips.ethereum.org/EIPS/eip-2930) access list that you can [include in a transaction](../../concepts/transactions/types.md#access_list-transactions). @@ -6846,95 +6796,6 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"miner_setMinPriorityFee","params -### `miner_start` (Deprecated) - -Starts the mining process. -To start mining, you must first specify a miner coinbase using the [`--miner-coinbase`](../cli/options.md#miner-coinbase) command line option or using [`miner_setCoinbase`](#miner_setcoinbase). - -#### Parameters - -None - -#### Returns - -`result`: _boolean_ - `true` if mining starts, or if the node is already mining - - - - - -```bash -curl -X POST --data '{"jsonrpc":"2.0","method":"miner_start","params":[],"id":1}' http://127.0.0.1:8545/ -H "Content-Type: application/json" -``` - - - - - -```json -{ "jsonrpc": "2.0", "method": "miner_start", "params": [], "id": 1 } -``` - - - - - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "result": true -} -``` - - - - - -### `miner_stop` (Deprecated) - -Stops the mining process on the client. - -#### Parameters - -None - -#### Returns - -`result`: _boolean_ - `true` if mining stops, or if the node is not mining - - - - - -```bash -curl -X POST --data '{"jsonrpc":"2.0","method":"miner_stop","params":[],"id":1}' http://127.0.0.1:8545/ -H "Content-Type: application/json" -``` - - - - - -```json -{ "jsonrpc": "2.0", "method": "miner_stop", "params": [], "id": 1 } -``` - - - - - -```json -{ - "jsonrpc": "2.0", - "id": 1, - "result": true -} -``` - - - - - ## `NET` methods The `NET` API methods provide network-related information. diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md index c3095584e7..a3f6f4f237 100644 --- a/docs/public-networks/reference/cli/options.md +++ b/docs/public-networks/reference/cli/options.md @@ -35,7 +35,7 @@ You can specify Besu options: - `_` replaces `-`. - Has a `BESU_` prefix. - For example, set `--miner-coinbase` using the `BESU_MINER_COINBASE` environment variable. + For example, set `--rpc-http-enabled` using the `BESU_RPC_HTTP_ENABLED` environment variable. - In a [configuration file](../../how-to/configure-besu/index.md). @@ -2734,97 +2734,6 @@ For a running node, use: * [`miner_getMinPriorityFee`](../api/index.md#miner_getminpriorityfee) to get the value. * [`miner_setMinPriorityFee`](../api/index.md#miner_setminpriorityfee) to change the value. -### `miner-coinbase` - - - - - -```bash ---miner-coinbase= -``` - - - - - -```bash ---miner-coinbase=fe3b557e8fb62b89f4916b721be55ceb828dbd73 -``` - - - - - -```bash -BESU_MINER_COINBASE=fe3b557e8fb62b89f4916b721be55ceb828dbd73 -``` - - - - - -```bash -miner-coinbase="0xfe3b557e8fb62b89f4916b721be55ceb828dbd73" -``` - - - - - -The account you pay mining rewards to. -You must specify a valid coinbase when you enable mining using the -[`--miner-enabled`](#miner-enabled) option or the [`miner_start`](../api/index.md#miner_start-deprecated) -JSON-RPC API method. - -:::note - -Besu ignores this option in [proof-of-authority](../../../private-networks/concepts/poa.md) networks. -In proof-of-stake networks, such as Ethereum Mainnet, this option is used as a last resort for the -fee recipient, if the consensus layer client doesn't provide any. - -::: - -### `miner-enabled` - - - - - -```bash ---miner-enabled[=] -``` - - - - - -```bash ---miner-enabled=true -``` - - - - - -```bash -BESU_MINER_ENABLED=true -``` - - - - - -```bash -miner-enabled=true -``` - - - - - -Enables or disables mining when you start the node. The default is `false`. - ### `miner-extra-data`