Introduce a timeout for the evaluation of a single tx during block creation

CHANGELOG.md

@@ -19,6 +19,7 @@
 - Add `yParity` to GraphQL and JSON-RPC for relevant querise. [6119](https://github.com/hyperledger/besu/pull/6119)
 - Force tx replacement price bump to zero when zero base fee market is configured or `--min-gas-price` is set to 0. This allows for easier tx replacement in networks where there is not gas price. [#6079](https://github.com/hyperledger/besu/pull/6079)
 - Introduce the possibility to limit the time spent selecting pending transactions during block creation, using the new experimental option `Xblock-txs-selection-max-time` on PoS and PoW networks (by default set to 5000ms) or `Xpoa-block-txs-selection-max-time` on PoA networks (by default 75% of the min block time) [#6044](https://github.com/hyperledger/besu/pull/6044)
+- Introduce the possibility to limit the time spent evaluating a single pending transactions during block creation, using the new experimental option `Xblock-txs-selection-per-tx-max-time` (by default set to the value of block txs selection max time for your network) [#6089](https://github.com/hyperledger/besu/pull/6089)
 
 ### Bug fixes
 - Upgrade netty to address CVE-2023-44487, CVE-2023-34462 [#6100](https://github.com/hyperledger/besu/pull/6100)

besu/src/main/java/org/hyperledger/besu/cli/options/MiningOptions.java

@@ -187,6 +187,15 @@ static class Unstable {
                 + " To be only used on PoA networks, for other networks see Xblock-txs-selection-max-time."
                 + " (default: ${DEFAULT-VALUE})")
     private Percentage poaBlockTxsSelectionMaxTime = DEFAULT_POA_BLOCK_TXS_SELECTION_MAX_TIME;
+
+    @CommandLine.Option(
+        hidden = true,
+        names = {"--Xblock-txs-selection-per-tx-max-time"},
+        description =
+            "Specifies the maximum time, in milliseconds, that could be spent selecting a single transaction to be included in the block."
+                + " Must be positive and ≤ the max time allocated for the block txs selection."
+                + " (default: will get the block txs selection max time as specified by --Xblock-txs-selection-max-time or --Xpoa-block-txs-selection-max-time)")
+    private Long blockTxsSelectionPerTxMaxTime;
   }
 
   private MiningOptions() {}
@@ -324,6 +333,11 @@ static MiningOptions fromConfig(final MiningParameters miningParameters) {
 
     miningParameters.getCoinbase().ifPresent(coinbase -> miningOptions.coinbase = coinbase);
     miningParameters.getTargetGasLimit().ifPresent(tgl -> miningOptions.targetGasLimit = tgl);
+    miningParameters
+        .getUnstable()
+        .getConfiguredBlockTxsSelectionPerTxMaxTime()
+        .ifPresent(value -> miningOptions.unstableOptions.blockTxsSelectionPerTxMaxTime = value);
+
     return miningOptions;
   }
 
@@ -344,25 +358,31 @@ public MiningParameters toDomainObject() {
       updatableInitValuesBuilder.coinbase(coinbase);
     }
 
+    final var unstableParametersBuilder =
+        ImmutableMiningParameters.Unstable.builder()
+            .remoteSealersLimit(unstableOptions.remoteSealersLimit)
+            .remoteSealersTimeToLive(unstableOptions.remoteSealersTimeToLive)
+            .powJobTimeToLive(unstableOptions.powJobTimeToLive)
+            .maxOmmerDepth(unstableOptions.maxOmmersDepth)
+            .stratumExtranonce(unstableOptions.stratumExtranonce)
+            .posBlockCreationMaxTime(unstableOptions.posBlockCreationMaxTime)
+            .posBlockCreationRepetitionMinDuration(
+                unstableOptions.posBlockCreationRepetitionMinDuration)
+            .nonPoaBlockTxsSelectionMaxTime(unstableOptions.nonPoaBlockTxsSelectionMaxTime)
+            .poaBlockTxsSelectionMaxTime(unstableOptions.poaBlockTxsSelectionMaxTime);
+
+    if (unstableOptions.blockTxsSelectionPerTxMaxTime != null) {
+      unstableParametersBuilder.configuredBlockTxsSelectionPerTxMaxTime(
+          unstableOptions.blockTxsSelectionPerTxMaxTime);
+    }
+
     final var miningParametersBuilder =
         ImmutableMiningParameters.builder()
             .mutableInitValues(updatableInitValuesBuilder.build())
             .isStratumMiningEnabled(iStratumMiningEnabled)
             .stratumNetworkInterface(stratumNetworkInterface)
             .stratumPort(stratumPort)
-            .unstable(
-                ImmutableMiningParameters.Unstable.builder()
-                    .remoteSealersLimit(unstableOptions.remoteSealersLimit)
-                    .remoteSealersTimeToLive(unstableOptions.remoteSealersTimeToLive)
-                    .powJobTimeToLive(unstableOptions.powJobTimeToLive)
-                    .maxOmmerDepth(unstableOptions.maxOmmersDepth)
-                    .stratumExtranonce(unstableOptions.stratumExtranonce)
-                    .posBlockCreationMaxTime(unstableOptions.posBlockCreationMaxTime)
-                    .posBlockCreationRepetitionMinDuration(
-                        unstableOptions.posBlockCreationRepetitionMinDuration)
-                    .nonPoaBlockTxsSelectionMaxTime(unstableOptions.nonPoaBlockTxsSelectionMaxTime)
-                    .poaBlockTxsSelectionMaxTime(unstableOptions.poaBlockTxsSelectionMaxTime)
-                    .build());
+            .unstable(unstableParametersBuilder.build());
 
     return miningParametersBuilder.build();
   }

besu/src/test/java/org/hyperledger/besu/cli/options/MiningOptionsTest.java

@@ -32,6 +32,8 @@
 
 import java.io.IOException;
 import java.nio.file.Path;
+import java.util.Arrays;
+import java.util.List;
 import java.util.Optional;
 
 import org.apache.tuweni.bytes.Bytes;
@@ -384,6 +386,48 @@ public void poaBlockTxsSelectionMaxTimeOnlyCompatibleWithPoaNetworks() {
         "90");
   }
 
+  @Test
+  public void txsSelectionPerTxMaxTimeDefaultValue() {
+    // by default, it takes the value of the block txs selection max time
+    internalTestSuccess(
+        miningParams ->
+            assertThat(miningParams.getUnstable().getBlockTxsSelectionPerTxMaxTime())
+                .isEqualTo(miningParams.getUnstable().getBlockTxsSelectionMaxTime())
+                .isEqualTo(DEFAULT_NON_POA_BLOCK_TXS_SELECTION_MAX_TIME));
+  }
+
+  @Test
+  public void txsSelectionPerTxMaxTimeOption() {
+    internalTestSuccess(
+        miningParams ->
+            assertThat(miningParams.getUnstable().getBlockTxsSelectionPerTxMaxTime())
+                .isEqualTo(700L),
+        "--Xblock-txs-selection-per-tx-max-time",
+        "700");
+  }
+
+  @Test
+  public void txsSelectionPerTxMaxTimeOptionGetsTheValueOfTxsSelectionMaxTimeIfNotConfigured() {
+    // by default, it takes the value of the block txs selection max time
+    internalTestSuccess(
+        miningParams ->
+            assertThat(miningParams.getUnstable().getBlockTxsSelectionPerTxMaxTime())
+                .isEqualTo(miningParams.getUnstable().getBlockTxsSelectionMaxTime())
+                .isEqualTo(1000L),
+        "--Xblock-txs-selection-max-time",
+        "1000");
+  }
+
+  @Test
+  public void txsSelectionPerTxMaxTimeOutOfAllowedRange() {
+    internalTestFailure(
+        "blockTxsSelectionPerTxMaxTime (4000) is greater than the blockTxsSelectionMaxTime (3000)",
+        "--Xblock-txs-selection-max-time",
+        "3000",
+        "--Xblock-txs-selection-per-tx-max-time",
+        "4000");
+  }
+
   @Override
   protected MiningParameters createDefaultDomainObject() {
     return MiningParameters.newDefault();
@@ -413,4 +457,9 @@ protected MiningOptions optionsFromDomainObject(final MiningParameters domainObj
   protected MiningOptions getOptionsFromBesuCommand(final TestBesuCommand besuCommand) {
     return besuCommand.getMiningOptions();
   }
+
+  @Override
+  protected List<String> getFieldsWithComputedDefaults() {
+    return Arrays.asList("unstableOptions.blockTxsSelectionPerTxMaxTime");
+  }
 }

build.gradle

@@ -174,6 +174,7 @@ allprojects {
       importOrder 'org.hyperledger', 'java', ''
       trimTrailingWhitespace()
       endWithNewline()
+      toggleOffOn()
     }
     groovyGradle {
       target '*.gradle'

consensus/merge/src/test/java/org/hyperledger/besu/consensus/merge/blockcreation/MergeCoordinatorTest.java

@@ -90,6 +90,7 @@
 import java.util.concurrent.TimeoutException;
 import java.util.concurrent.atomic.AtomicLong;
 import java.util.concurrent.atomic.AtomicReference;
+import java.util.function.Supplier;
 
 import com.google.common.base.Suppliers;
 import org.apache.tuweni.bytes.Bytes;
@@ -182,6 +183,7 @@ public class MergeCoordinatorTest implements MergeGenesisConfigHelper {
   private final BadBlockManager badBlockManager = spy(new BadBlockManager());
 
   @BeforeEach
+  @SuppressWarnings("unchecked")
   public void setUp() {
     when(mergeContext.as(MergeContext.class)).thenReturn(mergeContext);
     when(mergeContext.getTerminalTotalDifficulty())
@@ -206,7 +208,7 @@ public void setUp() {
     genesisState.writeStateTo(mutable);
     mutable.persist(null);
 
-    when(ethScheduler.scheduleBlockCreationTask(any()))
+    when(ethScheduler.scheduleBlockCreationTask(any(Runnable.class)))
         .thenAnswer(
             invocation -> {
               final Runnable runnable = invocation.getArgument(0);
@@ -217,6 +219,17 @@ public void setUp() {
               return blockCreationTask;
             });
 
+    when(ethScheduler.scheduleBlockCreationTask(any(Supplier.class)))
+        .thenAnswer(
+            invocation -> {
+              final Supplier<?> supplier = invocation.getArgument(0);
+              if (!invocation.toString().contains("MergeCoordinator")) {
+                return CompletableFuture.supplyAsync(supplier);
+              }
+              blockCreationTask = CompletableFuture.supplyAsync((Supplier<Void>) supplier);
+              return blockCreationTask;
+            });
+
     MergeConfigOptions.setMergeEnabled(true);
 
     when(ethContext.getEthPeers().subscribeConnect(any())).thenReturn(1L);
@@ -234,6 +247,10 @@ public void setUp() {
 
     this.transactionPool.setEnabled();
 
+    createMergeCoordinator(miningParameters);
+  }
+
+  private void createMergeCoordinator(final MiningParameters miningParameters) {
     this.coordinator =
         new MergeCoordinator(
             protocolContext,
@@ -558,6 +575,7 @@ public void shouldStopRetryBlockCreationIfTimeExpired() throws InterruptedExcept
             .from(miningParameters)
             .unstable(Unstable.builder().posBlockCreationMaxTime(100).build())
             .build();
+    createMergeCoordinator(miningParameters);
     doAnswer(
             invocation -> {
               retries.incrementAndGet();
@@ -752,15 +770,7 @@ public void shouldUseExtraDataFromMiningParameters() {
             .mutableInitValues(MutableInitValues.builder().extraData(extraData).build())
             .build();
 
-    this.coordinator =
-        new MergeCoordinator(
-            protocolContext,
-            protocolSchedule,
-            ethScheduler,
-            transactionPool,
-            miningParameters,
-            backwardSyncContext,
-            Optional.empty());
+    createMergeCoordinator(miningParameters);
 
     final PayloadIdentifier payloadId =
         this.coordinator.preparePayload(