Fix invalid error codes on some JSON RPC apis (hyperledger#2138)

Signed-off-by: Karim TAAM <karim.t2am@gmail.com>
lucassaldanha · May 8, 2021 · 1e2411c · 1e2411c
1 parent 9c404d9
commit 1e2411c
Show file tree

Hide file tree

Showing 9 changed files with 37 additions and 22 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -20,7 +20,7 @@
 
 - Fixed issue in discv5 where nonce was incorrectly reused. [\#2075](https://github.com/hyperledger/besu/pull/2075)
 - Fixed issues in debug_standardTraceBadBlockToFile and debug_standardTraceBlockToFile. [\#2120](https://github.com/hyperledger/besu/pull/2120)
-
+- Fixed invalid error code in several JSON RPC methods when the requested block is not in the range. [\#2138](https://github.com/hyperledger/besu/pull/2138)
 
 ## 21.1.5
 

diff --git a/...r/besu/ethereum/api/jsonrpc/internal/methods/AbstractBlockParameterOrBlockHashMethod.java b/...r/besu/ethereum/api/jsonrpc/internal/methods/AbstractBlockParameterOrBlockHashMethod.java
@@ -73,11 +73,12 @@ protected Object handleParamTypes(final JsonRpcRequestContext requestContext) {
       result = pendingResult(requestContext);
     } else if (blockParameterOrBlockHash.isNumeric() || blockParameterOrBlockHash.isEarliest()) {
       OptionalLong blockNumber = blockParameterOrBlockHash.getNumber();
-      if (blockNumber.isEmpty()
-          || blockNumber.getAsLong() < 0
-          || blockNumber.getAsLong() > getBlockchainQueries().headBlockNumber()) {
+      if (blockNumber.isEmpty() || blockNumber.getAsLong() < 0) {
         return new JsonRpcErrorResponse(
             requestContext.getRequest().getId(), JsonRpcError.INVALID_PARAMS);
+      } else if (blockNumber.getAsLong() > getBlockchainQueries().headBlockNumber()) {
+        return new JsonRpcErrorResponse(
+            requestContext.getRequest().getId(), JsonRpcError.BLOCK_NOT_FOUND);
       }
 
       result =

diff --git a/...api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/EthCall.java b/...api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/EthCall.java
@@ -14,6 +14,8 @@
  */
 package org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods;
 
+import static org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcError.BLOCK_NOT_FOUND;
+
 import org.hyperledger.besu.ethereum.api.jsonrpc.JsonRpcErrorConverter;
 import org.hyperledger.besu.ethereum.api.jsonrpc.RpcMethod;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequestContext;
@@ -84,7 +86,7 @@ protected Object resultByBlockHash(final JsonRpcRequestContext request, final Ha
                             new JsonRpcErrorResponse(
                                 request.getRequest().getId(),
                                 JsonRpcErrorConverter.convertTransactionInvalidReason(reason))))
-        .orElse(errorResponse(request, JsonRpcError.INTERNAL_ERROR));
+        .orElse(errorResponse(request, BLOCK_NOT_FOUND));
   }
 
   @Override

diff --git a/...src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/EthCallTest.java b/...src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/EthCallTest.java
@@ -16,7 +16,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.catchThrowable;
-import static org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcError.INTERNAL_ERROR;
+import static org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcError.BLOCK_NOT_FOUND;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyLong;
 import static org.mockito.ArgumentMatchers.eq;
@@ -102,7 +102,7 @@ public void shouldThrowInvalidJsonRpcParametersExceptionWhenMissingToField() {
   @Test
   public void shouldReturnInternalErrorWhenProcessorReturnsEmpty() {
     final JsonRpcRequestContext request = ethCallRequest(callParameter(), "latest");
-    final JsonRpcResponse expectedResponse = new JsonRpcErrorResponse(null, INTERNAL_ERROR);
+    final JsonRpcResponse expectedResponse = new JsonRpcErrorResponse(null, BLOCK_NOT_FOUND);
 
     when(blockchainQueries.getBlockchain()).thenReturn(blockchain);
     when(blockchainQueries.getBlockchain().getChainHead()).thenReturn(chainHead);
@@ -189,6 +189,18 @@ public void shouldUseCorrectBlockNumberWhenSpecified() {
     verify(transactionSimulator).process(any(), any(), any(), any());
   }
 
+  @Test
+  public void shouldReturnBlockNotFoundWhenInvalidBlockNumberSpecified() {
+    final JsonRpcRequestContext request = ethCallRequest(callParameter(), Quantity.create(33L));
+    when(blockchainQueries.headBlockNumber()).thenReturn(14L);
+    final JsonRpcResponse expectedResponse = new JsonRpcErrorResponse(null, BLOCK_NOT_FOUND);
+
+    JsonRpcResponse response = method.response(request);
+    assertThat(response).usingRecursiveComparison().isEqualTo(expectedResponse);
+
+    verify(blockchainQueries).headBlockNumber();
+  }
+
   private JsonCallParameter callParameter() {
     return new JsonCallParameter(
         Address.fromHexString("0x0"),

diff --git a/...org/hyperledger/besu/ethereum/api/jsonrpc/eth/eth_getBalance_illegalRangeGreaterThan.json b/...org/hyperledger/besu/ethereum/api/jsonrpc/eth/eth_getBalance_illegalRangeGreaterThan.json
@@ -12,9 +12,9 @@
     "jsonrpc": "2.0",
     "id": 28,
     "error": {
-      "code": -32602,
-      "message": "Invalid params"
+      "code": -32000,
+      "message": "Block not found"
     }
   },
-  "statusCode": 400
+  "statusCode": 200
 }
diff --git a/...es/org/hyperledger/besu/ethereum/api/jsonrpc/eth/eth_getCode_illegalRangeGreaterThan.json b/...es/org/hyperledger/besu/ethereum/api/jsonrpc/eth/eth_getCode_illegalRangeGreaterThan.json
@@ -12,9 +12,9 @@
     "jsonrpc": "2.0",
     "id": 13,
     "error": {
-      "code": -32602,
-      "message": "Invalid params"
+      "code": -32000,
+      "message": "Block not found"
     }
   },
-  "statusCode": 400
+  "statusCode": 200
 }
diff --git a/...s/org/hyperledger/besu/ethereum/api/jsonrpc/eth/eth_getProof_illegalRangeGreaterThan.json b/...s/org/hyperledger/besu/ethereum/api/jsonrpc/eth/eth_getProof_illegalRangeGreaterThan.json
@@ -13,9 +13,9 @@
     "jsonrpc": "2.0",
     "id": 28,
     "error": {
-      "code": -32602,
-      "message": "Invalid params"
+      "code": -32000,
+      "message": "Block not found"
     }
   },
-  "statusCode": 400
+  "statusCode": 200
 }
diff --git a/...g/hyperledger/besu/ethereum/api/jsonrpc/eth/eth_getStorageAt_illegalRangeGreaterThan.json b/...g/hyperledger/besu/ethereum/api/jsonrpc/eth/eth_getStorageAt_illegalRangeGreaterThan.json
@@ -13,9 +13,9 @@
     "jsonrpc": "2.0",
     "id": 337,
     "error": {
-      "code": -32602,
-      "message": "Invalid params"
+      "code": -32000,
+      "message": "Block not found"
     }
   },
-  "statusCode": 400
+  "statusCode": 200
 }
diff --git a/...s/org/hyperledger/besu/ethereum/api/jsonrpc/eth/eth_getTransactionCount_illegalRange.json b/...s/org/hyperledger/besu/ethereum/api/jsonrpc/eth/eth_getTransactionCount_illegalRange.json
@@ -12,9 +12,9 @@
     "jsonrpc": "2.0",
     "id": 487,
     "error": {
-      "code": -32602,
-      "message": "Invalid params"
+      "code": -32000,
+      "message": "Block not found"
     }
   },
-  "statusCode": 400
+  "statusCode": 200
 }