[ETCM-1045] Move getChainWeightByHash from Blockchain to BlockchainReader

Author: Leonor Boga

src/it/scala/io/iohk/ethereum/sync/RegularSyncItSpec.scala

@@ -178,16 +178,23 @@ class RegularSyncItSpec extends FreeSpecBase with Matchers with BeforeAndAfterAl
       _ <- peer2.waitForRegularSyncLoadLastBlock(blockNumer + 3)
     } yield {
       assert(
-        peer1.bl.getChainWeightByHash(peer1.blockchainReader.getBestBlock().get.hash) == peer2.bl.getChainWeightByHash(
-          peer2.blockchainReader.getBestBlock().get.hash
-        )
+        peer1.blockchainReader.getChainWeightByHash(
+          peer1.blockchainReader.getBestBlock().get.hash
+        ) == peer2.blockchainReader
+          .getChainWeightByHash(
+            peer2.blockchainReader.getBestBlock().get.hash
+          )
       )
       (
         peer1.blockchainReader.getBlockByNumber(peer1.blockchainReader.getBestBranch(), blockNumer + 1),
         peer2.blockchainReader.getBlockByNumber(peer2.blockchainReader.getBestBranch(), blockNumer + 1)
       ) match {
         case (Some(blockP1), Some(blockP2)) =>
-          assert(peer1.bl.getChainWeightByHash(blockP1.hash) == peer2.bl.getChainWeightByHash(blockP2.hash))
+          assert(
+            peer1.blockchainReader.getChainWeightByHash(blockP1.hash) == peer2.blockchainReader.getChainWeightByHash(
+              blockP2.hash
+            )
+          )
         case (_, _) => fail("invalid difficulty validation")
       }
     }

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

