Tracer option for debug trace RPC calls

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.DebugTraceTransactionDetails;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.DebugStructLoggerTracerResult;
 import org.hyperledger.besu.plugin.services.rpc.RpcResponseType;
 import org.hyperledger.besu.testutil.BlockTestUtil;
 
@@ -68,8 +68,8 @@ public void debugTraceTransactionSuccessTest() {
 
     final JsonRpcResponse response = method.response(request);
     assertThat(response.getType()).isEqualTo(RpcResponseType.SUCCESS);
-    DebugTraceTransactionDetails debugTraceTransactionDetails =
-        (DebugTraceTransactionDetails) ((JsonRpcSuccessResponse) response).getResult();
+    DebugStructLoggerTracerResult debugTraceTransactionDetails =
+        (DebugStructLoggerTracerResult) ((JsonRpcSuccessResponse) response).getResult();
     assertThat(debugTraceTransactionDetails.getGas()).isEqualTo(23705L);
     assertThat(debugTraceTransactionDetails.getReturnValue()).isEmpty();
     assertThat(debugTraceTransactionDetails.failed()).isFalse();

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

@@ -115,7 +115,7 @@ protected Collection<DebugTraceTransactionResult> getTraces(
 
                       TransactionSource transactionSource = new TransactionSource(block);
                       DebugOperationTracer debugOperationTracer =
-                          new DebugOperationTracer(traceOptions, true);
+                          new DebugOperationTracer(traceOptions.defaultTracerConfig(), true);
                       ExecuteTransactionStep executeTransactionStep =
                           new ExecuteTransactionStep(
                               chainUpdater,
@@ -124,8 +124,7 @@ protected Collection<DebugTraceTransactionResult> getTraces(
                               debugOperationTracer,
                               protocolSpec,
                               block);
-                      DebugTraceTransactionStep debugTraceTransactionStep =
-                          new DebugTraceTransactionStep();
+
                       Pipeline<TransactionTrace> traceBlockPipeline =
                           createPipelineFrom(
                                   "getTransactions",
@@ -136,7 +135,10 @@ protected Collection<DebugTraceTransactionResult> getTraces(
                                   "debug_trace_block")
                               .thenProcess("executeTransaction", executeTransactionStep)
                               .thenProcessAsyncOrdered(
-                                  "debugTraceTransactionStep", debugTraceTransactionStep, 4)
+                                  "debugTraceTransactionStep",
+                                  DebugTraceTransactionStepFactory.createAsync(
+                                      traceOptions.tracerType()),
+                                  4)
                               .andFinishWith("collect_results", tracesList::add);
 
                       try {

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

@@ -32,12 +32,14 @@
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.tracing.vm.VmTraceGenerator;
 import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
 import org.hyperledger.besu.ethereum.core.Block;
+import org.hyperledger.besu.ethereum.debug.DefaultTracerConfig;
 import org.hyperledger.besu.ethereum.debug.TraceOptions;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
 import org.hyperledger.besu.ethereum.mainnet.TransactionValidationParams;
 import org.hyperledger.besu.ethereum.transaction.TransactionSimulator;
 import org.hyperledger.besu.ethereum.transaction.TransactionSimulatorResult;
 
+import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
 import java.util.concurrent.atomic.AtomicInteger;
@@ -121,8 +123,11 @@ protected TransactionValidationParams buildTransactionValidationParams() {
 
   protected TraceOptions buildTraceOptions(final Set<TraceTypeParameter.TraceType> traceTypes) {
     return new TraceOptions(
-        traceTypes.contains(TraceType.STATE_DIFF),
-        false,
-        traceTypes.contains(TraceType.TRACE) || traceTypes.contains(TraceType.VM_TRACE));
+        "",
+        new DefaultTracerConfig(
+            traceTypes.contains(TraceType.STATE_DIFF),
+            false,
+            traceTypes.contains(TraceType.TRACE) || traceTypes.contains(TraceType.VM_TRACE)),
+        Map.of());
   }
 }

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

@@ -24,7 +24,7 @@
 import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
 import org.hyperledger.besu.ethereum.api.query.TransactionWithMetadata;
 import org.hyperledger.besu.ethereum.core.Block;
-import org.hyperledger.besu.ethereum.debug.TraceOptions;
+import org.hyperledger.besu.ethereum.debug.DefaultTracerConfig;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
 import org.hyperledger.besu.ethereum.vm.DebugOperationTracer;
 
@@ -84,7 +84,8 @@ private TransactionTrace getTransactionTrace(final Block block, final Hash trans
                     .trace(
                         mutableWorldState,
                         block,
-                        new DebugOperationTracer(new TraceOptions(false, false, true), false))
+                        new DebugOperationTracer(
+                            new DefaultTracerConfig(false, false, true), false))
                     .map(BlockTrace::getTransactionTraces)
                     .orElse(Collections.emptyList())
                     .stream()

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

@@ -73,7 +73,8 @@ protected Object resultByBlockNumber(
       return new JsonRpcErrorResponse(requestContext.getRequest().getId(), BLOCK_NOT_FOUND);
     }
 
-    final DebugOperationTracer tracer = new DebugOperationTracer(traceOptions, recordChildCallGas);
+    final DebugOperationTracer tracer =
+        new DebugOperationTracer(traceOptions.defaultTracerConfig(), recordChildCallGas);
     return transactionSimulator
         .process(
             callParams,

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

@@ -32,7 +32,7 @@
 import org.hyperledger.besu.ethereum.api.query.BlockWithMetadata;
 import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
 import org.hyperledger.besu.ethereum.api.query.TransactionWithMetadata;
-import org.hyperledger.besu.ethereum.debug.TraceOptions;
+import org.hyperledger.besu.ethereum.debug.DefaultTracerConfig;
 import org.hyperledger.besu.ethereum.vm.DebugOperationTracer;
 import org.hyperledger.besu.evm.account.Account;
 
@@ -119,7 +119,8 @@ protected Object resultByBlockHash(
                       .trace(
                           mutableWorldState,
                           blockHash,
-                          new DebugOperationTracer(new TraceOptions(false, true, true), false))
+                          new DebugOperationTracer(
+                              new DefaultTracerConfig(false, true, true), false))
                       .map(BlockTrace::getTransactionTraces)
                       .orElse(Collections.emptyList())
                       .stream()

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

@@ -122,7 +122,7 @@ protected Object resultByBlockNumber(
 
                       TransactionSource transactionSource = new TransactionSource(block);
                       DebugOperationTracer debugOperationTracer =
-                          new DebugOperationTracer(traceOptions, true);
+                          new DebugOperationTracer(traceOptions.defaultTracerConfig(), true);
                       ExecuteTransactionStep executeTransactionStep =
                           new ExecuteTransactionStep(
                               chainUpdater,
@@ -131,8 +131,7 @@ protected Object resultByBlockNumber(
                               debugOperationTracer,
                               protocolSpec,
                               block);
-                      DebugTraceTransactionStep debugTraceTransactionStep =
-                          new DebugTraceTransactionStep();
+
                       Pipeline<TransactionTrace> traceBlockPipeline =
                           createPipelineFrom(
                                   "getTransactions",
@@ -143,7 +142,10 @@ protected Object resultByBlockNumber(
                                   "debug_trace_block_by_number")
                               .thenProcess("executeTransaction", executeTransactionStep)
                               .thenProcessAsyncOrdered(
-                                  "debugTraceTransactionStep", debugTraceTransactionStep, 4)
+                                  "debugTraceTransactionStep",
+                                  DebugTraceTransactionStepFactory.createAsync(
+                                      traceOptions.tracerType()),
+                                  4)
                               .andFinishWith("collect_results", tracesList::add);
 
                       try {

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

@@ -26,7 +26,6 @@
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcError;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcErrorResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.RpcErrorType;
-import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.DebugTraceTransactionDetails;
 import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
 import org.hyperledger.besu.ethereum.debug.TraceOptions;
 import org.hyperledger.besu.ethereum.mainnet.ImmutableTransactionValidationParams;
@@ -103,8 +102,11 @@ protected PreCloseStateHandler<Object> getSimulatorResultHandler(
               final TransactionTrace transactionTrace =
                   new TransactionTrace(
                       result.transaction(), result.result(), tracer.getTraceFrames());
-
-              return new DebugTraceTransactionDetails(transactionTrace);
+              return DebugTraceTransactionStepFactory.create(
+                      getTraceOptions(requestContext).tracerType())
+                  .apply(transactionTrace)
+                  .getResult();
+              // return new DebugStructLoggerTracerResult(transactionTrace);
             });
   }
 

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.DebugTraceTransactionDetails;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.DebugTraceTransactionResult;
 import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
 import org.hyperledger.besu.ethereum.api.query.TransactionWithMetadata;
 import org.hyperledger.besu.ethereum.debug.TraceOptions;
@@ -76,31 +76,32 @@ public JsonRpcResponse response(final JsonRpcRequestContext requestContext) {
             RpcErrorType.INVALID_TRANSACTION_TRACE_PARAMS,
             e);
       }
-      final DebugTraceTransactionDetails debugTraceTransactionResult =
+      final DebugTraceTransactionResult debugResult =
           debugTraceTransactionResult(hash, transactionWithMetadata.get(), traceOptions);
 
       return new JsonRpcSuccessResponse(
-          requestContext.getRequest().getId(), debugTraceTransactionResult);
+          requestContext.getRequest().getId(), debugResult.getResult());
     } else {
       return new JsonRpcSuccessResponse(requestContext.getRequest().getId(), null);
     }
   }
 
-  private DebugTraceTransactionDetails debugTraceTransactionResult(
+  private DebugTraceTransactionResult debugTraceTransactionResult(
       final Hash hash,
       final TransactionWithMetadata transactionWithMetadata,
       final TraceOptions traceOptions) {
     final Hash blockHash = transactionWithMetadata.getBlockHash().get();
 
-    final DebugOperationTracer execTracer = new DebugOperationTracer(traceOptions, true);
+    final DebugOperationTracer execTracer =
+        new DebugOperationTracer(traceOptions.defaultTracerConfig(), true);
 
     return Tracer.processTracing(
             blockchain,
             blockHash,
             mutableWorldState ->
                 transactionTracer
                     .traceTransaction(mutableWorldState, blockHash, hash, execTracer)
-                    .map(DebugTraceTransactionDetails::new))
+                    .map(DebugTraceTransactionStepFactory.create(traceOptions.tracerType())))
         .orElse(null);
   }
 }

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

