feature: implement eth_simulateV1 #8406

Gabriel-Trintinalia · 2025-03-12T07:13:09Z

PR description

Adds support for eth_simulateV1

Spec: ethereum/execution-apis#484
Fixes: #6203

Currently passing 87/97 hive tests

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

…Trintinalia/besu into fill-gaps-between-calls

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Copilot

Pull Request Overview

This PR implements support for eth_simulateV1 by introducing new parameter and result classes, updating related method implementations, and adding accompanying tests. Key changes include:

New JSON-RPC parameter and result classes for simulation (e.g. JsonBlockStateCallParameter, SimulateV1Parameter, BlockStateCallResult).
Updates to the EthSimulateV1 method and registration in the RPC methods.
Modifications in existing classes (e.g. BlockOverridesParameter, TransactionCompleteResult) and test updates to support simulation.

Reviewed Changes

Copilot reviewed 44 out of 44 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/parameters/JsonBlockStateCallParameter.java	New parameter class for block state calls in simulation.
ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/parameters/SimulateV1Parameter.java	New parameter class for eth_simulateV1.
ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/bonsai/EthSimulateV1BySpecTest.java	New Bonsai tests for simulation.
ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/parameters/SimulateV1ParameterTest.java	New tests verifying validation errors and parameter ordering.
ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/BlockStateCallResult.java	New result class for simulation responses.
ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/TransactionCompleteResult.java	Adjusted access list handling in simulation transaction response.
ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/EthSimulateV1Test.java	Test cases validating the EthSimulateV1 method behavior.
ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/EthSimulateV1.java	Implementation of the new eth_simulateV1 JSON-RPC method.
ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/parameters/BlockOverridesParameter.java	Renamed parameter and updated handling for mixHash/prevRandao input.
ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/AbstractJsonRpcHttpServiceTest.java	Updated service test configuration to use DEFAULT_GAS_CAP.
besu/src/main/java/org/hyperledger/besu/services/BlockSimulatorServiceImpl.java	Introduced fake signature logic and refactored simulation parameter creation.
consensus/qbft/src/test/java/org/hyperledger/besu/consensus/qbft/validator/ValidatorContractControllerTest.java	Adjusted test calls with additional Optional.empty() parameter.
datatypes/src/main/java/org/hyperledger/besu/datatypes/StateOverride.java	Added builder method documentation block.
ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/BlockResult.java	Removed outdated call processing results field from BlockResult.
ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/CallProcessingResult.java	Refactored error handling to use JsonRpcError.
ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/methods/EthJsonRpcMethods.java	Registered EthSimulateV1 in the available RPC methods.
ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/RpcMethod.java	Added ETH_SIMULATE_V1 as a supported RPC method.
ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/methods/JsonRpcMethodsFactory.java	Updated method factory to pass miningConfiguration for simulation.

Comments suppressed due to low confidence (1)

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/parameters/BlockOverridesParameter.java:73

Ensure that falling back to 'prevRandao' when 'mixHash' is not present is appropriate given the changed type from Optional to Optional. Consider applying an explicit type conversion or validation to avoid potential runtime type issues.

mixHash.isPresent() ? mixHash : prevRandao);

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

macfarla

few comments. needs a changelog entry

.../src/main/java/org/hyperledger/besu/ethereum/transaction/exceptions/BlockStateCallError.java

evm/src/main/java/org/hyperledger/besu/evm/tracing/EthTransferLogOperationTracer.java

plugin-api/src/main/java/org/hyperledger/besu/plugin/data/BlockOverrides.java

fab-10

Partial review. A question about support for pending block tag

fab-10 · 2025-03-24T14:07:06Z

.../src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/EthSimulateV1.java