@@ -283,7 +283,7 @@ abstract class CommonFakePeer(peerName: String, fakePeerCustomConfig: FakePeerCu
   def getCurrentState(): BlockchainState = {
     val bestBlock = blockchainReader.getBestBlock().get
     val currentWorldState = getMptForBlock(bestBlock)
-    val currentWeight = bl.getChainWeightByHash(bestBlock.hash).get
+    val currentWeight = blockchainReader.getChainWeightByHash(bestBlock.hash).get
     BlockchainState(bestBlock, currentWorldState, currentWeight)
   }
 
@@ -356,7 +356,7 @@ abstract class CommonFakePeer(peerName: String, fakePeerCustomConfig: FakePeerCu
       currentBestBlock: Block
   )(updateWorldForBlock: (BigInt, InMemoryWorldStateProxy) => InMemoryWorldStateProxy): Task[Unit] =
     Task {
-      val currentWeight = bl.getChainWeightByHash(currentBestBlock.hash).get
+      val currentWeight = blockchainReader.getChainWeightByHash(currentBestBlock.hash).get
       val currentWorld = getMptForBlock(currentBestBlock)
       val (newBlock, newWeight, _) =
         createChildBlock(currentBestBlock, currentWeight, currentWorld)(updateWorldForBlock)

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

@@ -186,7 +186,7 @@ class BlockchainMock(genesisHash: ByteString) extends Blockchain {
 
   override def removeBlock(hash: ByteString): Unit = ???
 
-  override def getChainWeightByHash(blockhash: ByteString): Option[ChainWeight] = ???
+  def getAccount(address: Address, blockNumber: BigInt): Option[Account] = ???
 
   override def getAccountStorageAt(rootHash: ByteString, position: BigInt, ethCompatibleStorage: Boolean): ByteString =
     ???

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

@@ -130,7 +130,7 @@ class SyncController(
         consensus,
         blockchainReader,
         stateStorage,
-        new BranchResolution(blockchain, blockchainReader),
+        new BranchResolution(blockchainReader),
         validators.blockValidator,
         blacklist,
         syncConfig,

src/main/scala/io/iohk/ethereum/blockchain/sync/fast/FastSync.scala

@@ -643,7 +643,7 @@ class FastSync(
         } yield (validatedHeader, parentWeight)
 
       def getParentChainWeight(header: BlockHeader) =
-        blockchain.getChainWeightByHash(header.parentHash).toRight(ParentChainWeightNotFound(header))
+        blockchainReader.getChainWeightByHash(header.parentHash).toRight(ParentChainWeightNotFound(header))
 
       @tailrec
       def processHeaders(headers: Seq[BlockHeader]): HeaderProcessingResult =
@@ -941,7 +941,7 @@ class FastSync(
       }
 
     def assignBlockchainWork(peerWithInfo: PeerWithInfo): Unit = {
-      val PeerWithInfo(peer, peerInfo) = peerWithInfo
+      val PeerWithInfo(peer, _) = peerWithInfo
       log.debug(s"Assigning blockchain work for peer [{}]", peer.id.value)
       if (syncState.receiptsQueue.nonEmpty) {
         requestReceipts(peer)

src/main/scala/io/iohk/ethereum/consensus/ConsensusImpl.scala

@@ -72,7 +72,7 @@ class ConsensusImpl(
           log.debug("Ignoring duplicated block: {}", block.idTag)
           Task.now(DuplicateBlock)
         } else {
-          blockchain.getChainWeightByHash(bestBlock.header.hash) match {
+          blockchainReader.getChainWeightByHash(bestBlock.header.hash) match {
             case Some(weight) =>
               doBlockPreValidation(block).flatMap {
                 case Left(error) => Task.now(BlockImportFailed(error.reason.toString))
@@ -234,7 +234,7 @@ class ConsensusImpl(
     val reorgResult = for {
       parent <- newBranch.headOption
       parentHash = parent.header.parentHash
-      parentWeight <- blockchain.getChainWeightByHash(parentHash)
+      parentWeight <- blockchainReader.getChainWeightByHash(parentHash)
     } yield {
       log.debug(
         "Removing blocks starting from number {} and parent {}",
@@ -330,7 +330,7 @@ class ConsensusImpl(
 
           val blockDataOpt = for {
             receipts <- blockchainReader.getReceiptsByHash(hash)
-            weight <- blockchain.getChainWeightByHash(hash)
+            weight <- blockchainReader.getChainWeightByHash(hash)
           } yield BlockData(block, receipts, weight)
 
           blockchain.removeBlock(hash)

src/main/scala/io/iohk/ethereum/domain/Blockchain.scala

@@ -54,12 +54,6 @@ trait Blockchain {
     */
   def getReadOnlyMptStorage(): MptStorage
 
-  /** Looks up ChainWeight for a given chain
-    * @param blockhash Hash of top block in the chain
-    * @return ChainWeight if found
-    */
-  def getChainWeightByHash(blockhash: ByteString): Option[ChainWeight]
-
   def getLatestCheckpointBlockNumber(): BigInt
 
   def removeBlock(hash: ByteString): Unit
@@ -81,8 +75,6 @@ class BlockchainImpl(
 ) extends Blockchain
     with Logger {
 
-  override def getChainWeightByHash(blockhash: ByteString): Option[ChainWeight] = chainWeightStorage.get(blockhash)
-
   override def getLatestCheckpointBlockNumber(): BigInt = appStateStorage.getLatestCheckpointBlockNumber()
 
   override def getAccountStorageAt(

src/main/scala/io/iohk/ethereum/domain/BlockchainReader.scala

@@ -1,13 +1,15 @@
 package io.iohk.ethereum.domain
 
 import akka.util.ByteString
-
-import io.iohk.ethereum.db.storage.AppStateStorage
-import io.iohk.ethereum.db.storage.BlockBodiesStorage
-import io.iohk.ethereum.db.storage.BlockHeadersStorage
-import io.iohk.ethereum.db.storage.BlockNumberMappingStorage
-import io.iohk.ethereum.db.storage.ReceiptStorage
-import io.iohk.ethereum.db.storage.StateStorage
+import io.iohk.ethereum.db.storage.{
+  AppStateStorage,
+  BlockBodiesStorage,
+  BlockHeadersStorage,
+  BlockNumberMappingStorage,
+  ChainWeightStorage,
+  ReceiptStorage,
+  StateStorage
+}
 import io.iohk.ethereum.domain.branch.BestBranch
 import io.iohk.ethereum.domain.branch.Branch
 import io.iohk.ethereum.domain.branch.EmptyBranch
@@ -21,7 +23,8 @@ class BlockchainReader(
     blockNumberMappingStorage: BlockNumberMappingStorage,
     stateStorage: StateStorage,
     receiptStorage: ReceiptStorage,
-    appStateStorage: AppStateStorage
+    appStateStorage: AppStateStorage,
+    chainWeightStorage: ChainWeightStorage
 ) extends Logger {
 
   /** Allows to query a blockHeader by block hash
@@ -150,6 +153,12 @@ class BlockchainReader(
       case EmptyBranch => None
     }
 
+  /** Looks up ChainWeight for a given chain
+    * @param blockhash Hash of top block in the chain
+    * @return ChainWeight if found
+    */
+  def getChainWeightByHash(blockhash: ByteString): Option[ChainWeight] = chainWeightStorage.get(blockhash)
+
   /** Allows to query for a block based on it's number
     *
     * @param number Block number
@@ -189,7 +198,8 @@ object BlockchainReader {
     storages.blockNumberMappingStorage,
     storages.stateStorage,
     storages.receiptStorage,
-    storages.appStateStorage
+    storages.appStateStorage,
+    storages.chainWeightStorage
   )
 
 }

src/main/scala/io/iohk/ethereum/jsonrpc/EthBlocksService.scala

@@ -75,7 +75,7 @@ class EthBlocksService(
   def getByBlockHash(request: BlockByBlockHashRequest): ServiceResponse[BlockByBlockHashResponse] = Task {
     val BlockByBlockHashRequest(blockHash, fullTxs) = request
     val blockOpt = blockchainReader.getBlockByHash(blockHash).orElse(blockQueue.getBlockByHash(blockHash))
-    val weight = blockchain.getChainWeightByHash(blockHash).orElse(blockQueue.getChainWeightByHash(blockHash))
+    val weight = blockchainReader.getChainWeightByHash(blockHash).orElse(blockQueue.getChainWeightByHash(blockHash))
 
     val blockResponseOpt = blockOpt.map(block => BlockResponse(block, weight, fullTxs = fullTxs))
     Right(BlockByBlockHashResponse(blockResponseOpt))
@@ -90,7 +90,7 @@ class EthBlocksService(
     val BlockByNumberRequest(blockParam, fullTxs) = request
     val blockResponseOpt =
       resolveBlock(blockParam).toOption.map { case ResolvedBlock(block, pending) =>
-        val weight = blockchain.getChainWeightByHash(block.header.hash)
+        val weight = blockchainReader.getChainWeightByHash(block.header.hash)
         BlockResponse(block, weight, fullTxs = fullTxs, pendingBlock = pending.isDefined)
       }
     Right(BlockByNumberResponse(blockResponseOpt))
@@ -122,7 +122,7 @@ class EthBlocksService(
         else
           None
       }
-    val weight = uncleHeaderOpt.flatMap(uncleHeader => blockchain.getChainWeightByHash(uncleHeader.hash))
+    val weight = uncleHeaderOpt.flatMap(uncleHeader => blockchainReader.getChainWeightByHash(uncleHeader.hash))
 
     //The block in the response will not have any txs or uncles
     val uncleBlockResponseOpt = uncleHeaderOpt.map { uncleHeader =>
@@ -144,7 +144,7 @@ class EthBlocksService(
       .flatMap { case ResolvedBlock(block, pending) =>
         if (uncleIndex >= 0 && uncleIndex < block.body.uncleNodesList.size) {
           val uncleHeader = block.body.uncleNodesList.apply(uncleIndex.toInt)
-          val weight = blockchain.getChainWeightByHash(uncleHeader.hash)
+          val weight = blockchainReader.getChainWeightByHash(uncleHeader.hash)
 
           //The block in the response will not have any txs or uncles
           Some(

src/main/scala/io/iohk/ethereum/ledger/BlockQueue.scala

@@ -65,7 +65,7 @@ class BlockQueue(
         None
 
       case None =>
-        val parentWeight = blockchain.getChainWeightByHash(parentHash)
+        val parentWeight = blockchainReader.getChainWeightByHash(parentHash)
 
         parentWeight match {
 

src/main/scala/io/iohk/ethereum/ledger/BranchResolution.scala

@@ -4,12 +4,11 @@ import cats.data.NonEmptyList
 
 import io.iohk.ethereum.domain.Block
 import io.iohk.ethereum.domain.BlockHeader
-import io.iohk.ethereum.domain.Blockchain
 import io.iohk.ethereum.domain.BlockchainReader
 import io.iohk.ethereum.domain.ChainWeight
 import io.iohk.ethereum.utils.Logger
 
-class BranchResolution(blockchain: Blockchain, blockchainReader: BlockchainReader) extends Logger {
+class BranchResolution(blockchainReader: BlockchainReader) extends Logger {
 
   def resolveBranch(headers: NonEmptyList[BlockHeader]): BranchResolutionResult =
     if (!doHeadersFormChain(headers)) {
@@ -49,7 +48,7 @@ class BranchResolution(blockchain: Blockchain, blockchainReader: BlockchainReade
         .map(_.header)
         .orElse(newHeaders.headOption)
         .map { header =>
-          blockchain
+          blockchainReader
             .getChainWeightByHash(header.parentHash)
             .toRight(s"ChainWeight for ${header.idTag} not found when resolving branch: $newHeaders")
         }

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

@@ -19,7 +19,7 @@ case class EtcNodeStatus64ExchangeState(
 
   override protected def createStatusMsg(): MessageSerializable = {
     val bestBlockHeader = getBestBlockHeader()
-    val chainWeight = blockchain.getChainWeightByHash(bestBlockHeader.hash).get
+    val chainWeight = blockchainReader.getChainWeightByHash(bestBlockHeader.hash).get
 
     val status = ETC64.Status(
       protocolVersion = Capability.ETC64.version,

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

@@ -20,7 +20,7 @@ case class EthNodeStatus63ExchangeState(
 
   override protected def createStatusMsg(): MessageSerializable = {
     val bestBlockHeader = getBestBlockHeader()
-    val chainWeight = blockchain.getChainWeightByHash(bestBlockHeader.hash).get
+    val chainWeight = blockchainReader.getChainWeightByHash(bestBlockHeader.hash).get
 
     val status = BaseETH6XMessages.Status(
       protocolVersion = Capability.ETH63.version,

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

@@ -35,7 +35,7 @@ case class EthNodeStatus64ExchangeState(
 
   override protected def createStatusMsg(): MessageSerializable = {
     val bestBlockHeader = getBestBlockHeader()
-    val chainWeight = blockchain.getChainWeightByHash(bestBlockHeader.hash).get
+    val chainWeight = blockchainReader.getChainWeightByHash(bestBlockHeader.hash).get
     val genesisHash = blockchainReader.genesisHeader.hash
 
     val status = ETH64.Status(

src/test/scala/io/iohk/ethereum/consensus/ConsensusSpec.scala

@@ -133,7 +133,7 @@ class ConsensusSpec extends AnyFlatSpec with Matchers with ScalaFutures {
 
     setBlockExists(block, inChain = false, inQueue = false)
     setBestBlock(bestBlock)
-    (blockchain.getChainWeightByHash _).expects(*).returning(None)
+    (blockchainReader.getChainWeightByHash _).expects(*).returning(None)
 
     (blockchainReader.getBlockHeaderByHash _).expects(*).returning(Some(block.header))
 
@@ -191,7 +191,7 @@ class ConsensusSpec extends AnyFlatSpec with Matchers with ScalaFutures {
     blockchainWriter.save(blockData3.block, blockData3.receipts, blockData3.weight, saveAsBestBlock = true)
 
     blockchainReader.getBestBlock().get shouldEqual newBlock3
-    blockchain.getChainWeightByHash(newBlock3.header.hash) shouldEqual Some(newWeight3)
+    blockchainReader.getChainWeightByHash(newBlock3.header.hash) shouldEqual Some(newWeight3)
 
     blockQueue.isQueued(oldBlock2.header.hash) shouldBe true
     blockQueue.isQueued(oldBlock3.header.hash) shouldBe true
@@ -235,7 +235,7 @@ class ConsensusSpec extends AnyFlatSpec with Matchers with ScalaFutures {
     }
 
     blockchainReader.getBestBlock().get shouldEqual oldBlock3
-    blockchain.getChainWeightByHash(oldBlock3.header.hash) shouldEqual Some(oldWeight3)
+    blockchainReader.getChainWeightByHash(oldBlock3.header.hash) shouldEqual Some(oldWeight3)
 
     blockQueue.isQueued(newBlock2.header.hash) shouldBe true
     blockQueue.isQueued(newBlock3.header.hash) shouldBe false
@@ -348,7 +348,7 @@ class ConsensusSpec extends AnyFlatSpec with Matchers with ScalaFutures {
   it should "correctly import a checkpoint block" in new EphemBlockchain with CheckpointHelpers {
     val parentBlock: Block = getBlock(bestNum)
     val regularBlock: Block = getBlock(bestNum + 1, difficulty = 200, parent = parentBlock.hash)
-    val checkpointBlock: Block = getCheckpointBlock(parentBlock, difficulty = 100)
+    val checkpointBlock: Block = getCheckpointBlock(parentBlock)
 
     val weightParent = ChainWeight.totalDifficultyOnly(parentBlock.header.difficulty + 999)
     val weightRegular = weightParent.increase(regularBlock.header)
@@ -376,15 +376,15 @@ class ConsensusSpec extends AnyFlatSpec with Matchers with ScalaFutures {
     blockchainWriter.save(checkpointBlock, Nil, weightCheckpoint, saveAsBestBlock = true)
 
     blockchainReader.getBestBlock().get shouldEqual checkpointBlock
-    blockchain.getChainWeightByHash(checkpointBlock.hash) shouldEqual Some(weightCheckpoint)
+    blockchainReader.getChainWeightByHash(checkpointBlock.hash) shouldEqual Some(weightCheckpoint)
   }
 
   it should "not import a block with higher difficulty that does not follow a checkpoint" in new EphemBlockchain
     with CheckpointHelpers {
 
     val parentBlock: Block = getBlock(bestNum)
     val regularBlock: Block = getBlock(bestNum + 1, difficulty = 200, parent = parentBlock.hash)
-    val checkpointBlock: Block = getCheckpointBlock(parentBlock, difficulty = 100)
+    val checkpointBlock: Block = getCheckpointBlock(parentBlock)
 
     val weightParent = ChainWeight.totalDifficultyOnly(parentBlock.header.difficulty + 999)
     val weightCheckpoint = weightParent.increase(checkpointBlock.header)

src/test/scala/io/iohk/ethereum/ledger/BlockQueueSpec.scala

@@ -176,7 +176,7 @@ class BlockQueueSpec extends AnyFlatSpec with Matchers with MockFactory {
         block: Block,
         weight: Option[ChainWeight] = None
     ): CallHandler1[ByteString, Option[ChainWeight]] =
-      (blockchain.getChainWeightByHash _).expects(block.header.parentHash).returning(weight)
+      (blockchainReader.getChainWeightByHash _).expects(block.header.parentHash).returning(weight)
 
     def randomHash(): ByteString =
       ObjectGenerators.byteStringOfLengthNGen(32).sample.get