Ibft transmitted packets are logged by gossiper

consensus/ibft/src/integration-test/java/tech/pegasys/pantheon/consensus/ibft/support/TestContextBuilder.java

@@ -25,6 +25,7 @@
 import tech.pegasys.pantheon.consensus.common.VoteTallyUpdater;
 import tech.pegasys.pantheon.consensus.ibft.BlockTimer;
 import tech.pegasys.pantheon.consensus.ibft.EventMultiplexer;
+import tech.pegasys.pantheon.consensus.ibft.Gossiper;
 import tech.pegasys.pantheon.consensus.ibft.IbftBlockHashing;
 import tech.pegasys.pantheon.consensus.ibft.IbftBlockInterface;
 import tech.pegasys.pantheon.consensus.ibft.IbftContext;
@@ -34,6 +35,7 @@
 import tech.pegasys.pantheon.consensus.ibft.IbftHelpers;
 import tech.pegasys.pantheon.consensus.ibft.IbftProtocolSchedule;
 import tech.pegasys.pantheon.consensus.ibft.RoundTimer;
+import tech.pegasys.pantheon.consensus.ibft.UniqueMessageMulticaster;
 import tech.pegasys.pantheon.consensus.ibft.blockcreation.IbftBlockCreatorFactory;
 import tech.pegasys.pantheon.consensus.ibft.blockcreation.ProposerSelector;
 import tech.pegasys.pantheon.consensus.ibft.payload.MessageFactory;
