Remove RpcApis and switch to String

Signed-off-by: Antony Denyer <[email protected]>
hyperledger · Sep 16, 2021 · 91f2e5c · 91f2e5c
1 parent 8b293d8
commit 91f2e5c
Show file tree

Hide file tree

Showing 53 changed files with 178 additions and 429 deletions.
diff --git a/...l/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/node/ProcessBesuNodeRunner.java b/...l/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/node/ProcessBesuNodeRunner.java
@@ -18,8 +18,6 @@
 import static java.nio.charset.StandardCharsets.UTF_8;
 
 import org.hyperledger.besu.cli.options.unstable.NetworkingOptions;
-import org.hyperledger.besu.ethereum.api.jsonrpc.RpcApi;
-import org.hyperledger.besu.ethereum.api.jsonrpc.RpcApis;
 import org.hyperledger.besu.ethereum.p2p.rlpx.connections.netty.TLSConfiguration;
 import org.hyperledger.besu.ethereum.permissioning.PermissioningConfiguration;
 import org.hyperledger.besu.metrics.prometheus.MetricsConfiguration;
@@ -447,8 +445,8 @@ private void createStaticNodes(final BesuNode node) {
     StaticNodesUtils.createStaticNodesFile(node.homeDirectory(), node.getStaticNodes());
   }
 
