Qbft RPCs should be disabled after starting with or switching to use …

…validator contract (hyperledger#2817) Signed-off-by: Simon Dudley <simon.dudley@consensys.net>
lacchain · Nov 3, 2023 · 5514ed5 · 5514ed5
1 parent eb70713
commit 5514ed5
Show file tree

Hide file tree

Showing 8 changed files with 59 additions and 53 deletions.
diff --git a/...st/java/org/hyperledger/besu/consensus/common/jsonrpc/AbstractVoteProposerMethodTest.java b/...st/java/org/hyperledger/besu/consensus/common/jsonrpc/AbstractVoteProposerMethodTest.java
@@ -24,12 +24,15 @@
 import org.hyperledger.besu.datatypes.Address;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequest;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequestContext;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcError;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcErrorResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcSuccessResponse;
 
 import java.util.Optional;
 
 import com.google.common.collect.ImmutableMap;
+import org.assertj.core.api.Assertions;
 import org.junit.Test;
 
 public abstract class AbstractVoteProposerMethodTest {
@@ -74,4 +77,18 @@ public void testConversionFromVoteTypeToBoolean() {
 
     assertThat(response).isEqualToComparingFieldByField(expectedResponse);
   }
+
+  @Test
+  public void methodNotEnabledWhenNoVoteProvider() {
+    final JsonRpcRequestContext request =
+        new JsonRpcRequestContext(
+            new JsonRpcRequest(JSON_RPC_VERSION, getMethodName(), new Object[] {}));
+    final JsonRpcResponse expectedResponse =
+        new JsonRpcErrorResponse(request.getRequest().getId(), JsonRpcError.METHOD_NOT_ENABLED);
+    when(validatorProvider.getVoteProvider()).thenReturn(Optional.empty());
+
+    final JsonRpcResponse response = getMethod().response(request);
+
+    Assertions.assertThat(response).usingRecursiveComparison().isEqualTo(expectedResponse);
+  }
 }
diff --git a/...in/java/org/hyperledger/besu/consensus/qbft/jsonrpc/methods/QbftDiscardValidatorVote.java b/...in/java/org/hyperledger/besu/consensus/qbft/jsonrpc/methods/QbftDiscardValidatorVote.java
@@ -50,7 +50,7 @@ public JsonRpcResponse response(final JsonRpcRequestContext requestContext) {
       return new JsonRpcSuccessResponse(requestContext.getRequest().getId(), true);
     } else {
       return new JsonRpcErrorResponse(
-          requestContext.getRequest().getId(), JsonRpcError.METHOD_UNIMPLEMENTED);
+          requestContext.getRequest().getId(), JsonRpcError.METHOD_NOT_ENABLED);
     }
   }
 }
diff --git a/...in/java/org/hyperledger/besu/consensus/qbft/jsonrpc/methods/QbftProposeValidatorVote.java b/...in/java/org/hyperledger/besu/consensus/qbft/jsonrpc/methods/QbftProposeValidatorVote.java
@@ -60,7 +60,7 @@ public JsonRpcResponse response(final JsonRpcRequestContext requestContext) {
       return new JsonRpcSuccessResponse(requestContext.getRequest().getId(), true);
     } else {
       return new JsonRpcErrorResponse(
-          requestContext.getRequest().getId(), JsonRpcError.METHOD_UNIMPLEMENTED);
+          requestContext.getRequest().getId(), JsonRpcError.METHOD_NOT_ENABLED);
     }
   }
 }
diff --git a/.../main/java/org/hyperledger/besu/consensus/qbft/validator/NoOpTransactionVoteProvider.java b/.../main/java/org/hyperledger/besu/consensus/qbft/validator/NoOpTransactionVoteProvider.java
diff --git a/...main/java/org/hyperledger/besu/consensus/qbft/validator/TransactionValidatorProvider.java b/...main/java/org/hyperledger/besu/consensus/qbft/validator/TransactionValidatorProvider.java
@@ -69,6 +69,6 @@ public Collection<Address> getValidatorsForBlock(final BlockHeader header) {
 
   @Override
   public Optional<VoteProvider> getVoteProvider() {
-    return Optional.of(new NoOpTransactionVoteProvider());
+    return Optional.empty();
   }
 }
