Sequenced pool synonym for legacy pool (hyperledger#6274)

* Sequenced pool synonym for legacy pool Signed-off-by: Matthew Whitehead <matthew1001@gmail.com> * Class rename Signed-off-by: Matthew Whitehead <matthew1001@gmail.com> * Spotless fixes Signed-off-by: Matthew Whitehead <matthew1001@gmail.com> * Add SEQUENCED to config overview test Signed-off-by: Matthew Whitehead <matthew1001@gmail.com> * Update CHANGELOG.md Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com> Signed-off-by: Matt Whitehead <matthew1001@hotmail.com> * add a fix to load correctly the storage trie in the Bonsai WorldState (hyperledger#6205) revert some modification that was made to pass tests hyperledger#5686 and fix this tests by loading the storage with EMPTY_TRIE_HASH if we detect that it has been cleared before pushing the new slots after recreation. --------- Signed-off-by: Karim TAAM <karim.t2am@gmail.com> --------- Signed-off-by: Matthew Whitehead <matthew1001@gmail.com> Signed-off-by: Matt Whitehead <matthew1001@hotmail.com> Signed-off-by: Karim TAAM <karim.t2am@gmail.com> Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com> Co-authored-by: matkt <karim.t2am@gmail.com> Signed-off-by: jflo <justin+github@florentine.us>
jflo · Dec 18, 2023 · 0feccae · 0feccae
1 parent 9e616d2
commit 0feccae
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 20 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@
 
 ### Additions and Improvements
 - Add error messages on authentication failures with username and password [#6212](https://github.com/hyperledger/besu/pull/6212)
+- New `Sequenced` transaction pool. The pool is an evolution of the `legacy` pool and is likely to be more suitable to enterprise or permissioned chains than the `layered` transaction pool. Select to use this pool with `--tx-pool=sequenced`. Supports the same options as the `legacy` pool [#6211](https://github.com/hyperledger/besu/issues/6211)
 
 ### Bug fixes
 

diff --git a/besu/src/main/java/org/hyperledger/besu/cli/options/TransactionPoolOptions.java b/besu/src/main/java/org/hyperledger/besu/cli/options/TransactionPoolOptions.java
@@ -19,6 +19,7 @@
 import static org.hyperledger.besu.cli.DefaultCommandValues.MANDATORY_LONG_FORMAT_HELP;
 import static org.hyperledger.besu.ethereum.eth.transactions.TransactionPoolConfiguration.Implementation.LAYERED;
 import static org.hyperledger.besu.ethereum.eth.transactions.TransactionPoolConfiguration.Implementation.LEGACY;
+import static org.hyperledger.besu.ethereum.eth.transactions.TransactionPoolConfiguration.Implementation.SEQUENCED;
 
 import org.hyperledger.besu.cli.converter.DurationMillisConverter;
 import org.hyperledger.besu.cli.converter.FractionConverter;
@@ -171,10 +172,10 @@ static class Layered {
 
   @CommandLine.ArgGroup(
       validate = false,
-      heading = "@|bold Tx Pool Legacy Implementation Options|@%n")
-  private final Legacy legacyOptions = new Legacy();
+      heading = "@|bold Tx Pool Sequenced Implementation Options|@%n")
+  private final Sequenced sequencedOptions = new Sequenced();
 
-  static class Legacy {
+  static class Sequenced {
     private static final String TX_POOL_RETENTION_HOURS = "--tx-pool-retention-hours";
     private static final String TX_POOL_LIMIT_BY_ACCOUNT_PERCENTAGE =
         "--tx-pool-limit-by-account-percentage";
@@ -272,10 +273,10 @@ public static TransactionPoolOptions fromConfig(final TransactionPoolConfigurati
         config.getPendingTransactionsLayerMaxCapacityBytes();
     options.layeredOptions.txPoolMaxPrioritized = config.getMaxPrioritizedTransactions();
     options.layeredOptions.txPoolMaxFutureBySender = config.getMaxFutureBySender();
-    options.legacyOptions.txPoolLimitByAccountPercentage =
+    options.sequencedOptions.txPoolLimitByAccountPercentage =
         config.getTxPoolLimitByAccountPercentage();
-    options.legacyOptions.txPoolMaxSize = config.getTxPoolMaxSize();
-    options.legacyOptions.pendingTxRetentionPeriod = config.getPendingTxRetentionPeriod();
+    options.sequencedOptions.txPoolMaxSize = config.getTxPoolMaxSize();
+    options.sequencedOptions.pendingTxRetentionPeriod = config.getPendingTxRetentionPeriod();
     options.unstableOptions.txMessageKeepAliveSeconds =
         config.getUnstable().getTxMessageKeepAliveSeconds();
     options.unstableOptions.eth65TrxAnnouncedBufferingPeriod =
@@ -295,14 +296,14 @@ public void validate(
       final CommandLine commandLine, final GenesisConfigOptions genesisConfigOptions) {
     CommandLineUtils.failIfOptionDoesntMeetRequirement(
         commandLine,
-        "Could not use legacy transaction pool options with layered implementation",
+        "Could not use legacy or sequenced transaction pool options with layered implementation",
         !txPoolImplementation.equals(LAYERED),
-        CommandLineUtils.getCLIOptionNames(Legacy.class));
+        CommandLineUtils.getCLIOptionNames(Sequenced.class));
 
     CommandLineUtils.failIfOptionDoesntMeetRequirement(
         commandLine,
-        "Could not use layered transaction pool options with legacy implementation",
-        !txPoolImplementation.equals(LEGACY),
+        "Could not use layered transaction pool options with legacy or sequenced implementation",
+        !txPoolImplementation.equals(LEGACY) && !txPoolImplementation.equals(SEQUENCED),
         CommandLineUtils.getCLIOptionNames(Layered.class));
 
     CommandLineUtils.failIfOptionDoesntMeetRequirement(
@@ -327,9 +328,9 @@ public TransactionPoolConfiguration toDomainObject() {
         .pendingTransactionsLayerMaxCapacityBytes(layeredOptions.txPoolLayerMaxCapacity)
         .maxPrioritizedTransactions(layeredOptions.txPoolMaxPrioritized)
         .maxFutureBySender(layeredOptions.txPoolMaxFutureBySender)
-        .txPoolLimitByAccountPercentage(legacyOptions.txPoolLimitByAccountPercentage)
-        .txPoolMaxSize(legacyOptions.txPoolMaxSize)
-        .pendingTxRetentionPeriod(legacyOptions.pendingTxRetentionPeriod)
+        .txPoolLimitByAccountPercentage(sequencedOptions.txPoolLimitByAccountPercentage)
+        .txPoolMaxSize(sequencedOptions.txPoolMaxSize)
+        .pendingTxRetentionPeriod(sequencedOptions.pendingTxRetentionPeriod)
         .unstable(
             ImmutableTransactionPoolConfiguration.Unstable.builder()
                 .txMessageKeepAliveSeconds(unstableOptions.txMessageKeepAliveSeconds)

diff --git a/besu/src/test/java/org/hyperledger/besu/cli/ConfigurationOverviewBuilderTest.java b/besu/src/test/java/org/hyperledger/besu/cli/ConfigurationOverviewBuilderTest.java
@@ -17,6 +17,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.hyperledger.besu.ethereum.eth.transactions.TransactionPoolConfiguration.Implementation.LAYERED;
 import static org.hyperledger.besu.ethereum.eth.transactions.TransactionPoolConfiguration.Implementation.LEGACY;
+import static org.hyperledger.besu.ethereum.eth.transactions.TransactionPoolConfiguration.Implementation.SEQUENCED;
 import static org.mockito.Mockito.mock;
 
 import org.hyperledger.besu.evm.internal.EvmConfiguration;
@@ -180,6 +181,13 @@ void setTxPoolImplementationLegacy() {
     assertThat(legacyTxPoolSelected).contains("Using LEGACY transaction pool implementation");
   }
 
+  @Test
+  void setTxPoolImplementationSequenced() {
+    builder.setTxPoolImplementation(SEQUENCED);
+    final String sequencedTxPoolSelected = builder.build();
+    assertThat(sequencedTxPoolSelected).contains("Using SEQUENCED transaction pool implementation");
+  }
+
   @Test
   void setWorldStateUpdateModeDefault() {
     builder.setWorldStateUpdateMode(EvmConfiguration.DEFAULT.worldUpdaterMode());

diff --git a/besu/src/test/java/org/hyperledger/besu/cli/options/TransactionPoolOptionsTest.java b/besu/src/test/java/org/hyperledger/besu/cli/options/TransactionPoolOptionsTest.java
@@ -17,6 +17,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.hyperledger.besu.ethereum.eth.transactions.TransactionPoolConfiguration.Implementation.LAYERED;
 import static org.hyperledger.besu.ethereum.eth.transactions.TransactionPoolConfiguration.Implementation.LEGACY;
+import static org.hyperledger.besu.ethereum.eth.transactions.TransactionPoolConfiguration.Implementation.SEQUENCED;
 
 import org.hyperledger.besu.cli.converter.DurationMillisConverter;
 import org.hyperledger.besu.datatypes.Address;
@@ -63,7 +64,7 @@ public void strictTxReplayProtection_default() {
   }
 
   @Test
-  public void pendingTransactionRetentionPeriod() {
+  public void pendingTransactionRetentionPeriodLegacy() {
     final int pendingTxRetentionHours = 999;
     internalTestSuccess(
         config ->
@@ -73,6 +74,17 @@ public void pendingTransactionRetentionPeriod() {
         "--tx-pool=legacy");
   }
 
+  @Test
+  public void pendingTransactionRetentionPeriodSequenced() {
+    final int pendingTxRetentionHours = 999;
+    internalTestSuccess(
+        config ->
+            assertThat(config.getPendingTxRetentionPeriod()).isEqualTo(pendingTxRetentionHours),
+        "--tx-pool-retention-hours",
+        String.valueOf(pendingTxRetentionHours),
+        "--tx-pool=sequenced");
+  }
+
   @Test
   public void disableLocalsDefault() {
     internalTestSuccess(config -> assertThat(config.getNoLocalPriority()).isFalse());
@@ -193,29 +205,44 @@ public void selectLegacyImplementationByArg() {
         "--tx-pool=legacy");
   }
 
+  @Test
+  public void selectSequencedImplementationByArg() {
+    internalTestSuccess(
+        config -> assertThat(config.getTxPoolImplementation()).isEqualTo(SEQUENCED),
+        "--tx-pool=sequenced");
+  }
+
   @Test
   public void failIfLegacyOptionsWhenLayeredSelectedByDefault() {
     internalTestFailure(
-        "Could not use legacy transaction pool options with layered implementation",
+        "Could not use legacy or sequenced transaction pool options with layered implementation",
         "--tx-pool-max-size=1000");
   }
 
   @Test
   public void failIfLegacyOptionsWhenLayeredSelectedByArg() {
     internalTestFailure(
-        "Could not use legacy transaction pool options with layered implementation",
+        "Could not use legacy or sequenced transaction pool options with layered implementation",
         "--tx-pool=layered",
         "--tx-pool-max-size=1000");
   }
 
   @Test
   public void failIfLayeredOptionsWhenLegacySelectedByArg() {
     internalTestFailure(
-        "Could not use layered transaction pool options with legacy implementation",
+        "Could not use layered transaction pool options with legacy or sequenced implementation",
         "--tx-pool=legacy",
         "--tx-pool-max-prioritized=1000");
   }
 
+  @Test
+  public void failIfLayeredOptionsWhenSequencedSelectedByArg() {
+    internalTestFailure(
+        "Could not use layered transaction pool options with legacy or sequenced implementation",
+        "--tx-pool=sequenced",
+        "--tx-pool-max-prioritized=1000");
+  }
+
   @Test
   public void byDefaultNoPrioritySenders() {
     internalTestSuccess(config -> assertThat(config.getPrioritySenders()).isEmpty());

diff --git a/besu/src/test/resources/everything_config.toml b/besu/src/test/resources/everything_config.toml
@@ -185,7 +185,7 @@ tx-pool-save-file="txpool.dump"
 tx-pool-layer-max-capacity=12345678
 tx-pool-max-prioritized=9876
 tx-pool-max-future-by-sender=321
-## Legacy
+## Legacy/Sequenced
 tx-pool-retention-hours=999
 tx-pool-max-size=1234
 tx-pool-limit-by-account-percentage=0.017

diff --git a/...ain/java/org/hyperledger/besu/ethereum/eth/transactions/TransactionPoolConfiguration.java b/...ain/java/org/hyperledger/besu/ethereum/eth/transactions/TransactionPoolConfiguration.java
@@ -50,8 +50,9 @@ default int getTxMessageKeepAliveSeconds() {
   }
 
   enum Implementation {
-    LEGACY,
-    LAYERED;
+    LEGACY, // Remove in future version
+    LAYERED,
+    SEQUENCED; // Synonym for LEGACY
   }
 
   String DEFAULT_SAVE_FILE_NAME = "txpool.dump";