-  private String apiList(final Collection<RpcApi> rpcApis) {
-    return rpcApis.stream().map(RpcApis::getValue).collect(Collectors.joining(","));
+  private String apiList(final Collection<String> rpcApis) {
+    return String.join(",", rpcApis);
   }
 
   @Override

diff --git a/...yperledger/besu/tests/acceptance/dsl/node/configuration/BesuNodeConfigurationBuilder.java b/...yperledger/besu/tests/acceptance/dsl/node/configuration/BesuNodeConfigurationBuilder.java
@@ -107,13 +107,13 @@ public BesuNodeConfigurationBuilder miningEnabled() {
   public BesuNodeConfigurationBuilder miningEnabled(final boolean enabled) {
     this.miningParameters =
         new MiningParameters.Builder().enabled(enabled).coinbase(AddressHelpers.ofValue(1)).build();
-    this.jsonRpcConfiguration.addRpcApi(RpcApis.MINER);
+    this.jsonRpcConfiguration.addRpcApi(RpcApis.MINER.name());
     return this;
   }
 
   public BesuNodeConfigurationBuilder miningConfiguration(final MiningParameters miningParameters) {
     this.miningParameters = miningParameters;
-    this.jsonRpcConfiguration.addRpcApi(RpcApis.MINER);
+    this.jsonRpcConfiguration.addRpcApi(RpcApis.MINER.name());
     return this;
   }
 
@@ -143,18 +143,18 @@ public BesuNodeConfigurationBuilder metricsEnabled() {
   }
 
   public BesuNodeConfigurationBuilder enablePrivateTransactions() {
-    this.jsonRpcConfiguration.addRpcApi(RpcApis.EEA);
-    this.jsonRpcConfiguration.addRpcApi(RpcApis.PRIV);
+    this.jsonRpcConfiguration.addRpcApi(RpcApis.EEA.name());
+    this.jsonRpcConfiguration.addRpcApi(RpcApis.PRIV.name());
     return this;
   }
 
   public BesuNodeConfigurationBuilder jsonRpcTxPool() {
-    this.jsonRpcConfiguration.addRpcApi(RpcApis.TX_POOL);
+    this.jsonRpcConfiguration.addRpcApi(RpcApis.TXPOOL.name());
     return this;
   }
 
   public BesuNodeConfigurationBuilder jsonRpcAdmin() {
-    this.jsonRpcConfiguration.addRpcApi(RpcApis.ADMIN);
+    this.jsonRpcConfiguration.addRpcApi(RpcApis.ADMIN.name());
     return this;
   }
 

diff --git a/...in/java/org/hyperledger/besu/tests/acceptance/dsl/node/configuration/BesuNodeFactory.java b/...in/java/org/hyperledger/besu/tests/acceptance/dsl/node/configuration/BesuNodeFactory.java
@@ -23,7 +23,6 @@
 import org.hyperledger.besu.crypto.KeyPair;
 import org.hyperledger.besu.enclave.EnclaveFactory;
 import org.hyperledger.besu.ethereum.api.jsonrpc.JsonRpcConfiguration;
-import org.hyperledger.besu.ethereum.api.jsonrpc.RpcApi;
 import org.hyperledger.besu.ethereum.api.jsonrpc.websocket.WebSocketConfiguration;
 import org.hyperledger.besu.ethereum.core.AddressHelpers;
 import org.hyperledger.besu.ethereum.core.InMemoryPrivacyStorageProvider;
@@ -262,7 +261,7 @@ public BesuNode createPluginsNode(
             .build());
   }
 
-  public BesuNode createArchiveNodeWithRpcApis(final String name, final RpcApi... enabledRpcApis)
+  public BesuNode createArchiveNodeWithRpcApis(final String name, final String... enabledRpcApis)
       throws IOException {
     final JsonRpcConfiguration jsonRpcConfig = node.createJsonRpcEnabledConfig();
     jsonRpcConfig.setRpcApis(asList(enabledRpcApis));

diff --git a/...rg/hyperledger/besu/tests/acceptance/dsl/node/configuration/NodeConfigurationFactory.java b/...rg/hyperledger/besu/tests/acceptance/dsl/node/configuration/NodeConfigurationFactory.java
@@ -16,14 +16,13 @@
 
 import static java.util.Collections.singletonList;
 import static java.util.stream.Collectors.toList;
-import static org.hyperledger.besu.consensus.clique.jsonrpc.CliqueRpcApis.CLIQUE;
-import static org.hyperledger.besu.consensus.ibft.jsonrpc.IbftRpcApis.IBFT;
-import static org.hyperledger.besu.consensus.qbft.jsonrpc.QbftRpcApis.QBFT;
 import static org.hyperledger.besu.ethereum.api.jsonrpc.RpcApis.ADMIN;
+import static org.hyperledger.besu.ethereum.api.jsonrpc.RpcApis.CLIQUE;
+import static org.hyperledger.besu.ethereum.api.jsonrpc.RpcApis.IBFT;
 import static org.hyperledger.besu.ethereum.api.jsonrpc.RpcApis.MINER;
+import static org.hyperledger.besu.ethereum.api.jsonrpc.RpcApis.QBFT;
 
 import org.hyperledger.besu.ethereum.api.jsonrpc.JsonRpcConfiguration;
-import org.hyperledger.besu.ethereum.api.jsonrpc.RpcApi;
 import org.hyperledger.besu.ethereum.api.jsonrpc.websocket.WebSocketConfiguration;
 import org.hyperledger.besu.tests.acceptance.dsl.node.RunnableNode;
 import org.hyperledger.besu.tests.acceptance.dsl.node.configuration.genesis.GenesisConfigurationProvider;
@@ -46,23 +45,23 @@ public Optional<String> createGenesisConfigForValidators(
   }
 
   public JsonRpcConfiguration createJsonRpcWithCliqueEnabledConfig() {
-    return createJsonRpcWithRpcApiEnabledConfig(CLIQUE);
+    return createJsonRpcWithRpcApiEnabledConfig(CLIQUE.name());
   }
 
   public JsonRpcConfiguration createJsonRpcWithIbft2EnabledConfig(final boolean minerEnabled) {
     return minerEnabled
-        ? createJsonRpcWithRpcApiEnabledConfig(IBFT, MINER)
-        : createJsonRpcWithRpcApiEnabledConfig(IBFT);
+        ? createJsonRpcWithRpcApiEnabledConfig(IBFT.name(), MINER.name())
+        : createJsonRpcWithRpcApiEnabledConfig(IBFT.name());
   }
 
   public JsonRpcConfiguration createJsonRpcWithIbft2AdminEnabledConfig() {
-    return createJsonRpcWithRpcApiEnabledConfig(IBFT, ADMIN);
+    return createJsonRpcWithRpcApiEnabledConfig(IBFT.name(), ADMIN.name());
   }
 
   public JsonRpcConfiguration createJsonRpcWithQbftEnabledConfig(final boolean minerEnabled) {
     return minerEnabled
-        ? createJsonRpcWithRpcApiEnabledConfig(QBFT, MINER)
-        : createJsonRpcWithRpcApiEnabledConfig(QBFT);
+        ? createJsonRpcWithRpcApiEnabledConfig(QBFT.name(), MINER.name())
+        : createJsonRpcWithRpcApiEnabledConfig(QBFT.name());
   }
 
   public JsonRpcConfiguration createJsonRpcEnabledConfig() {
@@ -81,12 +80,12 @@ public WebSocketConfiguration createWebSocketEnabledConfig() {
   }
 
   public JsonRpcConfiguration jsonRpcConfigWithAdmin() {
-    return createJsonRpcWithRpcApiEnabledConfig(ADMIN);
+    return createJsonRpcWithRpcApiEnabledConfig(ADMIN.name());
   }
 
-  public JsonRpcConfiguration createJsonRpcWithRpcApiEnabledConfig(final RpcApi... rpcApi) {
+  public JsonRpcConfiguration createJsonRpcWithRpcApiEnabledConfig(final String... rpcApi) {
     final JsonRpcConfiguration jsonRpcConfig = createJsonRpcEnabledConfig();
-    final List<RpcApi> rpcApis = new ArrayList<>(jsonRpcConfig.getRpcApis());
+    final List<String> rpcApis = new ArrayList<>(jsonRpcConfig.getRpcApis());
     rpcApis.addAll(Arrays.asList(rpcApi));
     jsonRpcConfig.setRpcApis(rpcApis);
     return jsonRpcConfig;

diff --git a/...r/besu/tests/acceptance/dsl/node/configuration/permissioning/PermissionedNodeBuilder.java b/...r/besu/tests/acceptance/dsl/node/configuration/permissioning/PermissionedNodeBuilder.java
@@ -18,7 +18,6 @@
 import static java.util.stream.Collectors.toList;
 
 import org.hyperledger.besu.ethereum.api.jsonrpc.JsonRpcConfiguration;
-import org.hyperledger.besu.ethereum.api.jsonrpc.RpcApi;
 import org.hyperledger.besu.ethereum.api.jsonrpc.RpcApis;
 import org.hyperledger.besu.ethereum.core.Address;
 import org.hyperledger.besu.ethereum.p2p.peers.EnodeURLImpl;
@@ -297,9 +296,9 @@ private JsonRpcConfiguration jsonRpcConfigWithPermApiEnabled() {
     jsonRpcConfig.setPort(0);
     jsonRpcConfig.setHostsAllowlist(singletonList("*"));
     jsonRpcConfig.setCorsAllowedDomains(singletonList("*"));
-    final List<RpcApi> rpcApis = new ArrayList<>(jsonRpcConfig.getRpcApis());
-    rpcApis.add(RpcApis.PERM);
-    rpcApis.add(RpcApis.ADMIN);
+    final List<String> rpcApis = new ArrayList<>(jsonRpcConfig.getRpcApis());
+    rpcApis.add(RpcApis.PERM.name());
+    rpcApis.add(RpcApis.ADMIN.name());
     jsonRpcConfig.setRpcApis(rpcApis);
     return jsonRpcConfig;
   }

diff --git a/...ance-tests/test-plugins/src/main/java/org/hyperledger/besu/plugins/TestPicoCLIPlugin.java b/...ance-tests/test-plugins/src/main/java/org/hyperledger/besu/plugins/TestPicoCLIPlugin.java
@@ -59,8 +59,7 @@ public void register(final BesuContext context) {
 
     context
         .getService(PicoCLIOptions.class)
-        .ifPresent(
-            picoCLIOptions -> picoCLIOptions.addPicoCLIOptions("test", TestPicoCLIPlugin.this));
+        .ifPresent(picoCLIOptions -> picoCLIOptions.addPicoCLIOptions("test", this));
 
     callbackDir = new File(System.getProperty("besu.plugins.dir", "plugins"));
     writeSignal("registered");

diff --git a/...sts/src/test/java/org/hyperledger/besu/tests/acceptance/RpcApisTogglesAcceptanceTest.java b/...sts/src/test/java/org/hyperledger/besu/tests/acceptance/RpcApisTogglesAcceptanceTest.java
@@ -35,7 +35,7 @@ public class RpcApisTogglesAcceptanceTest extends AcceptanceTestBase {
   public void before() throws Exception {
     rpcEnabledNode = besu.createArchiveNode("rpc-enabled");
     rpcDisabledNode = besu.createArchiveNodeWithRpcDisabled("rpc-disabled");
-    ethApiDisabledNode = besu.createArchiveNodeWithRpcApis("eth-api-disabled", RpcApis.NET);
+    ethApiDisabledNode = besu.createArchiveNodeWithRpcApis("eth-api-disabled", RpcApis.NET.name());
     cluster.start(rpcEnabledNode, rpcDisabledNode, ethApiDisabledNode);
   }
 

diff --git a/besu/src/main/java/org/hyperledger/besu/RunnerBuilder.java b/besu/src/main/java/org/hyperledger/besu/RunnerBuilder.java
@@ -32,7 +32,6 @@
 import org.hyperledger.besu.ethereum.api.graphql.GraphQLProvider;
 import org.hyperledger.besu.ethereum.api.jsonrpc.JsonRpcConfiguration;
 import org.hyperledger.besu.ethereum.api.jsonrpc.JsonRpcHttpService;
-import org.hyperledger.besu.ethereum.api.jsonrpc.RpcApi;
 import org.hyperledger.besu.ethereum.api.jsonrpc.health.HealthService;
 import org.hyperledger.besu.ethereum.api.jsonrpc.health.LivenessCheck;
 import org.hyperledger.besu.ethereum.api.jsonrpc.health.ReadinessCheck;
@@ -825,7 +824,7 @@ private Map<String, JsonRpcMethod> jsonRpcMethods(
       final MiningCoordinator miningCoordinator,
       final ObservableMetricsSystem metricsSystem,
       final Set<Capability> supportedCapabilities,
-      final Collection<RpcApi> jsonRpcApis,
+      final Collection<String> jsonRpcApis,
       final FilterManager filterManager,
       final Optional<AccountLocalConfigPermissioningController> accountAllowlistController,
       final Optional<NodeLocalConfigPermissioningController> nodeAllowlistController,

diff --git a/besu/src/main/java/org/hyperledger/besu/cli/BesuCommand.java b/besu/src/main/java/org/hyperledger/besu/cli/BesuCommand.java
@@ -24,7 +24,7 @@
 import static org.hyperledger.besu.controller.BesuController.DATABASE_PATH;
 import static org.hyperledger.besu.ethereum.api.graphql.GraphQLConfiguration.DEFAULT_GRAPHQL_HTTP_PORT;
 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.RpcApis.DEFAULT_RPC_APIS;
 import static org.hyperledger.besu.ethereum.api.jsonrpc.websocket.WebSocketConfiguration.DEFAULT_WEBSOCKET_PORT;
 import static org.hyperledger.besu.ethereum.permissioning.GoQuorumPermissioningConfiguration.QIP714_DEFAULT_BLOCK;
 import static org.hyperledger.besu.metrics.BesuMetricCategory.DEFAULT_METRIC_CATEGORIES;
@@ -43,7 +43,6 @@
 import org.hyperledger.besu.cli.config.NetworkName;
 import org.hyperledger.besu.cli.converter.MetricCategoryConverter;
 import org.hyperledger.besu.cli.converter.PercentageConverter;
-import org.hyperledger.besu.cli.converter.RpcApisConverter;
 import org.hyperledger.besu.cli.custom.CorsAllowedOriginsProperty;
 import org.hyperledger.besu.cli.custom.JsonRPCAllowlistHostsProperty;
 import org.hyperledger.besu.cli.custom.RpcAuthFileValidator;
@@ -96,7 +95,6 @@
 import org.hyperledger.besu.ethereum.api.ImmutableApiConfiguration;
 import org.hyperledger.besu.ethereum.api.graphql.GraphQLConfiguration;
 import org.hyperledger.besu.ethereum.api.jsonrpc.JsonRpcConfiguration;
-import org.hyperledger.besu.ethereum.api.jsonrpc.RpcApi;
 import org.hyperledger.besu.ethereum.api.jsonrpc.RpcApis;
 import org.hyperledger.besu.ethereum.api.jsonrpc.websocket.WebSocketConfiguration;
 import org.hyperledger.besu.ethereum.api.tls.FileBasedPasswordProvider;
@@ -185,6 +183,7 @@
 import java.nio.file.Path;
 import java.time.Clock;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Base64;
 import java.util.Collection;
 import java.util.HashMap;
@@ -554,12 +553,11 @@ void setBannedNodeIds(final List<String> values) {
   @Option(
       names = {"--rpc-http-api", "--rpc-http-apis"},
       paramLabel = "<api name>",
-      split = ",",
+      split = " {0,1}, {0,1}",
       arity = "1..*",
-      converter = RpcApisConverter.class,
       description =
           "Comma separated list of APIs to enable on JSON-RPC HTTP service (default: ${DEFAULT-VALUE})")
-  private final Collection<RpcApi> rpcHttpApis = DEFAULT_JSON_RPC_APIS;
+  private final List<String> rpcHttpApis = DEFAULT_RPC_APIS;
 
   @Option(
       names = {"--rpc-http-authentication-enabled"},
@@ -651,12 +649,11 @@ void setBannedNodeIds(final List<String> values) {
   @Option(
       names = {"--rpc-ws-api", "--rpc-ws-apis"},
       paramLabel = "<api name>",
-      split = ",",
+      split = " {0,1}, {0,1}",
       arity = "1..*",
-      converter = RpcApisConverter.class,
       description =
           "Comma separated list of APIs to enable on JSON-RPC WebSocket service (default: ${DEFAULT-VALUE})")
-  private final List<RpcApi> rpcWsApis = DEFAULT_JSON_RPC_APIS;
+  private final List<String> rpcWsApis = DEFAULT_RPC_APIS;
 
   @Option(
       names = {"--rpc-ws-authentication-enabled"},
@@ -1456,6 +1453,7 @@ private void validateOptions() {
     validateNatParams();
     validateNetStatsParams();
     validateDnsOptionsParams();
+    validateRpcOptionsParams();
     p2pTLSConfigOptions.checkP2PTLSOptionsDependencies(logger, commandLine);
     pkiBlockCreationOptions.checkPkiBlockCreationOptionsDependencies(logger, commandLine);
   }
@@ -1525,6 +1523,18 @@ private void validateDnsOptionsParams() {
     }
   }
 
+  public void validateRpcOptionsParams() {
+    if (!rpcHttpApis.stream()
+        .allMatch(x -> Arrays.stream(RpcApis.values()).anyMatch(y -> x.equals(y.name())))) {
+      throw new ParameterException(this.commandLine, "Invalid value for option '--rpc-http-apis'");
+    }
+
+    if (!rpcWsApis.stream()
+        .allMatch(x -> Arrays.stream(RpcApis.values()).anyMatch(y -> x.equals(y.name())))) {
+      throw new ParameterException(this.commandLine, "Invalid value for option '--rpc-ws-apis'");
+    }
+  }
+
   private GenesisConfigOptions readGenesisConfigOptions() {
     final GenesisConfigOptions genesisConfigOptions;
     try {
@@ -1994,7 +2004,7 @@ public MetricsConfiguration metricsConfiguration() {
 
   private Optional<PermissioningConfiguration> permissioningConfiguration() throws Exception {
     if (!(localPermissionsEnabled() || contractPermissionsEnabled())) {
-      if (rpcHttpApis.contains(RpcApis.PERM) || rpcWsApis.contains(RpcApis.PERM)) {
+      if (rpcHttpApis.contains(RpcApis.PERM.name()) || rpcWsApis.contains(RpcApis.PERM.name())) {
         logger.warn(
             "Permissions are disabled. Cannot enable PERM APIs when not using Permissions.");
       }
@@ -2226,7 +2236,8 @@ private PrivacyParameters privacyParameters(final KeyValueStorageProvider storag
     }
 
     if (!isGoQuorumCompatibilityMode
-        && (rpcHttpApis.contains(RpcApis.GOQUORUM) || rpcWsApis.contains(RpcApis.GOQUORUM))) {
+        && (rpcHttpApis.contains(RpcApis.GOQUORUM.name())
+            || rpcWsApis.contains(RpcApis.GOQUORUM.name()))) {
       logger.warn("Cannot use GOQUORUM API methods when not in GoQuorum mode.");
     }
     privacyParametersBuilder.setPrivacyService(privacyPluginPluginService);
@@ -2249,10 +2260,10 @@ public WorldStateArchive createPrivateWorldStateArchive(final StorageProvider st
   }
 
   private boolean anyPrivacyApiEnabled() {
-    return rpcHttpApis.contains(RpcApis.EEA)
-        || rpcWsApis.contains(RpcApis.EEA)
-        || rpcHttpApis.contains(RpcApis.PRIV)
-        || rpcWsApis.contains(RpcApis.PRIV);
+    return rpcHttpApis.contains(RpcApis.EEA.name())
+        || rpcWsApis.contains(RpcApis.EEA.name())
+        || rpcHttpApis.contains(RpcApis.PRIV.name())
+        || rpcWsApis.contains(RpcApis.PRIV.name());
   }
 
   private PrivacyKeyValueStorageProvider privacyKeyStorageProvider(final String name) {

diff --git a/besu/src/main/java/org/hyperledger/besu/cli/converter/RpcApisConverter.java b/besu/src/main/java/org/hyperledger/besu/cli/converter/RpcApisConverter.java
diff --git a/besu/src/main/java/org/hyperledger/besu/controller/BesuController.java b/besu/src/main/java/org/hyperledger/besu/controller/BesuController.java
@@ -20,7 +20,6 @@
 import org.hyperledger.besu.config.PowAlgorithm;
 import org.hyperledger.besu.crypto.NodeKey;
 import org.hyperledger.besu.ethereum.ProtocolContext;
-import org.hyperledger.besu.ethereum.api.jsonrpc.RpcApi;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.JsonRpcMethod;
 import org.hyperledger.besu.ethereum.api.jsonrpc.methods.JsonRpcMethods;
 import org.hyperledger.besu.ethereum.blockcreation.MiningCoordinator;
@@ -156,7 +155,7 @@ public MiningParameters getMiningParameters() {
   }
 
   public Map<String, JsonRpcMethod> getAdditionalJsonRpcMethods(
-      final Collection<RpcApi> enabledRpcApis) {
+      final Collection<String> enabledRpcApis) {
     return additionalJsonRpcMethodsFactory.create(enabledRpcApis);
   }