@@ -156,7 +158,9 @@ public TestContext build() {
     // Use a stubbed version of the multicaster, to prevent creating PeerConnections etc.
     final StubValidatorMulticaster multicaster = new StubValidatorMulticaster();
 
-    final IbftGossip gossiper = useGossip ? new IbftGossip(multicaster) : mock(IbftGossip.class);
+    final UniqueMessageMulticaster uniqueMulticaster = new UniqueMessageMulticaster(multicaster);
+
+    final Gossiper gossiper = useGossip ? new IbftGossip(uniqueMulticaster) : mock(Gossiper.class);
 
     final ControllerAndState controllerAndState =
         createControllerAndFinalState(
@@ -219,11 +223,11 @@ private static Block createGenesisBlock(final Set<Address> validators) {
 
   private static ControllerAndState createControllerAndFinalState(
       final MutableBlockchain blockChain,
-      final StubValidatorMulticaster stubbedMulticaster,
+      final StubValidatorMulticaster multicaster,
       final KeyPair nodeKeys,
       final Clock clock,
       final IbftEventQueue ibftEventQueue,
-      final IbftGossip gossiper) {
+      final Gossiper gossiper) {
 
     final WorldStateArchive worldStateArchive = createInMemoryWorldStateArchive();
 
@@ -272,7 +276,7 @@ private static ControllerAndState createControllerAndFinalState(
             nodeKeys,
             Util.publicKeyToAddress(nodeKeys.getPublicKey()),
             proposerSelector,
-            stubbedMulticaster,
+            multicaster,
             new RoundTimer(
                 ibftEventQueue, ROUND_TIMER_SEC * 1000, Executors.newScheduledThreadPool(1)),
             new BlockTimer(
@@ -298,8 +302,8 @@ private static ControllerAndState createControllerAndFinalState(
                 new IbftRoundFactory(
                     finalState, protocolContext, protocolSchedule, minedBlockObservers),
                 messageValidatorFactory),
-            new HashMap<>(),
-            gossiper);
+            gossiper,
+            new HashMap<>());
 
     final EventMultiplexer eventMultiplexer = new EventMultiplexer(ibftController);
     //////////////////////////// END IBFT PantheonController ////////////////////////////

consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/Gossiper.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2019 ConsenSys AG.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+package tech.pegasys.pantheon.consensus.ibft;
+
+import tech.pegasys.pantheon.ethereum.p2p.api.Message;
+
+public interface Gossiper {
+
+  void send(Message message);
+}

consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/IbftGossip.java

@@ -20,57 +20,35 @@
 import tech.pegasys.pantheon.consensus.ibft.messagedata.RoundChangeMessageData;
 import tech.pegasys.pantheon.consensus.ibft.network.ValidatorMulticaster;
 import tech.pegasys.pantheon.consensus.ibft.payload.SignedData;
-import tech.pegasys.pantheon.crypto.SECP256K1.Signature;
 import tech.pegasys.pantheon.ethereum.core.Address;
 import tech.pegasys.pantheon.ethereum.p2p.api.Message;
 import tech.pegasys.pantheon.ethereum.p2p.api.MessageData;
 
-import java.util.Collections;
-import java.util.LinkedHashMap;
 import java.util.List;
-import java.util.Map;
-import java.util.Set;
 
 import com.google.common.collect.Lists;
 
 /** Class responsible for rebroadcasting IBFT messages to known validators */
-public class IbftGossip {
-  private final ValidatorMulticaster multicaster;
-
-  // Size of the seenMessages cache, should end up utilising 65bytes * this number + some meta data
-  private final int maxSeenMessages;
-
-  // Set that starts evicting members when it hits capacity
-  private final Set<Signature> seenMessages =
-      Collections.newSetFromMap(
-          new LinkedHashMap<Signature, Boolean>() {
-            @Override
-            protected boolean removeEldestEntry(final Map.Entry<Signature, Boolean> eldest) {
-              return size() > maxSeenMessages;
-            }
-          });
+public class IbftGossip implements Gossiper {
 
-  IbftGossip(final ValidatorMulticaster multicaster, final int maxSeenMessages) {
-    this.maxSeenMessages = maxSeenMessages;
-    this.multicaster = multicaster;
-  }
+  private final ValidatorMulticaster multicaster;
 
   /**
    * Constructor that attaches gossip logic to a set of multicaster
    *
    * @param multicaster Network connections to the remote validators
    */
   public IbftGossip(final ValidatorMulticaster multicaster) {
-    this(multicaster, 10_000);
+    this.multicaster = multicaster;
   }
 
   /**
    * Retransmit a given IBFT message to other known validators nodes
    *
    * @param message The raw message to be gossiped
-   * @return Whether the message was rebroadcast or has been ignored as a repeat
    */
-  public boolean gossipMessage(final Message message) {
+  @Override
+  public void send(final Message message) {
     final MessageData messageData = message.getData();
     final SignedData<?> signedData;
     switch (messageData.getCode()) {
@@ -93,16 +71,9 @@ public boolean gossipMessage(final Message message) {
         throw new IllegalArgumentException(
             "Received message does not conform to any recognised IBFT message structure.");
     }
-    final Signature signature = signedData.getSignature();
-    if (seenMessages.contains(signature)) {
-      return false;
-    } else {
-      final List<Address> excludeAddressesList =
-          Lists.newArrayList(
-              message.getConnection().getPeer().getAddress(), signedData.getSender());
-      multicaster.send(messageData, excludeAddressesList);
-      seenMessages.add(signature);
-      return true;
-    }
+    final List<Address> excludeAddressesList =
+        Lists.newArrayList(message.getConnection().getPeer().getAddress(), signedData.getSender());
+
+    multicaster.send(messageData, excludeAddressesList);
   }
 }

consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/UniqueMessageMulticaster.java

@@ -0,0 +1,68 @@
+/*
+ * Copyright 2019 ConsenSys AG.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+package tech.pegasys.pantheon.consensus.ibft;
+
+import tech.pegasys.pantheon.consensus.ibft.network.ValidatorMulticaster;
+import tech.pegasys.pantheon.ethereum.core.Address;
+import tech.pegasys.pantheon.ethereum.p2p.api.MessageData;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.Set;
+
+public class UniqueMessageMulticaster implements ValidatorMulticaster {
+
+  private final int maxSeenMessages;
+  private final ValidatorMulticaster multicaster;
+
+  UniqueMessageMulticaster(final ValidatorMulticaster multicaster, final int maxSeenMessages) {
+    this.maxSeenMessages = maxSeenMessages;
+    this.multicaster = multicaster;
+  }
+
+  /**
+   * Constructor that attaches gossip logic to a set of multicaster
+   *
+   * @param multicaster Network connections to the remote validators
+   */
+  public UniqueMessageMulticaster(final ValidatorMulticaster multicaster) {
+    this(multicaster, 10_000);
+  }
+
+  // Set that starts evicting members when it hits capacity
+  private final Set<Integer> seenMessages =
+      Collections.newSetFromMap(
+          new LinkedHashMap<Integer, Boolean>() {
+            @Override
+            protected boolean removeEldestEntry(final Map.Entry<Integer, Boolean> eldest) {
+              return size() > maxSeenMessages;
+            }
+          });
+
+  @Override
+  public void send(final MessageData message) {
+    send(message, Collections.emptyList());
+  }
+
+  @Override
+  public void send(final MessageData message, final Collection<Address> blackList) {
+    final int uniqueID = message.hashCode();
+    if (seenMessages.contains(uniqueID)) {
+      return;
+    }
+    multicaster.send(message, blackList);
+    seenMessages.add(uniqueID);
+  }
+}

consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/statemachine/IbftController.java

@@ -15,6 +15,7 @@
 import static java.util.Collections.emptyList;
 
 import tech.pegasys.pantheon.consensus.ibft.ConsensusRoundIdentifier;
+import tech.pegasys.pantheon.consensus.ibft.Gossiper;
 import tech.pegasys.pantheon.consensus.ibft.IbftGossip;
 import tech.pegasys.pantheon.consensus.ibft.ibftevent.BlockTimerExpiry;
 import tech.pegasys.pantheon.consensus.ibft.ibftevent.IbftReceivedMessageEvent;
@@ -51,27 +52,23 @@ public class IbftController {
   private final IbftBlockHeightManagerFactory ibftBlockHeightManagerFactory;
   private final Map<Long, List<Message>> futureMessages;
   private BlockHeightManager currentHeightManager;
-  private final IbftGossip gossiper;
+  private final Gossiper gossiper;
 
   public IbftController(
       final Blockchain blockchain,
       final IbftFinalState ibftFinalState,
-      final IbftBlockHeightManagerFactory ibftBlockHeightManagerFactory) {
-    this(
-        blockchain,
-        ibftFinalState,
-        ibftBlockHeightManagerFactory,
-        Maps.newHashMap(),
-        new IbftGossip(ibftFinalState.getValidatorMulticaster()));
+      final IbftBlockHeightManagerFactory ibftBlockHeightManagerFactory,
+      final IbftGossip gossiper) {
+    this(blockchain, ibftFinalState, ibftBlockHeightManagerFactory, gossiper, Maps.newHashMap());
   }
 
   @VisibleForTesting
   public IbftController(
       final Blockchain blockchain,
       final IbftFinalState ibftFinalState,
       final IbftBlockHeightManagerFactory ibftBlockHeightManagerFactory,
-      final Map<Long, List<Message>> futureMessages,
-      final IbftGossip gossiper) {
+      final Gossiper gossiper,
+      final Map<Long, List<Message>> futureMessages) {
     this.blockchain = blockchain;
     this.ibftFinalState = ibftFinalState;
     this.ibftBlockHeightManagerFactory = ibftBlockHeightManagerFactory;
@@ -142,7 +139,7 @@ private <P extends Payload> void consumeMessage(
         signedPayload.getPayload().getMessageType(),
         signedPayload);
     if (processMessage(signedPayload, message)) {
-      gossiper.gossipMessage(message);
+      gossiper.send(message);
       handleMessage.accept(signedPayload);
     }
   }