[ETCM-355] Send fork id in the Status message

Author: lukasz-golebiewski

src/it/scala/io/iohk/ethereum/sync/util/CommonFakePeer.scala

@@ -192,6 +192,7 @@ abstract class CommonFakePeer(peerName: String, fakePeerCustomConfig: FakePeerCu
       override val blockchain: Blockchain = CommonFakePeer.this.bl
       override val blockchainReader: BlockchainReader = CommonFakePeer.this.blockchainReader
       override val appStateStorage: AppStateStorage = storagesInstance.storages.appStateStorage
+      override val blockchainConfig: BlockchainConfig = Config.blockchains.blockchainConfig
       override val capabilities: List[Capability] = blockchainConfig.capabilities
     }
 

src/it/scala/io/iohk/ethereum/txExecTest/util/DumpChainApp.scala

@@ -49,6 +49,7 @@ import io.iohk.ethereum.network.rlpx.RLPxConnectionHandler.RLPxConfiguration
 import io.iohk.ethereum.nodebuilder.AuthHandshakerBuilder
 import io.iohk.ethereum.nodebuilder.NodeKeyBuilder
 import io.iohk.ethereum.security.SecureRandomBuilder
+import io.iohk.ethereum.utils.BlockchainConfig
 import io.iohk.ethereum.utils.Config
 import io.iohk.ethereum.utils.NodeStatus
 import io.iohk.ethereum.utils.ServerStatus
@@ -121,6 +122,7 @@ object DumpChainApp
       override val blockchain: Blockchain = DumpChainApp.blockchain
       override val blockchainReader: BlockchainReader = DumpChainApp.blockchainReader
       override val appStateStorage: AppStateStorage = storagesInstance.storages.appStateStorage
+      override val blockchainConfig: BlockchainConfig = Config.blockchains.blockchainConfig
       override val capabilities: List[Capability] = blockchainConfig.capabilities
     }
 

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

@@ -26,6 +26,7 @@ import io.iohk.ethereum.network.p2p.messages.ETC64.NewBlock
 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.WireProtocol.Disconnect
 import io.iohk.ethereum.utils.ByteStringUtils
 
