[ETCM-355] Introduce ProtocolFamily

This also fixes a bug in NewBlock message creation, where only
protocol version was taken into account

Author: lukasz-golebiewski

src/main/scala/io/iohk/ethereum/blockchain/sync/regular/BlockBroadcast.scala

@@ -17,7 +17,7 @@ import io.iohk.ethereum.network.p2p.messages.BaseETH6XMessages
 import io.iohk.ethereum.network.p2p.messages.ETC64
 import io.iohk.ethereum.network.p2p.messages.ETH62
 import io.iohk.ethereum.network.p2p.messages.ETH62.BlockHash
-import io.iohk.ethereum.network.p2p.messages.ProtocolVersions
+import io.iohk.ethereum.network.p2p.messages.ProtocolFamily._
 
 class BlockBroadcast(val etcPeerManager: ActorRef) {
 
@@ -45,10 +45,12 @@ class BlockBroadcast(val etcPeerManager: ActorRef) {
 
   private def broadcastNewBlock(blockToBroadcast: BlockToBroadcast, peers: Map[PeerId, PeerWithInfo]): Unit =
     obtainRandomPeerSubset(peers.values.map(_.peer).toSet).foreach { peer =>
-      val message: MessageSerializable =
-        if (peers(peer.id).peerInfo.remoteStatus.protocolVersion.toByte == ProtocolVersions.ETC64.version)
-          blockToBroadcast.as64
-        else blockToBroadcast.as63
+      val remoteStatus = peers(peer.id).peerInfo.remoteStatus
+
+      val message: MessageSerializable = remoteStatus.protocolFamily match {
+        case ETH => blockToBroadcast.as63
+        case ETC => blockToBroadcast.as64
+      }
       etcPeerManager ! EtcPeerManagerActor.SendMessage(message, peer.id)
     }
 

src/main/scala/io/iohk/ethereum/network/EtcPeerManagerActor.scala

@@ -27,6 +27,9 @@ import io.iohk.ethereum.network.p2p.messages.ETH62.BlockHeaders
 import io.iohk.ethereum.network.p2p.messages.ETH62.GetBlockHeaders
 import io.iohk.ethereum.network.p2p.messages.ETH62.NewBlockHashes
 import io.iohk.ethereum.network.p2p.messages.ETH64
+import io.iohk.ethereum.network.p2p.messages.ProtocolFamily
+import io.iohk.ethereum.network.p2p.messages.ProtocolFamily.ETC
+import io.iohk.ethereum.network.p2p.messages.ProtocolFamily.ETH
 import io.iohk.ethereum.network.p2p.messages.WireProtocol.Disconnect
 import io.iohk.ethereum.utils.ByteStringUtils
 
@@ -240,6 +243,7 @@ object EtcPeerManagerActor {
     * (they are different versions of Status msg)
     */
   case class RemoteStatus(
+      protocolFamily: ProtocolFamily,
       protocolVersion: Int,
       networkId: Int,
       chainWeight: ChainWeight,
@@ -248,6 +252,7 @@ object EtcPeerManagerActor {
   ) {
     override def toString: String =
       s"RemoteStatus { " +
+        s"protocolFamily: $protocolFamily, " +
         s"protocolVersion: $protocolVersion, " +
         s"networkId: $networkId, " +
         s"chainWeight: $chainWeight, " +
@@ -259,6 +264,7 @@ object EtcPeerManagerActor {
   object RemoteStatus {
     def apply(status: ETH64.Status): RemoteStatus =
       RemoteStatus(
+        ETH,
         status.protocolVersion,
         status.networkId,
         ChainWeight.totalDifficultyOnly(status.totalDifficulty),
@@ -267,10 +273,18 @@ object EtcPeerManagerActor {
       )
 
     def apply(status: ETC64.Status): RemoteStatus =
-      RemoteStatus(status.protocolVersion, status.networkId, status.chainWeight, status.bestHash, status.genesisHash)
+      RemoteStatus(
+        ETC,
+        status.protocolVersion,
+        status.networkId,
+        status.chainWeight,
+        status.bestHash,
+        status.genesisHash
+      )
 
     def apply(status: BaseETH6XMessages.Status): RemoteStatus =
       RemoteStatus(
+        ETH,
         status.protocolVersion,
         status.networkId,
         ChainWeight.totalDifficultyOnly(status.totalDifficulty),

src/main/scala/io/iohk/ethereum/network/handshaker/EtcHelloExchangeState.scala

@@ -31,18 +31,15 @@ case class EtcHelloExchangeState(handshakerConfiguration: EtcHandshakerConfigura
     log.debug("Protocol handshake finished with peer ({})", hello)
     // FIXME in principle this should be already negotiated
     Capability.negotiate(hello.capabilities.toList, handshakerConfiguration.blockchainConfig.capabilities) match {
-      case Some(ProtocolVersions.ETC64) => {
+      case Some(ProtocolVersions.ETC64) =>
         log.debug("Negotiated protocol version with client {} is etc/64", hello.clientId)
         EtcNodeStatus64ExchangeState(handshakerConfiguration)
-      }
-      case Some(ProtocolVersions.ETH63) => {
+      case Some(ProtocolVersions.ETH63) =>
         log.debug("Negotiated protocol version with client {} is eth/63", hello.clientId)
         EthNodeStatus63ExchangeState(handshakerConfiguration)
-      }
-      case Some(ProtocolVersions.ETH64) => {
+      case Some(ProtocolVersions.ETH64) =>
         log.debug("Negotiated protocol version with client {} is eth/64", hello.clientId)
         EthNodeStatus64ExchangeState(handshakerConfiguration)
-      }
       case _ =>
         log.debug(
           s"Connected peer does not support {} / {} / {} protocol. Disconnecting.",

src/main/scala/io/iohk/ethereum/network/p2p/messages/package.scala

@@ -1,5 +1,13 @@
 package io.iohk.ethereum.network.p2p
 
+package messages {
+  sealed trait ProtocolFamily
+  object ProtocolFamily {
+    final case object ETH extends ProtocolFamily
+    final case object ETC extends ProtocolFamily
+  }
+}
+
 package object messages {
   object ProtocolVersions {
     val ETH61: Capability = Capability("eth", 61.toByte)

src/test/scala/io/iohk/ethereum/blockchain/sync/BlockBroadcastSpec.scala

@@ -27,6 +27,7 @@ import io.iohk.ethereum.network.p2p.messages.BaseETH6XMessages
 import io.iohk.ethereum.network.p2p.messages.ETC64.NewBlock
 import io.iohk.ethereum.network.p2p.messages.ETH62
 import io.iohk.ethereum.network.p2p.messages.ETH62.NewBlockHashes
+import io.iohk.ethereum.network.p2p.messages.ProtocolFamily
 import io.iohk.ethereum.network.p2p.messages.ProtocolVersions
 
 class BlockBroadcastSpec
@@ -61,7 +62,9 @@ class BlockBroadcastSpec
     val blockHeader: BlockHeader = baseBlockHeader.copy(number = initialPeerInfo.maxBlockNumber - 3)
     val newBlockNewHashes = NewBlockHashes(Seq(ETH62.BlockHash(blockHeader.hash, blockHeader.number)))
     val peerInfo = initialPeerInfo
-      .copy(remoteStatus = peerStatus.copy(protocolVersion = ProtocolVersions.ETH63.version))
+      .copy(remoteStatus =
+        peerStatus.copy(protocolFamily = ProtocolFamily.ETH, protocolVersion = ProtocolVersions.ETH63.version)
+      )
       .withChainWeight(ChainWeight.totalDifficultyOnly(initialPeerInfo.chainWeight.totalDifficulty))
     val newBlock =
       BaseETH6XMessages.NewBlock(Block(blockHeader, BlockBody(Nil, Nil)), peerInfo.chainWeight.totalDifficulty + 2)
@@ -176,6 +179,7 @@ class BlockBroadcastSpec
     val baseBlockHeader = Fixtures.Blocks.Block3125369.header
 
     val peerStatus: RemoteStatus = RemoteStatus(
+      protocolFamily = ProtocolFamily.ETC,
       protocolVersion = ProtocolVersions.ETC64.version,
       networkId = 1,
       chainWeight = ChainWeight(10, 10000),

src/test/scala/io/iohk/ethereum/blockchain/sync/PeersClientSpec.scala

@@ -16,6 +16,7 @@ import io.iohk.ethereum.network.EtcPeerManagerActor.PeerInfo
 import io.iohk.ethereum.network.EtcPeerManagerActor.RemoteStatus
 import io.iohk.ethereum.network.Peer
 import io.iohk.ethereum.network.PeerId
+import io.iohk.ethereum.network.p2p.messages.ProtocolFamily
 import io.iohk.ethereum.network.p2p.messages.ProtocolVersions
 
 class PeersClientSpec extends AnyFlatSpec with Matchers with ScalaCheckPropertyChecks {
@@ -80,6 +81,7 @@ class PeersClientSpec extends AnyFlatSpec with Matchers with ScalaCheckPropertyC
     val peer3: Peer = Peer(PeerId("peer3"), new InetSocketAddress("127.0.0.1", 3), TestProbe().ref, false)
 
     private val peerStatus = RemoteStatus(
+      protocolFamily = ProtocolFamily.ETH,
       protocolVersion = ProtocolVersions.ETH63.version,
       networkId = 1,
       chainWeight = ChainWeight(0, 0),

src/test/scala/io/iohk/ethereum/blockchain/sync/PivotBlockSelectorSpec.scala

@@ -38,6 +38,7 @@ import io.iohk.ethereum.network.p2p.Message
 import io.iohk.ethereum.network.p2p.messages.BaseETH6XMessages.NewBlock
 import io.iohk.ethereum.network.p2p.messages.Codes
 import io.iohk.ethereum.network.p2p.messages.ETH62._
+import io.iohk.ethereum.network.p2p.messages.ProtocolFamily
 import io.iohk.ethereum.network.p2p.messages.ProtocolVersions
 import io.iohk.ethereum.utils.Config.SyncConfig
 
@@ -587,6 +588,7 @@ class PivotBlockSelectorSpec
 
     val peer1Status: RemoteStatus =
       RemoteStatus(
+        ProtocolFamily.ETC,
         ProtocolVersions.ETC64.version,
         1,
         ChainWeight.totalDifficultyOnly(20),

src/test/scala/io/iohk/ethereum/blockchain/sync/StateSyncSpec.scala

@@ -41,6 +41,7 @@ import io.iohk.ethereum.network.PeerEventBusActor.PeerEvent.MessageFromPeer
 import io.iohk.ethereum.network.PeerId
 import io.iohk.ethereum.network.p2p.messages.ETH63.GetNodeData.GetNodeDataEnc
 import io.iohk.ethereum.network.p2p.messages.ETH63.NodeData
+import io.iohk.ethereum.network.p2p.messages.ProtocolFamily
 import io.iohk.ethereum.network.p2p.messages.ProtocolVersions
 import io.iohk.ethereum.utils.Config
 
@@ -131,6 +132,7 @@ class StateSyncSpec
     val syncInit: TestProbe = TestProbe()
 
     val peerStatus: RemoteStatus = RemoteStatus(
+      protocolFamily = ProtocolFamily.ETH,
       protocolVersion = ProtocolVersions.ETH63.version,
       networkId = 1,
       chainWeight = ChainWeight.totalDifficultyOnly(10000),

src/test/scala/io/iohk/ethereum/blockchain/sync/TestSyncPeers.scala

@@ -10,6 +10,7 @@ import io.iohk.ethereum.network.EtcPeerManagerActor.PeerInfo
 import io.iohk.ethereum.network.EtcPeerManagerActor.RemoteStatus
 import io.iohk.ethereum.network.Peer
 import io.iohk.ethereum.network.PeerId
+import io.iohk.ethereum.network.p2p.messages.ProtocolFamily
 import io.iohk.ethereum.network.p2p.messages.ProtocolVersions
 
 trait TestSyncPeers { self: TestSyncConfig =>
@@ -25,6 +26,7 @@ trait TestSyncPeers { self: TestSyncConfig =>
 
   val peer1Status: RemoteStatus =
     RemoteStatus(
+      ProtocolFamily.ETC,
       ProtocolVersions.ETC64.version,
       1,
       ChainWeight.totalDifficultyOnly(20),

src/test/scala/io/iohk/ethereum/blockchain/sync/fast/FastSyncBranchResolverActorSpec.scala

@@ -44,6 +44,7 @@ import io.iohk.ethereum.network.PeerEventBusActor.PeerEvent.MessageFromPeer
 import io.iohk.ethereum.network.PeerId
 import io.iohk.ethereum.network.p2p.messages.ETH62.BlockHeaders
 import io.iohk.ethereum.network.p2p.messages.ETH62.GetBlockHeaders
+import io.iohk.ethereum.network.p2p.messages.ProtocolFamily
 import io.iohk.ethereum.network.p2p.messages.ProtocolVersions
 import io.iohk.ethereum.utils.Logger
 
@@ -264,6 +265,7 @@ class FastSyncBranchResolverActorSpec
     def getPeerInfo(peer: Peer, protocolVersion: Int = ProtocolVersions.ETC64.version): PeerInfo = {
       val status =
         RemoteStatus(
+          ProtocolFamily.ETC,
           protocolVersion,
           1,
           ChainWeight.totalDifficultyOnly(1),