ETCM-944 - Refactoring - extract methods getWorldStateProxy and getReadOnlyWorldStateProxy from Blockchain

Author: Leonor Boga

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

@@ -59,14 +59,15 @@ class BlockImporterItSpec
   val pendingTransactionsManagerProbe = TestProbe()
   val supervisor = TestProbe()
 
-  val emptyWorld: InMemoryWorldStateProxy =
-    blockchain.getWorldStateProxy(
-      -1,
-      UInt256.Zero,
-      ByteString(MerklePatriciaTrie.EmptyRootHash),
-      noEmptyAccounts = false,
-      ethCompatibleStorage = true
-    )
+  val emptyWorld = InMemoryWorldStateProxy(
+    storagesInstance.storages.evmCodeStorage,
+    blockchain.getBackingStorage(-1),
+    blockchain,
+    blockchainConfig.accountStartNonce,
+    ByteString(MerklePatriciaTrie.EmptyRootHash),
+    noEmptyAccounts = false,
+    ethCompatibleStorage = true
+  )
 
   override protected lazy val successValidators: Validators = new Mocks.MockValidatorsAlwaysSucceed {
     override val ommersValidator: OmmersValidator = (
@@ -82,7 +83,13 @@ class BlockImporterItSpec
 
   override lazy val ledger = new TestLedgerImpl(successValidators) {
     override private[ledger] lazy val blockExecution =
-      new BlockExecution(blockchain, blockchainConfig, consensus.blockPreparator, blockValidation) {
+      new BlockExecution(
+        blockchain,
+        storagesInstance.storages.evmCodeStorage,
+        blockchainConfig,
+        consensus.blockPreparator,
+        blockValidation
+      ) {
         override def executeAndValidateBlock(
             block: Block,
             alreadyValidated: Boolean = false

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

@@ -14,7 +14,7 @@ import io.iohk.ethereum.db.components.{RocksDbDataSourceComponent, Storages}
 import io.iohk.ethereum.db.dataSource.{RocksDbConfig, RocksDbDataSource}
 import io.iohk.ethereum.db.storage.pruning.{ArchivePruning, PruningMode}
 import io.iohk.ethereum.db.storage.{AppStateStorage, Namespaces}
-import io.iohk.ethereum.domain.{Block, Blockchain, BlockchainImpl, ChainWeight}
+import io.iohk.ethereum.domain.{Block, Blockchain, BlockchainImpl, ChainWeight, UInt256}
 import io.iohk.ethereum.security.SecureRandomBuilder
 import io.iohk.ethereum.ledger.InMemoryWorldStateProxy
 import io.iohk.ethereum.mpt.MerklePatriciaTrie
@@ -241,10 +241,12 @@ abstract class CommonFakePeer(peerName: String, fakePeerCustomConfig: FakePeerCu
   )
 
   private def getMptForBlock(block: Block) = {
-    bl.getWorldStateProxy(
-      blockNumber = block.number,
-      accountStartNonce = blockchainConfig.accountStartNonce,
-      stateRootHash = block.header.stateRoot,
+    InMemoryWorldStateProxy(
+      storagesInstance.storages.evmCodeStorage,
+      bl.getBackingStorage(block.number),
+      bl,
+      blockchainConfig.accountStartNonce,
+      block.header.stateRoot,
       noEmptyAccounts = EvmConfig.forBlock(block.number, blockchainConfig).noEmptyAccounts,
       ethCompatibleStorage = blockchainConfig.ethCompatibleStorage
     )

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

@@ -32,11 +32,11 @@ import io.iohk.ethereum.sync.util.SyncCommonItSpecUtils.FakePeerCustomConfig.def
 import io.iohk.ethereum.sync.util.SyncCommonItSpecUtils._
 import io.iohk.ethereum.transactions.PendingTransactionsManager
 import io.iohk.ethereum.utils._
-import io.iohk.ethereum.vm.EvmConfig
 import monix.eval.Task
 import monix.execution.Scheduler
 import akka.actor.typed.scaladsl.adapter._
 import io.iohk.ethereum.blockchain.sync.regular.BlockFetcher.AdaptedMessageFromEventBus
+import io.iohk.ethereum.mpt.MerklePatriciaTrie
 
 import scala.concurrent.duration._
 object RegularSyncItSpecUtils {
@@ -61,7 +61,15 @@ object RegularSyncItSpecUtils {
       val fullConfig = FullConsensusConfig(consensusConfig, specificConfig)
       val vm = VmSetup.vm(VmConfig(config), blockchainConfig, testMode = false)
       val consensus =
-        PoWConsensus(vm, bl, blockchainConfig, fullConfig, ValidatorsExecutorAlwaysSucceed, NoAdditionalPoWData)
+        PoWConsensus(
+          vm,
+          storagesInstance.storages.evmCodeStorage,
+          bl,
+          blockchainConfig,
+          fullConfig,
+          ValidatorsExecutorAlwaysSucceed,
+          NoAdditionalPoWData
+        )
       consensus
     }
 
@@ -73,7 +81,14 @@ object RegularSyncItSpecUtils {
       )
 
     lazy val ledger: Ledger =
-      new LedgerImpl(bl, blockchainConfig, syncConfig, buildEthashConsensus(), Scheduler.global)
+      new LedgerImpl(
+        bl,
+        storagesInstance.storages.evmCodeStorage,
+        blockchainConfig,
+        syncConfig,
+        buildEthashConsensus(),
+        Scheduler.global
+      )
 
     lazy val ommersPool: ActorRef = system.actorOf(OmmersPool.props(bl, 1), "ommers-pool")
 
@@ -197,12 +212,14 @@ object RegularSyncItSpecUtils {
     }
 
     private def getMptForBlock(block: Block) = {
-      bl.getWorldStateProxy(
-        blockNumber = block.number,
-        accountStartNonce = blockchainConfig.accountStartNonce,
-        stateRootHash = block.header.stateRoot,
-        noEmptyAccounts = EvmConfig.forBlock(block.number, blockchainConfig).noEmptyAccounts,
-        ethCompatibleStorage = blockchainConfig.ethCompatibleStorage
+      InMemoryWorldStateProxy(
+        storagesInstance.storages.evmCodeStorage,
+        bl.getBackingStorage(block.number),
+        bl,
+        UInt256.Zero,
+        ByteString(MerklePatriciaTrie.EmptyRootHash),
+        noEmptyAccounts = false,
+        ethCompatibleStorage = true
       )
     }
 

src/it/scala/io/iohk/ethereum/txExecTest/ContractTest.scala

@@ -1,8 +1,7 @@
 package io.iohk.ethereum.txExecTest
 
 import java.util.concurrent.Executors
-
-import io.iohk.ethereum.domain.Receipt
+import io.iohk.ethereum.domain.{BlockchainImpl, BlockchainStorages, Receipt}
 import io.iohk.ethereum.ledger.{BlockExecution, BlockQueue, BlockValidation, Ledger}
 import io.iohk.ethereum.txExecTest.util.FixtureProvider
 import io.iohk.ethereum.utils.Config
@@ -18,47 +17,28 @@ class ContractTest extends AnyFlatSpec with Matchers {
   val ec = ExecutionContext.fromExecutor(Executors.newFixedThreadPool(4))
   val noErrors = a[Right[_, Seq[Receipt]]]
 
-  "Ledger" should "transfer ether" in new ScenarioSetup {
+  "Ledger" should "execute and validate" in new ScenarioSetup {
     val fixtures: FixtureProvider.Fixture = FixtureProvider.loadFixtures("/txExecTest/purchaseContract")
-
-    val testBlockchainStorages = FixtureProvider.prepareStorages(0, fixtures)
+    val testBlockchainStorages = FixtureProvider.prepareStorages(2, fixtures)
 
     //block only with ether transfers
     val blockValidation = new BlockValidation(consensus, blockchain, BlockQueue(blockchain, syncConfig))
-    val blockExecution = new BlockExecution(blockchain, blockchainConfig, consensus.blockPreparator, blockValidation)
+    val blockExecution = new BlockExecution(
+      blockchain,
+      testBlockchainStorages.evmCodeStorage,
+      blockchainConfig,
+      consensus.blockPreparator,
+      blockValidation
+    )
+
+    // transfer ether
     blockExecution.executeAndValidateBlock(fixtures.blockByNumber(1)) shouldBe noErrors
-  }
-
-  it should "deploy contract" in new ScenarioSetup {
-    val fixtures: FixtureProvider.Fixture = FixtureProvider.loadFixtures("/txExecTest/purchaseContract")
 
-    val testBlockchainStorages = FixtureProvider.prepareStorages(1, fixtures)
-
-    //contract creation
-    val blockValidation = new BlockValidation(consensus, blockchain, BlockQueue(blockchain, syncConfig))
-    val blockExecution = new BlockExecution(blockchain, blockchainConfig, consensus.blockPreparator, blockValidation)
+    // deploy contract
     blockExecution.executeAndValidateBlock(fixtures.blockByNumber(2)) shouldBe noErrors
-  }
-
-  it should "execute contract call" in new ScenarioSetup {
-    val fixtures: FixtureProvider.Fixture = FixtureProvider.loadFixtures("/txExecTest/purchaseContract")
 
-    val testBlockchainStorages = FixtureProvider.prepareStorages(2, fixtures)
-
-    //block with ether transfers and contract call
-    val blockValidation = new BlockValidation(consensus, blockchain, BlockQueue(blockchain, syncConfig))
-    val blockExecution = new BlockExecution(blockchain, blockchainConfig, consensus.blockPreparator, blockValidation)
-    blockExecution.executeAndValidateBlock(fixtures.blockByNumber(3)) shouldBe noErrors
-  }
-
-  it should "execute contract that pays 2 accounts" in new ScenarioSetup {
-    val fixtures: FixtureProvider.Fixture = FixtureProvider.loadFixtures("/txExecTest/purchaseContract")
-
-    val testBlockchainStorages = FixtureProvider.prepareStorages(2, fixtures)
-
-    //block contains contract paying 2 accounts
-    val blockValidation = new BlockValidation(consensus, blockchain, BlockQueue(blockchain, syncConfig))
-    val blockExecution = new BlockExecution(blockchain, blockchainConfig, consensus.blockPreparator, blockValidation)
+    // execute contract call
+    // execute contract that pays 2 accounts
     blockExecution.executeAndValidateBlock(fixtures.blockByNumber(3)) shouldBe noErrors
   }
 }

src/it/scala/io/iohk/ethereum/txExecTest/ECIP1017Test.scala

@@ -78,7 +78,13 @@ class ECIP1017Test extends AnyFlatSpec with Matchers {
       val storages = FixtureProvider.prepareStorages(blockToExecute - 1, fixtures)
       val blockchain = BlockchainImpl(storages)
       val blockValidation = new BlockValidation(consensus, blockchain, BlockQueue(blockchain, syncConfig))
-      val blockExecution = new BlockExecution(blockchain, blockchainConfig, consensus.blockPreparator, blockValidation)
+      val blockExecution = new BlockExecution(
+        blockchain,
+        testBlockchainStorages.evmCodeStorage,
+        blockchainConfig,
+        consensus.blockPreparator,
+        blockValidation
+      )
       blockExecution.executeAndValidateBlock(fixtures.blockByNumber(blockToExecute)) shouldBe noErrors
     }
   }

src/it/scala/io/iohk/ethereum/txExecTest/ForksTest.scala

@@ -69,7 +69,13 @@ class ForksTest extends AnyFlatSpec with Matchers {
       val storages = FixtureProvider.prepareStorages(blockToExecute - 1, fixtures)
       val blockchain = BlockchainImpl(storages)
       val blockValidation = new BlockValidation(consensus, blockchain, BlockQueue(blockchain, syncConfig))
-      val blockExecution = new BlockExecution(blockchain, blockchainConfig, consensus.blockPreparator, blockValidation)
+      val blockExecution = new BlockExecution(
+        blockchain,
+        testBlockchainStorages.evmCodeStorage,
+        blockchainConfig,
+        consensus.blockPreparator,
+        blockValidation
+      )
       blockExecution.executeAndValidateBlock(fixtures.blockByNumber(blockToExecute)) shouldBe noErrors
     }
   }

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

@@ -12,7 +12,7 @@ import io.iohk.ethereum.db.dataSource.{DataSourceBatchUpdate, RocksDbDataSource}
 import io.iohk.ethereum.db.storage.NodeStorage.{NodeEncoded, NodeHash}
 import io.iohk.ethereum.db.storage.TransactionMappingStorage.TransactionLocation
 import io.iohk.ethereum.db.storage.pruning.{ArchivePruning, PruningMode}
-import io.iohk.ethereum.db.storage.{AppStateStorage, StateStorage}
+import io.iohk.ethereum.db.storage.{AppStateStorage, MptStorage, StateStorage}
 import io.iohk.ethereum.domain.BlockHeader.HeaderExtraFields.HefEmpty
 import io.iohk.ethereum.domain.{Blockchain, UInt256, _}
 import io.iohk.ethereum.jsonrpc.ProofService.{EmptyStorageValueProof, StorageProof, StorageProofKey, StorageValueProof}
@@ -190,22 +190,6 @@ class BlockchainMock(genesisHash: ByteString) extends Blockchain {
   override type S = InMemoryWorldStateProxyStorage
   override type WS = InMemoryWorldStateProxy
 
-  override def getWorldStateProxy(
-      blockNumber: BigInt,
-      accountStartNonce: UInt256,
-      stateRootHash: ByteString,
-      noEmptyAccounts: Boolean,
-      ethCompatibleStorage: Boolean
-  ): InMemoryWorldStateProxy = ???
-
-  override def getReadOnlyWorldStateProxy(
-      blockNumber: Option[BigInt],
-      accountStartNonce: UInt256,
-      stateRootHash: ByteString,
-      noEmptyAccounts: Boolean,
-      ethCompatibleStorage: Boolean
-  ): InMemoryWorldStateProxy = ???
-
   def getBestBlockNumber(): BigInt = ???
 
   def saveBlockNumber(number: BigInt, hash: NodeHash): Unit = ???
@@ -217,4 +201,8 @@ class BlockchainMock(genesisHash: ByteString) extends Blockchain {
   override def save(block: Block, receipts: Seq[Receipt], weight: ChainWeight, saveAsBestBlock: Boolean): Unit = ???
 
   override def getLatestCheckpointBlockNumber(): BigInt = ???
+
+  override def getBackingStorage(blockNumber: BigInt): MptStorage = ???
+
+  override def getReadOnlyStorage(): MptStorage = ???
 }

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

@@ -65,13 +65,13 @@ object FixtureProvider {
     val blocksToInclude = fixtures.blockByNumber.toSeq.sortBy { case (number, _) => number }.takeWhile {
       case (number, _) => number <= blockNumber
     }
-    val blockchain = BlockchainImpl(storages)
 
     blocksToInclude.foreach { case (_, block) =>
       val receiptsUpdates = fixtures.receipts
         .get(block.header.hash)
         .map(r => storages.receiptStorage.put(block.header.hash, r))
         .getOrElse(storages.receiptStorage.emptyBatchUpdate)
+
       storages.blockBodiesStorage
         .put(block.header.hash, fixtures.blockBodies(block.header.hash))
         .and(storages.blockHeadersStorage.put(block.header.hash, fixtures.blockHeaders(block.header.hash)))

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

@@ -19,6 +19,7 @@ trait ConsensusBuilder {
   */
 trait StdConsensusBuilder extends ConsensusBuilder {
   self: VmBuilder
+    with StorageBuilder
     with BlockchainBuilder
     with BlockchainConfigBuilder
     with ConsensusConfigBuilder
@@ -43,7 +44,15 @@ trait StdConsensusBuilder extends ConsensusBuilder {
       case Protocol.PoW | Protocol.MockedPow => NoAdditionalPoWData
       case Protocol.RestrictedPoW => RestrictedPoWMinerData(nodeKey)
     }
-    val consensus = PoWConsensus(vm, blockchain, blockchainConfig, fullConfig, validators, additionalPoWData)
+    val consensus = PoWConsensus(
+      vm,
+      storagesInstance.storages.evmCodeStorage,
+      blockchain,
+      blockchainConfig,
+      fullConfig,
+      validators,
+      additionalPoWData
+    )
     consensus
   }
 

src/main/scala/io/iohk/ethereum/consensus/blocks/BlockGeneratorSkeleton.scala

@@ -8,7 +8,7 @@ import io.iohk.ethereum.consensus.pow.blocks.Ommers
 import io.iohk.ethereum.consensus.validators.std.MptListValidator.intByteArraySerializable
 import io.iohk.ethereum.crypto.kec256
 import io.iohk.ethereum.db.dataSource.EphemDataSource
-import io.iohk.ethereum.db.storage.StateStorage
+import io.iohk.ethereum.db.storage.{EvmCodeStorage, StateStorage}
 import io.iohk.ethereum.domain._
 import io.iohk.ethereum.domain.BlockHeader.HeaderExtraFields._
 import io.iohk.ethereum.consensus.pow.blocks.OmmersSeqEnc
@@ -22,7 +22,6 @@ import io.iohk.ethereum.utils.ByteUtils.or
   * This is a skeleton for a generic [[io.iohk.ethereum.consensus.blocks.BlockGenerator BlockGenerator]].
   */
 abstract class BlockGeneratorSkeleton(
-    blockchain: Blockchain,
     blockchainConfig: BlockchainConfig,
     consensusConfig: ConsensusConfig,
     difficultyCalc: DifficultyCalculator,
@@ -82,6 +81,7 @@ abstract class BlockGeneratorSkeleton(
   ): BlockHeader
 
   protected def prepareBlock(
+      evmCodeStorage: EvmCodeStorage,
       parent: Block,
       transactions: Seq[SignedTransaction],
       beneficiary: Address,
@@ -97,7 +97,7 @@ abstract class BlockGeneratorSkeleton(
     val body = newBlockBody(transactionsForBlock, x)
     val block = Block(header, body)
 
-    blockPreparator.prepareBlock(block, parent.header, initialWorldStateBeforeExecution) match {
+    blockPreparator.prepareBlock(evmCodeStorage, block, parent.header, initialWorldStateBeforeExecution) match {
       case PreparedBlock(prepareBlock, BlockResult(_, gasUsed, receipts), stateRoot, updatedWorld) =>
         val receiptsLogs: Seq[Array[Byte]] =
           BloomFilter.EmptyBloomFilter.toArray +: receipts.map(_.logsBloomFilter.toArray)

src/main/scala/io/iohk/ethereum/consensus/blocks/NoOmmersBlockGenerator.scala

@@ -6,16 +6,16 @@ import io.iohk.ethereum.domain._
 import io.iohk.ethereum.ledger.{BlockPreparator, InMemoryWorldStateProxy}
 import io.iohk.ethereum.utils.BlockchainConfig
 import io.iohk.ethereum.consensus.ConsensusMetrics
+import io.iohk.ethereum.db.storage.EvmCodeStorage
 
 abstract class NoOmmersBlockGenerator(
-    blockchain: Blockchain,
+    evmCodeStorage: EvmCodeStorage,
     blockchainConfig: BlockchainConfig,
     consensusConfig: ConsensusConfig,
     blockPreparator: BlockPreparator,
     difficultyCalc: DifficultyCalculator,
     blockTimestampProvider: BlockTimestampProvider = DefaultBlockTimestampProvider
 ) extends BlockGeneratorSkeleton(
-      blockchain,
       blockchainConfig,
       consensusConfig,
       difficultyCalc,
@@ -50,7 +50,16 @@ abstract class NoOmmersBlockGenerator(
     val blockNumber = pHeader.number + 1
 
     val prepared =
-      prepareBlock(parent, transactions, beneficiary, blockNumber, blockPreparator, x, initialWorldStateBeforeExecution)
+      prepareBlock(
+        evmCodeStorage,
+        parent,
+        transactions,
+        beneficiary,
+        blockNumber,
+        blockPreparator,
+        x,
+        initialWorldStateBeforeExecution
+      )
     cache.updateAndGet((t: List[PendingBlockAndState]) => (prepared :: t).take(blockCacheSize))
 
     prepared