@@ -256,6 +257,15 @@ object EtcPeerManagerActor {
   }
 
   object RemoteStatus {
+    def apply(status: ETH64.Status): RemoteStatus =
+      RemoteStatus(
+        status.protocolVersion,
+        status.networkId,
+        ChainWeight.totalDifficultyOnly(status.totalDifficulty),
+        status.bestHash,
+        status.genesisHash
+      )
+
     def apply(status: ETC64.Status): RemoteStatus =
       RemoteStatus(status.protocolVersion, status.networkId, status.chainWeight, status.bestHash, status.genesisHash)
 

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

@@ -10,6 +10,7 @@ import io.iohk.ethereum.network.ForkResolver
 import io.iohk.ethereum.network.PeerManagerActor.PeerConfiguration
 import io.iohk.ethereum.network.p2p.messages.Capability
 import io.iohk.ethereum.utils.NodeStatus
+import io.iohk.ethereum.utils.BlockchainConfig
 
 case class EtcHandshaker private (
     handshakerState: HandshakerState[PeerInfo],
@@ -38,4 +39,5 @@ trait EtcHandshakerConfiguration {
   val peerConfiguration: PeerConfiguration
   val forkResolverOpt: Option[ForkResolver]
   val capabilities: List[Capability]
+  val blockchainConfig: BlockchainConfig
 }

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

@@ -33,10 +33,12 @@ case class EtcHelloExchangeState(handshakerConfiguration: EtcHandshakerConfigura
     Capability.negotiate(hello.capabilities.toList, handshakerConfiguration.capabilities) match {
       case Some(ProtocolVersions.ETC64) => EtcNodeStatus64ExchangeState(handshakerConfiguration)
       case Some(ProtocolVersions.ETH63) => EtcNodeStatus63ExchangeState(handshakerConfiguration)
+      case Some(ProtocolVersions.ETH64) => EthNodeStatus64ExchangeState(handshakerConfiguration)
       case _ =>
         log.debug(
-          s"Connected peer does not support {} / {} protocol. Disconnecting.",
+          s"Connected peer does not support {} / {} / {} protocol. Disconnecting.",
           ProtocolVersions.ETH63,
+          ProtocolVersions.ETH64,
           ProtocolVersions.ETC64
         )
         DisconnectedState(Disconnect.Reasons.IncompatibleP2pProtocolVersion)

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

@@ -0,0 +1,37 @@
+package io.iohk.ethereum.network.handshaker
+
+import io.iohk.ethereum.forkid.ForkId
+import io.iohk.ethereum.network.EtcPeerManagerActor.{PeerInfo, RemoteStatus}
+import io.iohk.ethereum.network.p2p.messages.{BaseETH6XMessages, ProtocolVersions, ETH64}
+import io.iohk.ethereum.network.p2p.{Message, MessageSerializable}
+
+case class EthNodeStatus64ExchangeState(
+    handshakerConfiguration: EtcHandshakerConfiguration
+) extends EtcNodeStatusExchangeState[ETH64.Status] {
+
+  import handshakerConfiguration._
+
+  def applyResponseMessage: PartialFunction[Message, HandshakerState[PeerInfo]] = { case status: ETH64.Status =>
+    // TODO: validate fork id of the remote peer
+    applyRemoteStatusMessage(RemoteStatus(status))
+  }
+
+  override protected def createStatusMsg(): MessageSerializable = {
+    val bestBlockHeader = getBestBlockHeader()
+    val chainWeight = blockchain.getChainWeightByHash(bestBlockHeader.hash).get
+    val genesisHash = blockchain.genesisHeader.hash
+
+    val status = ETH64.Status(
+      protocolVersion = ProtocolVersions.ETH64.version,
+      networkId = peerConfiguration.networkId,
+      totalDifficulty = chainWeight.totalDifficulty,
+      bestHash = bestBlockHeader.hash,
+      genesisHash = genesisHash,
+      forkId = ForkId.create(genesisHash, blockchainConfig)(blockchain.getBestBlockNumber())
+    )
+
+    log.debug(s"Sending status $status")
+    status
+  }
+
+}

src/main/scala/io/iohk/ethereum/network/p2p/MessageDecoders.scala

@@ -59,24 +59,23 @@ object ETH64MessageDecoder extends MessageDecoder {
   import io.iohk.ethereum.network.p2p.messages.ETH64.Status._
   import io.iohk.ethereum.network.p2p.messages.BaseETH6XMessages.NewBlock._
 
-  def fromBytes(msgCode: Int, payload: Array[Byte]): Message = {
+  def fromBytes(msgCode: Int, payload: Array[Byte]): Message =
     msgCode match {
-      case Codes.GetNodeDataCode => payload.toGetNodeData
-      case Codes.NodeDataCode => payload.toNodeData
-      case Codes.GetReceiptsCode => payload.toGetReceipts
-      case Codes.ReceiptsCode => payload.toReceipts
-      case Codes.NewBlockHashesCode => payload.toNewBlockHashes
-      case Codes.GetBlockHeadersCode => payload.toGetBlockHeaders
-      case Codes.BlockHeadersCode => payload.toBlockHeaders
-      case Codes.GetBlockBodiesCode => payload.toGetBlockBodies
-      case Codes.BlockBodiesCode => payload.toBlockBodies
+      case Codes.GetNodeDataCode           => payload.toGetNodeData
+      case Codes.NodeDataCode              => payload.toNodeData
+      case Codes.GetReceiptsCode           => payload.toGetReceipts
+      case Codes.ReceiptsCode              => payload.toReceipts
+      case Codes.NewBlockHashesCode        => payload.toNewBlockHashes
+      case Codes.GetBlockHeadersCode       => payload.toGetBlockHeaders
+      case Codes.BlockHeadersCode          => payload.toBlockHeaders
+      case Codes.GetBlockBodiesCode        => payload.toGetBlockBodies
+      case Codes.BlockBodiesCode           => payload.toBlockBodies
       case Codes.BlockHashesFromNumberCode => payload.toBlockHashesFromNumber
-      case Codes.StatusCode => payload.toStatus
-      case Codes.NewBlockCode => payload.toNewBlock
-      case Codes.SignedTransactionsCode => payload.toSignedTransactions
-      case _ => throw new RuntimeException(s"Unknown message type: $msgCode")
+      case Codes.StatusCode                => payload.toStatus
+      case Codes.NewBlockCode              => payload.toNewBlock
+      case Codes.SignedTransactionsCode    => payload.toSignedTransactions
+      case _                               => throw new RuntimeException(s"Unknown message type: $msgCode")
     }
-  }
 }
 
 object ETH63MessageDecoder extends MessageDecoder {

src/main/scala/io/iohk/ethereum/nodebuilder/NodeBuilder.scala

@@ -238,6 +238,7 @@ trait HandshakerBuilder {
       override val blockchainReader: BlockchainReader = self.blockchainReader
       override val appStateStorage: AppStateStorage = self.storagesInstance.storages.appStateStorage
       override val capabilities: List[Capability] = self.blockchainConfig.capabilities
+      override val blockchainConfig: BlockchainConfig = self.blockchainConfig
     }
 
   lazy val handshaker: Handshaker[PeerInfo] = EtcHandshaker(handshakerConfiguration)

src/test/scala/io/iohk/ethereum/network/handshaker/EtcHandshakerSpec.scala

@@ -12,6 +12,7 @@ import io.iohk.ethereum.blockchain.sync.EphemBlockchainTestSetup
 import io.iohk.ethereum.crypto.generateKeyPair
 import io.iohk.ethereum.db.storage.AppStateStorage
 import io.iohk.ethereum.domain._
+import io.iohk.ethereum.forkid.ForkId
 import io.iohk.ethereum.network.EtcPeerManagerActor.PeerInfo
 import io.iohk.ethereum.network.EtcPeerManagerActor.RemoteStatus
 import io.iohk.ethereum.network.ForkResolver
@@ -26,6 +27,7 @@ import io.iohk.ethereum.network.p2p.messages.ETC64
 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.GetBlockHeaders.GetBlockHeadersEnc
+import io.iohk.ethereum.network.p2p.messages.ETH64
 import io.iohk.ethereum.network.p2p.messages.ProtocolVersions
 import io.iohk.ethereum.network.p2p.messages.WireProtocol.Disconnect
 import io.iohk.ethereum.network.p2p.messages.WireProtocol.Hello
@@ -190,6 +192,40 @@ class EtcHandshakerSpec extends AnyFlatSpec with Matchers {
     }
   }
 
+  it should "send status with fork id when peer supports ETH64" in new LocalPeerETH64Setup
+    with RemotePeerETH64Setup {
+
+    val newChainWeight = ChainWeight.zero.increase(genesisBlock.header).increase(firstBlock.header)
+
+    blockchain.save(firstBlock, Nil, newChainWeight, saveAsBestBlock = true)
+
+    val newLocalStatusMsg =
+      localStatusMsg
+        .copy(
+          bestHash = firstBlock.header.hash,
+          totalDifficulty = newChainWeight.totalDifficulty,
+          forkId = ForkId(0xfc64ec04L, Some(1150000))
+        )
+
+    initHandshakerWithoutResolver.nextMessage.map(_.messageToSend) shouldBe Right(localHello: HelloEnc)
+
+    val handshakerAfterHelloOpt = initHandshakerWithoutResolver.applyMessage(remoteHello)
+    assert(handshakerAfterHelloOpt.isDefined)
+
+    handshakerAfterHelloOpt.get.nextMessage.map(_.messageToSend.underlyingMsg) shouldBe Right(newLocalStatusMsg)
+
+    val handshakerAfterStatusOpt = handshakerAfterHelloOpt.get.applyMessage(remoteStatusMsg)
+    assert(handshakerAfterStatusOpt.isDefined)
+
+    handshakerAfterStatusOpt.get.nextMessage match {
+      case Left(HandshakeSuccess(peerInfo)) =>
+        peerInfo.remoteStatus.protocolVersion shouldBe localStatus.protocolVersion
+
+      case other =>
+        fail(s"Invalid handshaker state: $other")
+    }
+  }
+
   it should "fail if a timeout happened during hello exchange" in new TestSetup {
     val handshakerAfterTimeout = initHandshakerWithoutResolver.processTimeout
     handshakerAfterTimeout.nextMessage.map(_.messageToSend) shouldBe Left(
@@ -287,6 +323,7 @@ class EtcHandshakerSpec extends AnyFlatSpec with Matchers {
       override val appStateStorage: AppStateStorage = TestSetup.this.storagesInstance.storages.appStateStorage
       override val capabilities: List[Capability] = pv
       override val blockchainReader: BlockchainReader = TestSetup.this.blockchainReader
+      override val blockchainConfig: BlockchainConfig = TestSetup.this.blockchainConfig
     }
 
     val etcHandshakerConfigurationWithResolver: MockEtcHandshakerConfiguration = new MockEtcHandshakerConfiguration {
@@ -296,7 +333,7 @@ class EtcHandshakerSpec extends AnyFlatSpec with Matchers {
     }
 
     val initHandshakerWithoutResolver: EtcHandshaker = EtcHandshaker(
-      new MockEtcHandshakerConfiguration(List(ProtocolVersions.ETC64, ProtocolVersions.ETH63))
+      new MockEtcHandshakerConfiguration(List(ProtocolVersions.ETC64, ProtocolVersions.ETH63, ProtocolVersions.ETH64))
     )
 
     val initHandshakerWithResolver: EtcHandshaker = EtcHandshaker(etcHandshakerConfigurationWithResolver)
@@ -309,7 +346,7 @@ class EtcHandshakerSpec extends AnyFlatSpec with Matchers {
     val localHello: Hello = Hello(
       p2pVersion = EtcHelloExchangeState.P2pVersion,
       clientId = Config.clientId,
-      capabilities = Seq(Etc64Capability, Eth63Capability),
+      capabilities = Seq(Etc64Capability, Eth63Capability, Eth64Capability),
       listenPort = 0, //Local node not listening
       nodeId = ByteString(nodeStatus.nodeId)
     )
@@ -329,6 +366,18 @@ class EtcHandshakerSpec extends AnyFlatSpec with Matchers {
     val localStatus: RemoteStatus = RemoteStatus(localStatusMsg)
   }
 
+  trait LocalPeerETH64Setup extends LocalPeerSetup {
+    val localStatusMsg = ETH64.Status(
+      protocolVersion = ProtocolVersions.ETH64.version,
+      networkId = Config.Network.peer.networkId,
+      totalDifficulty = genesisBlock.header.difficulty,
+      bestHash = genesisBlock.header.hash,
+      genesisHash = genesisBlock.header.hash,
+      forkId = ForkId(1L, None)
+    )
+    val localStatus = RemoteStatus(localStatusMsg)
+  }
+
   trait LocalPeerETC64Setup extends LocalPeerSetup {
     val localStatusMsg: ETC64.Status = ETC64.Status(
       protocolVersion = ProtocolVersions.ETC64.version,
@@ -387,4 +436,25 @@ class EtcHandshakerSpec extends AnyFlatSpec with Matchers {
         genesisHash = genesisBlock.header.hash
       )
   }
+
+  trait RemotePeerETH64Setup extends RemotePeerSetup {
+    val remoteHello = Hello(
+      p2pVersion = EtcHelloExchangeState.P2pVersion,
+      clientId = "remote-peer",
+      capabilities = Seq(Eth64Capability),
+      listenPort = remotePort,
+      nodeId = ByteString(remoteNodeStatus.nodeId)
+    )
+
+    val remoteStatusMsg = ETH64.Status(
+      protocolVersion = ProtocolVersions.ETH64.version,
+      networkId = Config.Network.peer.networkId,
+      totalDifficulty = 0,
+      bestHash = genesisBlock.header.hash,
+      genesisHash = genesisBlock.header.hash,
+      forkId = ForkId(2L, Some(3L))
+    )
+
+    val remoteStatus = RemoteStatus(remoteStatusMsg)
+  }
 }

src/test/scala/io/iohk/ethereum/network/p2p/PeerActorSpec.scala

@@ -58,6 +58,7 @@ import io.iohk.ethereum.network.p2p.messages.WireProtocol._
 import io.iohk.ethereum.network.rlpx.RLPxConnectionHandler
 import io.iohk.ethereum.network.rlpx.RLPxConnectionHandler.RLPxConfiguration
 import io.iohk.ethereum.security.SecureRandomBuilder
+import io.iohk.ethereum.utils.BlockchainConfig
 import io.iohk.ethereum.utils.Config
 import io.iohk.ethereum.utils.NodeStatus
 import io.iohk.ethereum.utils.ServerStatus
@@ -587,6 +588,7 @@ class PeerActorSpec
       override val blockchainReader: BlockchainReader = self.blockchainReader
       override val appStateStorage: AppStateStorage = self.storagesInstance.storages.appStateStorage
       override val capabilities: List[Capability] = List(protocol)
+      override val blockchainConfig: BlockchainConfig = self.blockchainConfig
     }
 
     val handshaker: EtcHandshaker = EtcHandshaker(handshakerConfiguration)