add plugin API to enable plugins to validate transaction before they …

…are added to the transaction pool (#5891)

* add plugin API to enable plugins to validate transaction before they are added to the transaction pool

Signed-off-by: Stefan <stefan.pingel@consensys.net>

* updated plugin version

Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>

---------

Signed-off-by: Stefan <stefan.pingel@consensys.net>
Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>
Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com>

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

@@ -43,16 +43,19 @@
 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.PluginTransactionValidatorService;
 import org.hyperledger.besu.plugin.services.SecurityModuleService;
 import org.hyperledger.besu.plugin.services.StorageService;
 import org.hyperledger.besu.plugin.services.TransactionSelectionService;
 import org.hyperledger.besu.plugin.services.storage.rocksdb.RocksDBPlugin;
 import org.hyperledger.besu.plugin.services.txselection.TransactionSelectorFactory;
+import org.hyperledger.besu.plugin.services.txvalidator.PluginTransactionValidatorFactory;
 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.PluginTransactionValidatorServiceImpl;
 import org.hyperledger.besu.services.RpcEndpointServiceImpl;
 import org.hyperledger.besu.services.SecurityModuleServiceImpl;
 import org.hyperledger.besu.services.StorageServiceImpl;
@@ -97,7 +100,8 @@ private BesuPluginContextImpl buildPluginContext(
     besuPluginContext.addService(PicoCLIOptions.class, new PicoCLIOptionsImpl(commandLine));
     besuPluginContext.addService(
         TransactionSelectionService.class, new TransactionSelectionServiceImpl());
-
+    besuPluginContext.addService(
+        PluginTransactionValidatorService.class, new PluginTransactionValidatorServiceImpl());
     final Path pluginsPath;
     final String pluginDir = System.getProperty("besu.plugins.dir");
     if (pluginDir == null || pluginDir.isEmpty()) {
@@ -184,6 +188,8 @@ public void startNode(final BesuNode node) {
     final Optional<TransactionSelectorFactory> transactionSelectorFactory =
         getTransactionSelectorFactory(besuPluginContext);
 
+    final PluginTransactionValidatorFactory pluginTransactionValidatorFactory =
+        getPluginTransactionValidatorFactory(besuPluginContext);
     builder
         .synchronizerConfiguration(new SynchronizerConfiguration.Builder().build())
         .dataDirectory(node.homeDirectory())
@@ -206,7 +212,8 @@ public void startNode(final BesuNode node) {
         .maxRemotelyInitiatedPeers(15)
         .networkConfiguration(node.getNetworkingConfiguration())
         .randomPeerPriority(false)
-        .transactionSelectorFactory(transactionSelectorFactory);
+        .transactionSelectorFactory(transactionSelectorFactory)
+        .pluginTransactionValidatorFactory(pluginTransactionValidatorFactory);
 
     node.getGenesisConfig()
         .map(GenesisConfigFile::fromConfig)
@@ -322,4 +329,11 @@ private Optional<TransactionSelectorFactory> getTransactionSelectorFactory(
         besuPluginContext.getService(TransactionSelectionService.class);
     return txSelectionService.isPresent() ? txSelectionService.get().get() : Optional.empty();
   }
+
+  private PluginTransactionValidatorFactory getPluginTransactionValidatorFactory(
+      final BesuPluginContextImpl besuPluginContext) {
+    final Optional<PluginTransactionValidatorService> txValidatorService =
+        besuPluginContext.getService(PluginTransactionValidatorService.class);
+    return txValidatorService.map(PluginTransactionValidatorService::get).orElse(null);
+  }
 }

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

@@ -117,6 +117,7 @@ public BesuNode createMinerNodeWithExtraCliOptions(
             .name(name)
             .miningEnabled()
             .jsonRpcEnabled()
+            .jsonRpcTxPool()
             .webSocketEnabled()
             .extraCLIOptions(extraCliOptions);
     builder = configModifier.apply(builder);

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

@@ -164,6 +164,7 @@
 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.PluginTransactionValidatorService;
 import org.hyperledger.besu.plugin.services.PrivacyPluginService;
 import org.hyperledger.besu.plugin.services.RpcEndpointService;
 import org.hyperledger.besu.plugin.services.SecurityModuleService;
@@ -177,11 +178,13 @@
 import org.hyperledger.besu.plugin.services.storage.PrivacyKeyValueStorageFactory;
 import org.hyperledger.besu.plugin.services.storage.rocksdb.RocksDBPlugin;
 import org.hyperledger.besu.plugin.services.txselection.TransactionSelectorFactory;
+import org.hyperledger.besu.plugin.services.txvalidator.PluginTransactionValidatorFactory;
 import org.hyperledger.besu.services.BesuEventsImpl;
 import org.hyperledger.besu.services.BesuPluginContextImpl;
 import org.hyperledger.besu.services.BlockchainServiceImpl;
 import org.hyperledger.besu.services.PermissioningServiceImpl;
 import org.hyperledger.besu.services.PicoCLIOptionsImpl;
+import org.hyperledger.besu.services.PluginTransactionValidatorServiceImpl;
 import org.hyperledger.besu.services.PrivacyPluginServiceImpl;
 import org.hyperledger.besu.services.RpcEndpointServiceImpl;
 import org.hyperledger.besu.services.SecurityModuleServiceImpl;
@@ -372,6 +375,7 @@ public class BesuCommand implements DefaultCommandValues, Runnable {
   P2PDiscoveryOptionGroup p2PDiscoveryOptionGroup = new P2PDiscoveryOptionGroup();
 
   private final TransactionSelectionServiceImpl transactionSelectionServiceImpl;
+  private final PluginTransactionValidatorServiceImpl transactionValidatorServiceImpl;
 
   static class P2PDiscoveryOptionGroup {
 
@@ -1355,7 +1359,8 @@ public BesuCommand(
         new PrivacyPluginServiceImpl(),
         new PkiBlockCreationConfigurationProvider(),
         new RpcEndpointServiceImpl(),
-        new TransactionSelectionServiceImpl());
+        new TransactionSelectionServiceImpl(),
+        new PluginTransactionValidatorServiceImpl());
   }
 
   /**
@@ -1376,6 +1381,7 @@ public BesuCommand(
    * @param pkiBlockCreationConfigProvider instance of PkiBlockCreationConfigurationProvider
    * @param rpcEndpointServiceImpl instance of RpcEndpointServiceImpl
    * @param transactionSelectionServiceImpl instance of TransactionSelectionServiceImpl
+   * @param transactionValidatorServiceImpl instance of TransactionValidatorServiceImpl
    */
   @VisibleForTesting
   protected BesuCommand(
@@ -1393,7 +1399,8 @@ protected BesuCommand(
       final PrivacyPluginServiceImpl privacyPluginService,
       final PkiBlockCreationConfigurationProvider pkiBlockCreationConfigProvider,
       final RpcEndpointServiceImpl rpcEndpointServiceImpl,
-      final TransactionSelectionServiceImpl transactionSelectionServiceImpl) {
+      final TransactionSelectionServiceImpl transactionSelectionServiceImpl,
+      final PluginTransactionValidatorServiceImpl transactionValidatorServiceImpl) {
     this.besuComponent = besuComponent;
     this.logger = besuComponent.getBesuCommandLogger();
     this.rlpBlockImporter = rlpBlockImporter;
@@ -1412,6 +1419,7 @@ protected BesuCommand(
     this.pkiBlockCreationConfigProvider = pkiBlockCreationConfigProvider;
     this.rpcEndpointServiceImpl = rpcEndpointServiceImpl;
     this.transactionSelectionServiceImpl = transactionSelectionServiceImpl;
+    this.transactionValidatorServiceImpl = transactionValidatorServiceImpl;
   }
 
   /**
@@ -1593,6 +1601,8 @@ private void preparePlugins() {
     besuPluginContext.addService(RpcEndpointService.class, rpcEndpointServiceImpl);
     besuPluginContext.addService(
         TransactionSelectionService.class, transactionSelectionServiceImpl);
+    besuPluginContext.addService(
+        PluginTransactionValidatorService.class, transactionValidatorServiceImpl);
 
     // register built-in plugins
     rocksDBPlugin = new RocksDBPlugin();
@@ -2193,7 +2203,7 @@ private void ensureAllNodesAreInAllowlist(
       final Collection<EnodeURL> enodeAddresses,
       final LocalPermissioningConfiguration permissioningConfiguration) {
     try {
-      PermissioningConfigurationValidator.areAllNodesAreInAllowlist(
+      PermissioningConfigurationValidator.areAllNodesInAllowlist(
           enodeAddresses, permissioningConfiguration);
     } catch (final Exception e) {
       throw new ParameterException(this.commandLine, e.getMessage());
@@ -2226,15 +2236,14 @@ public BesuController buildController() {
    */
   public BesuControllerBuilder getControllerBuilder() {
     final KeyValueStorageProvider storageProvider = keyValueStorageProvider(keyValueStorageName);
-    final Optional<TransactionSelectorFactory> transactionSelectorFactory =
-        getTransactionSelectorFactory();
     return controllerBuilderFactory
         .fromEthNetworkConfig(
             updateNetworkConfig(network), genesisConfigOverrides, getDefaultSyncModeIfNotSet())
         .synchronizerConfiguration(buildSyncConfig())
         .ethProtocolConfiguration(unstableEthProtocolOptions.toDomainObject())
         .networkConfiguration(unstableNetworkingOptions.toDomainObject())
-        .transactionSelectorFactory(transactionSelectorFactory)
+        .transactionSelectorFactory(getTransactionSelectorFactory())
+        .pluginTransactionValidatorFactory(getPluginTransactionValidatorFactory())
         .dataDirectory(dataDir())
         .miningParameters(
             new MiningParameters.Builder()
@@ -2291,6 +2300,12 @@ private Optional<TransactionSelectorFactory> getTransactionSelectorFactory() {
     return txSelectionService.isPresent() ? txSelectionService.get().get() : Optional.empty();
   }
 
+  private PluginTransactionValidatorFactory getPluginTransactionValidatorFactory() {
+    final Optional<PluginTransactionValidatorService> txSValidatorService =
+        besuPluginContext.getService(PluginTransactionValidatorService.class);
+    return txSValidatorService.map(PluginTransactionValidatorService::get).orElse(null);
+  }
+
   private GraphQLConfiguration graphQLConfiguration() {
 
     CommandLineUtils.checkOptionDependencies(

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

@@ -96,6 +96,7 @@
 import org.hyperledger.besu.plugin.services.MetricsSystem;
 import org.hyperledger.besu.plugin.services.permissioning.NodeMessagePermissioningProvider;
 import org.hyperledger.besu.plugin.services.txselection.TransactionSelectorFactory;
+import org.hyperledger.besu.plugin.services.txvalidator.PluginTransactionValidatorFactory;
 
 import java.io.Closeable;
 import java.math.BigInteger;
@@ -185,6 +186,8 @@ public abstract class BesuControllerBuilder implements MiningParameterOverrides
   /** the Dagger configured context that can provide dependencies */
   protected Optional<BesuComponent> besuComponent = Optional.empty();
 
+  private PluginTransactionValidatorFactory pluginTransactionValidatorFactory;
+
   /**
    * Provide a BesuComponent which can be used to get other dependencies
    *
@@ -537,6 +540,18 @@ public BesuControllerBuilder transactionSelectorFactory(
     return this;
   }
 
+  /**
+   * sets the pluginTransactionValidatorFactory
+   *
+   * @param pluginTransactionValidatorFactory factory that creates plugin transaction Validators
+   * @return the besu controller builder
+   */
+  public BesuControllerBuilder pluginTransactionValidatorFactory(
+      final PluginTransactionValidatorFactory pluginTransactionValidatorFactory) {
+    this.pluginTransactionValidatorFactory = pluginTransactionValidatorFactory;
+    return this;
+  }
+
   /**
    * Build besu controller.
    *
@@ -695,7 +710,8 @@ public BesuController build() {
             metricsSystem,
             syncState,
             miningParameters,
-            transactionPoolConfiguration);
+            transactionPoolConfiguration,
+            pluginTransactionValidatorFactory);
 
     final List<PeerValidator> peerValidators = createPeerValidators(protocolSchedule);
 

besu/src/main/java/org/hyperledger/besu/services/PluginTransactionValidatorServiceImpl.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright contributors to Hyperledger Besu.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package org.hyperledger.besu.services;
+
+import org.hyperledger.besu.plugin.services.PluginTransactionValidatorService;
+import org.hyperledger.besu.plugin.services.txvalidator.PluginTransactionValidatorFactory;
+
+/** The Transaction Validation service implementation. */
+public class PluginTransactionValidatorServiceImpl implements PluginTransactionValidatorService {
+
+  private PluginTransactionValidatorFactory factory;
+
+  @Override
+  public PluginTransactionValidatorFactory get() {
+    return factory;
+  }
+
+  @Override
+  public void registerTransactionValidatorFactory(
+      final PluginTransactionValidatorFactory transactionValidatorFactory) {
+    factory = transactionValidatorFactory;
+  }
+}

besu/src/main/java/org/hyperledger/besu/util/PermissioningConfigurationValidator.java

@@ -34,7 +34,7 @@ public class PermissioningConfigurationValidator {
    * @param permissioningConfiguration the permissioning configuration
    * @throws Exception In case of nodes are not in allow list
    */
-  public static void areAllNodesAreInAllowlist(
+  public static void areAllNodesInAllowlist(
       final Collection<EnodeURL> nodeURIs,
       final LocalPermissioningConfiguration permissioningConfiguration)
       throws Exception {

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

@@ -76,6 +76,7 @@
 import org.hyperledger.besu.plugin.services.storage.SegmentIdentifier;
 import org.hyperledger.besu.services.BesuPluginContextImpl;
 import org.hyperledger.besu.services.PermissioningServiceImpl;
+import org.hyperledger.besu.services.PluginTransactionValidatorServiceImpl;
 import org.hyperledger.besu.services.PrivacyPluginServiceImpl;
 import org.hyperledger.besu.services.RpcEndpointServiceImpl;
 import org.hyperledger.besu.services.SecurityModuleServiceImpl;
@@ -240,6 +241,8 @@ public void initMocks() throws Exception {
     when(mockControllerBuilder.maxRemotelyInitiatedPeers(anyInt()))
         .thenReturn(mockControllerBuilder);
     when(mockControllerBuilder.transactionSelectorFactory(any())).thenReturn(mockControllerBuilder);
+    when(mockControllerBuilder.pluginTransactionValidatorFactory(any()))
+        .thenReturn(mockControllerBuilder);
     when(mockControllerBuilder.besuComponent(any(BesuComponent.class)))
         .thenReturn(mockControllerBuilder);
     // doReturn used because of generic BesuController
@@ -489,7 +492,8 @@ public static class TestBesuCommand extends BesuCommand {
           privacyPluginService,
           pkiBlockCreationConfigProvider,
           rpcEndpointServiceImpl,
-          new TransactionSelectionServiceImpl());
+          new TransactionSelectionServiceImpl(),
+          new PluginTransactionValidatorServiceImpl());
     }
 
     @Override

besu/src/test/java/org/hyperledger/besu/services/BesuEventsImplTest.java

@@ -156,7 +156,8 @@ public void setUp() {
             new NoOpMetricsSystem(),
             syncState,
             new MiningParameters.Builder().minTransactionGasPrice(Wei.ZERO).build(),
-            txPoolConfig);
+            txPoolConfig,
+            null);
 
     serviceImpl = new BesuEventsImpl(blockchain, blockBroadcaster, transactionPool, syncState);
   }

besu/src/test/java/org/hyperledger/besu/util/LocalPermissioningConfigurationValidatorTest.java

@@ -68,7 +68,7 @@ public void sepoliaWithNodesAllowlistOptionWhichDoesIncludeRopstenBootnodesMustN
             toml.toAbsolutePath().toString());
 
     final List<EnodeURL> enodeURIs = ethNetworkConfig.getBootNodes();
-    PermissioningConfigurationValidator.areAllNodesAreInAllowlist(
+    PermissioningConfigurationValidator.areAllNodesInAllowlist(
         enodeURIs, permissioningConfiguration);
   }
 
@@ -92,7 +92,7 @@ public void nodesAllowlistOptionWhichDoesNotIncludeBootnodesMustError() throws E
 
     try {
       final List<EnodeURL> enodeURIs = ethNetworkConfig.getBootNodes();
-      PermissioningConfigurationValidator.areAllNodesAreInAllowlist(
+      PermissioningConfigurationValidator.areAllNodesInAllowlist(
           enodeURIs, permissioningConfiguration);
       fail("expected exception because sepolia bootnodes are not in node-allowlist");
     } catch (Exception e) {
@@ -142,7 +142,7 @@ public void nodeAllowlistCheckShouldIgnoreDiscoveryPortParam() throws Exception
     // However, for the allowlist validation, we should ignore the discovery port and don't throw an
     // error
     try {
-      PermissioningConfigurationValidator.areAllNodesAreInAllowlist(
+      PermissioningConfigurationValidator.areAllNodesInAllowlist(
           Lists.newArrayList(enodeURL), permissioningConfiguration);
     } catch (Exception e) {
       fail(
@@ -180,7 +180,7 @@ public void nodeAllowlistCheckShouldWorkWithHostnameIfDnsEnabled() throws Except
     // However, for the allowlist validation, we should ignore the discovery port and don't throw an
     // error
     try {
-      PermissioningConfigurationValidator.areAllNodesAreInAllowlist(
+      PermissioningConfigurationValidator.areAllNodesInAllowlist(
           Lists.newArrayList(enodeURL), permissioningConfiguration);
     } catch (Exception e) {
       fail(

consensus/clique/src/test/java/org/hyperledger/besu/consensus/clique/blockcreation/CliqueBlockCreatorTest.java

@@ -235,7 +235,8 @@ private TransactionPool createTransactionPool() {
             ethContext,
             mock(MiningParameters.class),
             new TransactionPoolMetrics(metricsSystem),
-            conf);
+            conf,
+            null);
     transactionPool.setEnabled();
     return transactionPool;
   }

consensus/clique/src/test/java/org/hyperledger/besu/consensus/clique/blockcreation/CliqueMinerExecutorTest.java

@@ -222,7 +222,8 @@ private TransactionPool createTransactionPool() {
             cliqueEthContext,
             mock(MiningParameters.class),
             new TransactionPoolMetrics(metricsSystem),
-            conf);
+            conf,
+            null);
 
     transactionPool.setEnabled();
     return transactionPool;

consensus/ibft/src/integration-test/java/org/hyperledger/besu/consensus/ibft/support/TestContextBuilder.java

@@ -357,7 +357,8 @@ private static ControllerAndState createControllerAndFinalState(
             ethContext,
             miningParams,
             new TransactionPoolMetrics(metricsSystem),
-            poolConf);
+            poolConf,
+            null);
 
     transactionPool.setEnabled();
 

consensus/ibft/src/test/java/org/hyperledger/besu/consensus/ibft/blockcreation/BftBlockCreatorTest.java

@@ -145,7 +145,8 @@ public BlockHeaderValidator.Builder createBlockHeaderRuleset(
             ethContext,
             mock(MiningParameters.class),
             new TransactionPoolMetrics(metricsSystem),
-            poolConf);
+            poolConf,
+            null);
 
     transactionPool.setEnabled();
 

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

@@ -222,7 +222,8 @@ public void setUp() {
             ethContext,
             miningParameters,
             new TransactionPoolMetrics(metricsSystem),
-            poolConf);
+            poolConf,
+            null);
 
     this.transactionPool.setEnabled();