Go quorum interop

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

@@ -26,7 +26,7 @@
 import static org.hyperledger.besu.ethereum.api.jsonrpc.JsonRpcConfiguration.DEFAULT_JSON_RPC_PORT;
 import static org.hyperledger.besu.ethereum.api.jsonrpc.RpcApis.DEFAULT_JSON_RPC_APIS;
 import static org.hyperledger.besu.ethereum.api.jsonrpc.websocket.WebSocketConfiguration.DEFAULT_WEBSOCKET_PORT;
-import static org.hyperledger.besu.ethereum.permissioning.QuorumPermissioningConfiguration.QIP714_DEFAULT_BLOCK;
+import static org.hyperledger.besu.ethereum.permissioning.GoQuorumPermissioningConfiguration.QIP714_DEFAULT_BLOCK;
 import static org.hyperledger.besu.metrics.BesuMetricCategory.DEFAULT_METRIC_CATEGORIES;
 import static org.hyperledger.besu.metrics.MetricsProtocol.PROMETHEUS;
 import static org.hyperledger.besu.metrics.prometheus.MetricsConfiguration.DEFAULT_METRICS_PORT;
@@ -112,16 +112,21 @@
 import org.hyperledger.besu.ethereum.p2p.peers.EnodeDnsConfiguration;
 import org.hyperledger.besu.ethereum.p2p.peers.EnodeURL;
 import org.hyperledger.besu.ethereum.p2p.peers.StaticNodesParser;
+import org.hyperledger.besu.ethereum.permissioning.GoQuorumPermissioningConfiguration;
 import org.hyperledger.besu.ethereum.permissioning.LocalPermissioningConfiguration;
 import org.hyperledger.besu.ethereum.permissioning.PermissioningConfiguration;
 import org.hyperledger.besu.ethereum.permissioning.PermissioningConfigurationBuilder;
-import org.hyperledger.besu.ethereum.permissioning.QuorumPermissioningConfiguration;
 import org.hyperledger.besu.ethereum.permissioning.SmartContractPermissioningConfiguration;
 import org.hyperledger.besu.ethereum.privacy.storage.keyvalue.PrivacyKeyValueStorageProvider;
 import org.hyperledger.besu.ethereum.privacy.storage.keyvalue.PrivacyKeyValueStorageProviderBuilder;
+import org.hyperledger.besu.ethereum.storage.StorageProvider;
 import org.hyperledger.besu.ethereum.storage.keyvalue.KeyValueStorageProvider;
 import org.hyperledger.besu.ethereum.storage.keyvalue.KeyValueStorageProviderBuilder;
+import org.hyperledger.besu.ethereum.worldstate.DefaultWorldStateArchive;
 import org.hyperledger.besu.ethereum.worldstate.PrunerConfiguration;
+import org.hyperledger.besu.ethereum.worldstate.WorldStateArchive;
+import org.hyperledger.besu.ethereum.worldstate.WorldStatePreimageStorage;
+import org.hyperledger.besu.ethereum.worldstate.WorldStateStorage;
 import org.hyperledger.besu.metrics.BesuMetricCategory;
 import org.hyperledger.besu.metrics.MetricCategoryRegistryImpl;
 import org.hyperledger.besu.metrics.MetricsProtocol;
@@ -912,7 +917,7 @@ void setBannedNodeIds(final List<String> values) {
       description = "The URL on which the enclave is running")
   private final URI privacyUrl = PrivacyParameters.DEFAULT_ENCLAVE_URL;
 
