Skip to content

Commit

Permalink
Engine API is enabled by default (#1411)
Browse files Browse the repository at this point in the history
* Engine API enabled by default

Signed-off-by: Tan Chee Keong <tanck2005@gmail.com>

* Revise engine api default

Signed-off-by: Tan Chee Keong <tanck2005@gmail.com>

* Apply suggestions from code review

Signed-off-by: Alexandra Tran Carrillo <12214231+alexandratran@users.noreply.github.com>

---------

Signed-off-by: Tan Chee Keong <tanck2005@gmail.com>
Signed-off-by: Alexandra Tran Carrillo <12214231+alexandratran@users.noreply.github.com>
Co-authored-by: Alexandra Tran Carrillo <12214231+alexandratran@users.noreply.github.com>
  • Loading branch information
chong-he and alexandratran committed Oct 5, 2023
1 parent 029faa4 commit 68fea25
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 16 deletions.
17 changes: 3 additions & 14 deletions docs/public-networks/how-to/use-engine-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,19 @@ tags:

## Configure the Engine API

To configure the Engine API:
The Engine API is enabled by default even if no consensus client configuration exists. You can configure the Engine API to:

- [Enable the Engine API](#enable-the-engine-api) (it's disabled by default).
- [Enable the JSON-RPC API](use-besu-api/index.md#enable-api-access). Ensure the [`ETH` method is enabled](use-besu-api/json-rpc.md#api-methods-enabled-by-default) (it's enabled by default).
- Specify the [service ports](#service-ports).
- Specify the [host allowlist](#host-allowlist).

```bash title="Example Engine API configuration"
besu --engine-rpc-enabled --rpc-http-enabled --engine-rpc-port=8551 --engine-host-allowlist=localhost,127.0.0.1 --engine-jwt-secret=jwt.hex
besu --engine-rpc-port=8551 --engine-host-allowlist=localhost,127.0.0.1 --engine-jwt-secret=jwt.hex
```

### Enable the Engine API

Enable the Engine API with the [`--engine-rpc-enabled`](../reference/cli/options.md#engine-rpc-enabled) CLI option.

:::note

The `--engine-rpc-enabled` CLI option enables the Engine API even if no consensus client configuration exists.

:::

### Service ports

To specify the port the Engine API service listens on for HTTP and WebSocket, use the [`--engine-rpc-port`](../reference/cli/options.md#engine-rpc-port) option. The default is `8551`.
To specify the port the Engine API service listens on for HTTP and WebSocket, use the [`--engine-rpc-port`](../reference/cli/options.md#engine-rpc-port) option. The default is `8551`. This option is useful when you have another execution engine running on port 8551, in which case you can specify Besu to use another port, for example, `--engine-rpc-port 8552`.

### Host allowlist

Expand Down
2 changes: 1 addition & 1 deletion docs/public-networks/reference/cli/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -657,7 +657,7 @@ engine-rpc-enabled=true
<!--/tabs-->
Enables or disables the [Engine API](../engine-api/index.md). The default is `false`.
Enables or disables the [Engine API](../engine-api/index.md). The default is `true`.
### `engine-rpc-port`
Expand Down
2 changes: 1 addition & 1 deletion docs/public-networks/reference/engine-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ tags:

:::info

Ensure you enable the Engine API methods with the [`--engine-rpc-enabled`](../cli/options.md#engine-rpc-enabled) CLI option.
The engine API is enabled by default.

:::

Expand Down

0 comments on commit 68fea25

Please sign in to comment.