Skip to main content

Engine API methods

Consensus and execution clients communicate with each other using the Engine API. When running Besu as an execution client, use these API calls to communicate with a consensus client.

info

The engine API is enabled by default.

See the Ethereum Engine API specification for more information. Not all changes to the Engine API are documented on this page.

Methods​

engine_exchangeCapabilities​

Exchanges a list of supported Engine API methods between the consensus client and Besu.

Parameters​

remoteCapabilities: array of strings - Engine API method names that the consensus client supports

Returns​

localCapabilities: array of strings - Engine API method names that Besu supports

curl -X POST --data '{"jsonrpc":"2.0","method":"engine_exchangeCapabilities","params":[["engine_exchangeTransitionConfigurationV1","engine_forkchoiceUpdatedV1","engine_getPayloadBodiesByHash","engine_getPayloadBodiesByRangeV1","engine_getPayloadV1","engine_newPayloadV1"]],"id":67}' http://127.0.0.1:8550

engine_exchangeTransitionConfigurationV1​

Sends the transition configuration to the consensus client to verify the configuration between both clients.

note

The execution client runs this call every 60 seconds in the background. The log displays a warning message if the call hasn't been sent in 120 seconds.

Parameters​

transitionConfiguration: object - Transition configuration object

Returns​

transitionConfiguration: object - Transition configuration object

curl -X POST --data '{"jsonrpc":"2.0","method":"engine_exchangeTransitionConfigurationV1","params":[{"terminalTotalDifficulty": 0, "terminalBlockHash": "0x0000000000000000000000000000000000000000000000000000000000000000", "terminalBlockNumber": "0x1"}],"id":67}' http://127.0.0.1:8550

engine_forkchoiceUpdatedV1​

Updates the fork choice with the consensus client.

Parameters​

Returns​

  • payloadStatus: object - Payload status object

  • payloadId: data - identifier of the payload build process or null

curl -X POST --data '{"jsonrpc":"2.0","method":"engine_forkchoiceUpdatedV1","params":[{"headBlockHash": "0x3559e851470f6e7bbed1db474980683e8c315bfce99b2a6ef47c057c04de7858", "safeBlockHash": "0x3559e851470f6e7bbed1db474980683e8c315bfce99b2a6ef47c057c04de7858", "finalizedBlockHash": "0x3b8fb240d288781d4aac94d3fd16809ee413bc99294a085798a589dae51ddd4a"},null],"id":67}' http://127.0.0.1:8550

engine_getPayloadBodiesByHashV1​

Returns the bodies of the execution payloads corresponding to the specified block hashes.

Parameters​

blockHashes: array of strings - Block hashes

Returns​

engineGetPayloadBodiesResultV1: array of objects - Execution payload body objects

curl -X POST --data '{"jsonrpc":"2.0","method":"engine_getPayloadBodiesByHashV1","params":[["0xd5f1812548be429cbdc6376b29611fc49e06f1359758c4ceaaa3b393e2239f9c","0xfe88c94d860f01a17f961bf4bdfb6e0c6cd10d3fda5cc861e805ca1240c58553"]],"id":1}' http://127.0.0.1:8550

engine_getPayloadBodiesByRangeV1​

Returns the bodies of the execution payloads corresponding to the specified range of block numbers.

Parameters​

  • startBlockNumber: string - Number of the starting block of the range, as a hexadecimal string

  • count: string - Number of blocks in the range (including the starting block), as a hexadecimal string

Returns​

engineGetPayloadBodiesResultV1: array of objects - Execution payload body objects

curl -X POST --data '{"jsonrpc":"2.0","method":"engine_getPayloadBodiesByRangeV1","params":["0x20", "0x2"],"id":1}' http://127.0.0.1:8550

engine_getPayloadV1​

Prepares the payload to send to the consensus client.

Parameters​

payloadId: data - Identifier of the payload build process

Returns​

executionPayload: object - Execution payload object

curl -X POST --data '{"jsonrpc":"2.0","method":"engine_getPayloadV1","params":["0x0000000021f32cc1"],"id":1}' http://127.0.0.1:8550

engine_newPayloadV1​

Executes the payload with the consensus client.

Parameters​

executionPayload: object - Execution payload object

Returns​

curl -X POST --data '{"jsonrpc":"2.0","method":"engine_newPayloadV1","params":[
  {
    "parentHash": "0x3b8fb240d288781d4aac94d3fd16809ee413bc99294a085798a589dae51ddd4a",
    "feeRecipient": "0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b",
    "stateRoot": "0xca3149fa9e37db08d1cd49c9061db1002ef1cd58db2210f2115c8c989b2bdf45",
    "receiptsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
    "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
    "prevRandao": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "blockNumber": "0x1",
    "gasLimit": "0x1c9c380",
    "gasUsed": "0x0",
    "timestamp": "0x5",
    "extraData": "0x",
    "baseFeePerGas": "0x7",
    "blockHash": "0x3559e851470f6e7bbed1db474980683e8c315bfce99b2a6ef47c057c04de7858",
    "transactions": []
  }
],"id":67}' http://127.0.0.1:8550