diff --git a/...ava/org/hyperledger/besu/consensus/qbft/jsonrpc/methods/QbftDiscardValidatorVoteTest.java b/...ava/org/hyperledger/besu/consensus/qbft/jsonrpc/methods/QbftDiscardValidatorVoteTest.java
@@ -25,6 +25,8 @@
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequest;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequestContext;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.exception.InvalidJsonRpcParameters;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcError;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcErrorResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcSuccessResponse;
 
@@ -75,6 +77,18 @@ public void exceptionWhenInvalidAddressParameterSupplied() {
     method.response(request);
   }
 
+  @Test
+  public void methodNotEnabledWhenNoVoteProvider() {
+    final JsonRpcRequestContext request = requestWithParams(Address.fromHexString("1"));
+    final JsonRpcResponse expectedResponse =
+        new JsonRpcErrorResponse(request.getRequest().getId(), JsonRpcError.METHOD_NOT_ENABLED);
+    when(validatorProvider.getVoteProvider()).thenReturn(Optional.empty());
+
+    final JsonRpcResponse response = method.response(request);
+
+    assertThat(response).usingRecursiveComparison().isEqualTo(expectedResponse);
+  }
+
   @Test
   public void discardValidator() {
     final Address parameterAddress = Address.fromHexString("1");
@@ -85,7 +99,7 @@ public void discardValidator() {
 
     final JsonRpcResponse response = method.response(request);
 
-    assertThat(response).isEqualToComparingFieldByField(expectedResponse);
+    assertThat(response).usingRecursiveComparison().isEqualTo(expectedResponse);
 
     verify(voteProvider).discardVote(parameterAddress);
   }

diff --git a/...ava/org/hyperledger/besu/consensus/qbft/jsonrpc/methods/QbftProposeValidatorVoteTest.java b/...ava/org/hyperledger/besu/consensus/qbft/jsonrpc/methods/QbftProposeValidatorVoteTest.java
@@ -25,6 +25,8 @@
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequest;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequestContext;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.exception.InvalidJsonRpcParameters;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcError;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcErrorResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcSuccessResponse;
 
@@ -95,6 +97,18 @@ public void exceptionWhenInvalidBoolParameterSupplied() {
     method.response(request);
   }
 
+  @Test
+  public void methodNotEnabledWhenNoVoteProvider() {
+    final JsonRpcRequestContext request = requestWithParams(Address.fromHexString("1"));
+    final JsonRpcResponse expectedResponse =
+        new JsonRpcErrorResponse(request.getRequest().getId(), JsonRpcError.METHOD_NOT_ENABLED);
+    when(validatorProvider.getVoteProvider()).thenReturn(Optional.empty());
+
+    final JsonRpcResponse response = method.response(request);
+
+    assertThat(response).usingRecursiveComparison().isEqualTo(expectedResponse);
+  }
+
   @Test
   public void addValidator() {
     final Address parameterAddress = Address.fromHexString("1");
@@ -104,7 +118,7 @@ public void addValidator() {
 
     final JsonRpcResponse response = method.response(request);
 
-    assertThat(response).isEqualToComparingFieldByField(expectedResponse);
+    assertThat(response).usingRecursiveComparison().isEqualTo(expectedResponse);
 
     verify(voteProvider).authVote(parameterAddress);
   }
@@ -118,7 +132,7 @@ public void removeValidator() {
 
     final JsonRpcResponse response = method.response(request);
 
-    assertThat(response).isEqualToComparingFieldByField(expectedResponse);
+    assertThat(response).usingRecursiveComparison().isEqualTo(expectedResponse);
 
     verify(voteProvider).dropVote(parameterAddress);
   }

diff --git a/.../java/org/hyperledger/besu/consensus/qbft/validator/TransactionValidatorProviderTest.java b/.../java/org/hyperledger/besu/consensus/qbft/validator/TransactionValidatorProviderTest.java
@@ -172,4 +172,12 @@ public void validatorsMustBeSorted() {
         validators.stream().sorted().collect(Collectors.toList());
     assertThat(result).containsExactlyElementsOf(expectedValidators);
   }
+
+  @Test
+  public void voteProviderIsEmpty() {
+    TransactionValidatorProvider transactionValidatorProvider =
+        new TransactionValidatorProvider(blockChain, validatorContractController);
+
+    assertThat(transactionValidatorProvider.getVoteProvider()).isEmpty();
+  }
 }