Redesign of how JsonRpcMethods are created (hyperledger#159)

Signed-off-by: Christopher Hare <chris.hare@consensys.net>
Signed-off-by: Lucas Saldanha <lucas.saldanha@consensys.net>
Signed-off-by: SteveM <SteveM@myEtherWallet.com>

besu/src/main/java/org/hyperledger/besu/RunnerBuilder.java

@@ -36,7 +36,7 @@
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.filter.FilterManager;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.filter.FilterRepository;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.JsonRpcMethod;
-import org.hyperledger.besu.ethereum.api.jsonrpc.method.JsonRpcMethodsFactory;
+import org.hyperledger.besu.ethereum.api.jsonrpc.methods.JsonRpcMethodsFactory;
 import org.hyperledger.besu.ethereum.api.jsonrpc.websocket.WebSocketConfiguration;
 import org.hyperledger.besu.ethereum.api.jsonrpc.websocket.WebSocketRequestHandler;
 import org.hyperledger.besu.ethereum.api.jsonrpc.websocket.WebSocketService;

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

@@ -21,7 +21,7 @@
 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.method.JsonRpcMethodFactory;
+import org.hyperledger.besu.ethereum.api.jsonrpc.methods.JsonRpcMethods;
 import org.hyperledger.besu.ethereum.blockcreation.MiningCoordinator;
 import org.hyperledger.besu.ethereum.core.PrivacyParameters;
 import org.hyperledger.besu.ethereum.core.Synchronizer;
@@ -52,7 +52,7 @@ public class BesuController<C> implements java.io.Closeable {
   private final SubProtocolConfiguration subProtocolConfiguration;
   private final KeyPair keyPair;
   private final Synchronizer synchronizer;
-  private final JsonRpcMethodFactory additionalJsonRpcMethodsFactory;
+  private final JsonRpcMethods additionalJsonRpcMethodsFactory;
 
   private final TransactionPool transactionPool;
   private final MiningCoordinator miningCoordinator;
@@ -72,7 +72,7 @@ public class BesuController<C> implements java.io.Closeable {
       final TransactionPool transactionPool,
       final MiningCoordinator miningCoordinator,
       final PrivacyParameters privacyParameters,
-      final JsonRpcMethodFactory additionalJsonRpcMethodsFactory,
+      final JsonRpcMethods additionalJsonRpcMethodsFactory,
       final KeyPair keyPair,
       final List<Closeable> closeables,
       final PluginServiceFactory additionalPluginServices) {
@@ -147,7 +147,7 @@ public PrivacyParameters getPrivacyParameters() {
 
   public Map<String, JsonRpcMethod> getAdditionalJsonRpcMethods(
       final Collection<RpcApi> enabledRpcApis) {
-    return additionalJsonRpcMethodsFactory.createJsonRpcMethods(enabledRpcApis);
+    return additionalJsonRpcMethodsFactory.create(enabledRpcApis);
   }
 
   public SyncState getSyncState() {

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

@@ -21,7 +21,7 @@
 import org.hyperledger.besu.config.GenesisConfigFile;
 import org.hyperledger.besu.crypto.SECP256K1.KeyPair;
 import org.hyperledger.besu.ethereum.ProtocolContext;
-import org.hyperledger.besu.ethereum.api.jsonrpc.method.JsonRpcMethodFactory;
+import org.hyperledger.besu.ethereum.api.jsonrpc.methods.JsonRpcMethods;
 import org.hyperledger.besu.ethereum.blockcreation.MiningCoordinator;
 import org.hyperledger.besu.ethereum.chain.Blockchain;
 import org.hyperledger.besu.ethereum.chain.GenesisState;
@@ -279,7 +279,7 @@ public BesuController<C> build() {
     final SubProtocolConfiguration subProtocolConfiguration =
         createSubProtocolConfiguration(ethProtocolManager);
 
-    final JsonRpcMethodFactory additionalJsonRpcMethodFactory =
+    final JsonRpcMethods additionalJsonRpcMethodFactory =
         createAdditionalJsonRpcMethodFactory(protocolContext);
 
     List<Closeable> closeables = new ArrayList<>();
@@ -307,7 +307,7 @@ public BesuController<C> build() {
 
   protected void prepForBuild() {}
 
-  protected JsonRpcMethodFactory createAdditionalJsonRpcMethodFactory(
+  protected JsonRpcMethods createAdditionalJsonRpcMethodFactory(
       final ProtocolContext<C> protocolContext) {
     return apis -> Collections.emptyMap();
   }

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

@@ -22,14 +22,14 @@
 import org.hyperledger.besu.consensus.clique.blockcreation.CliqueBlockScheduler;
 import org.hyperledger.besu.consensus.clique.blockcreation.CliqueMinerExecutor;
 import org.hyperledger.besu.consensus.clique.blockcreation.CliqueMiningCoordinator;
-import org.hyperledger.besu.consensus.clique.jsonrpc.CliqueJsonRpcMethodsFactory;
+import org.hyperledger.besu.consensus.clique.jsonrpc.CliqueJsonRpcMethods;
 import org.hyperledger.besu.consensus.common.BlockInterface;
 import org.hyperledger.besu.consensus.common.EpochManager;
 import org.hyperledger.besu.consensus.common.VoteProposer;
 import org.hyperledger.besu.consensus.common.VoteTallyCache;
 import org.hyperledger.besu.consensus.common.VoteTallyUpdater;
 import org.hyperledger.besu.ethereum.ProtocolContext;
-import org.hyperledger.besu.ethereum.api.jsonrpc.method.JsonRpcMethodFactory;
+import org.hyperledger.besu.ethereum.api.jsonrpc.methods.JsonRpcMethods;
 import org.hyperledger.besu.ethereum.blockcreation.MiningCoordinator;
 import org.hyperledger.besu.ethereum.chain.Blockchain;
 import org.hyperledger.besu.ethereum.core.Address;
@@ -65,9 +65,9 @@ protected void prepForBuild() {
   }
 
   @Override
-  protected JsonRpcMethodFactory createAdditionalJsonRpcMethodFactory(
+  protected JsonRpcMethods createAdditionalJsonRpcMethodFactory(
       final ProtocolContext<CliqueContext> protocolContext) {
-    return new CliqueJsonRpcMethodsFactory(protocolContext);
+    return new CliqueJsonRpcMethods(protocolContext);
   }
 
   @Override

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

@@ -36,7 +36,7 @@
 import org.hyperledger.besu.consensus.ibft.blockcreation.IbftBlockCreatorFactory;
 import org.hyperledger.besu.consensus.ibft.blockcreation.IbftMiningCoordinator;
 import org.hyperledger.besu.consensus.ibft.blockcreation.ProposerSelector;
-import org.hyperledger.besu.consensus.ibft.jsonrpc.IbftJsonRpcMethodsFactory;
+import org.hyperledger.besu.consensus.ibft.jsonrpc.IbftJsonRpcMethods;
 import org.hyperledger.besu.consensus.ibft.network.ValidatorPeers;
 import org.hyperledger.besu.consensus.ibft.payload.MessageFactory;
 import org.hyperledger.besu.consensus.ibft.protocol.IbftProtocolManager;
@@ -48,7 +48,7 @@
 import org.hyperledger.besu.consensus.ibft.statemachine.IbftRoundFactory;
 import org.hyperledger.besu.consensus.ibft.validation.MessageValidatorFactory;
 import org.hyperledger.besu.ethereum.ProtocolContext;
-import org.hyperledger.besu.ethereum.api.jsonrpc.method.JsonRpcMethodFactory;
+import org.hyperledger.besu.ethereum.api.jsonrpc.methods.JsonRpcMethods;
 import org.hyperledger.besu.ethereum.blockcreation.MiningCoordinator;
 import org.hyperledger.besu.ethereum.chain.Blockchain;
 import org.hyperledger.besu.ethereum.chain.MinedBlockObserver;
@@ -82,9 +82,9 @@ protected void prepForBuild() {
   }
 
   @Override
-  protected JsonRpcMethodFactory createAdditionalJsonRpcMethodFactory(
+  protected JsonRpcMethods createAdditionalJsonRpcMethodFactory(
       final ProtocolContext<IbftContext> protocolContext) {
-    return new IbftJsonRpcMethodsFactory(protocolContext);
+    return new IbftJsonRpcMethods(protocolContext);
   }
 
   @Override

consensus/clique/src/main/java/org/hyperledger/besu/consensus/clique/jsonrpc/CliqueJsonRpcMethodsFactory.java → consensus/clique/src/main/java/org/hyperledger/besu/consensus/clique/jsonrpc/CliqueJsonRpcMethods.java

@@ -30,55 +30,45 @@
 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.internal.parameters.JsonRpcParameter;
-import org.hyperledger.besu.ethereum.api.jsonrpc.method.JsonRpcMethodFactory;
+import org.hyperledger.besu.ethereum.api.jsonrpc.methods.ApiGroupJsonRpcMethods;
 import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
 import org.hyperledger.besu.ethereum.chain.MutableBlockchain;
 import org.hyperledger.besu.ethereum.worldstate.WorldStateArchive;
 
-import java.util.Collection;
-import java.util.HashMap;
 import java.util.Map;
 
-public class CliqueJsonRpcMethodsFactory implements JsonRpcMethodFactory {
+public class CliqueJsonRpcMethods extends ApiGroupJsonRpcMethods {
 
+  private final JsonRpcParameter parameter = new JsonRpcParameter();
   private final ProtocolContext<CliqueContext> context;
 
-  public CliqueJsonRpcMethodsFactory(final ProtocolContext<CliqueContext> context) {
+  public CliqueJsonRpcMethods(final ProtocolContext<CliqueContext> context) {
     this.context = context;
   }
 
   @Override
-  public Map<String, JsonRpcMethod> createJsonRpcMethods(final Collection<RpcApi> jsonRpcApis) {
-    final Map<String, JsonRpcMethod> rpcMethods = new HashMap<>();
-    if (!jsonRpcApis.contains(CliqueRpcApis.CLIQUE)) {
-      return rpcMethods;
-    }
+  protected RpcApi getApiGroup() {
+    return CliqueRpcApis.CLIQUE;
+  }
+
+  @Override
+  protected Map<String, JsonRpcMethod> create() {
     final MutableBlockchain blockchain = context.getBlockchain();
     final WorldStateArchive worldStateArchive = context.getWorldStateArchive();
     final BlockchainQueries blockchainQueries =
         new BlockchainQueries(blockchain, worldStateArchive);
     final VoteProposer voteProposer = context.getConsensusState().getVoteProposer();
-    final JsonRpcParameter jsonRpcParameter = new JsonRpcParameter();
+
     // Must create our own voteTallyCache as using this would pollute the main voteTallyCache
     final VoteTallyCache voteTallyCache = createVoteTallyCache(context, blockchain);
 
-    final CliqueGetSigners cliqueGetSigners =
-        new CliqueGetSigners(blockchainQueries, voteTallyCache, jsonRpcParameter);
-    final CliqueGetSignersAtHash cliqueGetSignersAtHash =
-        new CliqueGetSignersAtHash(blockchainQueries, voteTallyCache, jsonRpcParameter);
-    final Propose proposeRpc = new Propose(voteProposer, jsonRpcParameter);
-    final Discard discardRpc = new Discard(voteProposer, jsonRpcParameter);
-    final CliqueProposals cliqueProposals = new CliqueProposals(voteProposer);
-    final CliqueGetSignerMetrics cliqueGetSignerMetrics =
-        new CliqueGetSignerMetrics(new CliqueBlockInterface(), blockchainQueries, jsonRpcParameter);
-
-    rpcMethods.put(cliqueGetSigners.getName(), cliqueGetSigners);
-    rpcMethods.put(cliqueGetSignersAtHash.getName(), cliqueGetSignersAtHash);
-    rpcMethods.put(proposeRpc.getName(), proposeRpc);
-    rpcMethods.put(discardRpc.getName(), discardRpc);
-    rpcMethods.put(cliqueProposals.getName(), cliqueProposals);
-    rpcMethods.put(cliqueGetSignerMetrics.getName(), cliqueGetSignerMetrics);
-    return rpcMethods;
+    return mapOf(
+        new CliqueGetSigners(blockchainQueries, voteTallyCache, parameter),
+        new CliqueGetSignersAtHash(blockchainQueries, voteTallyCache, parameter),
+        new Propose(voteProposer, parameter),
+        new Discard(voteProposer, parameter),
+        new CliqueProposals(voteProposer),
+        new CliqueGetSignerMetrics(new CliqueBlockInterface(), blockchainQueries, parameter));
   }
 
   private VoteTallyCache createVoteTallyCache(

consensus/ibft/src/main/java/org/hyperledger/besu/consensus/ibft/jsonrpc/IbftJsonRpcMethodsFactory.java → consensus/ibft/src/main/java/org/hyperledger/besu/consensus/ibft/jsonrpc/IbftJsonRpcMethods.java

@@ -28,50 +28,38 @@
 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.internal.parameters.JsonRpcParameter;
-import org.hyperledger.besu.ethereum.api.jsonrpc.method.JsonRpcMethodFactory;
+import org.hyperledger.besu.ethereum.api.jsonrpc.methods.ApiGroupJsonRpcMethods;
 import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
 
-import java.util.Collection;
-import java.util.HashMap;
 import java.util.Map;
 
-public class IbftJsonRpcMethodsFactory implements JsonRpcMethodFactory {
+public class IbftJsonRpcMethods extends ApiGroupJsonRpcMethods {
 
   private final JsonRpcParameter jsonRpcParameter = new JsonRpcParameter();
   private final ProtocolContext<IbftContext> context;
 
-  public IbftJsonRpcMethodsFactory(final ProtocolContext<IbftContext> context) {
+  public IbftJsonRpcMethods(final ProtocolContext<IbftContext> context) {
     this.context = context;
   }
 
   @Override
-  public Map<String, JsonRpcMethod> createJsonRpcMethods(final Collection<RpcApi> jsonRpcApis) {
-    final Map<String, JsonRpcMethod> rpcMethods = new HashMap<>();
-
-    if (jsonRpcApis.contains(IbftRpcApis.IBFT)) {
-      final BlockchainQueries blockchainQueries =
-          new BlockchainQueries(context.getBlockchain(), context.getWorldStateArchive());
-      final VoteProposer voteProposer = context.getConsensusState().getVoteProposer();
-      final BlockInterface blockInterface = new IbftBlockInterface();
-
-      addMethods(
-          rpcMethods,
-          new IbftProposeValidatorVote(voteProposer, jsonRpcParameter),
-          new IbftGetValidatorsByBlockNumber(blockchainQueries, blockInterface, jsonRpcParameter),
-          new IbftDiscardValidatorVote(voteProposer, jsonRpcParameter),
-          new IbftGetValidatorsByBlockHash(
-              context.getBlockchain(), blockInterface, jsonRpcParameter),
-          new IbftGetSignerMetrics(blockInterface, blockchainQueries, jsonRpcParameter),
-          new IbftGetPendingVotes(voteProposer));
-    }
-
-    return rpcMethods;
+  protected RpcApi getApiGroup() {
+    return IbftRpcApis.IBFT;
   }
 
-  private void addMethods(
-      final Map<String, JsonRpcMethod> methods, final JsonRpcMethod... rpcMethods) {
-    for (final JsonRpcMethod rpcMethod : rpcMethods) {
-      methods.put(rpcMethod.getName(), rpcMethod);
-    }
+  @Override
+  protected Map<String, JsonRpcMethod> create() {
+    final BlockchainQueries blockchainQueries =
+        new BlockchainQueries(context.getBlockchain(), context.getWorldStateArchive());
+    final VoteProposer voteProposer = context.getConsensusState().getVoteProposer();
+    final BlockInterface blockInterface = new IbftBlockInterface();
+
+    return mapOf(
+        new IbftProposeValidatorVote(voteProposer, jsonRpcParameter),
+        new IbftGetValidatorsByBlockNumber(blockchainQueries, blockInterface, jsonRpcParameter),
+        new IbftDiscardValidatorVote(voteProposer, jsonRpcParameter),
+        new IbftGetValidatorsByBlockHash(context.getBlockchain(), blockInterface, jsonRpcParameter),
+        new IbftGetSignerMetrics(blockInterface, blockchainQueries, jsonRpcParameter),
+        new IbftGetPendingVotes(voteProposer));
   }
 }

ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/JsonRpcTestMethodsFactory.java

@@ -24,7 +24,7 @@
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.filter.FilterManager;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.filter.FilterRepository;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.JsonRpcMethod;
-import org.hyperledger.besu.ethereum.api.jsonrpc.method.JsonRpcMethodsFactory;
+import org.hyperledger.besu.ethereum.api.jsonrpc.methods.JsonRpcMethodsFactory;
 import org.hyperledger.besu.ethereum.api.jsonrpc.websocket.WebSocketConfiguration;
 import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
 import org.hyperledger.besu.ethereum.blockcreation.EthHashMiningCoordinator;

ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/method/EthCallIntegrationTest.java → ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/methods/EthCallIntegrationTest.java

@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package org.hyperledger.besu.ethereum.api.jsonrpc.method;
+package org.hyperledger.besu.ethereum.api.jsonrpc.methods;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.catchThrowable;

ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/method/EthEstimateGasIntegrationTest.java → ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/methods/EthEstimateGasIntegrationTest.java

@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package org.hyperledger.besu.ethereum.api.jsonrpc.method;
+package org.hyperledger.besu.ethereum.api.jsonrpc.methods;
 
 import static org.assertj.core.api.Assertions.assertThat;
 

ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/method/EthGetBlockByHashIntegrationTest.java → ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/methods/EthGetBlockByHashIntegrationTest.java

@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package org.hyperledger.besu.ethereum.api.jsonrpc.method;
+package org.hyperledger.besu.ethereum.api.jsonrpc.methods;
 
 import static org.assertj.core.api.Assertions.assertThat;
 

ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/method/EthGetBlockByNumberIntegrationTest.java → ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/methods/EthGetBlockByNumberIntegrationTest.java

@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package org.hyperledger.besu.ethereum.api.jsonrpc.method;
+package org.hyperledger.besu.ethereum.api.jsonrpc.methods;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.catchThrowable;

ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/method/EthGetFilterChangesIntegrationTest.java → ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/methods/EthGetFilterChangesIntegrationTest.java

@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package org.hyperledger.besu.ethereum.api.jsonrpc.method;
+package org.hyperledger.besu.ethereum.api.jsonrpc.methods;
 
 import static java.util.Arrays.asList;
 import static java.util.Collections.emptyList;

ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/method/EthGetUncleByBlockHashAndIndexIntegrationTest.java → ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/methods/EthGetUncleByBlockHashAndIndexIntegrationTest.java

@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package org.hyperledger.besu.ethereum.api.jsonrpc.method;
+package org.hyperledger.besu.ethereum.api.jsonrpc.methods;
 
 import static org.assertj.core.api.Assertions.assertThat;
 

ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/method/EthGetUncleByBlockNumberAndIndexIntegrationTest.java → ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/methods/EthGetUncleByBlockNumberAndIndexIntegrationTest.java

@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package org.hyperledger.besu.ethereum.api.jsonrpc.method;
+package org.hyperledger.besu.ethereum.api.jsonrpc.methods;
 
 import static org.assertj.core.api.Assertions.assertThat;
 

ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/method/PrivGetPrivateTransactionIntegrationTest.java → ethereum/api/src/integration-test/java/org/hyperledger/besu/ethereum/api/jsonrpc/methods/PrivGetPrivateTransactionIntegrationTest.java

@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package org.hyperledger.besu.ethereum.api.jsonrpc.method;
+package org.hyperledger.besu.ethereum.api.jsonrpc.methods;
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static org.assertj.core.api.Assertions.assertThat;