make getBlockByNumber private in blockchain reader

Author: Aurélien Richez

src/main/scala/io/iohk/ethereum/consensus/pow/validators/OmmersValidator.scala

@@ -30,7 +30,7 @@ trait OmmersValidator {
 
     val getBlockHeaderByHash: ByteString => Option[BlockHeader] = blockchainReader.getBlockHeaderByHash
     val getNBlocksBack: (ByteString, Int) => List[Block] =
-      (_, n) => ((blockNumber - n) until blockNumber).toList.flatMap(blockchainReader.getBlockByNumber)
+      (_, n) => ((blockNumber - n) until blockNumber).toList.flatMap(blockchainReader.getBestBranch.getBlockByNumber)
 
     validate(parentHash, blockNumber, ommers, getBlockHeaderByHash, getNBlocksBack)
   }

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

@@ -139,7 +139,7 @@ class BlockchainImpl(
   override def isInChain(hash: ByteString): Boolean =
     (for {
       header <- blockchainReader.getBlockHeaderByHash(hash) if header.number <= blockchainReader.getBestBlockNumber()
-      hash <- blockchainReader.getHashByBlockNumber(header.number)
+      hash <- blockchainReader.getBestBranch().getHashByBlockNumber(header.number)
     } yield header.hash == hash).getOrElse(false)
 
   override def getChainWeightByHash(blockhash: ByteString): Option[ChainWeight] = chainWeightStorage.get(blockhash)
@@ -309,7 +309,7 @@ class BlockchainImpl(
     val latestCheckpointNumber = getLatestCheckpointBlockNumber()
 
     val blockNumberMappingUpdates =
-      if (blockchainReader.getHashByBlockNumber(block.number).contains(blockHash))
+      if (blockchainReader.getBestBranch().getHashByBlockNumber(block.number).contains(blockHash))
         removeBlockNumberMapping(block.number)
       else blockNumberMappingStorage.emptyBatchUpdate
 
@@ -378,7 +378,7 @@ class BlockchainImpl(
   ): BigInt =
     if (blockNumberToCheck > 0) {
       val maybePreviousCheckpointBlockNumber = for {
-        currentBlock <- blockchainReader.getBlockByNumber(blockNumberToCheck)
+        currentBlock <- blockchainReader.getBestBranch.getBlockByNumber(blockNumberToCheck)
         if currentBlock.hasCheckpoint &&
           currentBlock.number < latestCheckpointBlockNumber
       } yield currentBlock.number

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

@@ -50,31 +50,12 @@ class BlockchainReader(
       body <- getBlockBodyByHash(hash)
     } yield Block(header, body)
 
-  /** Returns a block hash given a block number
-    *
-    * @param number Number of the searchead block
-    * @return Block hash if found
-    */
-  def getHashByBlockNumber(number: BigInt): Option[ByteString] =
-    blockNumberMappingStorage.get(number)
-
   def getBlockHeaderByNumber(number: BigInt): Option[BlockHeader] =
     for {
       hash <- getHashByBlockNumber(number)
       header <- getBlockHeaderByHash(hash)
     } yield header
 
-  /** Allows to query for a block based on it's number
-    *
-    * @param number Block number
-    * @return Block if it exists
-    */
-  def getBlockByNumber(number: BigInt): Option[Block] =
-    for {
-      hash <- getHashByBlockNumber(number)
-      block <- getBlockByHash(hash)
-    } yield block
-
   /** Returns MPT node searched by it's hash
     * @param hash Node Hash
     * @return MPT node
@@ -124,7 +105,26 @@ class BlockchainReader(
     getBlockHeaderByNumber(0).get
 
   def genesisBlock: Block =
-    getBlockByNumber(0).get
+    getBestBranch().getBlockByNumber(0).get
+
+  /** Allows to query for a block based on it's number
+    *
+    * @param number Block number
+    * @return Block if it exists
+    */
+  private def getBlockByNumber(number: BigInt): Option[Block] =
+    for {
+      hash <- getHashByBlockNumber(number)
+      block <- getBlockByHash(hash)
+    } yield block
+
+  /** Returns a block hash given a block number
+    *
+    * @param number Number of the searchead block
+    * @return Block hash if found
+    */
+  private def getHashByBlockNumber(number: BigInt): Option[ByteString] =
+    blockNumberMappingStorage.get(number)
 }
 
 object BlockchainReader {

src/main/scala/io/iohk/ethereum/domain/branch/BestBlockchainBranch.scala

@@ -27,7 +27,7 @@ class BestBlockchainBranch(
   override def getBlockByNumber(number: BigInt): Option[Block] =
     if (tipBlockHeader.number <= number && number > 0) {
       for {
-        hash <- blockchainReader.getHashByBlockNumber(number)
+        hash <- getHashByBlockNumber(number)
         block <- blockchainReader.getBlockByHash(hash)
       } yield block
     } else None

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

@@ -36,7 +36,7 @@ class CheckpointingService(
       req.parentCheckpoint.forall(blockchainReader.getBlockHeaderByHash(_).exists(_.number < blockToReturnNum))
 
     Task {
-      blockchainReader.getBlockByNumber(blockToReturnNum)
+      blockchainReader.getBestBranch.getBlockByNumber(blockToReturnNum)
     }.flatMap {
       case Some(b) if isValidParent =>
         Task.now(Right(GetLatestBlockResponse(Some(BlockInfo(b.hash, b.number)))))

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

@@ -204,7 +204,7 @@ class EthProofService(
 
   private def resolveBlock(blockParam: BlockParam): Either[JsonRpcError, ResolvedBlock] = {
     def getBlock(number: BigInt): Either[JsonRpcError, Block] =
-      blockchainReader
+      blockchainReader.getBestBranch
         .getBlockByNumber(number)
         .toRight(JsonRpcError.InvalidParams(s"Block $number not found"))
 

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

@@ -157,7 +157,7 @@ class EthTxService(
 
     Task {
       val gasPrice = ((bestBlock - blockDifference) to bestBlock)
-        .flatMap(blockchainReader.getBlockByNumber)
+        .flatMap(blockchainReader.getBestBranch.getBlockByNumber)
         .flatMap(_.body.transactionList)
         .map(_.tx.gasPrice)
       if (gasPrice.nonEmpty) {

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

@@ -33,7 +33,7 @@ trait ResolveBlock {
     }
 
   private def getBlock(number: BigInt): Either[JsonRpcError, Block] =
-    blockchainReader
+    blockchainReader.getBestBranch
       .getBlockByNumber(number)
       .toRight(JsonRpcError.InvalidParams(s"Block $number not found"))
 

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

@@ -367,7 +367,7 @@ class TestService(
 
     val blockOpt = request.parameters.blockHashOrNumber
       .fold(
-        number => blockchainReader.getBlockByNumber(number),
+        number => blockchainReader.getBestBranch.getBlockByNumber(number),
         blockHash => blockchainReader.getBlockByHash(blockHash)
       )
 
@@ -406,7 +406,10 @@ class TestService(
   def storageRangeAt(request: StorageRangeRequest): ServiceResponse[StorageRangeResponse] = {
 
     val blockOpt = request.parameters.blockHashOrNumber
-      .fold(number => blockchainReader.getBlockByNumber(number), hash => blockchainReader.getBlockByHash(hash))
+      .fold(
+        number => blockchainReader.getBestBranch.getBlockByNumber(number),
+        hash => blockchainReader.getBlockByHash(hash)
+      )
 
     (for {
       block <- blockOpt.toRight(StorageRangeResponse(complete = false, Map.empty, None))

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

@@ -308,7 +308,7 @@ class BlockImport(
   private def removeBlocksUntil(parent: ByteString, fromNumber: BigInt): List[BlockData] = {
     @tailrec
     def removeBlocksUntil(parent: ByteString, fromNumber: BigInt, acc: List[BlockData]): List[BlockData] =
-      blockchainReader.getBlockByNumber(fromNumber) match {
+      blockchainReader.getBestBranch.getBlockByNumber(fromNumber) match {
         case Some(block) if block.header.hash == parent || fromNumber == 0 =>
           acc
 

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

@@ -41,7 +41,8 @@ class BlockValidation(
           val remaining = n - queuedBlocks.length - 1
 
           val numbers = (block.header.number - remaining) until block.header.number
-          val blocks = (numbers.toList.flatMap(blockchainReader.getBlockByNumber) :+ block) ::: queuedBlocks
+          val blocks =
+            (numbers.toList.flatMap(blockchainReader.getBestBranch.getBlockByNumber) :+ block) ::: queuedBlocks
           blocks
       }
     }

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

@@ -74,7 +74,7 @@ class BranchResolution(blockchain: Blockchain, blockchainReader: BlockchainReade
 
   private def getTopBlocksFromNumber(from: BigInt): List[Block] =
     (from to blockchainReader.getBestBlockNumber())
-      .flatMap(blockchainReader.getBlockByNumber)
+      .flatMap(blockchainReader.getBestBranch.getBlockByNumber)
       .toList
 }
 

src/main/scala/io/iohk/ethereum/testmode/TestEthBlockServiceWrapper.scala

@@ -75,7 +75,8 @@ class TestEthBlockServiceWrapper(
     .getBlockByNumber(request)
     .map(
       _.map { blockByBlockResponse =>
-        val fullBlock = blockchainReader.getBlockByNumber(blockByBlockResponse.blockResponse.get.number).get
+        val fullBlock =
+          blockchainReader.getBestBranch.getBlockByNumber(blockByBlockResponse.blockResponse.get.number).get
         BlockByNumberResponse(blockByBlockResponse.blockResponse.map(response => toEthResponse(fullBlock, response)))
       }
     )

src/main/scala/io/iohk/ethereum/transactions/TransactionHistoryService.scala

@@ -33,7 +33,7 @@ class TransactionHistoryService(
     val getLastCheckpoint = Task(blockchain.getLatestCheckpointBlockNumber()).memoizeOnSuccess
     val txnsFromBlocks = Observable
       .from(fromBlocks.reverse)
-      .mapParallelOrdered(10)(blockNr => Task(blockchainReader.getBlockByNumber(blockNr)))(
+      .mapParallelOrdered(10)(blockNr => Task(blockchainReader.getBestBranch.getBlockByNumber(blockNr)))(
         OverflowStrategy.Unbounded
       )
       .collect { case Some(block) => block }