Time limited block creation

CHANGELOG.md

@@ -1,16 +1,5 @@
 # Changelog
 
-### Breaking Changes
-
-### Deprecations
-
-### Additions and Improvements
-- TraceService: return results for transactions in block [#6086](https://github.com/hyperledger/besu/pull/6086)
-
-### Bug Fixes
-
-### Download Links
-
 ## 23.10.2
 
 ### Breaking Changes
@@ -22,6 +11,8 @@
 - Add a method to read from a `Memory` instance without altering its inner state [#6073](https://github.com/hyperledger/besu/pull/6073)
 - Accept `input` and `data` field for the payload of transaction-related RPC methods [#6094](https://github.com/hyperledger/besu/pull/6094)
 - Add APIs to set and get the min gas price a transaction must pay for being selected during block creation [#6097](https://github.com/hyperledger/besu/pull/6097)
+- Introduce the possibility to limit the time spent selecting pending transactions during block creation, using the new experimental option `Xtxs-selection-max-time` (by default set to 5000ms) [#6044](https://github.com/hyperledger/besu/pull/6044)
+- TraceService: return results for transactions in block [#6086](https://github.com/hyperledger/besu/pull/6086) 
 
 ### Bug fixes
 

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

@@ -25,6 +25,7 @@
 import static org.hyperledger.besu.ethereum.core.MiningParameters.Unstable.DEFAULT_POW_JOB_TTL;
 import static org.hyperledger.besu.ethereum.core.MiningParameters.Unstable.DEFAULT_REMOTE_SEALERS_LIMIT;
 import static org.hyperledger.besu.ethereum.core.MiningParameters.Unstable.DEFAULT_REMOTE_SEALERS_TTL;
+import static org.hyperledger.besu.ethereum.core.MiningParameters.Unstable.DEFAULT_TXS_SELECTION_MAX_TIME;
 
 import org.hyperledger.besu.cli.util.CommandLineUtils;
 import org.hyperledger.besu.datatypes.Address;
@@ -162,6 +163,14 @@ static class Unstable {
                 + " then it waits before next repetition. Must be positive and ≤ 2000 (default: ${DEFAULT-VALUE} milliseconds)")
     private Long posBlockCreationRepetitionMinDuration =
         DEFAULT_POS_BLOCK_CREATION_REPETITION_MIN_DURATION;
+
+    @CommandLine.Option(
+        hidden = true,
+        names = {"--Xtxs-selection-max-time"},
+        description =
+            "Specifies the maximum time, in milliseconds, that could be spent selecting transactions to be included in the block."
+                + " Must be positive and ≤ (default: ${DEFAULT-VALUE} milliseconds)")
+    private Long txsSelectionMaxTime = DEFAULT_TXS_SELECTION_MAX_TIME;
   }
 
   private MiningOptions() {}
@@ -231,14 +240,23 @@ public void validate(
     if (unstableOptions.posBlockCreationMaxTime <= 0
         || unstableOptions.posBlockCreationMaxTime > DEFAULT_POS_BLOCK_CREATION_MAX_TIME) {
       throw new ParameterException(
-          commandLine, "--Xpos-block-creation-max-time must be positive and ≤ 12000");
+          commandLine,
+          "--Xpos-block-creation-max-time must be positive and ≤ "
+              + DEFAULT_POS_BLOCK_CREATION_MAX_TIME);
     }
 
     if (unstableOptions.posBlockCreationRepetitionMinDuration <= 0
         || unstableOptions.posBlockCreationRepetitionMinDuration > 2000) {
       throw new ParameterException(
           commandLine, "--Xpos-block-creation-repetition-min-duration must be positive and ≤ 2000");
     }
+
+    if (unstableOptions.txsSelectionMaxTime <= 0
+        || unstableOptions.txsSelectionMaxTime > DEFAULT_TXS_SELECTION_MAX_TIME) {
+      throw new ParameterException(
+          commandLine,
+          "--Xtxs-selection-max-time must be positive and ≤ " + DEFAULT_TXS_SELECTION_MAX_TIME);
+    }
   }
 
   static MiningOptions fromConfig(final MiningParameters miningParameters) {
@@ -265,6 +283,8 @@ static MiningOptions fromConfig(final MiningParameters miningParameters) {
         miningParameters.getUnstable().getPosBlockCreationMaxTime();
     miningOptions.unstableOptions.posBlockCreationRepetitionMinDuration =
         miningParameters.getUnstable().getPosBlockCreationRepetitionMinDuration();
+    miningOptions.unstableOptions.txsSelectionMaxTime =
+        miningParameters.getUnstable().getTxsSelectionMaxTime();
 
     miningParameters.getCoinbase().ifPresent(coinbase -> miningOptions.coinbase = coinbase);
     miningParameters.getTargetGasLimit().ifPresent(tgl -> miningOptions.targetGasLimit = tgl);
@@ -304,6 +324,7 @@ public MiningParameters toDomainObject() {
                     .posBlockCreationMaxTime(unstableOptions.posBlockCreationMaxTime)
                     .posBlockCreationRepetitionMinDuration(
                         unstableOptions.posBlockCreationRepetitionMinDuration)
+                    .txsSelectionMaxTime(unstableOptions.txsSelectionMaxTime)
                     .build());
 
     return miningParametersBuilder.build();

besu/src/main/java/org/hyperledger/besu/controller/CliqueBesuControllerBuilder.java

@@ -91,7 +91,8 @@ protected MiningCoordinator createMiningCoordinator(
                 protocolContext.getConsensusContext(CliqueContext.class).getValidatorProvider(),
                 localAddress,
                 secondsBetweenBlocks),
-            epochManager);
+            epochManager,
+            ethProtocolManager.ethContext().getScheduler());
     final CliqueMiningCoordinator miningCoordinator =
         new CliqueMiningCoordinator(
             protocolContext.getBlockchain(),

besu/src/main/java/org/hyperledger/besu/controller/IbftBesuControllerBuilder.java

@@ -153,7 +153,8 @@ protected MiningCoordinator createMiningCoordinator(
             forksSchedule,
             miningParameters,
             localAddress,
-            bftExtraDataCodec().get());
+            bftExtraDataCodec().get(),
+            ethProtocolManager.ethContext().getScheduler());
 
     final ValidatorProvider validatorProvider =
         protocolContext.getConsensusContext(BftContext.class).getValidatorProvider();

besu/src/main/java/org/hyperledger/besu/controller/MainnetBesuControllerBuilder.java

@@ -55,7 +55,8 @@ protected MiningCoordinator createMiningCoordinator(
                 MainnetBlockHeaderValidator.MINIMUM_SECONDS_SINCE_PARENT,
                 MainnetBlockHeaderValidator.TIMESTAMP_TOLERANCE_S,
                 clock),
-            epochCalculator);
+            epochCalculator,
+            ethProtocolManager.ethContext().getScheduler());
 
     final PoWMiningCoordinator miningCoordinator =
         new PoWMiningCoordinator(

besu/src/main/java/org/hyperledger/besu/controller/MergeBesuControllerBuilder.java

@@ -35,7 +35,6 @@
 import org.hyperledger.besu.ethereum.eth.manager.EthProtocolManager;
 import org.hyperledger.besu.ethereum.eth.manager.EthScheduler;
 import org.hyperledger.besu.ethereum.eth.manager.MergePeerFilter;
-import org.hyperledger.besu.ethereum.eth.manager.MonitoredExecutors;
 import org.hyperledger.besu.ethereum.eth.peervalidation.PeerValidator;
 import org.hyperledger.besu.ethereum.eth.peervalidation.RequiredBlocksPeerValidator;
 import org.hyperledger.besu.ethereum.eth.sync.SynchronizerConfiguration;
@@ -46,13 +45,10 @@
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
 import org.hyperledger.besu.ethereum.mainnet.ScheduleBasedBlockHeaderFunctions;
 import org.hyperledger.besu.ethereum.worldstate.WorldStateArchive;
-import org.hyperledger.besu.plugin.services.MetricsSystem;
 
 import java.util.List;
 import java.util.Optional;
 import java.util.OptionalLong;
-import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.ExecutorService;
 import java.util.concurrent.atomic.AtomicReference;
 
 import org.slf4j.Logger;
@@ -85,7 +81,7 @@ protected MiningCoordinator createMiningCoordinator(
             syncState,
             BackwardChain.from(
                 storageProvider, ScheduleBasedBlockHeaderFunctions.create(protocolSchedule))),
-        metricsSystem);
+        ethProtocolManager.ethContext().getScheduler());
   }
 
   @Override