-  @CommandLine.Option(
+  @Option(
       names = {"--privacy-public-key-file"},
       description = "The enclave's public key file")
   private final File privacyPublicKeyFile = null;
@@ -1082,6 +1087,7 @@ void setBannedNodeIds(final List<String> values) {
       Suppliers.memoize(() -> MetricsSystemFactory.create(metricsConfiguration()));
   private Vertx vertx;
   private EnodeDnsConfiguration enodeDnsConfiguration;
+  private KeyValueStorageProvider keyValueStorageProvider;
 
   public BesuCommand(
       final Logger logger,
@@ -1546,21 +1552,17 @@ private BesuCommand configure() throws Exception {
         .ifPresent(p -> ensureAllNodesAreInAllowlist(staticNodes, p));
     metricsConfiguration = metricsConfiguration();
 
-    if (isGoQuorumCompatibilityMode) {
-      configureGoQuorumPrivacy();
-    }
-
     logger.info("Security Module: {}", securityModuleName);
     return this;
   }
 
-  private void configureGoQuorumPrivacy() {
-
-    GoQuorumPrivacyParameters.isEnabled = true;
-
-    GoQuorumPrivacyParameters.goQuorumEnclave = createGoQuorumEnclave();
-
-    GoQuorumPrivacyParameters.enclaveKey = readEnclaveKey();
+  private GoQuorumPrivacyParameters configureGoQuorumPrivacy(
+      final KeyValueStorageProvider storageProvider) {
+    return new GoQuorumPrivacyParameters(
+        createGoQuorumEnclave(),
+        readEnclaveKey(),
+        storageProvider.createGoQuorumPrivateStorage(),
+        createPrivateWorldStateArchive(storageProvider));
   }
 
   private GoQuorumEnclave createGoQuorumEnclave() {
@@ -1624,6 +1626,7 @@ public BesuController buildController() {
   }
 
   public BesuControllerBuilder getControllerBuilder() {
+    final KeyValueStorageProvider storageProvider = keyValueStorageProvider(keyValueStorageName);
     return controllerBuilderFactory
         .fromEthNetworkConfig(updateNetworkConfig(getNetwork()), genesisConfigOverrides)
         .synchronizerConfiguration(buildSyncConfig())
@@ -1646,10 +1649,10 @@ public BesuControllerBuilder getControllerBuilder() {
         .transactionPoolConfiguration(buildTransactionPoolConfiguration())
         .nodeKey(buildNodeKey())
         .metricsSystem(metricsSystem.get())
-        .privacyParameters(privacyParameters())
+        .privacyParameters(privacyParameters(storageProvider))
         .clock(Clock.systemUTC())
         .isRevertReasonEnabled(isRevertReasonEnabled)
-        .storageProvider(keyStorageProvider(keyValueStorageName))
+        .storageProvider(storageProvider)
         .isPruningEnabled(isPruningEnabled())
         .pruningConfiguration(
             new PrunerConfiguration(pruningBlockConfirmations, pruningBlocksRetained))
@@ -1990,7 +1993,7 @@ private Optional<PermissioningConfiguration> permissioningConfiguration() throws
     return Optional.of(permissioningConfiguration);
   }
 
-  private Optional<QuorumPermissioningConfiguration> quorumPermissioningConfig() {
+  private Optional<GoQuorumPermissioningConfiguration> quorumPermissioningConfig() {
     if (!isGoQuorumCompatibilityMode) {
       return Optional.empty();
     }
@@ -1999,7 +2002,8 @@ private Optional<QuorumPermissioningConfiguration> quorumPermissioningConfig() {
       final GenesisConfigOptions genesisConfigOptions = readGenesisConfigOptions();
       final OptionalLong qip714BlockNumber = genesisConfigOptions.getQip714BlockNumber();
       return Optional.of(
-          QuorumPermissioningConfiguration.enabled(qip714BlockNumber.orElse(QIP714_DEFAULT_BLOCK)));
+          GoQuorumPermissioningConfiguration.enabled(
+              qip714BlockNumber.orElse(QIP714_DEFAULT_BLOCK)));
     } catch (final Exception e) {
       throw new IllegalStateException("Error reading GoQuorum permissioning options", e);
     }
@@ -2013,7 +2017,7 @@ private boolean contractPermissionsEnabled() {
     return permissionsNodesContractEnabled || permissionsAccountsContractEnabled;
   }
 
-  private PrivacyParameters privacyParameters() {
+  private PrivacyParameters privacyParameters(final KeyValueStorageProvider storageProvider) {
 
     CommandLineUtils.checkOptionDependencies(
         logger,
@@ -2094,10 +2098,18 @@ private PrivacyParameters privacyParameters() {
         privacyParametersBuilder.setPrivacyTlsKnownEnclaveFile(privacyTlsKnownEnclaveFile);
       }
       privacyParametersBuilder.setEnclaveFactory(new EnclaveFactory(vertx));
-    } else {
-      if (anyPrivacyApiEnabled()) {
-        logger.warn("Privacy is disabled. Cannot use EEA/PRIV API methods when not using Privacy.");
-      }
+    } else if (isGoQuorumCompatibilityMode) {
+      privacyParametersBuilder.setGoQuorumPrivacyParameters(
+          Optional.of(configureGoQuorumPrivacy(storageProvider)));
+    }
+
+    if (!isPrivacyEnabled && anyPrivacyApiEnabled()) {
+      logger.warn("Privacy is disabled. Cannot use EEA/PRIV API methods when not using Privacy.");
+    }
+
+    if (!isGoQuorumCompatibilityMode
+        && (rpcHttpApis.contains(RpcApis.GOQUORUM) || rpcWsApis.contains(RpcApis.GOQUORUM))) {
+      logger.warn("Cannot use GOQUORUM API methods when not in GoQuorum mode.");
     }
 
     final PrivacyParameters privacyParameters = privacyParametersBuilder.build();
@@ -2110,6 +2122,14 @@ private PrivacyParameters privacyParameters() {
     return privacyParameters;
   }
 
+  public WorldStateArchive createPrivateWorldStateArchive(final StorageProvider storageProvider) {
+    final WorldStateStorage privateWorldStateStorage =
+        storageProvider.createPrivateWorldStateStorage();
+    final WorldStatePreimageStorage preimageStorage =
+        storageProvider.createPrivateWorldStatePreimageStorage();
+    return new DefaultWorldStateArchive(privateWorldStateStorage, preimageStorage);
+  }
+
   private boolean anyPrivacyApiEnabled() {
     return rpcHttpApis.contains(RpcApis.EEA)
         || rpcWsApis.contains(RpcApis.EEA)
@@ -2133,16 +2153,22 @@ private PrivacyKeyValueStorageFactory privacyKeyValueStorageFactory(final String
                 () -> new StorageException("No KeyValueStorageFactory found for key: " + name));
   }
 
-  private KeyValueStorageProvider keyStorageProvider(final String name) {
-    return new KeyValueStorageProviderBuilder()
-        .withStorageFactory(
-            storageService
-                .getByName(name)
-                .orElseThrow(
-                    () -> new StorageException("No KeyValueStorageFactory found for key: " + name)))
-        .withCommonConfiguration(pluginCommonConfiguration)
-        .withMetricsSystem(getMetricsSystem())
-        .build();
+  private KeyValueStorageProvider keyValueStorageProvider(final String name) {
+    if (this.keyValueStorageProvider == null) {
+      this.keyValueStorageProvider =
+          new KeyValueStorageProviderBuilder()
+              .withStorageFactory(
+                  storageService
+                      .getByName(name)
+                      .orElseThrow(
+                          () ->
+                              new StorageException(
+                                  "No KeyValueStorageFactory found for key: " + name)))
+              .withCommonConfiguration(pluginCommonConfiguration)
+              .withMetricsSystem(getMetricsSystem())
+              .build();
+    }
+    return this.keyValueStorageProvider;
   }
 
   private SynchronizerConfiguration buildSyncConfig() {
@@ -2226,7 +2252,7 @@ private void synchronize(
             .autoLogBloomCaching(autoLogBloomCachingEnabled)
             .ethstatsUrl(unstableEthstatsOptions.getEthstatsUrl())
             .ethstatsContact(unstableEthstatsOptions.getEthstatsContact())
-            .storageProvider(keyStorageProvider(keyValueStorageName))
+            .storageProvider(keyValueStorageProvider(keyValueStorageName))
             .build();
 
     addShutdownHook(runner);
@@ -2515,7 +2541,7 @@ private void checkGoQuorumCompatibilityConfig(final EthNetworkConfig ethNetworkC
     if (isGoQuorumCompatibilityMode) {
       final GenesisConfigOptions genesisConfigOptions = readGenesisConfigOptions();
       // this static flag is read by the RLP decoder
-      GoQuorumOptions.goquorumCompatibilityMode = true;
+      GoQuorumOptions.goQuorumCompatibilityMode = true;
 
       if (!genesisConfigOptions.isQuorum()) {
         throw new IllegalStateException(

config/src/main/java/org/hyperledger/besu/config/GoQuorumOptions.java

@@ -22,5 +22,5 @@ public class GoQuorumOptions {
   // To make it easier for tests to reset the value to default
   public static final boolean GOQUORUM_COMPATIBILITY_MODE_DEFAULT_VALUE = false;
 
-  public static boolean goquorumCompatibilityMode = GOQUORUM_COMPATIBILITY_MODE_DEFAULT_VALUE;
+  public static boolean goQuorumCompatibilityMode = GOQUORUM_COMPATIBILITY_MODE_DEFAULT_VALUE;
 }

consensus/clique/src/main/java/org/hyperledger/besu/consensus/clique/CliqueProtocolSchedule.java

@@ -19,7 +19,6 @@
 import org.hyperledger.besu.config.experimental.ExperimentalEIPs;
 import org.hyperledger.besu.consensus.common.EpochManager;
 import org.hyperledger.besu.crypto.NodeKey;
-import org.hyperledger.besu.ethereum.MainnetBlockValidator;
 import org.hyperledger.besu.ethereum.core.Address;
 import org.hyperledger.besu.ethereum.core.PrivacyParameters;
 import org.hyperledger.besu.ethereum.core.Util;
@@ -28,6 +27,7 @@
 import org.hyperledger.besu.ethereum.mainnet.BlockHeaderValidator;
 import org.hyperledger.besu.ethereum.mainnet.MainnetBlockBodyValidator;
 import org.hyperledger.besu.ethereum.mainnet.MainnetBlockImporter;
+import org.hyperledger.besu.ethereum.mainnet.MainnetProtocolSpecs;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolScheduleBuilder;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSpecBuilder;
@@ -70,7 +70,8 @@ public static ProtocolSchedule create(
                     cliqueConfig.getBlockPeriodSeconds(),
                     localNodeAddress,
                     builder,
-                    eip1559),
+                    eip1559,
+                    privacyParameters.getGoQuorumPrivacyParameters().isPresent()),
             privacyParameters,
             isRevertReasonEnabled,
             config.isQuorum())
@@ -89,15 +90,16 @@ private static ProtocolSpecBuilder applyCliqueSpecificModifications(
       final long secondsBetweenBlocks,
       final Address localNodeAddress,
       final ProtocolSpecBuilder specBuilder,
-      final Optional<EIP1559> eip1559) {
+      final Optional<EIP1559> eip1559,
+      final boolean goQuorumMode) {
 
     return specBuilder
         .blockHeaderValidatorBuilder(
             getBlockHeaderValidator(epochManager, secondsBetweenBlocks, eip1559))
         .ommerHeaderValidatorBuilder(
             getBlockHeaderValidator(epochManager, secondsBetweenBlocks, eip1559))
         .blockBodyValidatorBuilder(MainnetBlockBodyValidator::new)
-        .blockValidatorBuilder(MainnetBlockValidator::new)
+        .blockValidatorBuilder(MainnetProtocolSpecs.blockValidatorBuilder(goQuorumMode))
         .blockImporterBuilder(MainnetBlockImporter::new)
         .difficultyCalculator(new CliqueDifficultyCalculator(localNodeAddress))
         .blockReward(Wei.ZERO)

consensus/common/src/main/java/org/hyperledger/besu/consensus/common/bft/BftProtocolSchedule.java

@@ -18,12 +18,12 @@
 
 import org.hyperledger.besu.config.BftConfigOptions;
 import org.hyperledger.besu.config.GenesisConfigOptions;
-import org.hyperledger.besu.ethereum.MainnetBlockValidator;
 import org.hyperledger.besu.ethereum.core.Address;
 import org.hyperledger.besu.ethereum.core.PrivacyParameters;
 import org.hyperledger.besu.ethereum.core.Wei;
 import org.hyperledger.besu.ethereum.mainnet.MainnetBlockBodyValidator;
 import org.hyperledger.besu.ethereum.mainnet.MainnetBlockImporter;
+import org.hyperledger.besu.ethereum.mainnet.MainnetProtocolSpecs;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolScheduleBuilder;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSpecBuilder;
@@ -43,7 +43,7 @@ public static ProtocolSchedule create(
     return new ProtocolScheduleBuilder(
             config,
             DEFAULT_CHAIN_ID,
-            builder -> applyBftChanges(config.getBftConfigOptions(), builder),
+            builder -> applyBftChanges(config.getBftConfigOptions(), builder, config.isQuorum()),
             privacyParameters,
             isRevertReasonEnabled,
             config.isQuorum())
@@ -60,7 +60,9 @@ public static ProtocolSchedule create(final GenesisConfigOptions config) {
   }
 
   private static ProtocolSpecBuilder applyBftChanges(
-      final BftConfigOptions configOptions, final ProtocolSpecBuilder builder) {
+      final BftConfigOptions configOptions,
+      final ProtocolSpecBuilder builder,
+      final boolean goQuorumMode) {
 
     if (configOptions.getEpochLength() <= 0) {
       throw new IllegalArgumentException("Epoch length in config must be greater than zero");
@@ -74,7 +76,7 @@ private static ProtocolSpecBuilder applyBftChanges(
         .blockHeaderValidatorBuilder(bftBlockHeaderValidator(configOptions.getBlockPeriodSeconds()))
         .ommerHeaderValidatorBuilder(bftBlockHeaderValidator(configOptions.getBlockPeriodSeconds()))
         .blockBodyValidatorBuilder(MainnetBlockBodyValidator::new)
-        .blockValidatorBuilder(MainnetBlockValidator::new)
+        .blockValidatorBuilder(MainnetProtocolSpecs.blockValidatorBuilder(goQuorumMode))
         .blockImporterBuilder(MainnetBlockImporter::new)
         .difficultyCalculator((time, parent, protocolContext) -> BigInteger.ONE)
         .blockReward(Wei.of(configOptions.getBlockRewardWei()))

consensus/ibftlegacy/src/main/java/org/hyperledger/besu/consensus/ibftlegacy/IbftProtocolSchedule.java

@@ -18,11 +18,11 @@
 
 import org.hyperledger.besu.config.BftConfigOptions;
 import org.hyperledger.besu.config.GenesisConfigOptions;
-import org.hyperledger.besu.ethereum.MainnetBlockValidator;
 import org.hyperledger.besu.ethereum.core.PrivacyParameters;
 import org.hyperledger.besu.ethereum.core.Wei;
 import org.hyperledger.besu.ethereum.mainnet.MainnetBlockBodyValidator;
 import org.hyperledger.besu.ethereum.mainnet.MainnetBlockImporter;
+import org.hyperledger.besu.ethereum.mainnet.MainnetProtocolSpecs;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolScheduleBuilder;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSpecBuilder;
@@ -44,7 +44,7 @@ public static ProtocolSchedule create(
     return new ProtocolScheduleBuilder(
             config,
             DEFAULT_CHAIN_ID,
-            builder -> applyIbftChanges(blockPeriod, builder),
+            builder -> applyIbftChanges(blockPeriod, builder, config.isQuorum()),
             privacyParameters,
             isRevertReasonEnabled,
             config.isQuorum())
@@ -57,12 +57,14 @@ public static ProtocolSchedule create(
   }
 
   private static ProtocolSpecBuilder applyIbftChanges(
-      final long secondsBetweenBlocks, final ProtocolSpecBuilder builder) {
+      final long secondsBetweenBlocks,
+      final ProtocolSpecBuilder builder,
+      final boolean goQuorumMode) {
     return builder
         .blockHeaderValidatorBuilder(ibftBlockHeaderValidator(secondsBetweenBlocks))
         .ommerHeaderValidatorBuilder(ibftBlockHeaderValidator(secondsBetweenBlocks))
         .blockBodyValidatorBuilder(MainnetBlockBodyValidator::new)
-        .blockValidatorBuilder(MainnetBlockValidator::new)
+        .blockValidatorBuilder(MainnetProtocolSpecs.blockValidatorBuilder(goQuorumMode))
         .blockImporterBuilder(MainnetBlockImporter::new)
         .difficultyCalculator((time, parent, protocolContext) -> BigInteger.ONE)
         .blockReward(Wei.ZERO)

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

@@ -32,6 +32,7 @@ public class RpcApis {
   public static final RpcApi TX_POOL = new RpcApi("TXPOOL");
   public static final RpcApi TRACE = new RpcApi("TRACE");
   public static final RpcApi PLUGINS = new RpcApi("PLUGINS");
+  public static final RpcApi GOQUORUM = new RpcApi("GOQUORUM");
 
   public static final List<RpcApi> DEFAULT_JSON_RPC_APIS = Arrays.asList(ETH, NET, WEB3);
 
@@ -64,6 +65,8 @@ public static Optional<RpcApi> valueOf(final String name) {
       return Optional.of(TRACE);
     } else if (name.equals(PLUGINS.getCliValue())) {
       return Optional.of(PLUGINS);
+    } else if (name.equals(GOQUORUM.getCliValue())) {
+      return Optional.of(GOQUORUM);
     } else {
       return Optional.empty();
     }

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

@@ -94,14 +94,15 @@ public enum RpcMethod {
   ETH_GET_UNCLE_COUNT_BY_BLOCK_NUMBER("eth_getUncleCountByBlockNumber"),
   ETH_GET_WORK("eth_getWork"),
   ETH_HASHRATE("eth_hashrate"),
-  ETH_SUBMIT_HASHRATE("eth_submitHashrate"),
   ETH_MINING("eth_mining"),
   ETH_NEW_BLOCK_FILTER("eth_newBlockFilter"),
   ETH_NEW_FILTER("eth_newFilter"),
   ETH_NEW_PENDING_TRANSACTION_FILTER("eth_newPendingTransactionFilter"),
   ETH_PROTOCOL_VERSION("eth_protocolVersion"),
+  ETH_SEND_RAW_PRIVATE_TRANSACTION("eth_sendRawPrivateTransaction"),
   ETH_SEND_RAW_TRANSACTION("eth_sendRawTransaction"),
   ETH_SEND_TRANSACTION("eth_sendTransaction"),
+  ETH_SUBMIT_HASHRATE("eth_submitHashrate"),
   ETH_SUBMIT_WORK("eth_submitWork"),
   ETH_SUBSCRIBE("eth_subscribe"),
   ETH_SYNCING("eth_syncing"),