Decouple Consensus II (delete ConsensusImpl)

Author: Christos KK Loverdos

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

@@ -2,11 +2,9 @@ package io.iohk.ethereum.consensus
 
 import io.iohk.ethereum.consensus.blocks.{BlockGenerator, TestBlockGenerator}
 import io.iohk.ethereum.consensus.validators.Validators
-import io.iohk.ethereum.domain._
 import io.iohk.ethereum.ledger.BlockPreparator
 import io.iohk.ethereum.ledger.Ledger.VMImpl
 import io.iohk.ethereum.nodebuilder.Node
-import io.iohk.ethereum.utils.{BlockchainConfig, Logger}
 
 /**
  * Abstraction for a consensus protocol implementation.
@@ -81,33 +79,3 @@ trait TestConsensus extends Consensus {
   /** Internal API, used for testing */
   def withBlockGenerator(blockGenerator: TestBlockGenerator): TestConsensus
 }
-
-abstract class ConsensusImpl[C <: AnyRef](
-  theVm: VMImpl,
-  blockchain: BlockchainImpl,
-  blockchainConfig: BlockchainConfig,
-  fullConsensusConfig: FullConsensusConfig[C]
-) extends TestConsensus with Logger {
-
-  final type Config = C
-
-  protected val _blockPreparator = new BlockPreparator(
-    vm = vm,
-    signedTxValidator = validators.signedTransactionValidator,
-    blockchain = blockchain,
-    blockchainConfig = blockchainConfig
-  )
-
-  /**
-   * This is used by the [[io.iohk.ethereum.consensus.Consensus#blockGenerator blockGenerator]].
-   */
-  def blockPreparator: BlockPreparator = this._blockPreparator
-
-  /**
-   * This is the VM used to prepare and generate blocks.
-   */
-  def vm: VMImpl = theVm
-
-  def config: FullConsensusConfig[C] = fullConsensusConfig
-}
-

src/main/scala/io/iohk/ethereum/consensus/atomixraft/AtomixRaftConsensus.scala

@@ -24,27 +24,31 @@ import io.iohk.ethereum.domain.BlockchainImpl
 import io.iohk.ethereum.ledger.BlockPreparator
 import io.iohk.ethereum.ledger.Ledger.VMImpl
 import io.iohk.ethereum.nodebuilder.Node
