ETCM-985 Remove method saveNode from Blockchain class and use StateStorage directly (#1042)

Author: Leonor Boga

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

@@ -34,7 +34,6 @@ import io.iohk.ethereum.consensus.pow.validators.StdOmmersValidator
 import io.iohk.ethereum.consensus.validators.Validators
 import io.iohk.ethereum.crypto
 import io.iohk.ethereum.domain._
-import io.iohk.ethereum.ledger.BlockResult
 import io.iohk.ethereum.mpt.MerklePatriciaTrie
 import io.iohk.ethereum.utils.Config
 import io.iohk.ethereum.utils.Config.SyncConfig
@@ -123,6 +122,7 @@ class BlockImporterItSpec
       blockImport,
       blockchain,
       blockchainReader,
+      storagesInstance.storages.stateStorage,
       new BranchResolution(blockchain, blockchainReader),
       syncConfig,
       ommersPoolProbe.ref,
@@ -167,6 +167,7 @@ class BlockImporterItSpec
         mkBlockImport(validators = successValidators),
         blockchain,
         blockchainReader,
+        storagesInstance.storages.stateStorage,
         new BranchResolution(blockchain, blockchainReader),
         syncConfig,
         ommersPoolProbe.ref,
@@ -280,6 +281,7 @@ class BlockImporterItSpec
         mkBlockImport(validators = successValidators),
         blockchain,
         blockchainReader,
+        storagesInstance.storages.stateStorage,
         new BranchResolution(blockchain, blockchainReader),
         syncConfig,
         ommersPoolProbe.ref,

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

@@ -38,6 +38,7 @@ object FastSyncItSpecUtils {
         blockchainReader,
         blockchainWriter,
         storagesInstance.storages.evmCodeStorage,
+        storagesInstance.storages.stateStorage,
         storagesInstance.storages.nodeStorage,
         validators,
         peerEventBus,

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

@@ -147,6 +147,7 @@ object RegularSyncItSpecUtils {
         blockImport,
         bl,
         blockchainReader,
+        storagesInstance.storages.stateStorage,
         new BranchResolution(bl, blockchainReader),
         syncConfig,
         ommersPool,
@@ -164,6 +165,7 @@ object RegularSyncItSpecUtils {
         blockImport,
         bl,
         blockchainReader,
+        storagesInstance.storages.stateStorage,
         new BranchResolution(bl, blockchainReader),
         validators.blockValidator,
         blacklist,

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

@@ -20,7 +20,6 @@ import io.iohk.ethereum.db.components.Storages
 import io.iohk.ethereum.db.components.Storages.PruningModeComponent
 import io.iohk.ethereum.db.storage.AppStateStorage
 import io.iohk.ethereum.db.storage.MptStorage
-import io.iohk.ethereum.db.storage.NodeStorage.NodeEncoded
 import io.iohk.ethereum.db.storage.NodeStorage.NodeHash
 import io.iohk.ethereum.db.storage.pruning.ArchivePruning
 import io.iohk.ethereum.db.storage.pruning.PruningMode
@@ -184,8 +183,6 @@ class BlockchainMock(genesisHash: ByteString) extends Blockchain {
       ethCompatibleStorage: Boolean
   ): StorageProof = EmptyStorageValueProof(StorageProofKey(position))
 
-  override def saveNode(nodeHash: NodeHash, nodeEncoded: NodeEncoded, blockNumber: BigInt): Unit = ???
-
   override def removeBlock(hash: ByteString, withState: Boolean = true): Unit = ???
 
   override def getChainWeightByHash(blockhash: ByteString): Option[ChainWeight] = ???

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

@@ -14,6 +14,7 @@ import io.iohk.ethereum.db.storage.AppStateStorage
 import io.iohk.ethereum.db.storage.EvmCodeStorage
 import io.iohk.ethereum.db.storage.FastSyncStateStorage
 import io.iohk.ethereum.db.storage.NodeStorage
+import io.iohk.ethereum.db.storage.StateStorage
 import io.iohk.ethereum.domain.Blockchain
 import io.iohk.ethereum.domain.BlockchainReader
 import io.iohk.ethereum.domain.BlockchainWriter
@@ -27,6 +28,7 @@ class SyncController(
     blockchainReader: BlockchainReader,
     blockchainWriter: BlockchainWriter,
     evmCodeStorage: EvmCodeStorage,
+    stateStorage: StateStorage,
     nodeStorage: NodeStorage,
     fastSyncStateStorage: FastSyncStateStorage,
     blockImport: BlockImport,
@@ -96,6 +98,7 @@ class SyncController(
         blockchainReader,
         blockchainWriter,
         evmCodeStorage,
+        stateStorage,
         nodeStorage,
         validators,
         peerEventBus,
@@ -121,6 +124,7 @@ class SyncController(
         blockImport,
         blockchain,
         blockchainReader,
+        stateStorage,
         new BranchResolution(blockchain, blockchainReader),
         validators.blockValidator,
         blacklist,
@@ -145,6 +149,7 @@ object SyncController {
       blockchainReader: BlockchainReader,
       blockchainWriter: BlockchainWriter,
       evmCodeStorage: EvmCodeStorage,
+      stateStorage: StateStorage,
       nodeStorage: NodeStorage,
       syncStateStorage: FastSyncStateStorage,
       blockImport: BlockImport,
@@ -163,6 +168,7 @@ object SyncController {
         blockchainReader,
         blockchainWriter,
         evmCodeStorage,
+        stateStorage,
         nodeStorage,
         syncStateStorage,
         blockImport,

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

@@ -38,6 +38,7 @@ import io.iohk.ethereum.db.storage.AppStateStorage
 import io.iohk.ethereum.db.storage.EvmCodeStorage
 import io.iohk.ethereum.db.storage.FastSyncStateStorage
 import io.iohk.ethereum.db.storage.NodeStorage
+import io.iohk.ethereum.db.storage.StateStorage
 import io.iohk.ethereum.domain._
 import io.iohk.ethereum.mpt.MerklePatriciaTrie
 import io.iohk.ethereum.network.EtcPeerManagerActor.PeerInfo
@@ -56,6 +57,7 @@ class FastSync(
     val blockchainReader: BlockchainReader,
     blockchainWriter: BlockchainWriter,
     evmCodeStorage: EvmCodeStorage,
+    stateStorage: StateStorage,
     nodeStorage: NodeStorage,
     val validators: Validators,
     val peerEventBus: ActorRef,
@@ -176,6 +178,7 @@ class FastSync(
             blockchain,
             blockchainReader,
             evmCodeStorage,
+            stateStorage,
             nodeStorage,
             syncConfig.stateSyncBloomFilterSize
           ),
@@ -1150,6 +1153,7 @@ object FastSync {
       blockchainReader: BlockchainReader,
       blockchainWriter: BlockchainWriter,
       evmCodeStorage: EvmCodeStorage,
+      stateStorage: StateStorage,
       nodeStorage: NodeStorage,
       validators: Validators,
       peerEventBus: ActorRef,
@@ -1166,6 +1170,7 @@ object FastSync {
         blockchainReader,
         blockchainWriter,
         evmCodeStorage,
+        stateStorage,
         nodeStorage,
         validators,
         peerEventBus,

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

@@ -21,6 +21,7 @@ import io.iohk.ethereum.blockchain.sync.fast.SyncStateScheduler._
 import io.iohk.ethereum.db.dataSource.RocksDbDataSource.IterationError
 import io.iohk.ethereum.db.storage.EvmCodeStorage
 import io.iohk.ethereum.db.storage.NodeStorage
+import io.iohk.ethereum.db.storage.StateStorage
 import io.iohk.ethereum.domain.Account
 import io.iohk.ethereum.domain.Blockchain
 import io.iohk.ethereum.domain.BlockchainReader
@@ -59,9 +60,9 @@ import io.iohk.ethereum.network.p2p.messages.ETH63.MptNodeEncoders.MptNodeDec
   * Important part is that nodes retrieved by getMissingNodes, must eventually be provided for scheduler to make progress
   */
 class SyncStateScheduler(
-    blockchain: Blockchain,
     blockchainReader: BlockchainReader,
     evmCodeStorage: EvmCodeStorage,
+    stateStorage: StateStorage,
     bloomFilter: LoadableBloomFilter[ByteString]
 ) {
 
@@ -133,7 +134,7 @@ class SyncStateScheduler(
       bloomFilter.put(hash)
       reqType match {
         case _: CodeRequest => evmCodeStorage.put(hash, data).commit()
-        case _: NodeRequest => blockchain.saveNode(hash, data.toArray, targetBlockNumber)
+        case _: NodeRequest => stateStorage.saveNode(hash, data.toArray, targetBlockNumber)
       }
     }
     newState
@@ -294,6 +295,7 @@ object SyncStateScheduler {
       blockchain: Blockchain,
       blockchainReader: BlockchainReader,
       evmCodeStorage: EvmCodeStorage,
+      stateStorage: StateStorage,
       nodeStorage: NodeStorage,
       expectedBloomFilterSize: Int
   ): SyncStateScheduler = {
@@ -304,9 +306,9 @@ object SyncStateScheduler {
         .takeWhileInclusive(_.isRight)
 
     new SyncStateScheduler(
-      blockchain,
       blockchainReader,
       evmCodeStorage,
+      stateStorage,
       LoadableBloomFilter[ByteString](expectedBloomFilterSize, mptStateSavedKeys)
     )
   }

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

@@ -21,6 +21,7 @@ import io.iohk.ethereum.blockchain.sync.regular.BlockBroadcast.BlockToBroadcast
 import io.iohk.ethereum.blockchain.sync.regular.BlockBroadcasterActor.BroadcastBlocks
 import io.iohk.ethereum.blockchain.sync.regular.RegularSync.ProgressProtocol
 import io.iohk.ethereum.crypto.kec256
+import io.iohk.ethereum.db.storage.StateStorage
 import io.iohk.ethereum.domain._
 import io.iohk.ethereum.ledger._
 import io.iohk.ethereum.mpt.MerklePatriciaTrie.MissingNodeException
@@ -38,6 +39,7 @@ class BlockImporter(
     blockImport: BlockImport,
     blockchain: Blockchain,
     blockchainReader: BlockchainReader,
+    stateStorage: StateStorage,
     branchResolution: BranchResolution,
     syncConfig: SyncConfig,
     ommersPool: ActorRef,
@@ -116,7 +118,7 @@ class BlockImporter(
       state: ImporterState
   ): Receive = { case BlockFetcher.FetchedStateNode(nodeData) =>
     val node = nodeData.values.head
-    blockchain.saveNode(kec256(node), node.toArray, blocksToRetry.head.number)
+    stateStorage.saveNode(kec256(node), node.toArray, blocksToRetry.head.number)
     importBlocks(blocksToRetry, blockImportType)(state)
   }
 
@@ -328,6 +330,7 @@ object BlockImporter {
       blockImport: BlockImport,
       blockchain: Blockchain,
       blockchainReader: BlockchainReader,
+      stateStorage: StateStorage,
       branchResolution: BranchResolution,
       syncConfig: SyncConfig,
       ommersPool: ActorRef,
@@ -341,6 +344,7 @@ object BlockImporter {
         blockImport,
         blockchain,
         blockchainReader,
+        stateStorage,
         branchResolution,
         syncConfig,
         ommersPool,

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

@@ -20,6 +20,7 @@ import io.iohk.ethereum.blockchain.sync.regular.RegularSync.NewCheckpoint
 import io.iohk.ethereum.blockchain.sync.regular.RegularSync.ProgressProtocol
 import io.iohk.ethereum.blockchain.sync.regular.RegularSync.ProgressState
 import io.iohk.ethereum.consensus.validators.BlockValidator
+import io.iohk.ethereum.db.storage.StateStorage
 import io.iohk.ethereum.domain.Block
 import io.iohk.ethereum.domain.Blockchain
 import io.iohk.ethereum.domain.BlockchainReader
@@ -35,6 +36,7 @@ class RegularSync(
     blockImport: BlockImport,
     blockchain: Blockchain,
     blockchainReader: BlockchainReader,
+    stateStorage: StateStorage,
     branchResolution: BranchResolution,
     blockValidator: BlockValidator,
     blacklist: Blacklist,
@@ -65,6 +67,7 @@ class RegularSync(
         blockImport,
         blockchain,
         blockchainReader,
+        stateStorage,
         branchResolution,
         syncConfig,
         ommersPool,
@@ -137,6 +140,7 @@ object RegularSync {
       blockImport: BlockImport,
       blockchain: Blockchain,
       blockchainReader: BlockchainReader,
+      stateStorage: StateStorage,
       branchResolution: BranchResolution,
       blockValidator: BlockValidator,
       blacklist: Blacklist,
@@ -153,6 +157,7 @@ object RegularSync {
         blockImport,
         blockchain,
         blockchainReader,
+        stateStorage,
         branchResolution,
         blockValidator,
         blacklist,

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

@@ -8,8 +8,6 @@ import cats.syntax.flatMap._
 import scala.annotation.tailrec
 
 import io.iohk.ethereum.db.dataSource.DataSourceBatchUpdate
-import io.iohk.ethereum.db.storage.NodeStorage.NodeEncoded
-import io.iohk.ethereum.db.storage.NodeStorage.NodeHash
 import io.iohk.ethereum.db.storage._
 import io.iohk.ethereum.domain
 import io.iohk.ethereum.jsonrpc.ProofService.StorageProof
@@ -80,8 +78,6 @@ trait Blockchain {
 
   def saveBestKnownBlocks(bestBlockNumber: BigInt, latestCheckpointNumber: Option[BigInt] = None): Unit
 
-  def saveNode(nodeHash: NodeHash, nodeEncoded: NodeEncoded, blockNumber: BigInt): Unit
-
   /** 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
@@ -203,9 +199,6 @@ class BlockchainImpl(
       BestBlockLatestCheckpointNumbers(number, latestCheckpointNumber)
     )
 
-  def saveNode(nodeHash: NodeHash, nodeEncoded: NodeEncoded, blockNumber: BigInt): Unit =
-    stateStorage.saveNode(nodeHash, nodeEncoded, blockNumber)
-
   private def removeBlockNumberMapping(number: BigInt): DataSourceBatchUpdate =
     blockNumberMappingStorage.remove(number)
 

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

@@ -796,6 +796,7 @@ trait SyncControllerBuilder {
       blockchainReader,
       blockchainWriter,
       storagesInstance.storages.evmCodeStorage,
+      storagesInstance.storages.stateStorage,
       storagesInstance.storages.nodeStorage,
       storagesInstance.storages.fastSyncStateStorage,
       blockImport,

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

@@ -83,6 +83,7 @@ class FastSyncSpec
         blockchainWriter = blockchainWriter,
         evmCodeStorage = storagesInstance.storages.evmCodeStorage,
         nodeStorage = storagesInstance.storages.nodeStorage,
+        stateStorage = storagesInstance.storages.stateStorage,
         validators = validators,
         peerEventBus = peerEventBus.ref,
         etcPeerManager = etcPeerManager.ref,

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

@@ -257,6 +257,7 @@ class StateSyncSpec
             blockchain,
             blockchainReader,
             getNewStorages.storages.evmCodeStorage,
+            getNewStorages.storages.stateStorage,
             getNewStorages.storages.nodeStorage,
             syncConfig.stateSyncBloomFilterSize
           ),

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

@@ -546,6 +546,7 @@ class SyncControllerSpec
           blockchainReader,
           blockchainWriter,
           storagesInstance.storages.evmCodeStorage,
+          storagesInstance.storages.stateStorage,
           storagesInstance.storages.nodeStorage,
           storagesInstance.storages.fastSyncStateStorage,
           blockImport,

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

@@ -308,6 +308,7 @@ class SyncStateSchedulerSpec
           freshBlockchain,
           freshBlockchainReader,
           freshStorage.storages.evmCodeStorage,
+          freshStorage.storages.stateStorage,
           freshStorage.storages.nodeStorage,
           bloomFilterSize
         ),

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

@@ -33,6 +33,7 @@ import org.scalatest.matchers.should.Matchers
 import io.iohk.ethereum.BlockHelpers
 import io.iohk.ethereum.blockchain.sync._
 import io.iohk.ethereum.consensus.blocks.CheckpointBlockGenerator
+import io.iohk.ethereum.db.storage.StateStorage
 import io.iohk.ethereum.domain.BlockHeaderImplicits._
 import io.iohk.ethereum.domain._
 import io.iohk.ethereum.ledger._
@@ -75,6 +76,8 @@ trait RegularSyncFixtures { self: Matchers with AsyncMockFactory =>
     val blacklist: CacheBasedBlacklist = CacheBasedBlacklist.empty(100)
     lazy val branchResolution = new BranchResolution(blockchain, blockchainReader)
 
+    val stateStorage: StateStorage = stub[StateStorage]
+
     lazy val regularSync: ActorRef = system.actorOf(
       RegularSync
         .props(
@@ -84,6 +87,7 @@ trait RegularSyncFixtures { self: Matchers with AsyncMockFactory =>
           blockImport,
           blockchain,
           blockchainReader,
+          stateStorage,
           branchResolution,
           validators.blockValidator,
           blacklist,

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

@@ -473,6 +473,7 @@ class RegularSyncSpec
         val failingBlock: Block = testBlocksChunked.head.head
         peersClient.setAutoPilot(new PeersClientAutoPilot)
         override lazy val branchResolution: BranchResolution = stub[BranchResolution]
+        (blockchainReader.getBestBlockNumber _).when().returns(0)
         (branchResolution.resolveBranch _).when(*).returns(NewBetterBranch(Nil)).repeat(10)
         (blockImport
           .importBlock(_: Block)(_: Scheduler))
@@ -483,7 +484,7 @@ class RegularSyncSpec
         val nodeData = List(ByteString(failingBlock.header.toBytes: Array[Byte]))
         (blockchainReader.getBestBlockNumber _).when().returns(0)
         (blockchainReader.getBlockHeaderByNumber _).when(*).returns(Some(BlockHelpers.genesis.header))
-        (blockchain.saveNode _)
+        (stateStorage.saveNode _)
           .when(*, *, *)
           .onCall { (hash, encoded, totalDifficulty) =>
             val expectedNode = nodeData.head