Renaming

Signed-off-by: Fabio Di Fabio <[email protected]>

CHANGELOG.md

@@ -15,6 +15,7 @@
 - Add bft-style blockperiodseconds transitions to Clique [#6596](https://github.com/hyperledger/besu/pull/6596)
 - RocksDB database metadata refactoring [#6555](https://github.com/hyperledger/besu/pull/6555)
 - Make layered txpool aware of minGasPrice and minPriorityFeePerGas dynamic options [#6611](https://github.com/hyperledger/besu/pull/6611)
+- Refactor and extend `TransactionPoolValidatorService` [#6636](https://github.com/hyperledger/besu/pull/6636)
 
 ### Bug fixes
 

acceptance-tests/dsl/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/node/ThreadBesuNodeRunner.java

@@ -45,21 +45,21 @@
 import org.hyperledger.besu.plugin.services.BesuConfiguration;
 import org.hyperledger.besu.plugin.services.BesuEvents;
 import org.hyperledger.besu.plugin.services.PicoCLIOptions;
-import org.hyperledger.besu.plugin.services.PluginTransactionPoolValidatorService;
 import org.hyperledger.besu.plugin.services.RpcEndpointService;
 import org.hyperledger.besu.plugin.services.SecurityModuleService;
 import org.hyperledger.besu.plugin.services.StorageService;
+import org.hyperledger.besu.plugin.services.TransactionPoolValidatorService;
 import org.hyperledger.besu.plugin.services.TransactionSelectionService;
 import org.hyperledger.besu.plugin.services.storage.rocksdb.RocksDBPlugin;
 import org.hyperledger.besu.services.BesuConfigurationImpl;
 import org.hyperledger.besu.services.BesuEventsImpl;
 import org.hyperledger.besu.services.BesuPluginContextImpl;
 import org.hyperledger.besu.services.PermissioningServiceImpl;
 import org.hyperledger.besu.services.PicoCLIOptionsImpl;
-import org.hyperledger.besu.services.PluginTransactionPoolValidatorServiceImpl;
 import org.hyperledger.besu.services.RpcEndpointServiceImpl;
 import org.hyperledger.besu.services.SecurityModuleServiceImpl;
 import org.hyperledger.besu.services.StorageServiceImpl;
+import org.hyperledger.besu.services.TransactionPoolValidatorServiceImpl;
 import org.hyperledger.besu.services.TransactionSelectionServiceImpl;
 
 import java.io.File;
@@ -103,8 +103,7 @@ private BesuPluginContextImpl buildPluginContext(
     besuPluginContext.addService(
         TransactionSelectionService.class, transactionSelectionServiceImpl);
     besuPluginContext.addService(
-        PluginTransactionPoolValidatorService.class,
-        new PluginTransactionPoolValidatorServiceImpl());
+        TransactionPoolValidatorService.class, new TransactionPoolValidatorServiceImpl());
     final Path pluginsPath;
     final String pluginDir = System.getProperty("besu.plugins.dir");
     if (pluginDir == null || pluginDir.isEmpty()) {

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

@@ -160,12 +160,12 @@
 import org.hyperledger.besu.plugin.services.MetricsSystem;
 import org.hyperledger.besu.plugin.services.PermissioningService;
 import org.hyperledger.besu.plugin.services.PicoCLIOptions;
-import org.hyperledger.besu.plugin.services.PluginTransactionPoolValidatorService;
 import org.hyperledger.besu.plugin.services.PrivacyPluginService;
 import org.hyperledger.besu.plugin.services.RpcEndpointService;
 import org.hyperledger.besu.plugin.services.SecurityModuleService;
 import org.hyperledger.besu.plugin.services.StorageService;
 import org.hyperledger.besu.plugin.services.TraceService;
+import org.hyperledger.besu.plugin.services.TransactionPoolValidatorService;
 import org.hyperledger.besu.plugin.services.TransactionSelectionService;
 import org.hyperledger.besu.plugin.services.exception.StorageException;
 import org.hyperledger.besu.plugin.services.metrics.MetricCategory;
@@ -180,12 +180,12 @@
 import org.hyperledger.besu.services.BlockchainServiceImpl;
 import org.hyperledger.besu.services.PermissioningServiceImpl;
 import org.hyperledger.besu.services.PicoCLIOptionsImpl;
-import org.hyperledger.besu.services.PluginTransactionPoolValidatorServiceImpl;
 import org.hyperledger.besu.services.PrivacyPluginServiceImpl;
 import org.hyperledger.besu.services.RpcEndpointServiceImpl;
 import org.hyperledger.besu.services.SecurityModuleServiceImpl;
 import org.hyperledger.besu.services.StorageServiceImpl;
 import org.hyperledger.besu.services.TraceServiceImpl;
+import org.hyperledger.besu.services.TransactionPoolValidatorServiceImpl;
 import org.hyperledger.besu.services.TransactionSelectionServiceImpl;
 import org.hyperledger.besu.services.kvstore.InMemoryStoragePlugin;
 import org.hyperledger.besu.util.InvalidConfigurationException;
@@ -369,7 +369,7 @@ public class BesuCommand implements DefaultCommandValues, Runnable {
   P2PDiscoveryOptionGroup p2PDiscoveryOptionGroup = new P2PDiscoveryOptionGroup();
 
   private final TransactionSelectionServiceImpl transactionSelectionServiceImpl;
-  private final PluginTransactionPoolValidatorServiceImpl transactionValidatorServiceImpl;
+  private final TransactionPoolValidatorServiceImpl transactionValidatorServiceImpl;
   private final BlockchainServiceImpl blockchainServiceImpl;
 
   static class P2PDiscoveryOptionGroup {
@@ -955,7 +955,7 @@ public BesuCommand(
         new PkiBlockCreationConfigurationProvider(),
         new RpcEndpointServiceImpl(),
         new TransactionSelectionServiceImpl(),
-        new PluginTransactionPoolValidatorServiceImpl(),
+        new TransactionPoolValidatorServiceImpl(),
         new BlockchainServiceImpl());
   }
 
@@ -997,7 +997,7 @@ protected BesuCommand(
       final PkiBlockCreationConfigurationProvider pkiBlockCreationConfigProvider,
       final RpcEndpointServiceImpl rpcEndpointServiceImpl,
       final TransactionSelectionServiceImpl transactionSelectionServiceImpl,
-      final PluginTransactionPoolValidatorServiceImpl transactionValidatorServiceImpl,
+      final TransactionPoolValidatorServiceImpl transactionValidatorServiceImpl,
       final BlockchainServiceImpl blockchainServiceImpl) {
     this.besuComponent = besuComponent;
     this.logger = besuComponent.getBesuCommandLogger();
@@ -1209,7 +1209,7 @@ private void preparePlugins() {
     besuPluginContext.addService(
         TransactionSelectionService.class, transactionSelectionServiceImpl);
     besuPluginContext.addService(
-        PluginTransactionPoolValidatorService.class, transactionValidatorServiceImpl);
+        TransactionPoolValidatorService.class, transactionValidatorServiceImpl);
     besuPluginContext.addService(BlockchainService.class, blockchainServiceImpl);
 
     // register built-in plugins

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

@@ -30,7 +30,7 @@
 import org.hyperledger.besu.datatypes.Wei;
 import org.hyperledger.besu.ethereum.eth.transactions.ImmutableTransactionPoolConfiguration;
 import org.hyperledger.besu.ethereum.eth.transactions.TransactionPoolConfiguration;
-import org.hyperledger.besu.plugin.services.PluginTransactionPoolValidatorService;
+import org.hyperledger.besu.plugin.services.TransactionPoolValidatorService;
 import org.hyperledger.besu.util.number.Fraction;
 import org.hyperledger.besu.util.number.Percentage;
 
@@ -58,7 +58,7 @@ public class TransactionPoolOptions implements CLIOptions<TransactionPoolConfigu
   private static final String TX_POOL_PRIORITY_SENDERS = "--tx-pool-priority-senders";
   private static final String TX_POOL_MIN_GAS_PRICE = "--tx-pool-min-gas-price";
 
-  private PluginTransactionPoolValidatorService pluginTransactionPoolValidatorService;
+  private TransactionPoolValidatorService transactionPoolValidatorService;
 
   @CommandLine.Option(
       names = {TX_POOL_IMPLEMENTATION},
@@ -258,11 +258,11 @@ public static TransactionPoolOptions create() {
   /**
    * Set the plugin txpool validator service
    *
-   * @param pluginTransactionPoolValidatorService the plugin txpool validator service
+   * @param transactionPoolValidatorService the plugin txpool validator service
    */
   public void setPluginTransactionValidatorService(
-      final PluginTransactionPoolValidatorService pluginTransactionPoolValidatorService) {
-    this.pluginTransactionPoolValidatorService = pluginTransactionPoolValidatorService;
+      final TransactionPoolValidatorService transactionPoolValidatorService) {
+    this.transactionPoolValidatorService = transactionPoolValidatorService;
   }
 
   /**
@@ -290,7 +290,7 @@ public static TransactionPoolOptions fromConfig(final TransactionPoolConfigurati
         config.getTxPoolLimitByAccountPercentage();
     options.sequencedOptions.txPoolMaxSize = config.getTxPoolMaxSize();
     options.sequencedOptions.pendingTxRetentionPeriod = config.getPendingTxRetentionPeriod();
-    options.pluginTransactionPoolValidatorService = config.getPluginTransactionValidatorService();
+    options.transactionPoolValidatorService = config.getPluginTransactionValidatorService();
     options.unstableOptions.txMessageKeepAliveSeconds =
         config.getUnstable().getTxMessageKeepAliveSeconds();
     options.unstableOptions.eth65TrxAnnouncedBufferingPeriod =
@@ -345,7 +345,7 @@ public TransactionPoolConfiguration toDomainObject() {
         .txPoolLimitByAccountPercentage(sequencedOptions.txPoolLimitByAccountPercentage)
         .txPoolMaxSize(sequencedOptions.txPoolMaxSize)
         .pendingTxRetentionPeriod(sequencedOptions.pendingTxRetentionPeriod)
-        .pluginTransactionValidatorService(pluginTransactionPoolValidatorService)
+        .pluginTransactionValidatorService(transactionPoolValidatorService)
         .unstable(
             ImmutableTransactionPoolConfiguration.Unstable.builder()
                 .txMessageKeepAliveSeconds(unstableOptions.txMessageKeepAliveSeconds)

besu/src/main/java/org/hyperledger/besu/services/PluginTransactionPoolValidatorServiceImpl.java → besu/src/main/java/org/hyperledger/besu/services/TransactionPoolValidatorServiceImpl.java

@@ -14,28 +14,27 @@
  */
 package org.hyperledger.besu.services;
 
-import org.hyperledger.besu.plugin.services.PluginTransactionPoolValidatorService;
-import org.hyperledger.besu.plugin.services.txvalidator.PluginTransactionPoolTransactionValidator;
+import org.hyperledger.besu.plugin.services.TransactionPoolValidatorService;
+import org.hyperledger.besu.plugin.services.txvalidator.PluginTransactionPoolValidator;
 import org.hyperledger.besu.plugin.services.txvalidator.PluginTransactionPoolValidatorFactory;
 
 import java.util.Optional;
 
-/** The Transaction Validation service implementation. */
-public class PluginTransactionPoolValidatorServiceImpl
-    implements PluginTransactionPoolValidatorService {
+/** The Transaction pool validator service implementation. */
+public class TransactionPoolValidatorServiceImpl implements TransactionPoolValidatorService {
 
   private Optional<PluginTransactionPoolValidatorFactory> factory = Optional.empty();
 
   @Override
-  public PluginTransactionPoolTransactionValidator createTransactionValidator() {
+  public PluginTransactionPoolValidator createTransactionValidator() {
     return factory
         .map(PluginTransactionPoolValidatorFactory::createTransactionValidator)
-        .orElse(PluginTransactionPoolTransactionValidator.VALIDATE_ALL);
+        .orElse(PluginTransactionPoolValidator.VALIDATE_ALL);
   }
 
   @Override
-  public void registerTransactionValidatorFactory(
-      final PluginTransactionPoolValidatorFactory transactionValidatorFactory) {
-    factory = Optional.ofNullable(transactionValidatorFactory);
+  public void registerPluginTransactionValidatorFactory(
+      final PluginTransactionPoolValidatorFactory pluginTransactionPoolValidatorFactory) {
+    factory = Optional.ofNullable(pluginTransactionPoolValidatorFactory);
   }
 }

besu/src/test/java/org/hyperledger/besu/cli/CommandTestAbstract.java

@@ -86,11 +86,11 @@
 import org.hyperledger.besu.services.BesuPluginContextImpl;
 import org.hyperledger.besu.services.BlockchainServiceImpl;
 import org.hyperledger.besu.services.PermissioningServiceImpl;
-import org.hyperledger.besu.services.PluginTransactionPoolValidatorServiceImpl;
 import org.hyperledger.besu.services.PrivacyPluginServiceImpl;
 import org.hyperledger.besu.services.RpcEndpointServiceImpl;
 import org.hyperledger.besu.services.SecurityModuleServiceImpl;
 import org.hyperledger.besu.services.StorageServiceImpl;
+import org.hyperledger.besu.services.TransactionPoolValidatorServiceImpl;
 import org.hyperledger.besu.services.TransactionSelectionServiceImpl;
 import org.hyperledger.besu.services.kvstore.InMemoryKeyValueStorage;
 
@@ -569,7 +569,7 @@ public static class TestBesuCommand extends BesuCommand {
           pkiBlockCreationConfigProvider,
           rpcEndpointServiceImpl,
           new TransactionSelectionServiceImpl(),
-          new PluginTransactionPoolValidatorServiceImpl(),
+          new TransactionPoolValidatorServiceImpl(),
           new BlockchainServiceImpl());
     }
 

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/JsonRpcErrorConverter.java

@@ -75,7 +75,7 @@ public static RpcErrorType convertTransactionInvalidReason(
         return RpcErrorType.TOTAL_BLOB_GAS_TOO_HIGH;
       case TX_POOL_DISABLED:
         return RpcErrorType.TX_POOL_DISABLED;
-      case PLUGIN_TX_VALIDATOR:
+      case PLUGIN_TX_POOL_VALIDATOR:
         return RpcErrorType.PLUGIN_TX_VALIDATOR;
       case INVALID_BLOBS:
         return RpcErrorType.INVALID_BLOBS;

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

@@ -103,7 +103,7 @@ private JsonRpcResponse getJsonRpcResponse(
     if (sendEmptyHashOnInvalidBlock) {
       return new JsonRpcSuccessResponse(requestContext.getRequest().getId(), Hash.EMPTY.toString());
     } else {
-      if (errorReason == TransactionInvalidReason.PLUGIN_TX_VALIDATOR) {
+      if (errorReason == TransactionInvalidReason.PLUGIN_TX_POOL_VALIDATOR) {
         final RpcErrorType rpcErrorType =
             JsonRpcErrorConverter.convertTransactionInvalidReason(
                 validationResult.getInvalidReason());

ethereum/blockcreation/src/test/java/org/hyperledger/besu/ethereum/blockcreation/AbstractBlockTransactionSelectorTest.java

@@ -732,9 +732,11 @@ public void transactionSelectionPluginShouldBeNotifiedWhenTransactionSelectionCo
     final Transaction transaction = createTransaction(0, Wei.of(10), 21_000);
     ensureTransactionIsValid(transaction, 21_000, 0);
 
-    final TransactionInvalidReason invalidReason = TransactionInvalidReason.PLUGIN_TX_VALIDATOR;
+    final TransactionInvalidReason invalidReason =
+        TransactionInvalidReason.PLUGIN_TX_POOL_VALIDATOR;
     final Transaction invalidTransaction = createTransaction(1, Wei.of(10), 21_000);
-    ensureTransactionIsInvalid(invalidTransaction, TransactionInvalidReason.PLUGIN_TX_VALIDATOR);
+    ensureTransactionIsInvalid(
+        invalidTransaction, TransactionInvalidReason.PLUGIN_TX_POOL_VALIDATOR);
 
     final BlockTransactionSelector selector =
         createBlockSelectorAndSetupTxPool(

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/transaction/TransactionInvalidReason.java

@@ -49,7 +49,7 @@ public enum TransactionInvalidReason {
   INTERNAL_ERROR,
   TX_POOL_DISABLED,
   INVALID_BLOBS,
-  PLUGIN_TX_VALIDATOR,
+  PLUGIN_TX_POOL_VALIDATOR,
   EXECUTION_HALTED,
   // Private Transaction Invalid Reasons
   PRIVATE_TRANSACTION_INVALID,

ethereum/eth/src/main/java/org/hyperledger/besu/ethereum/eth/transactions/TransactionPool.java

@@ -435,15 +435,14 @@ && strictReplayProtectionShouldBeEnforcedLocally(chainHeadBlockHeader)
     }
 
     // Call the transaction validator plugin
-
-    final Optional<String> maybeError =
+    final Optional<String> maybePluginInvalid =
         configuration
             .getPluginTransactionValidatorService()
             .createTransactionValidator()
             .validateTransaction(transaction, isLocal, hasPriority);
-    if (maybeError.isPresent()) {
+    if (maybePluginInvalid.isPresent()) {
       return ValidationResultAndAccount.invalid(
-          TransactionInvalidReason.PLUGIN_TX_VALIDATOR, maybeError.get());
+          TransactionInvalidReason.PLUGIN_TX_POOL_VALIDATOR, maybePluginInvalid.get());
     }
 
     try (final var worldState =

ethereum/eth/src/main/java/org/hyperledger/besu/ethereum/eth/transactions/TransactionPoolConfiguration.java

@@ -16,8 +16,8 @@
 
 import org.hyperledger.besu.datatypes.Address;
 import org.hyperledger.besu.datatypes.Wei;
-import org.hyperledger.besu.plugin.services.PluginTransactionPoolValidatorService;
-import org.hyperledger.besu.plugin.services.txvalidator.PluginTransactionPoolTransactionValidator;
+import org.hyperledger.besu.plugin.services.TransactionPoolValidatorService;
+import org.hyperledger.besu.plugin.services.txvalidator.PluginTransactionPoolValidator;
 import org.hyperledger.besu.plugin.services.txvalidator.PluginTransactionPoolValidatorFactory;
 import org.hyperledger.besu.util.number.Fraction;
 import org.hyperledger.besu.util.number.Percentage;
@@ -158,16 +158,16 @@ default Wei getMinGasPrice() {
   }
 
   @Value.Default
-  default PluginTransactionPoolValidatorService getPluginTransactionValidatorService() {
-    return new PluginTransactionPoolValidatorService() {
+  default TransactionPoolValidatorService getPluginTransactionValidatorService() {
+    return new TransactionPoolValidatorService() {
       @Override
-      public PluginTransactionPoolTransactionValidator createTransactionValidator() {
-        return PluginTransactionPoolTransactionValidator.VALIDATE_ALL;
+      public PluginTransactionPoolValidator createTransactionValidator() {
+        return PluginTransactionPoolValidator.VALIDATE_ALL;
       }
 
       @Override
-      public void registerTransactionValidatorFactory(
-          final PluginTransactionPoolValidatorFactory transactionValidatorFactory) {}
+      public void registerPluginTransactionValidatorFactory(
+          final PluginTransactionPoolValidatorFactory pluginTransactionPoolValidatorFactory) {}
     };
   }