TransactionSimulator can be a singleton (hyperledger#7925)

Signed-off-by: Fabio Di Fabio <[email protected]> Co-authored-by: daniellehrner <[email protected]>
daniellehrner · Nov 29, 2024 · c320724 · c320724
1 parent afd4da1
commit c320724
Show file tree

Hide file tree

Showing 35 changed files with 180 additions and 116 deletions.
diff --git a/...sl/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/node/ThreadBesuNodeRunner.java b/...sl/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/node/ThreadBesuNodeRunner.java
@@ -458,7 +458,8 @@ public BesuController provideBesuController(
         final BesuControllerBuilder builder,
         final MetricsSystem metricsSystem,
         final KeyValueStorageProvider storageProvider,
-        final MiningConfiguration miningConfiguration) {
+        final MiningConfiguration miningConfiguration,
+        final ApiConfiguration apiConfiguration) {
 
       builder
           .synchronizerConfiguration(synchronizerConfiguration)
@@ -473,6 +474,7 @@ public BesuController provideBesuController(
           .maxRemotelyInitiatedPeers(15)
           .miningParameters(miningConfiguration)
           .randomPeerPriority(false)
+          .apiConfiguration(apiConfiguration)
           .besuComponent(null);
       return builder.build();
     }

diff --git a/besu/src/main/java/org/hyperledger/besu/RunnerBuilder.java b/besu/src/main/java/org/hyperledger/besu/RunnerBuilder.java
@@ -672,12 +672,7 @@ public Runner build() {
 
     final Synchronizer synchronizer = besuController.getSynchronizer();
 
-    final TransactionSimulator transactionSimulator =
-        new TransactionSimulator(
-            context.getBlockchain(),
-            context.getWorldStateArchive(),
-            protocolSchedule,
-            apiConfiguration.getGasCap());
+    final TransactionSimulator transactionSimulator = besuController.getTransactionSimulator();
 
     final Bytes localNodeId = nodeKey.getPublicKey().getEncodedBytes();
     final Optional<NodePermissioningController> nodePermissioningController =
@@ -840,7 +835,8 @@ public Runner build() {
               natService,
               besuPluginContext.getNamedPlugins(),
               dataDir,
-              rpcEndpointServiceImpl);
+              rpcEndpointServiceImpl,
+              transactionSimulator);
 
       jsonRpcHttpService =
           Optional.of(
@@ -885,7 +881,8 @@ public Runner build() {
               natService,
               besuPluginContext.getNamedPlugins(),
               dataDir,
-              rpcEndpointServiceImpl);
+              rpcEndpointServiceImpl,
+              transactionSimulator);
 
       final Optional<AuthenticationService> authToUse =
           engineJsonRpcConfiguration.get().isAuthenticationEnabled()
@@ -932,7 +929,7 @@ public Runner build() {
       graphQlContextMap.putIfAbsent(GraphQLContextType.SYNCHRONIZER, synchronizer);
       graphQlContextMap.putIfAbsent(
           GraphQLContextType.CHAIN_ID, protocolSchedule.getChainId().map(UInt256::valueOf));
-      graphQlContextMap.putIfAbsent(GraphQLContextType.GAS_CAP, apiConfiguration.getGasCap());
+      graphQlContextMap.putIfAbsent(GraphQLContextType.TRANSACTION_SIMULATOR, transactionSimulator);
       final GraphQL graphQL;
       try {
         graphQL = GraphQLProvider.buildGraphQL(fetchers);
@@ -980,7 +977,8 @@ public Runner build() {
               natService,
               besuPluginContext.getNamedPlugins(),
               dataDir,
-              rpcEndpointServiceImpl);
+              rpcEndpointServiceImpl,
+              transactionSimulator);
 
       createLogsSubscriptionService(
           context.getBlockchain(), subscriptionManager, privacyParameters, blockchainQueries);
@@ -1060,7 +1058,8 @@ public Runner build() {
               natService,
               besuPluginContext.getNamedPlugins(),
               dataDir,
-              rpcEndpointServiceImpl);
+              rpcEndpointServiceImpl,
+              transactionSimulator);
 
       jsonRpcIpcService =
           Optional.of(
@@ -1099,7 +1098,8 @@ public Runner build() {
               natService,
               besuPluginContext.getNamedPlugins(),
               dataDir,
-              rpcEndpointServiceImpl);
+              rpcEndpointServiceImpl,
+              transactionSimulator);
     } else {
       inProcessRpcMethods = Map.of();
     }
@@ -1261,7 +1261,8 @@ private Map<String, JsonRpcMethod> jsonRpcMethods(
       final NatService natService,
       final Map<String, BesuPlugin> namedPlugins,
       final Path dataDir,
-      final RpcEndpointServiceImpl rpcEndpointServiceImpl) {
+      final RpcEndpointServiceImpl rpcEndpointServiceImpl,
+      final TransactionSimulator transactionSimulator) {
     // sync vertx for engine consensus API, to process requests in FIFO order;
     final Vertx consensusEngineServer = Vertx.vertx(new VertxOptions().setWorkerPoolSize(1));
 
@@ -1298,7 +1299,8 @@ private Map<String, JsonRpcMethod> jsonRpcMethods(
                 besuController.getProtocolManager().ethContext().getEthPeers(),
                 consensusEngineServer,
                 apiConfiguration,
-                enodeDnsConfiguration);
+                enodeDnsConfiguration,
+                transactionSimulator);
     methods.putAll(besuController.getAdditionalJsonRpcMethods(jsonRpcApis));
 
     final var pluginMethods =

diff --git a/besu/src/main/java/org/hyperledger/besu/cli/BesuCommand.java b/besu/src/main/java/org/hyperledger/besu/cli/BesuCommand.java
@@ -134,7 +134,6 @@
 import org.hyperledger.besu.ethereum.storage.keyvalue.KeyValueSegmentIdentifier;
 import org.hyperledger.besu.ethereum.storage.keyvalue.KeyValueStorageProvider;
 import org.hyperledger.besu.ethereum.storage.keyvalue.KeyValueStorageProviderBuilder;
-import org.hyperledger.besu.ethereum.transaction.TransactionSimulator;
 import org.hyperledger.besu.ethereum.worldstate.DataStorageConfiguration;
 import org.hyperledger.besu.ethereum.worldstate.DiffBasedSubStorageConfiguration;
 import org.hyperledger.besu.ethereum.worldstate.ImmutableDataStorageConfiguration;
@@ -339,6 +338,8 @@ public class BesuCommand implements DefaultCommandValues, Runnable {
       Suppliers.memoize(this::readGenesisConfigOptions);
   private final Supplier<MiningConfiguration> miningParametersSupplier =
       Suppliers.memoize(this::getMiningParameters);
+  private final Supplier<ApiConfiguration> apiConfigurationSupplier =
+      Suppliers.memoize(this::getApiConfiguration);
 
   private RocksDBPlugin rocksDBPlugin;
 
@@ -712,7 +713,6 @@ static class PrivacyOptionGroup {
   private WebSocketConfiguration webSocketConfiguration;
   private JsonRpcIpcConfiguration jsonRpcIpcConfiguration;
   private InProcessRpcConfiguration inProcessRpcConfiguration;
-  private ApiConfiguration apiConfiguration;
   private MetricsConfiguration metricsConfiguration;
   private Optional<PermissioningConfiguration> permissioningConfiguration;
   private DataStorageConfiguration dataStorageConfiguration;
@@ -1237,7 +1237,7 @@ private Runner buildRunner() {
         webSocketConfiguration,
         jsonRpcIpcConfiguration,
         inProcessRpcConfiguration,
-        apiConfiguration,
+        apiConfigurationSupplier.get(),
         metricsConfiguration,
         permissioningConfiguration,
         staticNodes,
@@ -1249,11 +1249,7 @@ private void startPlugins(final Runner runner) {
         besuController.getProtocolContext().getBlockchain(), besuController.getProtocolSchedule());
     transactionSimulationServiceImpl.init(
         besuController.getProtocolContext().getBlockchain(),
-        new TransactionSimulator(
-            besuController.getProtocolContext().getBlockchain(),
-            besuController.getProtocolContext().getWorldStateArchive(),
-            besuController.getProtocolSchedule(),
-            apiConfiguration.getGasCap()));
+        besuController.getTransactionSimulator());
     rpcEndpointServiceImpl.init(runner.getInProcessRpcMethods());
 
     besuPluginContext.addService(
@@ -1447,7 +1443,6 @@ private void validateOptions() {
     validateTransactionPoolOptions();
     validateDataStorageOptions();
     validateGraphQlOptions();
-    validateApiOptions();
     validateConsensusSyncCompatibilityOptions();
     validatePluginOptions();
   }
@@ -1705,7 +1700,6 @@ private void configure() throws Exception {
             unstableIpcOptions.getIpcPath(),
             unstableIpcOptions.getRpcIpcApis());
     inProcessRpcConfiguration = inProcessRpcOptions.toDomainObject();
-    apiConfiguration = apiConfigurationOptions.apiConfiguration();
     dataStorageConfiguration = getDataStorageConfiguration();
     // hostsWhitelist is a hidden option. If it is specified, add the list to hostAllowlist
     if (!hostsWhitelist.isEmpty()) {
@@ -1823,6 +1817,7 @@ public BesuControllerBuilder setupControllerBuilder() {
             .chainPruningConfiguration(unstableChainPruningOptions.toDomainObject())
             .cacheLastBlocks(numberOfblocksToCache)
             .genesisStateHashCacheEnabled(genesisStateHashCacheEnabled)
+            .apiConfiguration(apiConfigurationSupplier.get())
             .besuComponent(besuComponent);
     if (DataStorageFormat.BONSAI.equals(getDataStorageConfiguration().getDataStorageFormat())) {
       final DiffBasedSubStorageConfiguration subStorageConfiguration =
@@ -2148,6 +2143,11 @@ private MiningConfiguration getMiningParameters() {
     return miningParameters;
   }
 
+  private ApiConfiguration getApiConfiguration() {
+    validateApiOptions();
+    return apiConfigurationOptions.apiConfiguration();
+  }
+
   /**
    * Get the data storage configuration
    *

diff --git a/besu/src/main/java/org/hyperledger/besu/controller/BesuController.java b/besu/src/main/java/org/hyperledger/besu/controller/BesuController.java
@@ -35,6 +35,7 @@
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
 import org.hyperledger.besu.ethereum.p2p.config.SubProtocolConfiguration;
 import org.hyperledger.besu.ethereum.storage.StorageProvider;
+import org.hyperledger.besu.ethereum.transaction.TransactionSimulator;
 import org.hyperledger.besu.ethereum.worldstate.DataStorageConfiguration;
 
 import java.io.Closeable;
@@ -66,7 +67,6 @@ public class BesuController implements java.io.Closeable {
   private final NodeKey nodeKey;
   private final Synchronizer synchronizer;
   private final JsonRpcMethods additionalJsonRpcMethodsFactory;
-
   private final TransactionPool transactionPool;
   private final MiningCoordinator miningCoordinator;
   private final PrivacyParameters privacyParameters;
@@ -77,6 +77,7 @@ public class BesuController implements java.io.Closeable {
   private final EthPeers ethPeers;
   private final StorageProvider storageProvider;
   private final DataStorageConfiguration dataStorageConfiguration;
+  private final TransactionSimulator transactionSimulator;
 
   /**
    * Instantiates a new Besu controller.
@@ -99,6 +100,7 @@ public class BesuController implements java.io.Closeable {
    * @param ethPeers the eth peers
    * @param storageProvider the storage provider
    * @param dataStorageConfiguration the data storage configuration
+   * @param transactionSimulator the transaction simulator
    */
   BesuController(
       final ProtocolSchedule protocolSchedule,
@@ -118,7 +120,8 @@ public class BesuController implements java.io.Closeable {
       final PluginServiceFactory additionalPluginServices,
       final EthPeers ethPeers,
       final StorageProvider storageProvider,
-      final DataStorageConfiguration dataStorageConfiguration) {
+      final DataStorageConfiguration dataStorageConfiguration,
+      final TransactionSimulator transactionSimulator) {
     this.protocolSchedule = protocolSchedule;
     this.protocolContext = protocolContext;
     this.ethProtocolManager = ethProtocolManager;
@@ -137,6 +140,7 @@ public class BesuController implements java.io.Closeable {
     this.ethPeers = ethPeers;
     this.storageProvider = storageProvider;
     this.dataStorageConfiguration = dataStorageConfiguration;
+    this.transactionSimulator = transactionSimulator;
   }
 
   /**
@@ -307,6 +311,15 @@ public DataStorageConfiguration getDataStorageConfiguration() {
     return dataStorageConfiguration;
   }
 
+  /**
+   * Gets the transaction simulator
+   *
+   * @return the transaction simulator
+   */
+  public TransactionSimulator getTransactionSimulator() {
+    return transactionSimulator;
+  }
+
   /** The type Builder. */
   public static class Builder {
     /** Instantiates a new Builder. */

diff --git a/besu/src/main/java/org/hyperledger/besu/controller/BesuControllerBuilder.java b/besu/src/main/java/org/hyperledger/besu/controller/BesuControllerBuilder.java
@@ -28,6 +28,7 @@
 import org.hyperledger.besu.ethereum.ConsensusContext;
 import org.hyperledger.besu.ethereum.GasLimitCalculator;
 import org.hyperledger.besu.ethereum.ProtocolContext;
+import org.hyperledger.besu.ethereum.api.ApiConfiguration;
 import org.hyperledger.besu.ethereum.api.jsonrpc.methods.JsonRpcMethods;
 import org.hyperledger.besu.ethereum.blockcreation.MiningCoordinator;
 import org.hyperledger.besu.ethereum.chain.BadBlockManager;
@@ -84,6 +85,7 @@
 import org.hyperledger.besu.ethereum.p2p.config.SubProtocolConfiguration;
 import org.hyperledger.besu.ethereum.storage.StorageProvider;
 import org.hyperledger.besu.ethereum.storage.keyvalue.KeyValueSegmentIdentifier;
+import org.hyperledger.besu.ethereum.transaction.TransactionSimulator;
 import org.hyperledger.besu.ethereum.trie.diffbased.bonsai.BonsaiWorldStateProvider;
 import org.hyperledger.besu.ethereum.trie.diffbased.bonsai.cache.BonsaiCachedMerkleTrieLoader;
 import org.hyperledger.besu.ethereum.trie.diffbased.bonsai.storage.BonsaiWorldStateKeyValueStorage;
@@ -211,6 +213,12 @@ public abstract class BesuControllerBuilder implements MiningParameterOverrides
   /** whether parallel transaction processing is enabled or not */
   protected boolean isParallelTxProcessingEnabled;
 
+  /** The API configuration */
+  protected ApiConfiguration apiConfiguration;
+
+  /** The transaction simulator */
+  protected TransactionSimulator transactionSimulator;
+
   /** Instantiates a new Besu controller builder. */
   protected BesuControllerBuilder() {}
 
@@ -272,6 +280,17 @@ public BesuControllerBuilder synchronizerConfiguration(
     return this;
   }
 
+  /**
+   * API configuration besu controller builder.
+   *
+   * @param apiConfiguration the API config
+   * @return the besu controller builder
+   */
+  public BesuControllerBuilder apiConfiguration(final ApiConfiguration apiConfiguration) {
+    this.apiConfiguration = apiConfiguration;
+    return this;
+  }
+
   /**
    * Eth protocol configuration besu controller builder.
    *
@@ -556,6 +575,7 @@ public BesuController build() {
     checkNotNull(gasLimitCalculator, "Missing gas limit calculator");
     checkNotNull(evmConfiguration, "Missing evm config");
     checkNotNull(networkingConfiguration, "Missing network configuration");
+    checkNotNull(apiConfiguration, "Missing API configuration");
     checkNotNull(dataStorageConfiguration, "Missing data storage configuration");
     checkNotNull(besuComponent, "Must supply a BesuComponent");
     prepForBuild();
@@ -604,6 +624,10 @@ public BesuController build() {
       genesisState.writeStateTo(worldStateArchive.getMutable());
     }
 
+    transactionSimulator =
+        new TransactionSimulator(
+            blockchain, worldStateArchive, protocolSchedule, apiConfiguration.getGasCap());
+
     final var consensusContext =
         createConsensusContext(blockchain, worldStateArchive, protocolSchedule);
 
@@ -795,7 +819,8 @@ public BesuController build() {
         additionalPluginServices,
         ethPeers,
         storageProvider,
-        dataStorageConfiguration);
+        dataStorageConfiguration,
+        transactionSimulator);
   }
 
   private GenesisState getGenesisState(

diff --git a/besu/src/main/java/org/hyperledger/besu/controller/QbftBesuControllerBuilder.java b/besu/src/main/java/org/hyperledger/besu/controller/QbftBesuControllerBuilder.java
@@ -79,7 +79,6 @@
 import org.hyperledger.besu.ethereum.eth.transactions.TransactionPool;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
 import org.hyperledger.besu.ethereum.p2p.config.SubProtocolConfiguration;
-import org.hyperledger.besu.ethereum.transaction.TransactionSimulator;
 import org.hyperledger.besu.ethereum.worldstate.WorldStateArchive;
 import org.hyperledger.besu.plugin.services.BesuEvents;
 import org.hyperledger.besu.util.Subscribers;
@@ -399,8 +398,6 @@ protected BftContext createConsensusContext(
         BlockValidatorProvider.forkingValidatorProvider(
             blockchain, epochManager, bftBlockInterface().get(), validatorOverrides);
 
-    final TransactionSimulator transactionSimulator =
-        new TransactionSimulator(blockchain, worldStateArchive, protocolSchedule, 0L);
     transactionValidatorProvider =
         new TransactionValidatorProvider(
             blockchain, new ValidatorContractController(transactionSimulator), qbftForksSchedule);

diff --git a/besu/src/test/java/org/hyperledger/besu/FlexGroupPrivacyTest.java b/besu/src/test/java/org/hyperledger/besu/FlexGroupPrivacyTest.java
@@ -28,6 +28,7 @@
 import org.hyperledger.besu.datatypes.Address;
 import org.hyperledger.besu.enclave.EnclaveFactory;
 import org.hyperledger.besu.ethereum.GasLimitCalculator;
+import org.hyperledger.besu.ethereum.api.ImmutableApiConfiguration;
 import org.hyperledger.besu.ethereum.core.BlockHeader;
 import org.hyperledger.besu.ethereum.core.BlockHeaderTestFixture;
 import org.hyperledger.besu.ethereum.core.InMemoryKeyValueStorageProvider;
@@ -162,6 +163,7 @@ BesuController provideBesuController(
           .evmConfiguration(EvmConfiguration.DEFAULT)
           .networkConfiguration(NetworkingConfiguration.create())
           .besuComponent(context)
+          .apiConfiguration(ImmutableApiConfiguration.builder().build())
           .build();
     }
   }

diff --git a/besu/src/test/java/org/hyperledger/besu/PrivacyReorgTest.java b/besu/src/test/java/org/hyperledger/besu/PrivacyReorgTest.java
@@ -41,6 +41,7 @@
 import org.hyperledger.besu.enclave.types.ReceiveResponse;
 import org.hyperledger.besu.ethereum.GasLimitCalculator;
 import org.hyperledger.besu.ethereum.ProtocolContext;
+import org.hyperledger.besu.ethereum.api.ImmutableApiConfiguration;
 import org.hyperledger.besu.ethereum.chain.DefaultBlockchain;
 import org.hyperledger.besu.ethereum.core.Block;
 import org.hyperledger.besu.ethereum.core.BlockDataGenerator;
@@ -558,6 +559,7 @@ BesuController provideBesuController(
               .evmConfiguration(EvmConfiguration.DEFAULT)
               .networkConfiguration(NetworkingConfiguration.create())
               .besuComponent(context)
+              .apiConfiguration(ImmutableApiConfiguration.builder().build())
               .build();
       return retval;
     }