@@ -146,7 +142,7 @@ protected EthProtocolManager createEthProtocolManager(
    * @param miningParameters the mining parameters
    * @param syncState the sync state
    * @param backwardSyncContext the backward sync context
-   * @param metricsSystem the metrics system
+   * @param ethScheduler the scheduler
    * @return the mining coordinator
    */
   protected MiningCoordinator createTransitionMiningCoordinator(
@@ -156,24 +152,18 @@ protected MiningCoordinator createTransitionMiningCoordinator(
       final MiningParameters miningParameters,
       final SyncState syncState,
       final BackwardSyncContext backwardSyncContext,
-      final MetricsSystem metricsSystem) {
+      final EthScheduler ethScheduler) {
 
     this.syncState.set(syncState);
 
-    final ExecutorService blockBuilderExecutor =
-        MonitoredExecutors.newSingleThreadExecutor("PoS-Block-Builder", metricsSystem);
-
     final GenesisConfigOptions genesisConfigOptions = configOptionsSupplier.get();
     final Optional<Address> depositContractAddress =
         genesisConfigOptions.getDepositContractAddress();
 
     return new MergeCoordinator(
         protocolContext,
         protocolSchedule,
-        task -> {
-          LOG.debug("Block builder executor status {}", blockBuilderExecutor);
-          return CompletableFuture.runAsync(task, blockBuilderExecutor);
-        },
+        ethScheduler,
         transactionPool,
         miningParameters,
         backwardSyncContext,

besu/src/main/java/org/hyperledger/besu/controller/QbftBesuControllerBuilder.java

@@ -191,7 +191,8 @@ protected MiningCoordinator createMiningCoordinator(
             qbftForksSchedule,
             miningParameters,
             localAddress,
-            bftExtraDataCodec().get());
+            bftExtraDataCodec().get(),
+            ethProtocolManager.ethContext().getScheduler());
 
     final ValidatorProvider validatorProvider =
         protocolContext.getConsensusContext(BftContext.class).getValidatorProvider();

besu/src/main/java/org/hyperledger/besu/controller/TransitionBesuControllerBuilder.java

@@ -144,7 +144,7 @@ protected MiningCoordinator createMiningCoordinator(
                 transitionMiningParameters,
                 syncState,
                 transitionBackwardsSyncContext,
-                metricsSystem));
+                ethProtocolManager.ethContext().getScheduler()));
     initTransitionWatcher(protocolContext, composedCoordinator);
     return composedCoordinator;
   }

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

