Rename ommers

Author: Christos KK Loverdos

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

@@ -98,7 +98,7 @@ class AtomixRaftForger(
           parent = parentBlock,
           transactions = pendingTransactions,
           beneficiary = coinbase,
-          ommers = Nil // No ommers
+          x = Nil
         )
         errorOrPendingBlock match {
           case Left(error) ⇒

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

@@ -35,14 +35,12 @@ trait BlockGenerator {
 
   /**
    * Generates the next block.
-   *
-   * @param ommers We call it `ommers`, since this is the original use-case in Ethash but in general it can be anything
    */
   def generateBlock(
     parent: Block,
     transactions: Seq[SignedTransaction],
     beneficiary: Address,
-    ommers: X
+    x: X
   ): Either[BlockPreparationError, PendingBlock]
 }
 

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

@@ -42,19 +42,18 @@ abstract class BlockGeneratorSkeleton(
 
   protected val cache: AtomicReference[List[PendingBlockAndState]] = new AtomicReference(Nil)
 
-
-  protected def newBlockBody(transactions: Seq[SignedTransaction], ommers: X): BlockBody
+  protected def newBlockBody(transactions: Seq[SignedTransaction], x: X): BlockBody
 
   protected def defaultPrepareHeader(
     blockNumber: BigInt,
     parent: Block,
     beneficiary: Address,
     blockTimestamp: Long,
-    ommers: Ommers
+    x: Ommers
   ): BlockHeader =
       BlockHeader(
         parentHash = parent.header.hash,
-        ommersHash = ByteString(kec256(ommers.toBytes: Array[Byte])),
+        ommersHash = ByteString(kec256(x.toBytes: Array[Byte])),
         beneficiary = beneficiary.bytes,
         stateRoot = ByteString.empty,
         //we are not able to calculate transactionsRoot here because we do not know if they will fail
@@ -74,7 +73,7 @@ abstract class BlockGeneratorSkeleton(
   protected def prepareHeader(
     blockNumber: BigInt, parent: Block,
     beneficiary: Address, blockTimestamp: Long,
-    ommers: X
+    x: X
   ): BlockHeader
 
   protected def prepareBlock(
@@ -83,13 +82,13 @@ abstract class BlockGeneratorSkeleton(
     beneficiary: Address,
     blockNumber: BigInt,
     blockPreparator: BlockPreparator,
-    ommers: X
+    x: X
   ): PendingBlockAndState = {
 
     val blockTimestamp = blockTimestampProvider.getEpochSecond
-    val header = prepareHeader(blockNumber, parent, beneficiary, blockTimestamp, ommers)
+    val header = prepareHeader(blockNumber, parent, beneficiary, blockTimestamp, x)
     val transactionsForBlock = prepareTransactions(transactions, header.gasLimit)
-    val body = newBlockBody(transactionsForBlock, ommers)
+    val body = newBlockBody(transactionsForBlock, x)
     val block = Block(header, body)
 
     val prepared = blockPreparator.prepareBlock(block) match {

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

@@ -23,16 +23,17 @@ abstract class NoOmmersBlockGenerator(
 
   type X = Nil.type
 
-  protected def newBlockBody(transactions: Seq[SignedTransaction], ommers: Nil.type): BlockBody = {
-    BlockBody(transactions, ommers)
-  }
+  protected def newBlockBody(transactions: Seq[SignedTransaction], x: Nil.type): BlockBody =
+    BlockBody(transactions, x)
 
   protected def prepareHeader(
-    blockNumber: BigInt, parent: Block,
-    beneficiary: Address, blockTimestamp: Long,
-    ommers: Nil.type
+    blockNumber: BigInt,
+    parent: Block,
+    beneficiary: Address,
+    blockTimestamp: Long,
+    x: Nil.type
   ): BlockHeader =
-    defaultPrepareHeader(blockNumber, parent, beneficiary, blockTimestamp, ommers)
+    defaultPrepareHeader(blockNumber, parent, beneficiary, blockTimestamp, x)
 
 
   /** An empty `X` */
@@ -42,13 +43,13 @@ abstract class NoOmmersBlockGenerator(
     parent: Block,
     transactions: Seq[SignedTransaction],
     beneficiary: Address,
-    ommers: Nil.type
+    x: Nil.type
   ): Either[BlockPreparationError, PendingBlock] = {
 
     val pHeader = parent.header
     val blockNumber = pHeader.number + 1
 
-    val prepared = prepareBlock(parent, transactions, beneficiary, blockNumber, blockPreparator, ommers)
+    val prepared = prepareBlock(parent, transactions, beneficiary, blockNumber, blockPreparator, x)
     cache.updateAndGet((t: List[PendingBlockAndState]) => (prepared :: t).take(blockCacheSize))
 
     Right(prepared.pendingBlock)

src/main/scala/io/iohk/ethereum/consensus/ethash/blocks/EthashBlockGenerator.scala

@@ -38,16 +38,15 @@ class EthashBlockGeneratorImpl(
   blockTimestampProvider
 ) with EthashBlockGenerator {
 
-  protected def newBlockBody(transactions: Seq[SignedTransaction], ommers: Ommers): BlockBody = {
-    BlockBody(transactions, ommers)
-  }
+  protected def newBlockBody(transactions: Seq[SignedTransaction], x: Ommers): BlockBody =
+    BlockBody(transactions, x)
 
   protected def prepareHeader(
     blockNumber: BigInt, parent: Block,
     beneficiary: Address, blockTimestamp: Long,
-    ommers: Ommers
+    x: Ommers
   ): BlockHeader =
-    defaultPrepareHeader(blockNumber, parent, beneficiary, blockTimestamp, ommers)
+    defaultPrepareHeader(blockNumber, parent, beneficiary, blockTimestamp, x)
 
 
   /** An empty `X` */
@@ -66,7 +65,7 @@ class EthashBlockGeneratorImpl(
     parent: Block,
     transactions: Seq[SignedTransaction],
     beneficiary: Address,
-    ommers: Ommers
+    x: Ommers
   ): Either[BlockPreparationError, PendingBlock] = {
     val pHeader = parent.header
     val blockNumber = pHeader.number + 1
@@ -75,10 +74,10 @@ class EthashBlockGeneratorImpl(
     val ommersV = validators.ommersValidator
 
     val result: Either[InvalidOmmers, PendingBlockAndState] = ommersV
-      .validate(parentHash, blockNumber, ommers, blockchain)
+      .validate(parentHash, blockNumber, x, blockchain)
       .left.map(InvalidOmmers).flatMap { _ =>
 
-        val prepared = prepareBlock(parent, transactions, beneficiary, blockNumber, blockPreparator, ommers)
+        val prepared = prepareBlock(parent, transactions, beneficiary, blockNumber, blockPreparator, x)
         Right(prepared)
       }
 

src/test/scala/io/iohk/ethereum/consensus/BlockGeneratorSpec.scala

@@ -40,8 +40,7 @@ class BlockGeneratorSpec extends FlatSpec with Matchers with PropertyChecks with
   }
 
   it should "generate correct block with transactions" in new TestSetup {
-    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(
-      bestBlock, Seq(signedTransaction), Address(testAddress), blockGenerator.emptyX)
+    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(bestBlock, Seq(signedTransaction), Address(testAddress), blockGenerator.emptyX)
     result shouldBe a[Right[_, Block]]
 
     //mined with mantis + ethminer
@@ -58,8 +57,7 @@ class BlockGeneratorSpec extends FlatSpec with Matchers with PropertyChecks with
 
 
   it should "be possible to simulate transaction, on world returned with pending block " in new TestSetup {
-    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(
-      bestBlock, Seq(signedTransaction), Address(testAddress), blockGenerator.emptyX)
+    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(bestBlock, Seq(signedTransaction), Address(testAddress), blockGenerator.emptyX)
     result shouldBe a[Right[_, Block]]
 
     //mined with mantis + ethminer
@@ -74,8 +72,7 @@ class BlockGeneratorSpec extends FlatSpec with Matchers with PropertyChecks with
     val res = ledger.importBlock(fullBlock.right.get)
 
     // Create new pending block, with updated stateRootHash
-    val result1: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(
-      blockchain.getBestBlock(), Seq(signedTransaction), Address(testAddress), blockGenerator.emptyX)
+    val result1: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(blockchain.getBestBlock(), Seq(signedTransaction), Address(testAddress), blockGenerator.emptyX)
     result1 shouldBe a[Right[_, Block]]
 
     val pendBlockAndState = blockGenerator.getPendingBlockAndState.get
@@ -93,8 +90,7 @@ class BlockGeneratorSpec extends FlatSpec with Matchers with PropertyChecks with
   }
 
   it should "filter out failing transactions" in new TestSetup {
-    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(
-      bestBlock, Seq(signedTransaction, duplicatedSignedTransaction), Address(testAddress), blockGenerator.emptyX)
+    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(bestBlock, Seq(signedTransaction, duplicatedSignedTransaction), Address(testAddress), blockGenerator.emptyX)
     result shouldBe a[Right[_, Block]]
 
     //mined with mantis + ethminer
@@ -117,8 +113,7 @@ class BlockGeneratorSpec extends FlatSpec with Matchers with PropertyChecks with
         nonce = signedTransaction.tx.nonce + 1),
       keyPair, Some(0x3d.toByte))
 
-    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(
-      bestBlock, Seq(txWitGasTooBigGasLimit, signedTransaction, duplicatedSignedTransaction), Address(testAddress), blockGenerator.emptyX)
+    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(bestBlock, Seq(txWitGasTooBigGasLimit, signedTransaction, duplicatedSignedTransaction), Address(testAddress), blockGenerator.emptyX)
     result shouldBe a[Right[_, Block]]
 
     //mined with mantis + ethminer
@@ -160,8 +155,7 @@ class BlockGeneratorSpec extends FlatSpec with Matchers with PropertyChecks with
     val generalTx = SignedTransaction.sign(transaction, keyPair, None)
     val specificTx = SignedTransaction.sign(transaction.copy(nonce = transaction.nonce + 1), keyPair, Some(0x3d.toByte))
 
-    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(
-      bestBlock, Seq(generalTx, specificTx), Address(testAddress), blockGenerator.emptyX)
+    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(bestBlock, Seq(generalTx, specificTx), Address(testAddress), blockGenerator.emptyX)
     result shouldBe a[Right[_, Block]]
 
     //mined with mantis + ethminer
@@ -180,8 +174,7 @@ class BlockGeneratorSpec extends FlatSpec with Matchers with PropertyChecks with
   it should "generate block after eip155 and allow both chain specific and general transactions" in new TestSetup {
     val generalTx: SignedTransaction = SignedTransaction.sign(transaction.copy(nonce = transaction.nonce + 1), keyPair, None)
 
-    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(
-      bestBlock, Seq(generalTx, signedTransaction), Address(testAddress), blockGenerator.emptyX)
+    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(bestBlock, Seq(generalTx, signedTransaction), Address(testAddress), blockGenerator.emptyX)
     result shouldBe a[Right[_, Block]]
 
     //mined with mantis + ethminer
@@ -200,8 +193,7 @@ class BlockGeneratorSpec extends FlatSpec with Matchers with PropertyChecks with
   it should "include consecutive transactions from single sender" in new TestSetup {
     val nextTransaction: SignedTransaction = SignedTransaction.sign(transaction.copy(nonce = signedTransaction.tx.nonce + 1), keyPair, Some(0x3d.toByte))
 
-    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(
-      bestBlock, Seq(nextTransaction, signedTransaction), Address(testAddress), blockGenerator.emptyX)
+    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(bestBlock, Seq(nextTransaction, signedTransaction), Address(testAddress), blockGenerator.emptyX)
     result shouldBe a[Right[_, Block]]
 
     //mined with mantis + ethminer
@@ -232,9 +224,7 @@ class BlockGeneratorSpec extends FlatSpec with Matchers with PropertyChecks with
     val signedFailingTransaction: SignedTransaction = SignedTransaction.sign(failingTransaction,
       keyPairFromPrvKey(privateKeyWithNoEthere), Some(0x3d.toByte))
 
-    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(
-      bestBlock, Seq(nextTransaction, signedFailingTransaction, signedTransaction),
-      Address(testAddress), blockGenerator.emptyX)
+    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(bestBlock, Seq(nextTransaction, signedFailingTransaction, signedTransaction), Address(testAddress), blockGenerator.emptyX)
     result shouldBe a[Right[_, Block]]
 
     //mined with mantis + ethminer
@@ -256,8 +246,7 @@ class BlockGeneratorSpec extends FlatSpec with Matchers with PropertyChecks with
       keyPair,
       Some(0x3d.toByte))
 
-    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(
-      bestBlock, Seq(txWitSameNonceButLowerGasPrice, signedTransaction), Address(testAddress), blockGenerator.emptyX)
+    val result: Either[BlockPreparationError, PendingBlock] = blockGenerator.generateBlock(bestBlock, Seq(txWitSameNonceButLowerGasPrice, signedTransaction), Address(testAddress), blockGenerator.emptyX)
     result shouldBe a[Right[_, Block]]
 
     //mined with mantis + ethminer