Ibft Consensus Round Classes (#405)

The IbftRound is responsible for sequencing the transmission of
network packets based on received data.

consensus/ibft/build.gradle

@@ -41,6 +41,7 @@ dependencies {
   implementation 'com.google.guava:guava'
 
   testImplementation project(path: ':ethereum:core', configuration: 'testSupportArtifacts')
+  testImplementation project(path: ':config:', configuration:'testSupportArtifacts')
 
   testImplementation 'junit:junit'
   testImplementation 'org.awaitility:awaitility'

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

@@ -22,6 +22,7 @@
 import tech.pegasys.pantheon.ethereum.rlp.RLPInput;
 import tech.pegasys.pantheon.util.bytes.BytesValue;
 
+import java.util.Collection;
 import java.util.List;
 import java.util.Optional;
 
@@ -34,14 +35,14 @@ public class IbftExtraData {
   public static final int EXTRA_VANITY_LENGTH = 32;
 
   private final BytesValue vanityData;
-  private final List<Signature> seals;
+  private final Collection<Signature> seals;
   private final Optional<Vote> vote;
   private final int round;
   private final List<Address> validators;
 
   public IbftExtraData(
       final BytesValue vanityData,
-      final List<Signature> seals,
+      final Collection<Signature> seals,
       final Optional<Vote> vote,
       final int round,
       final List<Address> validators) {
@@ -127,7 +128,7 @@ public BytesValue getVanityData() {
     return vanityData;
   }
 
-  public List<Signature> getSeals() {
+  public Collection<Signature> getSeals() {
     return seals;
   }
 

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

@@ -12,9 +12,15 @@
  */
 package tech.pegasys.pantheon.consensus.ibft;
 
+import tech.pegasys.pantheon.crypto.SECP256K1.Signature;
+import tech.pegasys.pantheon.ethereum.core.Block;
+import tech.pegasys.pantheon.ethereum.core.BlockHeader;
+import tech.pegasys.pantheon.ethereum.core.BlockHeaderBuilder;
 import tech.pegasys.pantheon.ethereum.core.Hash;
 import tech.pegasys.pantheon.ethereum.core.Util;
 
+import java.util.Collection;
+
 public class IbftHelpers {
 
   public static final Hash EXPECTED_MIX_HASH =
@@ -23,4 +29,26 @@ public class IbftHelpers {
   public static int calculateRequiredValidatorQuorum(final int validatorCount) {
     return Util.fastDivCeiling(2 * validatorCount, 3);
   }
+
+  public static Block createSealedBlock(
+      final Block block, final Collection<Signature> commitSeals) {
+    final BlockHeader initialHeader = block.getHeader();
+    final IbftExtraData initialExtraData = IbftExtraData.decode(initialHeader.getExtraData());
+
+    final IbftExtraData sealedExtraData =
+        new IbftExtraData(
+            initialExtraData.getVanityData(),
+            commitSeals,
+            initialExtraData.getVote(),
+            initialExtraData.getRound(),
+            initialExtraData.getValidators());
+
+    final BlockHeader sealedHeader =
+        BlockHeaderBuilder.fromHeader(initialHeader)
+            .extraData(sealedExtraData.encode())
+            .blockHashFunction(IbftBlockHashing::calculateHashOfIbftBlockOnChain)
+            .buildBlockHeader();
+
+    return new Block(sealedHeader, block.getBody());
+  }
 }

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

@@ -41,6 +41,7 @@ public class IbftFinalState {
   private final IbftBlockCreatorFactory blockCreatorFactory;
   private final MessageFactory messageFactory;
   private final BlockHeaderValidator<IbftContext> ibftContextBlockHeaderValidator;
+  private final IbftMessageTransmitter messageTransmitter;
 
   public IbftFinalState(
       final ValidatorProvider validatorProvider,
@@ -63,6 +64,7 @@ public IbftFinalState(
     this.blockCreatorFactory = blockCreatorFactory;
     this.messageFactory = messageFactory;
     this.ibftContextBlockHeaderValidator = ibftContextBlockHeaderValidator;
+    this.messageTransmitter = new IbftMessageTransmitter(messageFactory, peers);
   }
 
   public int getQuorumSize() {
@@ -116,4 +118,8 @@ public Address getProposerForRound(final ConsensusRoundIdentifier roundIdentifie
   public BlockHeaderValidator<IbftContext> getBlockHeaderValidator() {
     return ibftContextBlockHeaderValidator;
   }
+
+  public IbftMessageTransmitter getTransmitter() {
+    return messageTransmitter;
+  }
 }

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

@@ -0,0 +1,103 @@
+/*
+ * Copyright 2018 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.statemachine;
+
+import tech.pegasys.pantheon.consensus.ibft.ConsensusRoundIdentifier;
+import tech.pegasys.pantheon.consensus.ibft.ibftmessage.CommitMessage;
+import tech.pegasys.pantheon.consensus.ibft.ibftmessage.NewRoundMessage;
+import tech.pegasys.pantheon.consensus.ibft.ibftmessage.PrepareMessage;
+import tech.pegasys.pantheon.consensus.ibft.ibftmessage.ProposalMessage;
+import tech.pegasys.pantheon.consensus.ibft.ibftmessage.RoundChangeMessage;
+import tech.pegasys.pantheon.consensus.ibft.ibftmessagedata.CommitPayload;
+import tech.pegasys.pantheon.consensus.ibft.ibftmessagedata.MessageFactory;
+import tech.pegasys.pantheon.consensus.ibft.ibftmessagedata.NewRoundPayload;
+import tech.pegasys.pantheon.consensus.ibft.ibftmessagedata.PreparePayload;
+import tech.pegasys.pantheon.consensus.ibft.ibftmessagedata.PreparedCertificate;
+import tech.pegasys.pantheon.consensus.ibft.ibftmessagedata.ProposalPayload;
+import tech.pegasys.pantheon.consensus.ibft.ibftmessagedata.RoundChangeCertificate;
+import tech.pegasys.pantheon.consensus.ibft.ibftmessagedata.RoundChangePayload;
+import tech.pegasys.pantheon.consensus.ibft.ibftmessagedata.SignedData;
+import tech.pegasys.pantheon.consensus.ibft.network.IbftNetworkPeers;
+import tech.pegasys.pantheon.crypto.SECP256K1.Signature;
+import tech.pegasys.pantheon.ethereum.core.Block;
+import tech.pegasys.pantheon.ethereum.core.Hash;
+
+import java.util.Optional;
+
+public class IbftMessageTransmitter {
+
+  private final MessageFactory messageFactory;
+  private final IbftNetworkPeers networkPeers;
+
+  public IbftMessageTransmitter(
+      final MessageFactory messageFactory, final IbftNetworkPeers networkPeers) {
+    this.messageFactory = messageFactory;
+    this.networkPeers = networkPeers;
+  }
+
+  public void multicastProposal(final ConsensusRoundIdentifier roundIdentifier, final Block block) {
+    final SignedData<ProposalPayload> signedPayload =
+        messageFactory.createSignedProposalPayload(roundIdentifier, block);
+
+    final ProposalMessage message = ProposalMessage.create(signedPayload);
+
+    networkPeers.multicastToValidators(message);
+  }
+
+  public void multicastPrepare(final ConsensusRoundIdentifier roundIdentifier, final Hash digest) {
+    final SignedData<PreparePayload> signedPayload =
+        messageFactory.createSignedPreparePayload(roundIdentifier, digest);
+
+    final PrepareMessage message = PrepareMessage.create(signedPayload);
+
+    networkPeers.multicastToValidators(message);
+  }
+
+  public void multicastCommit(
+      final ConsensusRoundIdentifier roundIdentifier,
+      final Hash digest,
+      final Signature commitSeal) {
+    final SignedData<CommitPayload> signedPayload =
+        messageFactory.createSignedCommitPayload(roundIdentifier, digest, commitSeal);
+
+    final CommitMessage message = CommitMessage.create(signedPayload);
+
+    networkPeers.multicastToValidators(message);
+  }
+
+  public void multicastRoundChange(
+      final ConsensusRoundIdentifier roundIdentifier,
+      final Optional<PreparedCertificate> preparedCertificate) {
+
+    final SignedData<RoundChangePayload> signedPayload =
+        messageFactory.createSignedRoundChangePayload(roundIdentifier, preparedCertificate);
+
+    final RoundChangeMessage message = RoundChangeMessage.create(signedPayload);
+
+    networkPeers.multicastToValidators(message);
+  }
+
+  public void multicastNewRound(
+      final ConsensusRoundIdentifier roundIdentifier,
+      final RoundChangeCertificate roundChangeCertificate,
+      final SignedData<ProposalPayload> proposalPayload) {
+
+    final SignedData<NewRoundPayload> signedPayload =
+        messageFactory.createSignedNewRoundPayload(
+            roundIdentifier, roundChangeCertificate, proposalPayload);
+
+    final NewRoundMessage message = NewRoundMessage.create(signedPayload);
+
+    networkPeers.multicastToValidators(message);
+  }
+}