@@ -0,0 +1,89 @@
+/*
+ * 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;
+
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.processor.TransactionTrace;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.DebugCallTracerResult;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.DebugStructLoggerTracerResult;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.DebugTraceTransactionResult;
+
+import java.util.concurrent.CompletableFuture;
+import java.util.function.Function;
+
+import com.fasterxml.jackson.annotation.JsonGetter;
+
+/**
+ * Factory for creating transaction steps for various tracers.
+ *
+ * <p>This factory provides methods to create functions that process a {@link TransactionTrace} and
+ * return a {@link DebugTraceTransactionResult} with the appropriate tracer result based on the
+ * specified tracer type. Both synchronous and asynchronous processing options are available through
+ * the {@code create} and {@code createAsync} methods respectively.
+ */
+public class DebugTraceTransactionStepFactory {
+
+  /**
+   * Creates a function that processes a {@link TransactionTrace} and returns a {@link
+   * DebugTraceTransactionResult} with the appropriate tracer result based on the specified tracer
+   * type.
+   *
+   * @param tracerType the type of tracer to use for processing the transaction trace
+   * @return a function that processes a {@link TransactionTrace} and returns a {@link
+   *     DebugTraceTransactionResult} with the appropriate tracer result
+   */
+  public static Function<TransactionTrace, DebugTraceTransactionResult> create(
+      final String tracerType) {
+    // Normalize null values to empty string
+    final String normalizedTracerType = tracerType == null ? "" : tracerType;
+    return switch (normalizedTracerType) {
+      case "" ->
+          transactionTrace -> {
+            var result = new DebugStructLoggerTracerResult(transactionTrace);
+            return new DebugTraceTransactionResult(transactionTrace, result);
+          };
+      case "callTracer" ->
+          transactionTrace -> {
+            var result = new DebugCallTracerResult(transactionTrace);
+            return new DebugTraceTransactionResult(transactionTrace, result);
+          };
+      // TODO: Load via "plugin" system, and then raise an error if not found
+      default ->
+          transactionTrace ->
+              new DebugTraceTransactionResult(transactionTrace, new NotYetImplemented());
+    };
+  }
+
+  /**
+   * Creates an asynchronous function that processes a {@link TransactionTrace} and returns a {@link
+   * DebugTraceTransactionResult} with the appropriate tracer result based on the specified tracer
+   * type.
+   *
+   * @param tracerType the type of tracer to use for processing the transaction trace
+   * @return an asynchronous function that processes a {@link TransactionTrace} and returns a {@link
+   *     DebugTraceTransactionResult} with the appropriate tracer result
+   */
+  public static Function<TransactionTrace, CompletableFuture<DebugTraceTransactionResult>>
+      createAsync(final String tracerType) {
+    return transactionTrace ->
+        CompletableFuture.supplyAsync(() -> create(tracerType).apply(transactionTrace));
+  }
+
+  static class NotYetImplemented {
+    @JsonGetter("error")
+    public String getError() {
+      return "Not Yet Implemented";
+    }
+  }
+}

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

