Add transaction hash for debug trace responses

ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/methods/DebugTraceTransactionIntegrationTest.java

@@ -24,7 +24,7 @@
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.JsonRpcMethod;
 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.results.DebugTraceTransactionResult;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.DebugTraceTransactionDetails;
 import org.hyperledger.besu.plugin.services.rpc.RpcResponseType;
 import org.hyperledger.besu.testutil.BlockTestUtil;
 
@@ -60,22 +60,20 @@ public void setUp() {
   @Test
   public void debugTraceTransactionSuccessTest() {
     final Map<String, Boolean> map = Map.of("disableStorage", true);
-    final Object[] params =
-        new Object[] {
-          Hash.fromHexString("0xcef53f2311d7c80e9086d661e69ac11a5f3d081e28e02a9ba9b66749407ac310"),
-          map
-        };
+    final Hash trxHash =
+        Hash.fromHexString("0xcef53f2311d7c80e9086d661e69ac11a5f3d081e28e02a9ba9b66749407ac310");
+    final Object[] params = new Object[] {trxHash, map};
     final JsonRpcRequestContext request =
         new JsonRpcRequestContext(new JsonRpcRequest("2.0", DEBUG_TRACE_TRANSACTION, params));
 
     final JsonRpcResponse response = method.response(request);
     assertThat(response.getType()).isEqualTo(RpcResponseType.SUCCESS);
-    DebugTraceTransactionResult debugTraceTransactionResult =
-        (DebugTraceTransactionResult) ((JsonRpcSuccessResponse) response).getResult();
-    assertThat(debugTraceTransactionResult.getGas()).isEqualTo(23705L);
-    assertThat(debugTraceTransactionResult.getReturnValue()).isEmpty();
-    assertThat(debugTraceTransactionResult.failed()).isFalse();
-    assertThat(debugTraceTransactionResult.getStructLogs()).hasSize(106);
+    DebugTraceTransactionDetails debugTraceTransactionDetails =
+        (DebugTraceTransactionDetails) ((JsonRpcSuccessResponse) response).getResult();
+    assertThat(debugTraceTransactionDetails.getGas()).isEqualTo(23705L);
+    assertThat(debugTraceTransactionDetails.getReturnValue()).isEmpty();
+    assertThat(debugTraceTransactionDetails.failed()).isFalse();
+    assertThat(debugTraceTransactionDetails.getStructLogs()).hasSize(106);
   }
 
   @Test

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

@@ -25,7 +25,7 @@
 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.DebugTraceTransactionResult;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.DebugTraceTransactionDetails;
 import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
 import org.hyperledger.besu.ethereum.api.query.TransactionWithMetadata;
 import org.hyperledger.besu.ethereum.debug.TraceOptions;
@@ -76,7 +76,7 @@ public JsonRpcResponse response(final JsonRpcRequestContext requestContext) {
             RpcErrorType.INVALID_TRANSACTION_TRACE_PARAMS,
             e);
       }
-      final DebugTraceTransactionResult debugTraceTransactionResult =
+      final DebugTraceTransactionDetails debugTraceTransactionResult =
           debugTraceTransactionResult(hash, transactionWithMetadata.get(), traceOptions);
 
       return new JsonRpcSuccessResponse(
@@ -86,7 +86,7 @@ public JsonRpcResponse response(final JsonRpcRequestContext requestContext) {
     }
   }
 
-  private DebugTraceTransactionResult debugTraceTransactionResult(
+  private DebugTraceTransactionDetails debugTraceTransactionResult(
       final Hash hash,
       final TransactionWithMetadata transactionWithMetadata,
       final TraceOptions traceOptions) {
@@ -100,7 +100,7 @@ private DebugTraceTransactionResult debugTraceTransactionResult(
             mutableWorldState ->
                 transactionTracer
                     .traceTransaction(mutableWorldState, blockHash, hash, execTracer)
-                    .map(DebugTraceTransactionResult::new))
+                    .map(DebugTraceTransactionDetails::new))
         .orElse(null);
   }
 }

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/DebugTraceTransactionDetails.java