+  }
+
+  @Override
+  protected BlockParameterOrBlockHash blockParameterOrBlockHash(


Should this method also support pending as block tag?

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

fab-10

LGTM, some minor optimizations, the open question about the behavior of the pending block tag, and what about the remaining failing Hive tests.

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/transaction/BlockSimulator.java

fab-10 · 2025-03-27T09:08:02Z

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/transaction/BlockSimulator.java


    BlockHeader finalBlockHeader =
        BlockHeaderBuilder.createDefault()
            .populateFrom(blockHeader)
            .ommersHash(BodyValidation.ommersHash(List.of()))
-            .stateRoot(blockOverrides.getStateRoot().orElseGet(ws::rootHash))
+            .stateRoot(blockOverrides.getStateRoot().orElseGet(ws::frontierRootHash))


why frontierRootHash?

@fab-10 Good question! Since eth_simulationV1 can simulate up to 256 blocks in the future, I need to retain the changes from each block in the accumulator to build the next block, while also needing the state root to construct the block header. The Frontier Root Hash does not clear the accumulator as the rootHash method does. One option could be to rename it to "intermediateRootHash." Perhaps @matkt has a better suggestion on how I could achieve this?

why you need to keep what you have in the accumulator ? you just have to persist in your worldstate for each block and start with empty accumulator for each block . no ?

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/transaction/TransactionSimulator.java

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Gabriel-Trintinalia · 2025-03-27T23:36:23Z

@fab-10 Thanks for the review. I have addressed the suggestions. Regarding the pending block, eth_simulateV1 will simulate a full block. So when the user chooses "latest", the block simulator will create a pending block whose parent is the latest. So this means that running the simulation on the pending tag would actually skip one block number. If this is required, it can be achieved by overriding the block number using the blockOverrides to the latest + 2. The outcome will be two blocks, one which is an empty block, and another with the actual simulation with the empty block as a parent.

fab-10 · 2025-03-28T09:20:02Z

@fab-10 Thanks for the review. I have addressed the suggestions. Regarding the pending block, eth_simulateV1 will simulate a full block. So when the user chooses "latest", the block simulator will create a pending block whose parent is the latest. So this means that running the simulation on the pending tag would actually skip one block number. If this is required, it can be achieved by overriding the block number using the blockOverrides to the latest + 2. The outcome will be two blocks, one which is an empty block, and another with the actual simulation with the empty block as a parent.

Fine to ship for me

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Gabriel-Trintinalia added 26 commits March 4, 2025 19:08

change parameter type

e63a2d1

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Fill gap between blockStateCalls

9a11471

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Fix comment

e9ce69b

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Fix comment

29eb7f0

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Merge branch 'main' into fill-gaps-between-calls

88e6497

Fix known api hash

1d50f75

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Merge branch 'fill-gaps-between-calls' of https://github.com/Gabriel-…

a50e5ca

…Trintinalia/besu into fill-gaps-between-calls

Initial code

1ca6c52

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Initial code

b8d8200

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Fix BlockOverrides parameters

7629e9c

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Revert change to signature

f40d182

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Merge branch 'main' into refactor-block-simulator

e8be8cd

fix known hash

abfad29

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

merge main into branch

03378dc

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Fix merge issue

cf8a1d5

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Fix known hash

9f51eeb

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

fix unit tests

ceb8e38

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

fix spotless

29cc8ed

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Initial code

97eeba7

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Merge branch 'main' into add-eth-simulateV1

4b360e3

Initial code

60160e1

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Initial code

1a068bc

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Fix test

6adfda9

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Fix javadoc

3eb07be

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Fix error

e6f6950

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Merge main into branch

faf9a17

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Gabriel-Trintinalia requested a review from Copilot March 12, 2025 07:13

Copilot AI reviewed Mar 12, 2025

View reviewed changes

Gabriel-Trintinalia added 2 commits March 12, 2025 19:27

Fix tests

2001a5f

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Merge main

75cc9f9

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Gabriel-Trintinalia added 8 commits March 20, 2025 10:41

Merge main into 'refactor-block-simulator'

479c4c0

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Accept PR suggestions

4d3ff40

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Merge 'refactor-block-simulator' into 'add-eth-simulate-v1'

734757f

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Fix test

26bd675

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Fix tests

ffaab75

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Minor improvement

afee176

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Fix unit tests

747bf2f

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Remove redundant test

b982cb0

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Gabriel-Trintinalia requested review from macfarla, fab-10 and pinges March 24, 2025 00:42

macfarla reviewed Mar 24, 2025

View reviewed changes

fab-10 reviewed Mar 24, 2025

View reviewed changes

Gabriel-Trintinalia added RPC mainnet labels Mar 24, 2025

Merge main into 'add-eth-simulatorV1'

2c18f10

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

fab-10 approved these changes Mar 27, 2025

View reviewed changes

Accept PR suggestions

9ff1d9f

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Gabriel-Trintinalia added 2 commits April 4, 2025 17:36

Merge branch 'main' into add-eth-simulateV1

e2091ba

changelog

a924416

Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>

Gabriel-Trintinalia added the doc-change-required Indicates an issue or PR that requires doc to be updated label Apr 4, 2025

Gabriel-Trintinalia enabled auto-merge (squash) April 4, 2025 06:41

Gabriel-Trintinalia changed the title ~~Implement eth_simulateV1~~ feature: implement eth_simulateV1 Apr 4, 2025

Gabriel-Trintinalia merged commit 1976ad1 into hyperledger:main Apr 4, 2025
43 checks passed

alexandratran mentioned this pull request Apr 10, 2025

Document eth_simulateV1 hyperledger/besu-docs#1798

Closed

alexandratran removed the doc-change-required Indicates an issue or PR that requires doc to be updated label Apr 10, 2025

garyschulte mentioned this pull request Aug 6, 2025

Add tracing for invalid transactions Consensys/shomei#123

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feature: implement eth_simulateV1 #8406

feature: implement eth_simulateV1 #8406

Uh oh!

Gabriel-Trintinalia commented Mar 12, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

macfarla left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fab-10 left a comment

Uh oh!

fab-10 Mar 24, 2025

Uh oh!

fab-10 left a comment

Uh oh!

Uh oh!

fab-10 Mar 27, 2025

Uh oh!

Gabriel-Trintinalia Mar 27, 2025 •

edited

Loading

Uh oh!

matkt Mar 28, 2025

Uh oh!

Uh oh!

Gabriel-Trintinalia commented Mar 27, 2025

Uh oh!

fab-10 commented Mar 28, 2025

Uh oh!

Uh oh!

Uh oh!

feature: implement eth_simulateV1 #8406

feature: implement eth_simulateV1 #8406

Uh oh!

Conversation

Gabriel-Trintinalia commented Mar 12, 2025

PR description

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

macfarla left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fab-10 left a comment

Choose a reason for hiding this comment

Uh oh!

fab-10 Mar 24, 2025

Choose a reason for hiding this comment

Uh oh!

fab-10 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fab-10 Mar 27, 2025

Choose a reason for hiding this comment

Uh oh!

Gabriel-Trintinalia Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

matkt Mar 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Gabriel-Trintinalia commented Mar 27, 2025

Uh oh!

fab-10 commented Mar 28, 2025

Uh oh!

Uh oh!

Uh oh!

Gabriel-Trintinalia Mar 27, 2025 •

edited

Loading