[ETCM-283] Pass block validator as param

Author: mirkoAlic

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

@@ -63,6 +63,8 @@ object RegularSyncItSpecUtils {
       "pending-transactions-manager"
     )
 
+    lazy val validators = new MockValidatorsAlwaysSucceed
+
     lazy val regularSync = system.actorOf(
       RegularSync.props(
         peersClient,
@@ -71,6 +73,7 @@ object RegularSyncItSpecUtils {
         ledger,
         bl,
         blockchainConfig, // FIXME: remove in ETCM-280
+        validators.blockValidator,
         testSyncConfig,
         ommersPool,
         pendingTransactionsManager,

src/main/scala/io/iohk/ethereum/blockchain/sync/SyncController.scala

@@ -102,6 +102,7 @@ class SyncController(
         ledger,
         blockchain,
         blockchainConfig,
+        validators.blockValidator,
         syncConfig,
         ommersPool,
         pendingTransactionsManager,

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

@@ -8,6 +8,7 @@ import cats.data.NonEmptyList
 import cats.instances.future._
 import cats.instances.option._
 import cats.syntax.either._
+import io.iohk.ethereum.consensus.validators.BlockValidator
 import io.iohk.ethereum.blockchain.sync.PeersClient._
 import io.iohk.ethereum.blockchain.sync.regular.BlockFetcherState.{
   AwaitingBodiesToBeIgnored,
@@ -37,6 +38,7 @@ class BlockFetcher(
     val peerEventBus: ActorRef,
     val supervisor: ActorRef,
     val syncConfig: SyncConfig,
+    val blockValidator: BlockValidator,
     implicit val scheduler: Scheduler
 ) extends Actor
     with ActorLogging {
@@ -54,7 +56,7 @@ class BlockFetcher(
   }
 
   private def idle(): Receive = handleCommonMessages(None) orElse { case Start(importer, blockNr) =>
-    BlockFetcherState.initial(importer, blockNr) |> fetchBlocks
+    BlockFetcherState.initial(importer, blockValidator, blockNr) |> fetchBlocks
     peerEventBus ! Subscribe(
       MessageClassifier(
         Set(NewBlock.code63, NewBlock.code64, NewBlockHashes.code, BlockHeaders.code),
@@ -363,9 +365,10 @@ object BlockFetcher {
       peerEventBus: ActorRef,
       supervisor: ActorRef,
       syncConfig: SyncConfig,
+      blockValidator: BlockValidator,
       scheduler: Scheduler
   ): Props =
-    Props(new BlockFetcher(peersClient, peerEventBus, supervisor, syncConfig, scheduler))
+    Props(new BlockFetcher(peersClient, peerEventBus, supervisor, syncConfig, blockValidator, scheduler))
 
   sealed trait FetchMsg
   case class Start(importer: ActorRef, fromBlock: BigInt) extends FetchMsg

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

@@ -3,8 +3,7 @@ package io.iohk.ethereum.blockchain.sync.regular
 import akka.actor.ActorRef
 import akka.util.ByteString
 import cats.data.NonEmptyList
-//FIXME: By using this class, we are coupling sync process with a specific consensus (the standard one).
-import io.iohk.ethereum.consensus.validators.std.StdBlockValidator
+import io.iohk.ethereum.consensus.validators.BlockValidator
 import io.iohk.ethereum.domain.{Block, BlockHeader, BlockBody, HeadersSeq}
 import io.iohk.ethereum.network.PeerId
 import io.iohk.ethereum.network.p2p.messages.PV62.BlockHash
@@ -14,6 +13,7 @@ import cats.syntax.option._
 
 import scala.collection.immutable.Queue
 import scala.annotation.tailrec
+import io.iohk.ethereum.consensus.validators.BlockValidator
 
 // scalastyle:off number.of.methods
 /**
@@ -37,6 +37,7 @@ import scala.annotation.tailrec
   */
 case class BlockFetcherState(
     importer: ActorRef,
+    blockValidator: BlockValidator,
     readyBlocks: Queue[Block],
     waitingHeaders: Queue[BlockHeader],
     fetchingHeadersState: FetchingHeadersState,
@@ -121,7 +122,7 @@ case class BlockFetcherState(
       case (Seq(), _ +: _) => None
       case (_, Seq()) => Some(matchedBlocks)
       case (header +: remainingHeaders, body +: remainingBodies) =>
-        val doMatch = StdBlockValidator.validateHeaderAndBody(header, body).isRight
+        val doMatch = blockValidator.validateHeaderAndBody(header, body).isRight
         if (doMatch)
           bodiesAreOrderedSubsetOfRequested(remainingHeaders, remainingBodies, matchedBlocks :+ Block(header, body))
         else
@@ -241,17 +242,19 @@ case class BlockFetcherState(
 object BlockFetcherState {
   case class StateNodeFetcher(hash: ByteString, replyTo: ActorRef)
 
-  def initial(importer: ActorRef, lastBlock: BigInt): BlockFetcherState = BlockFetcherState(
-    importer = importer,
-    readyBlocks = Queue(),
-    waitingHeaders = Queue(),
-    fetchingHeadersState = NotFetchingHeaders,
-    fetchingBodiesState = NotFetchingBodies,
-    stateNodeFetcher = None,
-    lastBlock = lastBlock,
-    knownTop = lastBlock + 1,
-    blockProviders = Map()
-  )
+  def initial(importer: ActorRef, blockValidator: BlockValidator, lastBlock: BigInt): BlockFetcherState =
+    BlockFetcherState(
+      importer = importer,
+      blockValidator = blockValidator,
+      readyBlocks = Queue(),
+      waitingHeaders = Queue(),
+      fetchingHeadersState = NotFetchingHeaders,
+      fetchingBodiesState = NotFetchingBodies,
+      stateNodeFetcher = None,
+      lastBlock = lastBlock,
+      knownTop = lastBlock + 1,
+      blockProviders = Map()
+    )
 
   trait FetchingHeadersState
   case object NotFetchingHeaders extends FetchingHeadersState

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

@@ -9,6 +9,7 @@ import io.iohk.ethereum.blockchain.sync.regular.RegularSync.{NewCheckpoint, Prog
 import io.iohk.ethereum.blockchain.sync.regular.BlockFetcher.InternalLastBlockImport
 import io.iohk.ethereum.blockchain.sync.BlockBroadcast
 import io.iohk.ethereum.consensus.blocks.CheckpointBlockGenerator
+import io.iohk.ethereum.consensus.validators.BlockValidator
 import io.iohk.ethereum.crypto.ECDSASignature
 import io.iohk.ethereum.domain.Blockchain
 import io.iohk.ethereum.ledger.Ledger
@@ -22,6 +23,7 @@ class RegularSync(
     ledger: Ledger,
     blockchain: Blockchain,
     blockchainConfig: BlockchainConfig,
+    blockValidator: BlockValidator,
     syncConfig: SyncConfig,
     ommersPool: ActorRef,
     pendingTransactionsManager: ActorRef,
@@ -31,7 +33,10 @@ class RegularSync(
     with ActorLogging {
 
   val fetcher: ActorRef =
-    context.actorOf(BlockFetcher.props(peersClient, peerEventBus, self, syncConfig, scheduler), "block-fetcher")
+    context.actorOf(
+      BlockFetcher.props(peersClient, peerEventBus, self, syncConfig, blockValidator, scheduler),
+      "block-fetcher"
+    )
   val broadcaster: ActorRef = context.actorOf(
     BlockBroadcasterActor
       .props(new BlockBroadcast(etcPeerManager, syncConfig), peerEventBus, etcPeerManager, syncConfig, scheduler),
@@ -122,6 +127,7 @@ object RegularSync {
       ledger: Ledger,
       blockchain: Blockchain,
       blockchainConfig: BlockchainConfig,
+      blockValidator: BlockValidator,
       syncConfig: SyncConfig,
       ommersPool: ActorRef,
       pendingTransactionsManager: ActorRef,
@@ -136,6 +142,7 @@ object RegularSync {
         ledger,
         blockchain,
         blockchainConfig,
+        blockValidator,
         syncConfig,
         ommersPool,
         pendingTransactionsManager,

src/test/scala/io/iohk/ethereum/blockchain/sync/regular/BlockFetcherSpec.scala

@@ -5,6 +5,7 @@ import java.net.InetSocketAddress
 import akka.actor.ActorSystem
 import akka.testkit.{TestKit, TestProbe}
 import com.miguno.akka.testing.VirtualTime
+import io.iohk.ethereum.Mocks.MockValidatorsAlwaysSucceed
 import io.iohk.ethereum.BlockHelpers
 import io.iohk.ethereum.Fixtures.{Blocks => FixtureBlocks}
 import io.iohk.ethereum.blockchain.sync.PeersClient.BlacklistPeer
@@ -134,6 +135,8 @@ class BlockFetcherSpec extends TestKit(ActorSystem("BlockFetcherSpec_System")) w
     val importer: TestProbe = TestProbe()
     val regularSync: TestProbe = TestProbe()
 
+    val validators = new MockValidatorsAlwaysSucceed
+
     override lazy val syncConfig = defaultSyncConfig.copy(
       // Same request size was selected for simplification purposes of the flow
       blockHeadersPerRequest = 10,
@@ -152,6 +155,7 @@ class BlockFetcherSpec extends TestKit(ActorSystem("BlockFetcherSpec_System")) w
           peerEventBus.ref,
           regularSync.ref,
           syncConfig,
+          validators.blockValidator,
           time.scheduler
         )
     )

src/test/scala/io/iohk/ethereum/blockchain/sync/regular/BlockFetcherStateSpec.scala

@@ -2,18 +2,23 @@ package io.iohk.ethereum.blockchain.sync.regular
 
 import akka.actor.ActorSystem
 import akka.testkit.{TestKit, TestProbe}
+import io.iohk.ethereum.Mocks.MockValidatorsAlwaysSucceed
 import io.iohk.ethereum.domain.Block
 import io.iohk.ethereum.Fixtures.Blocks.ValidBlock
 import io.iohk.ethereum.network.PeerId
 import org.scalatest.matchers.should.Matchers
 import org.scalatest.wordspec.AnyWordSpecLike
 
 class BlockFetcherStateSpec extends TestKit(ActorSystem()) with AnyWordSpecLike with Matchers {
+
+  lazy val validators = new MockValidatorsAlwaysSucceed
+
   "BlockFetcherState" when {
     "invalidating blocks" should {
       "not allow to go to negative block number" in {
         val importer = TestProbe().ref
-        val (_, actual) = BlockFetcherState.initial(importer, 10).invalidateBlocksFrom(-5, None)
+        val (_, actual) =
+          BlockFetcherState.initial(importer, validators.blockValidator, 10).invalidateBlocksFrom(-5, None)
 
         actual.lastBlock shouldBe 0
       }
@@ -26,7 +31,7 @@ class BlockFetcherStateSpec extends TestKit(ActorSystem()) with AnyWordSpecLike
         val newBestBlock = Block(ValidBlock.header.copy(number = ValidBlock.header.number + 1), ValidBlock.body)
         val fakePeerId = PeerId("fake")
 
-        val currentState = BlockFetcherState.initial(importer, currentBestBlock.number)
+        val currentState = BlockFetcherState.initial(importer, validators.blockValidator, currentBestBlock.number)
         val newState = currentState.appendNewBlock(newBestBlock, fakePeerId)
         newState.lastBlock shouldEqual newBestBlock.number
         newState.blockProviders(newBestBlock.number) shouldEqual fakePeerId

src/test/scala/io/iohk/ethereum/blockchain/sync/regular/RegularSyncFixtures.scala

@@ -68,6 +68,7 @@ trait RegularSyncFixtures { self: Matchers with AsyncMockFactory =>
           ledger,
           blockchain,
           blockchainConfig,
+          validators.blockValidator,
           syncConfig,
           ommersPool.ref,
           pendingTransactionsManager.ref,