@@ -0,0 +1,77 @@
+/*
+ * 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.results;
+
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.processor.TransactionTrace;
+import org.hyperledger.besu.ethereum.debug.TraceFrame;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import com.fasterxml.jackson.annotation.JsonGetter;
+import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+
+@JsonPropertyOrder({"gas", "failed", "returnValue", "structLogs"})
+public class DebugTraceTransactionDetails {
+
+  private final List<StructLog> structLogs;
+  private final String returnValue;
+  private final long gas;
+  private final boolean failed;
+
+  public DebugTraceTransactionDetails(final TransactionTrace transactionTrace) {
+    gas = transactionTrace.getGas();
+    returnValue = transactionTrace.getResult().getOutput().toString().substring(2);
+    structLogs = new ArrayList<>(transactionTrace.getTraceFrames().size());
+    transactionTrace.getTraceFrames().parallelStream()
+        .map(DebugTraceTransactionDetails::createStructLog)
+        .forEachOrdered(structLogs::add);
+    failed = !transactionTrace.getResult().isSuccessful();
+  }
+
+  public static Collection<DebugTraceTransactionResult> of(
+      final Collection<TransactionTrace> traces) {
+    return traces.stream().map(DebugTraceTransactionResult::new).collect(Collectors.toList());
+  }
+
+  private static StructLog createStructLog(final TraceFrame frame) {
+    return frame
+        .getExceptionalHaltReason()
+        .map(__ -> (StructLog) new StructLogWithError(frame))
+        .orElse(new StructLog(frame));
+  }
+
+  @JsonGetter(value = "structLogs")
+  public List<StructLog> getStructLogs() {
+    return structLogs;
+  }
+
+  @JsonGetter(value = "returnValue")
+  public String getReturnValue() {
+    return returnValue;
+  }
+
+  @JsonGetter(value = "gas")
+  public long getGas() {
+    return gas;
+  }
+
+  @JsonGetter(value = "failed")
+  public boolean failed() {
+    return failed;
+  }
+}

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/DebugTraceTransactionResult.java

@@ -1,5 +1,5 @@
 /*
- * Copyright ConsenSys AG.
+ * 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
@@ -15,63 +15,37 @@
 package org.hyperledger.besu.ethereum.api.jsonrpc.internal.results;
 
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.processor.TransactionTrace;
-import org.hyperledger.besu.ethereum.debug.TraceFrame;
 
-import java.util.ArrayList;
 import java.util.Collection;
-import java.util.List;
 import java.util.stream.Collectors;
 
 import com.fasterxml.jackson.annotation.JsonGetter;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 
-@JsonPropertyOrder({"gas", "failed", "returnValue", "structLogs"})
+@JsonPropertyOrder({"txHash", "result"})
 public class DebugTraceTransactionResult {
 
-  private final List<StructLog> structLogs;
-  private final String returnValue;
-  private final long gas;
-  private final boolean failed;
+  private final String txHash;
+
+  private final DebugTraceTransactionDetails result;
 
   public DebugTraceTransactionResult(final TransactionTrace transactionTrace) {
-    gas = transactionTrace.getGas();
-    returnValue = transactionTrace.getResult().getOutput().toString().substring(2);
-    structLogs = new ArrayList<>(transactionTrace.getTraceFrames().size());
-    transactionTrace.getTraceFrames().parallelStream()
-        .map(DebugTraceTransactionResult::createStructLog)
-        .forEachOrdered(structLogs::add);
-    failed = !transactionTrace.getResult().isSuccessful();
+    this.txHash = transactionTrace.getTransaction().getHash().toHexString();
+    this.result = new DebugTraceTransactionDetails(transactionTrace);
   }
 
   public static Collection<DebugTraceTransactionResult> of(
       final Collection<TransactionTrace> traces) {
     return traces.stream().map(DebugTraceTransactionResult::new).collect(Collectors.toList());
   }
 
-  private static StructLog createStructLog(final TraceFrame frame) {
-    return frame
-        .getExceptionalHaltReason()
-        .map(__ -> (StructLog) new StructLogWithError(frame))
-        .orElse(new StructLog(frame));
-  }
-
-  @JsonGetter(value = "structLogs")
-  public List<StructLog> getStructLogs() {
-    return structLogs;
-  }
-
-  @JsonGetter(value = "returnValue")
-  public String getReturnValue() {
-    return returnValue;
-  }
-
-  @JsonGetter(value = "gas")
-  public long getGas() {
-    return gas;
+  @JsonGetter(value = "txHash")
+  public String getTxHash() {
+    return txHash;
   }
 
-  @JsonGetter(value = "failed")
-  public boolean failed() {
-    return failed;
+  @JsonGetter(value = "result")
+  public DebugTraceTransactionDetails getResult() {
+    return result;
   }
 }

ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/bonsai/DebugTraceJsonRpcHttpBySpecTest.java

@@ -39,7 +39,8 @@ protected BlockchainSetupUtil getBlockchainSetupUtil(final DataStorageFormat sto
   }
 
   public static Object[][] specs() {
-    return AbstractJsonRpcHttpBySpecTest.findSpecFiles(new String[] {"debug/trace-call"});
+    return AbstractJsonRpcHttpBySpecTest.findSpecFiles(
+        new String[] {"debug/trace-call", "debug/trace-block"});
   }
 
   @Test

ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/forest/DebugTraceJsonRpcHttpBySpecTest.java

@@ -39,7 +39,8 @@ protected BlockchainSetupUtil getBlockchainSetupUtil(final DataStorageFormat sto
   }
 
   public static Object[][] specs() {
-    return AbstractJsonRpcHttpBySpecTest.findSpecFiles(new String[] {"debug/trace-call"});
+    return AbstractJsonRpcHttpBySpecTest.findSpecFiles(
+        new String[] {"debug/trace-call", "debug/trace-block"});
   }
 
   @Test

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

@@ -28,7 +28,7 @@
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.processor.Tracer;
 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.results.DebugTraceTransactionResult;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.DebugTraceTransactionDetails;
 import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
 import org.hyperledger.besu.ethereum.chain.Blockchain;
 import org.hyperledger.besu.ethereum.core.Block;
@@ -90,10 +90,10 @@ public void shouldReturnCorrectResponse() {
     when(blockchainQueries.getBlockchain()).thenReturn(blockchain);
     when(blockchain.getBlockByHash(block.getHash())).thenReturn(Optional.of(block));
 
-    DebugTraceTransactionResult result1 = mock(DebugTraceTransactionResult.class);
-    DebugTraceTransactionResult result2 = mock(DebugTraceTransactionResult.class);
+    DebugTraceTransactionDetails result1 = mock(DebugTraceTransactionDetails.class);
+    DebugTraceTransactionDetails result2 = mock(DebugTraceTransactionDetails.class);
 
-    List<DebugTraceTransactionResult> resultList = Arrays.asList(result1, result2);
+    List<DebugTraceTransactionDetails> resultList = Arrays.asList(result1, result2);
 
     try (MockedStatic<Tracer> mockedTracer = mockStatic(Tracer.class)) {
       mockedTracer
@@ -109,16 +109,17 @@ public void shouldReturnCorrectResponse() {
       assertThat(jsonRpcResponse).isInstanceOf(JsonRpcSuccessResponse.class);
       JsonRpcSuccessResponse response = (JsonRpcSuccessResponse) jsonRpcResponse;
 
-      final Collection<DebugTraceTransactionResult> traceResult = getResult(response);
+      final Collection<DebugTraceTransactionDetails> traceResult = getResult(response);
       assertThat(traceResult).isNotEmpty();
       assertThat(traceResult).isInstanceOf(Collection.class).hasSize(2);
       assertThat(traceResult).containsExactly(result1, result2);
     }
   }
 
   @SuppressWarnings("unchecked")
-  private Collection<DebugTraceTransactionResult> getResult(final JsonRpcSuccessResponse response) {
-    return (Collection<DebugTraceTransactionResult>) response.getResult();
+  private Collection<DebugTraceTransactionDetails> getResult(
+      final JsonRpcSuccessResponse response) {
+    return (Collection<DebugTraceTransactionDetails>) response.getResult();
   }
 
   @Test

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

@@ -28,7 +28,7 @@
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.processor.Tracer;
 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.results.DebugTraceTransactionResult;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.DebugTraceTransactionDetails;
 import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
 import org.hyperledger.besu.ethereum.chain.Blockchain;
 import org.hyperledger.besu.ethereum.core.Block;
@@ -88,10 +88,10 @@ public void shouldReturnCorrectResponse() {
     when(blockchain.getBlockByNumber(blockNumber)).thenReturn(Optional.of(block));
     when(block.getHeader()).thenReturn(blockHeader);
 
-    DebugTraceTransactionResult result1 = mock(DebugTraceTransactionResult.class);
-    DebugTraceTransactionResult result2 = mock(DebugTraceTransactionResult.class);
+    DebugTraceTransactionDetails result1 = mock(DebugTraceTransactionDetails.class);
+    DebugTraceTransactionDetails result2 = mock(DebugTraceTransactionDetails.class);
 
-    List<DebugTraceTransactionResult> resultList = Arrays.asList(result1, result2);
+    List<DebugTraceTransactionDetails> resultList = Arrays.asList(result1, result2);
 
     try (MockedStatic<Tracer> mockedTracer = mockStatic(Tracer.class)) {
       mockedTracer
@@ -105,16 +105,17 @@ public void shouldReturnCorrectResponse() {
       assertThat(jsonRpcResponse).isInstanceOf(JsonRpcSuccessResponse.class);
       JsonRpcSuccessResponse response = (JsonRpcSuccessResponse) jsonRpcResponse;
 
-      final Collection<DebugTraceTransactionResult> traceResult = getResult(response);
+      final Collection<DebugTraceTransactionDetails> traceResult = getResult(response);
       assertThat(traceResult).isNotEmpty();
       assertThat(traceResult).isInstanceOf(Collection.class).hasSize(2);
       assertThat(traceResult).containsExactly(result1, result2);
     }
   }
 
   @SuppressWarnings("unchecked")
-  private Collection<DebugTraceTransactionResult> getResult(final JsonRpcSuccessResponse response) {
-    return (Collection<DebugTraceTransactionResult>) response.getResult();
+  private Collection<DebugTraceTransactionDetails> getResult(
+      final JsonRpcSuccessResponse response) {
+    return (Collection<DebugTraceTransactionDetails>) response.getResult();
   }
 
   @Test

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

@@ -29,7 +29,7 @@
 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.DebugTraceTransactionResult;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.DebugTraceTransactionDetails;
 import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
 import org.hyperledger.besu.ethereum.chain.BadBlockManager;
 import org.hyperledger.besu.ethereum.chain.Blockchain;
@@ -144,10 +144,10 @@ public void shouldReturnCorrectResponse() {
     when(blockchain.getBlockByHash(block.getHeader().getParentHash()))
         .thenReturn(Optional.of(parentBlock));
 
-    DebugTraceTransactionResult result1 = mock(DebugTraceTransactionResult.class);
-    DebugTraceTransactionResult result2 = mock(DebugTraceTransactionResult.class);
+    DebugTraceTransactionDetails result1 = mock(DebugTraceTransactionDetails.class);
+    DebugTraceTransactionDetails result2 = mock(DebugTraceTransactionDetails.class);
 
-    List<DebugTraceTransactionResult> resultList = Arrays.asList(result1, result2);
+    List<DebugTraceTransactionDetails> resultList = Arrays.asList(result1, result2);
 
     try (MockedStatic<Tracer> mockedTracer = mockStatic(Tracer.class)) {
       mockedTracer
@@ -163,16 +163,17 @@ public void shouldReturnCorrectResponse() {
       assertThat(jsonRpcResponse).isInstanceOf(JsonRpcSuccessResponse.class);
       JsonRpcSuccessResponse response = (JsonRpcSuccessResponse) jsonRpcResponse;
 
-      final Collection<DebugTraceTransactionResult> traceResult = getResult(response);
+      final Collection<DebugTraceTransactionDetails> traceResult = getResult(response);
       assertThat(traceResult).isNotEmpty();
       assertThat(traceResult).isInstanceOf(Collection.class).hasSize(2);
       assertThat(traceResult).containsExactly(result1, result2);
     }
   }
 
   @SuppressWarnings("unchecked")
-  private Collection<DebugTraceTransactionResult> getResult(final JsonRpcSuccessResponse response) {
-    return (Collection<DebugTraceTransactionResult>) response.getResult();
+  private Collection<DebugTraceTransactionDetails> getResult(
+      final JsonRpcSuccessResponse response) {
+    return (Collection<DebugTraceTransactionDetails>) response.getResult();
   }
 
   @Test