PIE-2016: Added PoaQueryService method that returns local node signer… (

#163)

* PIE-2016: Added PoaQueryService method that returns local node signer address.

Signed-off-by: Mark Terry <mark.terry@consensys.net>

* [PIE-2016] PR fixes.

Signed-off-by: Mark Terry <mark.terry@consensys.net>

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

@@ -125,7 +125,7 @@ protected void validateContext(final ProtocolContext<CliqueContext> context) {
 
   @Override
   protected PluginServiceFactory createAdditionalPluginServices(final Blockchain blockchain) {
-    return new CliqueQueryPluginServiceFactory(blockchain);
+    return new CliqueQueryPluginServiceFactory(blockchain, nodeKeys);
   }
 
   @Override

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

@@ -17,24 +17,28 @@
 import org.hyperledger.besu.consensus.clique.CliqueBlockInterface;
 import org.hyperledger.besu.consensus.common.BlockInterface;
 import org.hyperledger.besu.consensus.common.PoaQueryServiceImpl;
+import org.hyperledger.besu.crypto.SECP256K1.KeyPair;
 import org.hyperledger.besu.ethereum.chain.Blockchain;
 import org.hyperledger.besu.plugin.services.metrics.PoAMetricsService;
 import org.hyperledger.besu.plugin.services.query.PoaQueryService;
 import org.hyperledger.besu.services.BesuPluginContextImpl;
 
 public class CliqueQueryPluginServiceFactory implements PluginServiceFactory {
 
-  final Blockchain blockchain;
+  private final Blockchain blockchain;
+  private final KeyPair localNodeKeypair;
 
-  public CliqueQueryPluginServiceFactory(final Blockchain blockchain) {
+  public CliqueQueryPluginServiceFactory(
+      final Blockchain blockchain, final KeyPair localNodeKeypair) {
     this.blockchain = blockchain;
+    this.localNodeKeypair = localNodeKeypair;
   }
 
   @Override
   public void appendPluginServices(final BesuPluginContextImpl besuContext) {
     final BlockInterface blockInterface = new CliqueBlockInterface();
-
-    final PoaQueryServiceImpl service = new PoaQueryServiceImpl(blockInterface, blockchain);
+    final PoaQueryServiceImpl service =
+        new PoaQueryServiceImpl(blockInterface, blockchain, localNodeKeypair);
     besuContext.addService(PoaQueryService.class, service);
     besuContext.addService(PoAMetricsService.class, service);
   }

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

@@ -192,7 +192,7 @@ protected MiningCoordinator createMiningCoordinator(
 
   @Override
   protected PluginServiceFactory createAdditionalPluginServices(final Blockchain blockchain) {
-    return new IbftQueryPluginServiceFactory(blockchain);
+    return new IbftQueryPluginServiceFactory(blockchain, nodeKeys);
   }
 
   @Override

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

@@ -17,6 +17,7 @@
 import org.hyperledger.besu.consensus.common.BlockInterface;
 import org.hyperledger.besu.consensus.ibft.IbftBlockInterface;
 import org.hyperledger.besu.consensus.ibft.queries.IbftQueryServiceImpl;
+import org.hyperledger.besu.crypto.SECP256K1.KeyPair;
 import org.hyperledger.besu.ethereum.chain.Blockchain;
 import org.hyperledger.besu.plugin.services.metrics.PoAMetricsService;
 import org.hyperledger.besu.plugin.services.query.IbftQueryService;
@@ -25,17 +26,21 @@
 
 public class IbftQueryPluginServiceFactory implements PluginServiceFactory {
 
-  final Blockchain blockchain;
+  private final Blockchain blockchain;
+  private final KeyPair localNodeKeypair;
 
-  public IbftQueryPluginServiceFactory(final Blockchain blockchain) {
+  public IbftQueryPluginServiceFactory(
+      final Blockchain blockchain, final KeyPair localNodeKeypair) {
     this.blockchain = blockchain;
+    this.localNodeKeypair = localNodeKeypair;
   }
 
   @Override
   public void appendPluginServices(final BesuPluginContextImpl besuContext) {
     final BlockInterface blockInterface = new IbftBlockInterface();
 
-    final IbftQueryServiceImpl service = new IbftQueryServiceImpl(blockInterface, blockchain);
+    final IbftQueryServiceImpl service =
+        new IbftQueryServiceImpl(blockInterface, blockchain, localNodeKeypair);
     besuContext.addService(IbftQueryService.class, service);
     besuContext.addService(PoaQueryService.class, service);
     besuContext.addService(PoAMetricsService.class, service);

consensus/common/build.gradle

@@ -32,6 +32,7 @@ dependencies {
 
   implementation project(':ethereum:core')
   implementation project(':ethereum:api')
+  implementation project(':crypto')
   implementation project(':util')
 
   implementation 'com.fasterxml.jackson.core:jackson-databind'

consensus/common/src/main/java/org/hyperledger/besu/consensus/common/PoaQueryServiceImpl.java

@@ -14,6 +14,7 @@
  */
 package org.hyperledger.besu.consensus.common;
 
+import org.hyperledger.besu.crypto.SECP256K1.KeyPair;
 import org.hyperledger.besu.ethereum.chain.Blockchain;
 import org.hyperledger.besu.plugin.data.Address;
 import org.hyperledger.besu.plugin.data.BlockHeader;
@@ -27,10 +28,15 @@ public class PoaQueryServiceImpl implements PoaQueryService, PoAMetricsService {
 
   private final BlockInterface blockInterface;
   private final Blockchain blockchain;
+  private final KeyPair localNodeKeypair;
 
-  public PoaQueryServiceImpl(final BlockInterface blockInterface, final Blockchain blockchain) {
+  public PoaQueryServiceImpl(
+      final BlockInterface blockInterface,
+      final Blockchain blockchain,
+      final KeyPair localNodeKeypair) {
     this.blockInterface = blockInterface;
     this.blockchain = blockchain;
+    this.localNodeKeypair = localNodeKeypair;
   }
 
   @Override
@@ -46,4 +52,9 @@ public Address getProposerOfBlock(final BlockHeader header) {
   protected Blockchain getBlockchain() {
     return blockchain;
   }
+
+  @Override
+  public Address getLocalSignerAddress() {
+    return org.hyperledger.besu.ethereum.core.Address.extract(localNodeKeypair.getPublicKey());
+  }
 }

consensus/ibft/src/main/java/org/hyperledger/besu/consensus/ibft/queries/IbftQueryServiceImpl.java

@@ -18,6 +18,7 @@
 import org.hyperledger.besu.consensus.common.PoaQueryServiceImpl;
 import org.hyperledger.besu.consensus.ibft.IbftBlockHashing;
 import org.hyperledger.besu.consensus.ibft.IbftExtraData;
+import org.hyperledger.besu.crypto.SECP256K1.KeyPair;
 import org.hyperledger.besu.ethereum.chain.Blockchain;
 import org.hyperledger.besu.ethereum.core.BlockHeader;
 import org.hyperledger.besu.ethereum.core.Hash;
@@ -30,8 +31,9 @@
 
 public class IbftQueryServiceImpl extends PoaQueryServiceImpl implements IbftQueryService {
 
-  public IbftQueryServiceImpl(final BlockInterface blockInterface, final Blockchain blockchain) {
-    super(blockInterface, blockchain);
+  public IbftQueryServiceImpl(
+      final BlockInterface blockInterface, final Blockchain blockchain, final KeyPair keyPair) {
+    super(blockInterface, blockchain, keyPair);
   }
 
   @Override

consensus/ibft/src/test/java/org/hyperledger/besu/consensus/ibft/queries/IbftQueryServiceImplTest.java

@@ -16,7 +16,6 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
-import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 
 import org.hyperledger.besu.consensus.ibft.IbftBlockHashing;
@@ -44,10 +43,15 @@
 import com.google.common.collect.Lists;
 import org.junit.Before;
 import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.junit.MockitoJUnitRunner;
 
+@RunWith(MockitoJUnitRunner.class)
 public class IbftQueryServiceImplTest {
 
-  private Blockchain blockchain = mock(Blockchain.class);
+  @Mock private Blockchain blockchain;
+  @Mock private KeyPair keyPair;
 
   private final List<KeyPair> validatorKeys =
       Lists.newArrayList(KeyPair.generate(), KeyPair.generate());
@@ -104,7 +108,8 @@ public void setup() {
 
   @Test
   public void roundNumberFromBlockIsReturned() {
-    final IbftQueryService service = new IbftQueryServiceImpl(new IbftBlockInterface(), blockchain);
+    final IbftQueryService service =
+        new IbftQueryServiceImpl(new IbftBlockInterface(), blockchain, keyPair);
 
     assertThat(service.getRoundNumberFrom(blockHeader)).isEqualTo(ROUND_NUMBER_IN_BLOCK);
   }
@@ -115,14 +120,16 @@ public void getRoundNumberThrowsIfBlockIsNotOnTheChain() {
         new NonBesuBlockHeader(blockHeader.getHash(), blockHeader.getExtraData());
     when(blockchain.getBlockHeader(blockHeader.getHash())).thenReturn(Optional.empty());
 
-    final IbftQueryService service = new IbftQueryServiceImpl(new IbftBlockInterface(), blockchain);
+    final IbftQueryService service =
+        new IbftQueryServiceImpl(new IbftBlockInterface(), blockchain, keyPair);
     assertThatExceptionOfType(RuntimeException.class)
         .isThrownBy(() -> service.getRoundNumberFrom(header));
   }
 
   @Test
   public void getSignersReturnsAddressesOfSignersInBlock() {
-    final IbftQueryService service = new IbftQueryServiceImpl(new IbftBlockInterface(), blockchain);
+    final IbftQueryService service =
+        new IbftQueryServiceImpl(new IbftBlockInterface(), blockchain, keyPair);
 
     final List<Address> signers =
         signingKeys.stream()
@@ -133,12 +140,13 @@ public void getSignersReturnsAddressesOfSignersInBlock() {
   }
 
   @Test
-  public void getSignersTheowsIfBlockIsNotOnTheChain() {
+  public void getSignersThrowsIfBlockIsNotOnTheChain() {
     final NonBesuBlockHeader header =
         new NonBesuBlockHeader(blockHeader.getHash(), blockHeader.getExtraData());
     when(blockchain.getBlockHeader(blockHeader.getHash())).thenReturn(Optional.empty());
 
-    final IbftQueryService service = new IbftQueryServiceImpl(new IbftBlockInterface(), blockchain);
+    final IbftQueryService service =
+        new IbftQueryServiceImpl(new IbftBlockInterface(), blockchain, keyPair);
     assertThatExceptionOfType(RuntimeException.class)
         .isThrownBy(() -> service.getSignersFrom(header));
   }

plugin-api/build.gradle

@@ -56,7 +56,7 @@ Calculated : ${currentHash}
 tasks.register('checkAPIChanges', FileStateChecker) {
   description = "Checks that the API for the Plugin-API project does not change without deliberate thought"
   files = sourceSets.main.allJava.files
-  knownHash = 'EzyP5PAUCOxCe4TLjOD8igvg7LejQp/727hnvjBMlwY='
+  knownHash = 'Uz20ItZSHoOEJdONKKwUtoyZxkCVF+bbw20IMmZfSZg='
 }
 check.dependsOn('checkAPIChanges')
 

plugin-api/src/main/java/org/hyperledger/besu/plugin/services/query/PoaQueryService.java

@@ -36,4 +36,12 @@ public interface PoaQueryService {
    * @return The identity of the proposer for the given block.
    */
   Address getProposerOfBlock(final BlockHeader header);
+
+  /**
+   * Retrieves the signer {@link Address} of the local node. This is the address added to the {@link
+   * BlockHeader} to identify that a specific node was a validator during block creation.
+   *
+   * @return The signer {@link Address} of the local node.
+   */
+  Address getLocalSignerAddress();
 }