fix: reject non-hex block numbers in debug_getRawReceipts, and eth_getProof

CHANGELOG.md

@@ -3,11 +3,10 @@
 ## Unreleased
 
 ### Breaking Changes
+- RPC changes to enhance compatibility with other ELs
+  - Block number parameter in RPCs will only support hex values. Non-hex (decimal) block number parameters are now rejected. This affects `debug_getRawBlock`, `debug_getRawHeader`, `debug_getRawReceipts`, and `eth_getProof`. [#10240](https://github.com/besu-eth/besu/pull/10240)
 
 ### Upcoming Breaking Changes
-- RPC changes to enhance compatibility with other ELs
-  - Block number parameter in RPCs will only support hex values. Support for non-hex (decimal) block number parameters is deprecated.
-  - This affects several RPCs, including `admin_logsRemoveCache`, `debug_getRawHeader`, `eth_call`, `eth_simulateV1`, `trace_call` and more.
 - Sunsetting features - for more context on the reasoning behind the deprecation of these features, including alternative options, read [this blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu)
   - Proof of Work consensus (PoW)
 - `--min-block-occupancy-ratio` is deprecated and will be removed in a future release

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

@@ -14,10 +14,11 @@
  */
 package org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods;
 
+import org.hyperledger.besu.datatypes.Hash;
 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.parameters.BlockParameter;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.BlockParameterOrBlockHash;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.JsonRpcParameter.JsonRpcParameterException;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcErrorResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.RpcErrorType;
@@ -26,7 +27,7 @@
 
 import com.google.common.base.Suppliers;
 
-public class DebugGetRawBlock extends AbstractBlockParameterMethod {
+public class DebugGetRawBlock extends AbstractBlockParameterOrBlockHashMethod {
 
   public DebugGetRawBlock(final BlockchainQueries blockchain) {
     super(Suppliers.ofInstance(blockchain));
@@ -38,22 +39,21 @@ public String getName() {
   }
 
   @Override
-  protected BlockParameter blockParameter(final JsonRpcRequestContext request) {
+  protected BlockParameterOrBlockHash blockParameterOrBlockHash(
+      final JsonRpcRequestContext request) {
     try {
-      return request.getRequiredParameter(0, BlockParameter.class);
+      return request.getRequiredParameter(0, BlockParameterOrBlockHash.class);
     } catch (JsonRpcParameterException e) {
       throw new InvalidJsonRpcParameters(
-          "Invalid block parameter (index 0)", RpcErrorType.INVALID_BLOCK_PARAMS, e);
+          "Invalid block or block hash parameter (index 0)", RpcErrorType.INVALID_BLOCK_PARAMS, e);
     }
   }
 
   @Override
-  protected Object resultByBlockNumber(
-      final JsonRpcRequestContext request, final long blockNumber) {
-
+  protected Object resultByBlockHash(final JsonRpcRequestContext request, final Hash blockHash) {
     return getBlockchainQueries()
         .getBlockchain()
-        .getBlockByNumber(blockNumber)
+        .getBlockByHash(blockHash)
         .<Object>map(block -> RLP.encode(block::writeTo).toString())
         .orElseGet(
             () ->

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

@@ -14,10 +14,11 @@
  */
 package org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods;
 
+import org.hyperledger.besu.datatypes.Hash;
 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.parameters.BlockParameter;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.BlockParameterOrBlockHash;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.JsonRpcParameter.JsonRpcParameterException;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcErrorResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.RpcErrorType;
@@ -26,7 +27,7 @@
 
 import com.google.common.base.Suppliers;
 
-public class DebugGetRawHeader extends AbstractBlockParameterMethod {
+public class DebugGetRawHeader extends AbstractBlockParameterOrBlockHashMethod {
 
   public DebugGetRawHeader(final BlockchainQueries blockchain) {
     super(Suppliers.ofInstance(blockchain));
@@ -38,22 +39,21 @@ public String getName() {
   }
 
   @Override
-  protected BlockParameter blockParameter(final JsonRpcRequestContext request) {
+  protected BlockParameterOrBlockHash blockParameterOrBlockHash(
+      final JsonRpcRequestContext request) {
     try {
-      return request.getRequiredParameter(0, BlockParameter.class);
+      return request.getRequiredParameter(0, BlockParameterOrBlockHash.class);
     } catch (JsonRpcParameterException e) {
       throw new InvalidJsonRpcParameters(
-          "Invalid block parameter (index 0)", RpcErrorType.INVALID_BLOCK_PARAMS, e);
+          "Invalid block or block hash parameter (index 0)", RpcErrorType.INVALID_BLOCK_PARAMS, e);
     }
   }
 
   @Override
-  protected Object resultByBlockNumber(
-      final JsonRpcRequestContext request, final long blockNumber) {
-
+  protected Object resultByBlockHash(final JsonRpcRequestContext request, final Hash blockHash) {
     return getBlockchainQueries()
-        .blockByNumber(blockNumber)
-        .<Object>map(block -> RLP.encode(block.getHeader()::writeTo).toString())
+        .getBlockHeaderByHash(blockHash)
+        .<Object>map(header -> RLP.encode(header::writeTo).toString())
         .orElseGet(
             () ->
                 new JsonRpcErrorResponse(

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

@@ -79,6 +79,9 @@ public BlockParameterOrBlockHash(final Object value) throws JsonProcessingExcept
         requireCanonical = false;
       } else if (normalizedValue.length() > 16) {
         throw new IllegalArgumentException("hex number > 64 bits");
+      } else if (!normalizedValue.startsWith("0x")) {
+        throw new IllegalArgumentException(
+            "Invalid block number: must be a hex string with 0x prefix");
       } else {
         type = BlockParameterType.NUMERIC;
         number = OptionalLong.of(Long.decode(value.toString()));

ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/DebugSetHeadTest.java

@@ -152,7 +152,8 @@ public void assertNullWhenBlockNotFound() {
 
     // move the head to number just after chain head
     var resp =
-        debugSetHead.response(debugSetHead("" + chainTip.getNumber() + 1, Optional.of(TRUE)));
+        debugSetHead.response(
+            debugSetHead("0x" + Long.toHexString(chainTip.getNumber() + 1), Optional.of(TRUE)));
     // success with null result if block not found
     assertThat(resp.getType()).isEqualTo(RpcResponseType.SUCCESS);
     assertThat(((JsonRpcSuccessResponse) resp).getResult()).isNull();

ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/EthGetProofTest.java

@@ -124,7 +124,7 @@ void shouldReturnNullWhenWorldStateUnavailable() {
         requestWithParams(
             Address.fromHexString("0x0000000000000000000000000000000000000000"),
             new String[] {storageKey.toString()},
-            String.valueOf(501));
+            "0x1f5");
 
     final JsonRpcResponse response = method.response(request);
 
@@ -139,7 +139,7 @@ void getProofWithAccount() {
 
     final JsonRpcRequestContext request =
         requestWithParams(
-            address.toString(), new String[] {storageKey.toString()}, String.valueOf(blockNumber));
+            address.toString(), new String[] {storageKey.toString()}, "0x1f4");
 
     final JsonRpcSuccessResponse response = (JsonRpcSuccessResponse) method.response(request);
     final GetProofResult result = (GetProofResult) response.getResult();
@@ -225,7 +225,7 @@ void getProofWithoutAccount() {
 
     final JsonRpcRequestContext request =
         requestWithParams(
-            address.toString(), new String[] {storageKey.toString()}, String.valueOf(blockNumber));
+            address.toString(), new String[] {storageKey.toString()}, "0x1f4");
 
     final JsonRpcSuccessResponse response = (JsonRpcSuccessResponse) method.response(request);
     final GetProofResult result = (GetProofResult) response.getResult();