rename BlockchainBranch to Branch

Author: Aurélien Richez

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

@@ -26,7 +26,7 @@ import io.iohk.ethereum.db.storage.pruning.PruningMode
 import io.iohk.ethereum.domain.BlockHeader.HeaderExtraFields.HefEmpty
 import io.iohk.ethereum.domain.Blockchain
 import io.iohk.ethereum.domain._
-import io.iohk.ethereum.domain.branch.BlockchainBranch
+import io.iohk.ethereum.domain.branch.Branch
 import io.iohk.ethereum.jsonrpc.ProofService.EmptyStorageValueProof
 import io.iohk.ethereum.jsonrpc.ProofService.StorageProof
 import io.iohk.ethereum.jsonrpc.ProofService.StorageProofKey
@@ -102,7 +102,7 @@ object DumpChainApp
 
   val blockchain: Blockchain = new BlockchainMock(genesisHash)
   val blockchainReader: BlockchainReader = mock[BlockchainReader]
-  val bestChain: BlockchainBranch = mock[BlockchainBranch]
+  val bestChain: Branch = mock[Branch]
   (blockchainReader.getBestBranch _).expects().anyNumberOfTimes().returning(bestChain)
   (bestChain.getHashByBlockNumber _).expects(*).returning(Some(genesisHash))
 

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

@@ -8,9 +8,9 @@ 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.domain.branch.BestBlockchainBranch
-import io.iohk.ethereum.domain.branch.BlockchainBranch
-import io.iohk.ethereum.domain.branch.EmptyBlockchainBranch
+import io.iohk.ethereum.domain.branch.BestBranch
+import io.iohk.ethereum.domain.branch.Branch
+import io.iohk.ethereum.domain.branch.EmptyBranch$
 import io.iohk.ethereum.mpt.MptNode
 import io.iohk.ethereum.utils.Logger
 
@@ -71,16 +71,16 @@ class BlockchainReader(
   def getReceiptsByHash(blockhash: ByteString): Option[Seq[Receipt]] = receiptStorage.get(blockhash)
 
   /** get the current best stored branch */
-  def getBestBranch(): BlockchainBranch =
+  def getBestBranch(): Branch =
     getBestBlock()
       .map { block =>
-        new BestBlockchainBranch(
+        new BestBranch(
           block.header,
           blockNumberMappingStorage,
           this
         )
       }
-      .getOrElse(EmptyBlockchainBranch)
+      .getOrElse(EmptyBranch$)
 
   def getBestBlockNumber(): BigInt = {
     val bestSavedBlockNumber = appStateStorage.getBestBlockNumber()

src/main/scala/io/iohk/ethereum/domain/branch/BestBlockchainBranch.scala renamed to src/main/scala/io/iohk/ethereum/domain/branch/BestBranch.scala

@@ -9,11 +9,11 @@ import io.iohk.ethereum.domain.BlockchainReader
 /** A Branch instance which only works for the best canonical branch or a subset of this branch.
   * This implementation uses the existing storage indexes to access blocks by number more efficiently.
   */
-class BestBlockchainBranch(
+class BestBranch(
     tipBlockHeader: BlockHeader,
     bestChainBlockNumberMappingStorage: BlockNumberMappingStorage,
     blockchainReader: BlockchainReader
-) extends BlockchainBranch {
+) extends Branch {
 
   /* The following assumptions are made in this class :
    *  - The whole branch exists in storage

src/main/scala/io/iohk/ethereum/domain/branch/BlockchainBranch.scala renamed to src/main/scala/io/iohk/ethereum/domain/branch/Branch.scala

@@ -4,7 +4,8 @@ import akka.util.ByteString
 
 import io.iohk.ethereum.domain.Block
 
-trait BlockchainBranch {
+/** An interface to manipulate blockchain branches */
+trait Branch {
 
   /** Returns a block inside this branch based on its number */
   def getBlockByNumber(number: BigInt): Option[Block]

src/main/scala/io/iohk/ethereum/domain/branch/EmptyBlockchainBranch.scala renamed to src/main/scala/io/iohk/ethereum/domain/branch/EmptyBranch$.scala

@@ -3,7 +3,7 @@ import akka.util.ByteString
 
 import io.iohk.ethereum.domain.Block
 
-object EmptyBlockchainBranch extends BlockchainBranch {
+object EmptyBranch$ extends Branch {
 
   override def getBlockByNumber(number: BigInt): Option[Block] = None
 

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

@@ -23,7 +23,7 @@ import io.iohk.ethereum.domain.BlockBody
 import io.iohk.ethereum.domain.BlockchainImpl
 import io.iohk.ethereum.domain.BlockchainReader
 import io.iohk.ethereum.domain.Checkpoint
-import io.iohk.ethereum.domain.branch.BlockchainBranch
+import io.iohk.ethereum.domain.branch.Branch
 import io.iohk.ethereum.jsonrpc.CheckpointingService._
 import io.iohk.ethereum.ledger.BlockQueue
 
@@ -186,7 +186,7 @@ class CheckpointingServiceSpec
   trait TestSetup {
     val blockchain: BlockchainImpl = mock[BlockchainImpl]
     val blockchainReader: BlockchainReader = mock[BlockchainReader]
-    val bestChain: BlockchainBranch = mock[BlockchainBranch]
+    val bestChain: Branch = mock[Branch]
     (blockchainReader.getBestBranch _).expects().anyNumberOfTimes().returning(bestChain)
     val blockQueue: BlockQueue = mock[BlockQueue]
     val syncController: TestProbe = TestProbe()

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

@@ -32,7 +32,7 @@ import io.iohk.ethereum.consensus.validators.BlockHeaderValidator
 import io.iohk.ethereum.crypto.generateKeyPair
 import io.iohk.ethereum.crypto.kec256
 import io.iohk.ethereum.domain._
-import io.iohk.ethereum.domain.branch.BlockchainBranch
+import io.iohk.ethereum.domain.branch.Branch
 import io.iohk.ethereum.ledger.BlockExecutionError.ValidationAfterExecError
 import io.iohk.ethereum.ledger.PC
 import io.iohk.ethereum.ledger.PR
@@ -412,7 +412,7 @@ trait TestSetupWithVmAndValidators extends EphemBlockchainTestSetup {
 trait MockBlockchain extends MockFactory { self: TestSetupWithVmAndValidators =>
   //+ cake overrides
 
-  val bestChain: BlockchainBranch = mock[BlockchainBranch]
+  val bestChain: Branch = mock[Branch]
   override lazy val blockchainReader: BlockchainReader = mock[BlockchainReader]
   override lazy val blockchainWriter: BlockchainWriter = mock[BlockchainWriter]
   (blockchainReader.getBestBranch _).expects().anyNumberOfTimes().returning(bestChain)