Skip to content

1875 remv miner cli options #1882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

1875 remv miner cli options #1882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f75227a
first pass to consider affected pages
m4sterbunny Nov 28, 2025
99ac4ef
fix for build
m4sterbunny Nov 28, 2025
40d21e4
responds to review
m4sterbunny Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/private-networks/get-started/install/run-docker-image.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,8 @@ This happens when the IPv6 support in Docker is disabled while connecting to an

### Run a node for testing

<!-- does it make sense to support "run a node that mines blocks" for current Besu? -->
Copy link
Contributor

@bgravenorst bgravenorst Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we remove the comments from this PR?


To run a node that mines blocks at a rate suitable for testing purposes with WebSocket enabled:

```bash
Expand Down
2 changes: 2 additions & 0 deletions docs/private-networks/get-started/start-node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ If you started Besu with the [`--rpc-http-enabled`](../../public-networks/refere

## Run a node for testing

<!-- does it make sense to support "run a node that mines blocks" for current Besu? -->

To run a node that mines blocks at a rate suitable for testing purposes:

```bash
Expand Down
4 changes: 1 addition & 3 deletions docs/private-networks/how-to/configure/consensus/clique.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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).
Expand Down
2 changes: 2 additions & 0 deletions docs/private-networks/how-to/monitor/opentelemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

<!-- do these docs need updating to remove deprecated --miner-enabled --miner-coinbase <COINBASE ADDRESS> -->

<Tabs>

<TabItem value="Syntax" label="Syntax" default>
Expand Down
2 changes: 2 additions & 0 deletions docs/private-networks/how-to/monitor/splunk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

<!-- do these docs need updating to remove deprecated --miner-enabled --miner-coinbase <COINBASE ADDRESS> -->

```bash
LOGGER=Splunk \
SPLUNK_URL=https://localhost:8088 \
Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/reference/cli/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 2 additions & 0 deletions docs/public-networks/get-started/install/run-docker-image.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ This happens when the IPv6 support in Docker is disabled while connecting to an

### Run a node for testing

<!-- do these docs need updating to remove deprecated --miner-enabled --miner-coinbase <COINBASE ADDRESS> -->

To run a node that mines blocks at a rate suitable for testing purposes with WebSocket enabled:

```bash
Expand Down
1 change: 1 addition & 0 deletions docs/public-networks/get-started/start-node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ By default, Besu stores data in the [Bonsai Tries format](../concepts/data-stora

## Run a node for testing

<!-- do these docs need updating to remove deprecated --miner-enabled --miner-coinbase <COINBASE ADDRESS> -->
To run a node that mines blocks at a rate suitable for testing purposes:

```bash
Expand Down
6 changes: 4 additions & 2 deletions docs/public-networks/how-to/monitor/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

<!-- can I remove the --miner-enabled --miner-coinbase flags -->

<Tabs>
<TabItem value="Syntax">

```bash
besu --network=dev --miner-enabled --miner-coinbase <COINBASE ADDRESS> --rpc-http-cors-origins="all" --rpc-http-enabled --metrics-enabled
besu --network=dev --rpc-http-cors-origins="all" --rpc-http-enabled --metrics-enabled
```

</TabItem>
<TabItem value="Example">

```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
```

</TabItem>
Expand Down
139 changes: 0 additions & 139 deletions docs/public-networks/reference/api/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2601,56 +2601,6 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_config","params":[],"id":1}'

</Tabs>

### `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

<Tabs>

<TabItem value="curl HTTP request" label="curl HTTP request" default>

```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"
```

</TabItem>

<TabItem value="wscat WS request" label="wscat WS request">

```json
{ "jsonrpc": "2.0", "method": "eth_coinbase", "params": [], "id": 53 }
```

</TabItem>

<TabItem value="JSON result" label="JSON result">

```json
{
"jsonrpc": "2.0",
"id": 53,
"result": "0xfe3b557e8fb62b89f4916b721be55ceb828dbd73"
}
```

</TabItem>

</Tabs>

### `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).
Expand Down Expand Up @@ -6846,95 +6796,6 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"miner_setMinPriorityFee","params

</Tabs>

### `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

<Tabs>

<TabItem value="curl HTTP request" label="curl HTTP request" default>

```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"
```

</TabItem>

<TabItem value="wscat WS request" label="wscat WS request">

```json
{ "jsonrpc": "2.0", "method": "miner_start", "params": [], "id": 1 }
```

</TabItem>

<TabItem value="JSON result" label="JSON result">

```json
{
"jsonrpc": "2.0",
"id": 1,
"result": true
}
```

</TabItem>

</Tabs>

### `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

<Tabs>

<TabItem value="curl HTTP request" label="curl HTTP request" default>

```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"
```

</TabItem>

<TabItem value="wscat WS request" label="wscat WS request">

```json
{ "jsonrpc": "2.0", "method": "miner_stop", "params": [], "id": 1 }
```

</TabItem>

<TabItem value="JSON result" label="JSON result">

```json
{
"jsonrpc": "2.0",
"id": 1,
"result": true
}
```

</TabItem>

</Tabs>

## `NET` methods

The `NET` API methods provide network-related information.
Expand Down
93 changes: 1 addition & 92 deletions docs/public-networks/reference/cli/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down Expand Up @@ -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`

<Tabs>

<TabItem value="Syntax" label="Syntax" default>

```bash
--miner-coinbase=<Ethereum account address>
```

</TabItem>

<TabItem value="Example" label="Example">

```bash
--miner-coinbase=fe3b557e8fb62b89f4916b721be55ceb828dbd73
```

</TabItem>

<TabItem value="Environment variable" label="Environment variable">

```bash
BESU_MINER_COINBASE=fe3b557e8fb62b89f4916b721be55ceb828dbd73
```

</TabItem>

<TabItem value="Configuration file" label="Configuration file">

```bash
miner-coinbase="0xfe3b557e8fb62b89f4916b721be55ceb828dbd73"
```

</TabItem>

</Tabs>

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`

<Tabs>

<TabItem value="Syntax" label="Syntax" default>

```bash
--miner-enabled[=<true|false>]
```

</TabItem>

<TabItem value="Example" label="Example">

```bash
--miner-enabled=true
```

</TabItem>

<TabItem value="Environment variable" label="Environment variable">

```bash
BESU_MINER_ENABLED=true
```

</TabItem>

<TabItem value="Configuration file" label="Configuration file">

```bash
miner-enabled=true
```

</TabItem>

</Tabs>

Enables or disables mining when you start the node. The default is `false`.

### `miner-extra-data`

<Tabs>
Expand Down
Loading