@@ -31,7 +31,7 @@
 import org.hyperledger.besu.ethereum.core.Block;
 import org.hyperledger.besu.ethereum.core.BlockHeader;
 import org.hyperledger.besu.ethereum.core.MutableWorldState;
-import org.hyperledger.besu.ethereum.debug.TraceOptions;
+import org.hyperledger.besu.ethereum.debug.DefaultTracerConfig;
 import org.hyperledger.besu.ethereum.eth.manager.EthScheduler;
 import org.hyperledger.besu.ethereum.mainnet.MainnetTransactionProcessor;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
@@ -127,7 +127,7 @@ protected ArrayNodeWrapper traceBlock(
 
               TransactionSource transactionSource = new TransactionSource(block);
               DebugOperationTracer debugOperationTracer =
-                  new DebugOperationTracer(new TraceOptions(false, false, true), false);
+                  new DebugOperationTracer(new DefaultTracerConfig(false, false, true), false);
               ExecuteTransactionStep executeTransactionStep =
                   new ExecuteTransactionStep(
                       chainUpdater,

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

@@ -156,7 +156,7 @@ private JsonNode getSingleCallResult(
       final WorldUpdater worldUpdater) {
     final Set<TraceTypeParameter.TraceType> traceTypes = traceTypeParameter.getTraceTypes();
     final DebugOperationTracer tracer =
-        new DebugOperationTracer(buildTraceOptions(traceTypes), false);
+        new DebugOperationTracer(buildTraceOptions(traceTypes).defaultTracerConfig(), false);
     final var miningBeneficiary =
         protocolSchedule
             .getByBlockHeader(header)