@@ -16,6 +16,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.hyperledger.besu.ethereum.core.MiningParameters.Unstable.DEFAULT_POS_BLOCK_CREATION_MAX_TIME;
+import static org.hyperledger.besu.ethereum.core.MiningParameters.Unstable.DEFAULT_TXS_SELECTION_MAX_TIME;
 import static org.mockito.Mockito.atMost;
 import static org.mockito.Mockito.verify;
 
@@ -308,6 +309,31 @@ public void posBlockCreationMaxTimeOutOfAllowedRange() {
         "17000");
   }
 
+  @Test
+  public void txsSelectionMaxTimeDefaultValue() {
+    internalTestSuccess(
+        miningParams ->
+            assertThat(miningParams.getUnstable().getTxsSelectionMaxTime())
+                .isEqualTo(DEFAULT_TXS_SELECTION_MAX_TIME));
+  }
+
+  @Test
+  public void txsSelectionMaxTimeOption() {
+    internalTestSuccess(
+        miningParams ->
+            assertThat(miningParams.getUnstable().getTxsSelectionMaxTime()).isEqualTo(1700L),
+        "--Xtxs-selection-max-time",
+        "1700");
+  }
+
+  @Test
+  public void txsSelectionMaxTimeOutOfAllowedRange() {
+    internalTestFailure(
+        "--Xtxs-selection-max-time must be positive and ≤ 5000",
+        "--Xtxs-selection-max-time",
+        "6000");
+  }
+
   @Override
   protected MiningParameters createDefaultDomainObject() {
     return MiningParameters.newDefault();

besu/src/test/java/org/hyperledger/besu/controller/TransitionControllerBuilderTest.java

@@ -49,12 +49,14 @@
 import org.hyperledger.besu.ethereum.mainnet.feemarket.FeeMarket;
 import org.hyperledger.besu.ethereum.storage.StorageProvider;
 import org.hyperledger.besu.metrics.noop.NoOpMetricsSystem;
+import org.hyperledger.besu.testutil.DeterministicEthScheduler;
 
 import java.util.Optional;
 
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
+import org.mockito.Answers;
 import org.mockito.Mock;
 import org.mockito.junit.MockitoJUnitRunner;
 
@@ -71,7 +73,10 @@ public class TransitionControllerBuilderTest {
   @Mock MutableBlockchain mockBlockchain;
   @Mock TransactionPool transactionPool;
   @Mock SyncState syncState;
-  @Mock EthProtocolManager ethProtocolManager;
+
+  @Mock(answer = Answers.RETURNS_DEEP_STUBS)
+  EthProtocolManager ethProtocolManager;
+
   @Mock PostMergeContext mergeContext;
   StorageProvider storageProvider = new InMemoryKeyValueStorageProvider();
 
@@ -101,6 +106,8 @@ public void setup() {
         .thenReturn(mock(CliqueContext.class));
     when(protocolContext.getConsensusContext(PostMergeContext.class)).thenReturn(mergeContext);
     when(protocolContext.getConsensusContext(MergeContext.class)).thenReturn(mergeContext);
+    when(ethProtocolManager.ethContext().getScheduler())
+        .thenReturn(new DeterministicEthScheduler());
     miningParameters = MiningParameters.newDefault();
   }
 

consensus/clique/src/main/java/org/hyperledger/besu/consensus/clique/blockcreation/CliqueBlockCreator.java

@@ -32,6 +32,7 @@
 import org.hyperledger.besu.ethereum.core.MiningParameters;
 import org.hyperledger.besu.ethereum.core.SealableBlockHeader;
 import org.hyperledger.besu.ethereum.core.Util;
+import org.hyperledger.besu.ethereum.eth.manager.EthScheduler;
 import org.hyperledger.besu.ethereum.eth.transactions.TransactionPool;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
 import org.hyperledger.besu.ethereum.mainnet.ScheduleBasedBlockHeaderFunctions;
@@ -64,7 +65,8 @@ public CliqueBlockCreator(
       final ProtocolSchedule protocolSchedule,
       final NodeKey nodeKey,
       final BlockHeader parentHeader,
-      final EpochManager epochManager) {
+      final EpochManager epochManager,
+      final EthScheduler ethScheduler) {
     super(
         miningParameters,
         __ -> Util.publicKeyToAddress(nodeKey.getPublicKey()),
@@ -73,7 +75,8 @@ public CliqueBlockCreator(
         protocolContext,
         protocolSchedule,
         parentHeader,
-        Optional.empty());
+        Optional.empty(),
+        ethScheduler);
     this.nodeKey = nodeKey;
     this.epochManager = epochManager;
   }

consensus/clique/src/main/java/org/hyperledger/besu/consensus/clique/blockcreation/CliqueMinerExecutor.java

@@ -28,6 +28,7 @@
 import org.hyperledger.besu.ethereum.core.BlockHeader;
 import org.hyperledger.besu.ethereum.core.MiningParameters;
 import org.hyperledger.besu.ethereum.core.Util;
+import org.hyperledger.besu.ethereum.eth.manager.EthScheduler;
 import org.hyperledger.besu.ethereum.eth.transactions.TransactionPool;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
 import org.hyperledger.besu.util.Subscribers;
@@ -66,8 +67,15 @@ public CliqueMinerExecutor(
       final NodeKey nodeKey,
       final MiningParameters miningParams,
       final AbstractBlockScheduler blockScheduler,
-      final EpochManager epochManager) {
-    super(protocolContext, protocolSchedule, transactionPool, miningParams, blockScheduler);
+      final EpochManager epochManager,
+      final EthScheduler ethScheduler) {
+    super(
+        protocolContext,
+        protocolSchedule,
+        transactionPool,
+        miningParams,
+        blockScheduler,
+        ethScheduler);
     this.nodeKey = nodeKey;
     this.localAddress = Util.publicKeyToAddress(nodeKey.getPublicKey());
     this.epochManager = epochManager;
@@ -89,7 +97,8 @@ public CliqueBlockMiner createMiner(
                 protocolSchedule,
                 nodeKey,
                 header,
-                epochManager);
+                epochManager,
+                ethScheduler);
 
     return new CliqueBlockMiner(
         blockCreator,