Remove experimental flag --Xenable-extra-debug-tracers (#9638)

This change makes the callTracer always available for debug_trace* RPC methods without requiring the experimental flag.

- Remove static enableExtraTracers flag from DebugTraceTransactionStepFactory
- Delete DebugTracerOptions class entirely (no longer needed)
- Remove unstableDebugTracerOptions from BesuCommand
- Update CALL_TRACER to always use CallTracerResultConverter
- Update tests to remove flag assignments
- Update unit test to reflect CALL_TRACER as fully implemented
- Update CHANGELOG.md with breaking change notice


Signed-off-by: Usman Saleem <usman@usmans.info>

Author: usmansaleem

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 
 ### Breaking Changes
+- Remove experimental CLI flag `--Xenable-extra-debug-tracers`. Call tracer (`callTracer`) is now always available for `debug_trace*` methods.
 - RPC changes to enhance compatibility with other ELs
   - RPCs using filter parameter including `eth_getLogs` and `trace_filter` return an error if `fromBlock` is greater than `toBlock`, or if `toBlock` extends beyond chain head (previously returned an empty list) [#9604](https://github.com/hyperledger/besu/pull/9604)
 

app/src/main/java/org/hyperledger/besu/cli/BesuCommand.java

@@ -45,7 +45,6 @@
 import org.hyperledger.besu.cli.options.ApiConfigurationOptions;
 import org.hyperledger.besu.cli.options.BalConfigurationOptions;
 import org.hyperledger.besu.cli.options.ChainPruningOptions;
-import org.hyperledger.besu.cli.options.DebugTracerOptions;
 import org.hyperledger.besu.cli.options.DnsOptions;
 import org.hyperledger.besu.cli.options.EngineRPCConfiguration;
 import org.hyperledger.besu.cli.options.EngineRPCOptions;
@@ -325,7 +324,6 @@ public class BesuCommand implements DefaultCommandValues, Runnable {
   private final IpcOptions unstableIpcOptions = IpcOptions.create();
   private final ChainPruningOptions unstableChainPruningOptions = ChainPruningOptions.create();
   private final QBFTOptions unstableQbftOptions = QBFTOptions.create();
-  private final DebugTracerOptions unstableDebugTracerOptions = DebugTracerOptions.create();
 
   // stable CLI options
   final DataStorageOptions dataStorageOptions = DataStorageOptions.create();
@@ -1250,7 +1248,6 @@ private void handleUnstableOptions() {
             .put("IPC Options", unstableIpcOptions)
             .put("Chain Data Pruning Options", unstableChainPruningOptions)
             .put("QBFT Options", unstableQbftOptions)
-            .put("Debug Tracer Options", unstableDebugTracerOptions)
             .build();
 
     UnstableOptionsSubCommand.createUnstableOptions(commandLine, unstableOptions);

app/src/main/java/org/hyperledger/besu/cli/options/DebugTracerOptions.java

@@ -21,7 +21,6 @@
 import org.hyperledger.besu.ethereum.api.jsonrpc.JsonRpcTestMethodsFactory;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequest;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequestContext;
-import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.DebugTraceTransactionStepFactory;
 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;
@@ -58,9 +57,6 @@ public class DebugStandardTraceBlockToFileIntegrationTest {
 
   @BeforeAll
   public static void setUpOnce() throws Exception {
-    // experimental tracers are meant to be enabled in tests
-    DebugTraceTransactionStepFactory.enableExtraTracers = true;
-
     final String genesisJson =
         Resources.toString(BlockTestUtil.getTestGenesisUrl(), StandardCharsets.UTF_8);
 

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

@@ -23,7 +23,6 @@
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequest;
 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.DebugTraceTransactionStepFactory;
 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;
@@ -53,9 +52,6 @@ public class DebugTraceTransactionIntegrationTest {
 
   @BeforeAll
   public static void setUpOnce() throws Exception {
-    // experimental tracers are meant to be enabled in tests
-    DebugTraceTransactionStepFactory.enableExtraTracers = true;
-
     final String genesisJson =
         Resources.toString(BlockTestUtil.getTestGenesisUrl(), StandardCharsets.UTF_8);
 

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

@@ -38,8 +38,6 @@
  * the {@code create} and {@code createAsync} methods respectively.
  */
 public class DebugTraceTransactionStepFactory {
-  // feature flag to enable non-default tracers
-  public static boolean enableExtraTracers = false;
 
   /**
    * Creates a function that processes a {@link TransactionTrace} and returns a {@link
@@ -62,12 +60,8 @@ public static Function<TransactionTrace, DebugTraceTransactionResult> create(
           };
       case CALL_TRACER ->
           transactionTrace -> {
-            if (enableExtraTracers) {
-              var result = CallTracerResultConverter.convert(transactionTrace);
-              return new DebugTraceTransactionResult(transactionTrace, result);
-            }
-            return new DebugTraceTransactionResult(
-                transactionTrace, new UnimplementedTracerResult());
+            var result = CallTracerResultConverter.convert(transactionTrace);
+            return new DebugTraceTransactionResult(transactionTrace, result);
           };
       case FLAT_CALL_TRACER ->
           transactionTrace -> {

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

@@ -17,7 +17,6 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 import org.hyperledger.besu.ethereum.api.jsonrpc.AbstractJsonRpcHttpBySpecTest;
-import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.DebugTraceTransactionStepFactory;
 import org.hyperledger.besu.ethereum.core.BlockchainSetupUtil;
 import org.hyperledger.besu.plugin.services.storage.DataStorageFormat;
 
@@ -30,9 +29,6 @@ public class DebugGethTraceJsonRpcHttpBySpecTest extends AbstractJsonRpcHttpBySp
   public void setup() throws Exception {
     setupBonsaiBlockchain();
     startService();
-
-    // Enable extra tracers for this test
-    DebugTraceTransactionStepFactory.enableExtraTracers = true;
   }
 
   @Override

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

@@ -91,7 +91,7 @@ void shouldCreateFunctionForOpcodeTracer() {
   @ParameterizedTest
   @EnumSource(
       value = TracerType.class,
-      names = {"CALL_TRACER", "FLAT_CALL_TRACER"})
+      names = {"FLAT_CALL_TRACER"})
   @DisplayName("should create function for unimplemented tracers")
   void shouldCreateFunctionForNotYetImplementedTracers(final TracerType tracerType) {
     // Given