Skip to content
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

Jump to bottom

Fix EngineNewPayloadV4Test unit test #6798

Closed
wants to merge 1 commit into from
Closed

Fix EngineNewPayloadV4Test unit test #6798

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 0 additions & 2 deletions ...org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/engine/EngineNewPayloadV4.java
View file
Open in desktop
Expand Up @@ -63,8 +63,6 @@ protected ValidationResult<RpcErrorType> validateParameters(
} else if (maybeBeaconBlockRootParam.isEmpty()) {
return ValidationResult.invalid(
RpcErrorType.INVALID_PARAMS, "Missing parent beacon block root field");
} else if (payloadParameter.getDeposits() == null) {
Copy link
Member Author

Choose a reason for hiding this comment

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

We don't need this early check as this is already handled by the DepositValidator on AbstractEngineNewPayload. However, if we do want to have this early check, we would need to modify some tests to support it.

IMHO, this comes down to: do we ever have a scenario where GetPayloadV4 is called pre-Prague?

Copy link
Contributor

@siladu siladu Mar 24, 2024 •
edited

Choose a reason for hiding this comment

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

Agree it appears to be a duplicate check. If we are having to validate params for other fields here already then think it makes sense to do it all in one place, rather than spread the check out.

Feels like the domain-level DepositsValidator shouldn't be doing this check if we already have this here

Copy link
Member Author

Choose a reason for hiding this comment

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

We have shared logic between the different version of engine_newPayload implemented on AbstractEngineNewPayload, because of that we still need the "conditional" validation on AbstractEngineNewPayload, determined by protocol schedule + DepositsValidator (choosing a validator implementation that makes sense for what fork we are in).

When it comes to EngineNewPayloadV4#validateParameters, we could enforce checking that the deposits field isn't empty, assuming that we only use V4 after Prague (need to confirm this).

Depending on what we think is the correct thing to do, we will need to adjust some of the testing because as of now, EnginePayloadV4 test extends EnginePayloadV3 and etc, and a lot of these tests will fail.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok this method should not be used pre-Prague. I'll adjust a few things.

Copy link
Contributor

Choose a reason for hiding this comment

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

@jflo might have the most recent context about the best way to migrate to V4.

Copy link
Contributor

Choose a reason for hiding this comment

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

yeah, this happened a ton on v3 as well, we really need to factor out all the inheritance and replace it with a composition approach.

return ValidationResult.invalid(RpcErrorType.INVALID_PARAMS, "Missing deposit field");
} else {
return ValidationResult.valid();
}
Expand Down
7 changes: 6 additions & 1 deletion ...hyperledger/besu/ethereum/api/jsonrpc/internal/methods/engine/EngineNewPayloadV3Test.java
View file
Open in desktop
Expand Up @@ -52,6 +52,7 @@
import org.hyperledger.besu.ethereum.core.encoding.TransactionEncoder;
import org.hyperledger.besu.ethereum.mainnet.BodyValidation;
import org.hyperledger.besu.ethereum.mainnet.CancunTargetingGasLimitCalculator;
import org.hyperledger.besu.ethereum.mainnet.ScheduledProtocolSpec.Hardfork;
import org.hyperledger.besu.ethereum.mainnet.ValidationResult;
import org.hyperledger.besu.evm.gascalculator.CancunGasCalculator;

Expand Down Expand Up @@ -107,7 +108,7 @@ public void shouldInvalidVersionedHash_whenShortVersionedHash() {
final Bytes shortHash = Bytes.fromHexString("0x" + "69".repeat(31));

final EnginePayloadParameter payload = mock(EnginePayloadParameter.class);
when(payload.getTimestamp()).thenReturn(cancunHardfork.milestone());
when(payload.getTimestamp()).thenReturn(getSupportedMilestone().milestone());
when(payload.getExcessBlobGas()).thenReturn("99");
when(payload.getBlobGasUsed()).thenReturn(9l);

Expand Down Expand Up @@ -263,4 +264,8 @@ protected JsonRpcResponse resp(final EnginePayloadParameter payload) {
return method.response(
new JsonRpcRequestContext(new JsonRpcRequest("2.0", this.method.getName(), params)));
}

protected Hardfork getSupportedMilestone() {
return cancunHardfork;
}
}
15 changes: 11 additions & 4 deletions ...hyperledger/besu/ethereum/api/jsonrpc/internal/methods/engine/EngineNewPayloadV4Test.java
View file
Open in desktop
Expand Up @@ -41,6 +41,7 @@
import org.hyperledger.besu.ethereum.core.Withdrawal;
import org.hyperledger.besu.ethereum.mainnet.BodyValidation;
import org.hyperledger.besu.ethereum.mainnet.DepositsValidator;
import org.hyperledger.besu.ethereum.mainnet.ScheduledProtocolSpec.Hardfork;
import org.hyperledger.besu.evm.gascalculator.PragueGasCalculator;

import java.util.Collections;
Expand All @@ -65,22 +66,23 @@ public EngineNewPayloadV4Test() {}
public void before() {
super.before();
maybeParentBeaconBlockRoot = Optional.of(Bytes32.ZERO);
// TODO this should be using NewPayloadV4
this.method =
new EngineNewPayloadV3(
new EngineNewPayloadV4(
vertx,
protocolSchedule,
protocolContext,
mergeCoordinator,
ethPeers,
engineCallListener);
lenient().when(protocolSchedule.hardforkFor(any())).thenReturn(Optional.of(pragueHardfork));
lenient()
.when(protocolSchedule.hardforkFor(any()))
.thenReturn(Optional.of(getSupportedMilestone()));
lenient().when(protocolSpec.getGasCalculator()).thenReturn(new PragueGasCalculator());
}

@Override
public void shouldReturnExpectedMethodName() {
assertThat(method.getName()).isEqualTo("engine_newPayloadV3");
assertThat(method.getName()).isEqualTo("engine_newPayloadV4");
}

@Test
Expand Down Expand Up @@ -200,4 +202,9 @@ protected JsonRpcResponse resp(final EnginePayloadParameter payload) {
return method.response(
new JsonRpcRequestContext(new JsonRpcRequest("2.0", this.method.getName(), params)));
}

@Override
protected Hardfork getSupportedMilestone() {
return pragueHardfork;
}
}