implement testing_buildBlockV1

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/RpcApis.java

@@ -33,7 +33,8 @@ public enum RpcApis {
   CLIQUE,
   IBFT,
   ENGINE,
-  QBFT;
+  QBFT,
+  TESTING;
 
   public static final List<String> DEFAULT_RPC_APIS = Arrays.asList("ETH", "NET", "WEB3");
 

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/RpcMethod.java

@@ -176,7 +176,8 @@ public enum RpcMethod {
   TX_POOL_BESU_PENDING_TRANSACTIONS("txpool_besuPendingTransactions"),
   WEB3_CLIENT_VERSION("web3_clientVersion"),
   WEB3_SHA3("web3_sha3"),
-  PLUGINS_RELOAD_CONFIG("plugins_reloadPluginConfig");
+  PLUGINS_RELOAD_CONFIG("plugins_reloadPluginConfig"),
+  TESTING_BUILD_BLOCK_V1("testing_buildBlockV1");
 
   private final String methodName;
 

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

@@ -0,0 +1,184 @@
+/*
+ * Copyright contributors to Besu.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.testing;
+
+import org.hyperledger.besu.datatypes.Wei;
+import org.hyperledger.besu.ethereum.ProtocolContext;
+import org.hyperledger.besu.ethereum.api.jsonrpc.RpcMethod;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequestContext;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.exception.InvalidJsonRpcParameters;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.JsonRpcMethod;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.EnginePayloadAttributesParameter;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.JsonRpcParameter.JsonRpcParameterException;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.TestingBuildBlockParameter;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.WithdrawalParameter;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcErrorResponse;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcResponse;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcSuccessResponse;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.RpcErrorType;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.BlobsBundleV1;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.EngineGetPayloadResultV4;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.Quantity;
+import org.hyperledger.besu.ethereum.blockcreation.BlockCreator.BlockCreationResult;
+import org.hyperledger.besu.ethereum.blockcreation.GenericBlockCreator;
+import org.hyperledger.besu.ethereum.core.BlockHeader;
+import org.hyperledger.besu.ethereum.core.BlockValueCalculator;
+import org.hyperledger.besu.ethereum.core.BlockWithReceipts;
+import org.hyperledger.besu.ethereum.core.MiningConfiguration;
+import org.hyperledger.besu.ethereum.core.Transaction;
+import org.hyperledger.besu.ethereum.core.Withdrawal;
+import org.hyperledger.besu.ethereum.core.encoding.EncodingContext;
+import org.hyperledger.besu.ethereum.core.encoding.TransactionDecoder;
+import org.hyperledger.besu.ethereum.core.encoding.TransactionEncoder;
+import org.hyperledger.besu.ethereum.eth.manager.EthScheduler;
+import org.hyperledger.besu.ethereum.eth.transactions.TransactionPool;
+import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
+import org.hyperledger.besu.util.HexUtils;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+import org.apache.tuweni.bytes.Bytes;
+
+public class TestingBuildBlockV1 implements JsonRpcMethod {
+
+  private final ProtocolContext protocolContext;
+  private final ProtocolSchedule protocolSchedule;
+  private final MiningConfiguration miningConfiguration;
+  private final TransactionPool transactionPool;
+  private final EthScheduler ethScheduler;
+
+  public TestingBuildBlockV1(
+      final ProtocolContext protocolContext,
+      final ProtocolSchedule protocolSchedule,
+      final MiningConfiguration miningConfiguration,
+      final TransactionPool transactionPool,
+      final EthScheduler ethScheduler) {
+    this.protocolContext = protocolContext;
+    this.protocolSchedule = protocolSchedule;
+    this.miningConfiguration = miningConfiguration;
+    this.transactionPool = transactionPool;
+    this.ethScheduler = ethScheduler;
+  }
+
+  @Override
+  public String getName() {
+    return RpcMethod.TESTING_BUILD_BLOCK_V1.getMethodName();
+  }
+
+  @Override
+  public JsonRpcResponse response(final JsonRpcRequestContext requestContext) {
+    final TestingBuildBlockParameter param;
+    try {
+      param = requestContext.getRequiredParameter(0, TestingBuildBlockParameter.class);
+    } catch (final JsonRpcParameterException e) {
+      throw new InvalidJsonRpcParameters(
+          "Invalid testing_buildBlockV1 parameter (index 0)", RpcErrorType.INVALID_PARAMS, e);
+    }
+
+    final EnginePayloadAttributesParameter payloadAttributes = param.getPayloadAttributes();
+
+    // Validate parent block exists
+    final Optional<BlockHeader> maybeParentHeader =
+        protocolContext.getBlockchain().getBlockHeader(param.getParentBlockHash());
+    if (maybeParentHeader.isEmpty()) {
+      return new JsonRpcErrorResponse(
+          requestContext.getRequest().getId(), RpcErrorType.INVALID_BLOCK_HASH_PARAMS);
+    }
+    final BlockHeader parentHeader = maybeParentHeader.get();
+
+    // Decode transactions from hex RLP
+    final List<Transaction> transactions;
+    try {
+      transactions =
+          param.getTransactions().stream()
+              .map(Bytes::fromHexString)
+              .map(bytes -> TransactionDecoder.decodeOpaqueBytes(bytes, EncodingContext.BLOCK_BODY))
+              .collect(Collectors.toList());
+    } catch (final Exception e) {
+      return new JsonRpcErrorResponse(
+          requestContext.getRequest().getId(), RpcErrorType.INVALID_PARAMS);
+    }
+
+    // Convert withdrawals
+    final Optional<List<Withdrawal>> withdrawals =
+        Optional.ofNullable(payloadAttributes.getWithdrawals())
+            .map(
+                wps ->
+                    wps.stream()
+                        .map(WithdrawalParameter::toWithdrawal)
+                        .collect(Collectors.toList()));
+
+    // Extra data
+    final Bytes extraData = param.getExtraData().map(Bytes::fromHexString).orElse(Bytes.EMPTY);
+
+    // Create block creator
+    final GenericBlockCreator blockCreator =
+        new GenericBlockCreator(
+            miningConfiguration,
+            (__, ___) -> payloadAttributes.getSuggestedFeeRecipient(),
+            (__) -> extraData,
+            transactionPool,
+            protocolContext,
+            protocolSchedule,
+            ethScheduler);
+
+    // Build the block
+    final BlockCreationResult result;
+    try {
+      result =
+          blockCreator.createBlock(
+              Optional.of(transactions),
+              Optional.of(Collections.emptyList()),
+              withdrawals,
+              Optional.of(payloadAttributes.getPrevRandao()),
+              Optional.ofNullable(payloadAttributes.getParentBeaconBlockRoot()),
+              Optional.empty(),
+              payloadAttributes.getTimestamp(),
+              false,
+              parentHeader);
+    } catch (final Exception e) {
+      return new JsonRpcErrorResponse(
+          requestContext.getRequest().getId(), RpcErrorType.INTERNAL_ERROR);
+    }
+
+    // Format response as EngineGetPayloadResultV4
+    final var block = result.getBlock();
+    final List<String> txsAsHex =
+        block.getBody().getTransactions().stream()
+            .map(tx -> TransactionEncoder.encodeOpaqueBytes(tx, EncodingContext.BLOCK_BODY))
+            .map(b -> HexUtils.toFastHex(b, true))
+            .collect(Collectors.toList());
+
+    final BlockWithReceipts blockWithReceipts =
+        new BlockWithReceipts(block, result.getTransactionSelectionResults().getReceipts());
+    final Wei blockValue = BlockValueCalculator.calculateBlockValue(blockWithReceipts);
+
+    final BlobsBundleV1 blobsBundle = new BlobsBundleV1(block.getBody().getTransactions());
+
+    final EngineGetPayloadResultV4 response =
+        new EngineGetPayloadResultV4(
+            block.getHeader(),
+            txsAsHex,
+            block.getBody().getWithdrawals(),
+            Optional.empty(),
+            Quantity.create(blockValue),
+            blobsBundle);
+
+    return new JsonRpcSuccessResponse(requestContext.getRequest().getId(), response);
+  }
+}

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/parameters/TestingBuildBlockParameter.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright contributors to Besu.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters;
+
+import org.hyperledger.besu.datatypes.Hash;
+
+import java.util.List;
+import java.util.Optional;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class TestingBuildBlockParameter {
+
+  private final Hash parentBlockHash;
+  private final EnginePayloadAttributesParameter payloadAttributes;
+  private final List<String> transactions;
+  private final String extraData;
+
+  @JsonCreator
+  public TestingBuildBlockParameter(
+      @JsonProperty("parentBlockHash") final String parentBlockHash,
+      @JsonProperty("payloadAttributes") final EnginePayloadAttributesParameter payloadAttributes,
+      @JsonProperty("transactions") final List<String> transactions,
+      @JsonProperty("extraData") final String extraData) {
+    this.parentBlockHash = Hash.fromHexString(parentBlockHash);
+    this.payloadAttributes = payloadAttributes;
+    this.transactions = transactions;
+    this.extraData = extraData;
+  }
+
+  public Hash getParentBlockHash() {
+    return parentBlockHash;
+  }
+
+  public EnginePayloadAttributesParameter getPayloadAttributes() {
+    return payloadAttributes;
+  }
+
+  public List<String> getTransactions() {
+    return transactions;
+  }
+
+  public Optional<String> getExtraData() {
+    return Optional.ofNullable(extraData);
+  }
+}

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

@@ -160,7 +160,13 @@ public Map<String, JsonRpcMethod> methods(
                   metricsSystem,
                   ethScheduler),
               new TxPoolJsonRpcMethods(transactionPool),
-              new PluginsJsonRpcMethods(namedPlugins));
+              new PluginsJsonRpcMethods(namedPlugins),
+              new TestingJsonRpcMethods(
+                  protocolContext,
+                  protocolSchedule,
+                  miningConfiguration,
+                  transactionPool,
+                  ethScheduler));
 
       for (final JsonRpcMethods apiGroup : availableApiGroups) {
         enabled.putAll(apiGroup.create(rpcApis));

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

@@ -0,0 +1,60 @@
+/*
+ * Copyright contributors to Besu.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package org.hyperledger.besu.ethereum.api.jsonrpc.methods;
+
+import org.hyperledger.besu.ethereum.ProtocolContext;
+import org.hyperledger.besu.ethereum.api.jsonrpc.RpcApis;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.JsonRpcMethod;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.testing.TestingBuildBlockV1;
+import org.hyperledger.besu.ethereum.core.MiningConfiguration;
+import org.hyperledger.besu.ethereum.eth.manager.EthScheduler;
+import org.hyperledger.besu.ethereum.eth.transactions.TransactionPool;
+import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
+
+import java.util.Map;
+
+public class TestingJsonRpcMethods extends ApiGroupJsonRpcMethods {
+
+  private final ProtocolContext protocolContext;
+  private final ProtocolSchedule protocolSchedule;
+  private final MiningConfiguration miningConfiguration;
+  private final TransactionPool transactionPool;
+  private final EthScheduler ethScheduler;
+
+  public TestingJsonRpcMethods(
+      final ProtocolContext protocolContext,
+      final ProtocolSchedule protocolSchedule,
+      final MiningConfiguration miningConfiguration,
+      final TransactionPool transactionPool,
+      final EthScheduler ethScheduler) {
+    this.protocolContext = protocolContext;
+    this.protocolSchedule = protocolSchedule;
+    this.miningConfiguration = miningConfiguration;
+    this.transactionPool = transactionPool;
+    this.ethScheduler = ethScheduler;
+  }
+
+  @Override
+  protected String getApiGroup() {
+    return RpcApis.TESTING.name();
+  }
+
+  @Override
+  protected Map<String, JsonRpcMethod> create() {
+    return mapOf(
+        new TestingBuildBlockV1(
+            protocolContext, protocolSchedule, miningConfiguration, transactionPool, ethScheduler));
+  }
+}