move genesisHeader and genesisBlock to BlockchainReader

Author: Aurélien Richez

src/it/scala/io/iohk/ethereum/ledger/BlockImporterItSpec.scala

@@ -132,7 +132,7 @@ class BlockImporterItSpec
     )
   )
 
-  val genesisBlock = blockchain.genesisBlock
+  val genesisBlock = blockchainReader.genesisBlock
   val block1: Block = getBlock(genesisBlock.number + 1, parent = genesisBlock.header.hash)
   // new chain is shorter but has a higher weight
   val newBlock2: Block = getBlock(genesisBlock.number + 2, difficulty = 108, parent = block1.header.hash)

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

@@ -210,10 +210,6 @@ class BlockchainMock(genesisHash: ByteString) extends Blockchain {
 
   override def isInChain(hash: NodeHash): Boolean = ???
 
-  override def genesisHeader: BlockHeader = ???
-
-  override def genesisBlock: Block = ???
-
   override def getBackingMptStorage(blockNumber: BigInt): MptStorage = ???
 
   override def getReadOnlyMptStorage(): MptStorage = ???

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

@@ -82,10 +82,6 @@ trait Blockchain {
 
   def saveNode(nodeHash: NodeHash, nodeEncoded: NodeEncoded, blockNumber: BigInt): Unit
 
-  def genesisHeader: BlockHeader
-
-  def genesisBlock: Block
-
   /** Strict check if given block hash is in chain
     * Using any of getXXXByHash is not always accurate - after restart the best block is often lower than before restart
     * The result of that is returning data of blocks which we don't consider as a part of the chain anymore
@@ -210,10 +206,6 @@ class BlockchainImpl(
   def saveNode(nodeHash: NodeHash, nodeEncoded: NodeEncoded, blockNumber: BigInt): Unit =
     stateStorage.saveNode(nodeHash, nodeEncoded, blockNumber)
 
-  def genesisHeader: BlockHeader = blockchainReader.getBlockHeaderByNumber(0).get
-
-  def genesisBlock: Block = blockchainReader.getBlockByNumber(0).get
-
   private def removeBlockNumberMapping(number: BigInt): DataSourceBatchUpdate =
     blockNumberMappingStorage.remove(number)
 

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

@@ -110,6 +110,12 @@ class BlockchainReader(
       )
     )
   }
+
+  def genesisHeader: BlockHeader =
+    getBlockHeaderByNumber(0).get
+
+  def genesisBlock: Block =
+    getBlockByNumber(0).get
 }
 
 object BlockchainReader {

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

@@ -20,7 +20,6 @@ import io.iohk.ethereum.consensus.pow.miners.MockedMiner.MockedMinerResponses._
 import io.iohk.ethereum.crypto
 import io.iohk.ethereum.crypto.ECDSASignature
 import io.iohk.ethereum.domain.Block
-import io.iohk.ethereum.domain.Blockchain
 import io.iohk.ethereum.domain.BlockchainReader
 import io.iohk.ethereum.domain.Checkpoint
 import io.iohk.ethereum.jsonrpc.QAService.MineBlocksResponse.MinerResponseType
@@ -30,7 +29,6 @@ import io.iohk.ethereum.utils.Logger
 
 class QAService(
     consensus: Consensus,
-    blockchain: Blockchain,
     blockchainReader: BlockchainReader,
     checkpointBlockGenerator: CheckpointBlockGenerator,
     blockchainConfig: BlockchainConfig,
@@ -62,7 +60,7 @@ class QAService(
             blockchainReader
               .getBlockByHash(hashValue)
               .orElse(blockchainReader.getBestBlock())
-              .getOrElse(blockchain.genesisBlock)
+              .getOrElse(blockchainReader.genesisBlock)
           val checkpoint = generateCheckpoint(hashValue, req.privateKeys)
           val checkpointBlock: Block = checkpointBlockGenerator.generate(parent, checkpoint)
           syncController ! NewCheckpoint(checkpointBlock)

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

@@ -185,7 +185,7 @@ class TestService(
     resetPreimages(genesisData)
 
     // remove current genesis (Try because it may not exist)
-    Try(blockchain.removeBlock(blockchain.genesisHeader.hash, withState = false))
+    Try(blockchain.removeBlock(blockchainReader.genesisHeader.hash, withState = false))
     // TODO clear the storage ? When relaunching some tests on the same running test mantis client,
     // we end up with duplicate blocks because they are still present in the storage layer
     // for example: bcMultiChainTest/ChainAtoChainB_BlockHash_Istanbul

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

@@ -16,7 +16,7 @@ class BranchResolution(blockchain: Blockchain, blockchainReader: BlockchainReade
       InvalidBranch
     } else {
       val knownParentOrGenesis = blockchain
-        .isInChain(headers.head.parentHash) || headers.head.hash == blockchain.genesisHeader.hash
+        .isInChain(headers.head.parentHash) || headers.head.hash == blockchainReader.genesisHeader.hash
 
       if (!knownParentOrGenesis)
         UnknownBranch

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

@@ -27,7 +27,7 @@ case class EtcNodeStatus63ExchangeState(
       networkId = peerConfiguration.networkId,
       totalDifficulty = chainWeight.totalDifficulty,
       bestHash = bestBlockHeader.hash,
-      genesisHash = blockchain.genesisHeader.hash
+      genesisHash = blockchainReader.genesisHeader.hash
     )
 
     log.debug(s"sending status $status")

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

@@ -26,7 +26,7 @@ case class EtcNodeStatus64ExchangeState(
       networkId = peerConfiguration.networkId,
       chainWeight = chainWeight,
       bestHash = bestBlockHeader.hash,
-      genesisHash = blockchain.genesisHeader.hash
+      genesisHash = blockchainReader.genesisHeader.hash
     )
 
     log.debug(s"sending status $status")

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

@@ -31,7 +31,7 @@ trait EtcNodeStatusExchangeState[T <: Message] extends InProgressState[PeerInfo]
     log.debug("Peer returned status ({})", status)
 
     val validNetworkID = status.networkId == handshakerConfiguration.peerConfiguration.networkId
-    val validGenesisHash = status.genesisHash == blockchain.genesisHeader.hash
+    val validGenesisHash = status.genesisHash == blockchainReader.genesisHeader.hash
 
     if (validNetworkID && validGenesisHash) {
       forkResolverOpt match {
@@ -46,7 +46,7 @@ trait EtcNodeStatusExchangeState[T <: Message] extends InProgressState[PeerInfo]
 
   protected def getBestBlockHeader(): BlockHeader = {
     val bestBlockNumber = blockchainReader.getBestBlockNumber()
-    blockchainReader.getBlockHeaderByNumber(bestBlockNumber).getOrElse(blockchain.genesisHeader)
+    blockchainReader.getBlockHeaderByNumber(bestBlockNumber).getOrElse(blockchainReader.genesisHeader)
   }
 
   protected def createStatusMsg(): MessageSerializable

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

@@ -592,7 +592,6 @@ trait QaServiceBuilder {
   lazy val qaService =
     new QAService(
       consensus,
-      blockchain,
       blockchainReader,
       checkpointBlockGenerator,
       blockchainConfig,

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

@@ -236,7 +236,10 @@ class BlockchainHostActorSpec extends AnyFlatSpec with Matchers {
 
     //then
     etcPeerManager.expectMsg(
-      EtcPeerManagerActor.SendMessage(BlockHeaders(Seq(firstHeader, secondHeader, blockchain.genesisHeader)), peerId)
+      EtcPeerManagerActor.SendMessage(
+        BlockHeaders(Seq(firstHeader, secondHeader, blockchainReader.genesisHeader)),
+        peerId
+      )
     )
   }
 

src/test/scala/io/iohk/ethereum/jsonrpc/QAServiceSpec.scala

@@ -115,7 +115,6 @@ class QAServiceSpec
 
     lazy val qaService = new QAService(
       testConsensus,
-      blockchain,
       blockchainReader,
       checkpointBlockGenerator,
       blockchainConfig,

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

@@ -458,7 +458,7 @@ trait MockBlockchain extends MockFactory { self: TestSetupWithVmAndValidators =>
     (blockchainReader.getBlockByNumber _).expects(number).returning(block)
 
   def setGenesisHeader(header: BlockHeader): Unit =
-    (() => blockchain.genesisHeader).expects().returning(header)
+    (() => blockchainReader.genesisHeader).expects().returning(header)
 }
 
 trait EphemBlockchain extends TestSetupWithVmAndValidators with MockFactory {

src/test/scala/io/iohk/ethereum/network/EtcPeerManagerSpec.scala

@@ -113,7 +113,10 @@ class EtcPeerManagerSpec extends AnyFlatSpec with Matchers {
     val secondHeader: BlockHeader = baseBlockHeader.copy(number = peer1Info.maxBlockNumber + 2)
 
     //when
-    peersInfoHolder ! MessageFromPeer(BlockHeaders(Seq(firstHeader, secondHeader, blockchain.genesisHeader)), peer1.id)
+    peersInfoHolder ! MessageFromPeer(
+      BlockHeaders(Seq(firstHeader, secondHeader, blockchainReader.genesisHeader)),
+      peer1.id
+    )
 
     //then
     requestSender.send(peersInfoHolder, PeerInfoRequest(peer1.id))