-import io.iohk.ethereum.utils.BlockchainConfig
+import io.iohk.ethereum.utils.{BlockchainConfig, Logger}
 
 class AtomixRaftConsensus private(
-  vm: VMImpl,
+  val vm: VMImpl,
   blockchain: BlockchainImpl,
   blockchainConfig: BlockchainConfig,
-  fullConsensusConfig: FullConsensusConfig[AtomixRaftConfig],
-  _validators: Validators,
-  _blockGenerator: AtomixRaftBlockGenerator
-) extends ConsensusImpl[AtomixRaftConfig](
-  vm,
-  blockchain,
-  blockchainConfig,
-  fullConsensusConfig
-) {
+  val config: FullConsensusConfig[AtomixRaftConfig],
+  val validators: Validators,
+  val blockGenerator: AtomixRaftBlockGenerator
+) extends TestConsensus with Logger {
+
+  type Config = AtomixRaftConfig
 
   private[this] final val miner = new AtomixRaftForgerRef
 
   private[this] final val raftServer = new RaftServerRef
 
-  private[this] val raftConfig: AtomixRaftConfig = config.specific
+  private[this] final val raftConfig: AtomixRaftConfig = config.specific
+
+  private[this] final val _blockPreparator = new BlockPreparator(
+    vm = vm,
+    signedTxValidator = validators.signedTransactionValidator,
+    blockchain = blockchain,
+    blockchainConfig = blockchainConfig
+  )
 
   private[this] def setupMiner(node: Node): Unit = {
     miner.setOnce {
@@ -131,6 +135,11 @@ class AtomixRaftConsensus private(
 
   def promoteToLeader(): Unit = raftServer.run(_.promote().join())
 
+  /**
+   * This is used by the [[io.iohk.ethereum.consensus.Consensus#blockGenerator blockGenerator]].
+   */
+  def blockPreparator: BlockPreparator = this._blockPreparator
+
   /**
    * Starts the consensus protocol on the current `node`.
    */
@@ -146,12 +155,6 @@ class AtomixRaftConsensus private(
 
   def protocol: Protocol = Protocol.AtomixRaft
 
-  /**
-   * Provides the set of validators specific to this consensus protocol.
-   */
-  def validators: Validators = this._validators
-
-
   /** Internal API, used for testing */
   protected def newBlockGenerator(validators: Validators): AtomixRaftBlockGenerator = {
     val blockPreparator = new BlockPreparator(
@@ -178,9 +181,9 @@ class AtomixRaftConsensus private(
       vm = vm,
       blockchain = blockchain,
       blockchainConfig = blockchainConfig,
-      fullConsensusConfig = fullConsensusConfig,
-      _validators = validators,
-      _blockGenerator = blockGenerator
+      config = config,
+      validators = validators,
+      blockGenerator = blockGenerator
     )
   }
 
@@ -190,9 +193,9 @@ class AtomixRaftConsensus private(
       vm = vm,
       blockchain = blockchain,
       blockchainConfig = blockchainConfig,
-      fullConsensusConfig = fullConsensusConfig,
-      _validators = _validators,
-      _blockGenerator = blockGenerator
+      config = config,
+      validators = validators,
+      blockGenerator = blockGenerator
     )
 
 
@@ -202,24 +205,18 @@ class AtomixRaftConsensus private(
       vm = vm,
       blockchain = blockchain,
       blockchainConfig = blockchainConfig,
-      fullConsensusConfig = fullConsensusConfig,
-      _validators = validators,
-      _blockGenerator = blockGenerator.asInstanceOf[AtomixRaftBlockGenerator]
+      config = config,
+      validators = validators,
+      blockGenerator = blockGenerator.asInstanceOf[AtomixRaftBlockGenerator]
     )
-
-  /**
-   * Returns the [[io.iohk.ethereum.consensus.blocks.BlockGenerator BlockGenerator]]
-   * this consensus protocol uses.
-   */
-  def blockGenerator: AtomixRaftBlockGenerator = this._blockGenerator
 }
 
 object AtomixRaftConsensus {
   def apply(
     vm: VMImpl,
     blockchain: BlockchainImpl,
     blockchainConfig: BlockchainConfig,
-    fullConsensusConfig: FullConsensusConfig[AtomixRaftConfig]
+    config: FullConsensusConfig[AtomixRaftConfig]
   ): AtomixRaftConsensus = {
 
     val validators = StdValidators(blockchainConfig)
@@ -234,17 +231,17 @@ object AtomixRaftConsensus {
     val blockGenerator = new AtomixRaftBlockGenerator(
       blockchain = blockchain,
       blockchainConfig = blockchainConfig,
-      consensusConfig = fullConsensusConfig.generic,
+      consensusConfig = config.generic,
       blockPreparator = blockPreparator
     )
 
     new AtomixRaftConsensus(
       vm = vm,
       blockchain = blockchain,
       blockchainConfig = blockchainConfig,
-      fullConsensusConfig = fullConsensusConfig,
-      _validators = validators,
-      _blockGenerator = blockGenerator
+      config = config,
+      validators = validators,
+      blockGenerator = blockGenerator
     )
   }
 }

src/main/scala/io/iohk/ethereum/consensus/ethash/EthashConsensus.scala

@@ -14,24 +14,28 @@ import io.iohk.ethereum.domain.BlockchainImpl
 import io.iohk.ethereum.ledger.BlockPreparator
 import io.iohk.ethereum.ledger.Ledger.VMImpl
 import io.iohk.ethereum.nodebuilder.Node
-import io.iohk.ethereum.utils.BlockchainConfig
+import io.iohk.ethereum.utils.{BlockchainConfig, Logger}
 
 /**
  * Implements standard Ethereum consensus (ethash PoW).
  */
 class EthashConsensus private(
-  vm: VMImpl,
+  val vm: VMImpl,
   blockchain: BlockchainImpl,
   blockchainConfig: BlockchainConfig,
-  fullConsensusConfig: FullConsensusConfig[EthashConfig],
-  _validators: EthashValidators,
-  _blockGenerator: EthashBlockGenerator
-) extends ConsensusImpl[EthashConfig](
-  vm,
-  blockchain,
-  blockchainConfig,
-  fullConsensusConfig
-) {
+  val config: FullConsensusConfig[EthashConfig],
+  val validators: EthashValidators,
+  val blockGenerator: EthashBlockGenerator
+) extends TestConsensus with Logger  {
+
+  type Config = EthashConfig
+
+  private[this] final val _blockPreparator = new BlockPreparator(
+    vm = vm,
+    signedTxValidator = validators.signedTransactionValidator,
+    blockchain = blockchain,
+    blockchainConfig = blockchainConfig
+  )
 
   private[this] val atomicMiner = new AtomicReference[Option[ActorRef]](None)
   private[this] def sendMiner(msg: MinerMsg): Unit =
@@ -53,6 +57,11 @@ class EthashConsensus private(
     sendMiner(EthashMiner.StopMining)
   }
 
+  /**
+   * This is used by the [[io.iohk.ethereum.consensus.Consensus#blockGenerator blockGenerator]].
+   */
+  def blockPreparator: BlockPreparator = this._blockPreparator
+
   /**
    * Starts the consensus protocol on the current `node`.
    */
@@ -70,12 +79,6 @@ class EthashConsensus private(
 
   def protocol: Protocol = Protocol.Ethash
 
-
-  /**
-   * Provides the set of validators specific to this consensus protocol.
-   */
-  def validators: EthashValidators = this._validators
-
   /** Internal API, used for testing */
   protected def newBlockGenerator(validators: Validators): EthashBlockGenerator = {
     validators match {
@@ -112,9 +115,9 @@ class EthashConsensus private(
           vm = vm,
           blockchain = blockchain,
           blockchainConfig = blockchainConfig,
-          fullConsensusConfig = fullConsensusConfig,
-          _validators = _validators,
-          _blockGenerator = blockGenerator
+          config = config,
+          validators = _validators,
+          blockGenerator = blockGenerator
         )
 
       case _ ⇒
@@ -127,9 +130,9 @@ class EthashConsensus private(
       vm = vm,
       blockchain = blockchain,
       blockchainConfig = blockchainConfig,
-      fullConsensusConfig = fullConsensusConfig,
-      _validators = validators,
-      _blockGenerator = blockGenerator
+      config = config,
+      validators = validators,
+      blockGenerator = blockGenerator
     )
 
   /** Internal API, used for testing */
@@ -138,24 +141,20 @@ class EthashConsensus private(
       vm = vm,
       blockchain = blockchain,
       blockchainConfig = blockchainConfig,
-      fullConsensusConfig = fullConsensusConfig,
-      _validators = validators,
-      _blockGenerator = blockGenerator.asInstanceOf[EthashBlockGenerator]
+      config = config,
+      validators = validators,
+      blockGenerator = blockGenerator.asInstanceOf[EthashBlockGenerator]
     )
 
-  /**
-   * Returns the [[io.iohk.ethereum.consensus.blocks.BlockGenerator BlockGenerator]]
-   * this consensus protocol uses.
-   */
-  def blockGenerator: EthashBlockGenerator = this._blockGenerator
+
 }
 
 object EthashConsensus {
   def apply(
     vm: VMImpl,
     blockchain: BlockchainImpl,
     blockchainConfig: BlockchainConfig,
-    fullConsensusConfig: FullConsensusConfig[EthashConfig]
+    config: FullConsensusConfig[EthashConfig]
   ): EthashConsensus = {
 
     val validators = StdEthashValidators(blockchainConfig)
@@ -171,17 +170,17 @@ object EthashConsensus {
       validators = validators,
       blockchain = blockchain,
       blockchainConfig = blockchainConfig,
-      consensusConfig = fullConsensusConfig.generic,
+      consensusConfig = config.generic,
       blockPreparator = blockPreparator
     )
 
     new EthashConsensus(
       vm = vm,
       blockchain = blockchain,
       blockchainConfig = blockchainConfig,
-      fullConsensusConfig = fullConsensusConfig,
-      _validators = validators,
-      _blockGenerator = blockGenerator
+      config = config,
+      validators = validators,
+      blockGenerator = blockGenerator
     )
   }
 }