Engine API is enabled by default (#1411)

* Engine API enabled by default Signed-off-by: Tan Chee Keong <[email protected]> * Revise engine api default Signed-off-by: Tan Chee Keong <[email protected]> * Apply suggestions from code review Signed-off-by: Alexandra Tran Carrillo <[email protected]> --------- Signed-off-by: Tan Chee Keong <[email protected]> Signed-off-by: Alexandra Tran Carrillo <[email protected]> Co-authored-by: Alexandra Tran Carrillo <[email protected]>
hyperledger · Oct 5, 2023 · 68fea25 · 68fea25
1 parent 029faa4
commit 68fea25
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 16 deletions.
diff --git a/docs/public-networks/how-to/use-engine-api.md b/docs/public-networks/how-to/use-engine-api.md
@@ -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
 

diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md
@@ -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`
 

diff --git a/docs/public-networks/reference/engine-api/index.md b/docs/public-networks/reference/engine-api/index.md
@@ -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.
 
 :::
-Original file 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 @@