[ETCM-143] Redefine block header structure and encoding (#709)

Author: Nicolás Tallar

src/ets/scala/io/iohk/ethereum/ets/blockchain/Scenario.scala

@@ -55,8 +55,8 @@ case class BlockHeaderDef(
 ) {
 
   def toBlockHeader: BlockHeader =
-    BlockHeader(parentHash, uncleHash, coinbase, stateRoot, transactionsTrie, receiptTrie, bloom, difficulty, number,
-      gasLimit, gasUsed, timestamp, extraData, mixHash, nonce, None
+    BlockHeader(parentHash, uncleHash, coinbase, stateRoot, transactionsTrie, receiptTrie, bloom,
+      difficulty, number, gasLimit, gasUsed, timestamp, extraData, mixHash, nonce
     )
 }
 

src/ets/scala/io/iohk/ethereum/ets/vm/ScenarioBuilder.scala

@@ -51,8 +51,7 @@ object ScenarioBuilder {
       env.currentTimestamp,
       bEmpty,
       bEmpty,
-      bEmpty,
-      None
+      bEmpty
     )
 
   def prepareWorld(accounts: Map[Address, AccountState], blockNumber: BigInt, exec: Exec): MockWorldState = {

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

@@ -7,7 +7,7 @@ import akka.actor.{Actor, ActorRef, _}
 import akka.util.ByteString
 import io.iohk.ethereum.crypto.kec256
 import io.iohk.ethereum.domain.{BlockBody, BlockHeader, Receipt}
-import io.iohk.ethereum.domain.BlockHeader._
+import io.iohk.ethereum.domain.BlockHeaderImplicits._
 import io.iohk.ethereum.network.{Peer, PeerManagerActor}
 import io.iohk.ethereum.network.PeerActor.SendMessage
 import io.iohk.ethereum.network.PeerManagerActor.{GetPeers, Peers}

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

@@ -26,6 +26,7 @@ import io.iohk.ethereum.db.dataSource.DataSourceBatchUpdate
 import org.bouncycastle.util.encoders.Hex
 
 import scala.concurrent.duration._
+import io.iohk.ethereum.domain.BlockHeader.HeaderExtraFields.HefEmpty
 
 object DumpChainApp extends App with NodeKeyBuilder with SecureRandomBuilder with AuthHandshakerBuilder {
     val conf = ConfigFactory.load("txExecTest/chainDump.conf")
@@ -103,7 +104,7 @@ object DumpChainApp extends App with NodeKeyBuilder with SecureRandomBuilder wit
   class BlockchainMock(genesisHash: ByteString) extends Blockchain {
 
     class FakeHeader() extends BlockHeader(ByteString.empty, ByteString.empty, ByteString.empty, ByteString.empty,
-      ByteString.empty, ByteString.empty, ByteString.empty, 0, 0, 0, 0, 0, ByteString.empty, ByteString.empty, ByteString.empty, None) {
+      ByteString.empty, ByteString.empty, ByteString.empty, 0, 0, 0, 0, 0, ByteString.empty, ByteString.empty, ByteString.empty, HefEmpty) {
       override lazy val hash: ByteString = genesisHash
     }
 

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

@@ -5,7 +5,7 @@ import java.io.Closeable
 import akka.util.ByteString
 import io.iohk.ethereum.db.storage._
 import io.iohk.ethereum.domain._
-import io.iohk.ethereum.domain.BlockHeader._
+import io.iohk.ethereum.domain.BlockHeaderImplicits._
 import io.iohk.ethereum.domain.BlockBody._
 import io.iohk.ethereum.network.p2p.messages.PV63._
 import MptNodeEncoders._

src/main/scala/io/iohk/ethereum/blockchain/data/GenesisDataLoader.scala

@@ -134,8 +134,7 @@ class GenesisDataLoader(
       unixTimestamp = BigInt(genesisData.timestamp.replace("0x", ""), 16).toLong,
       extraData = genesisData.extraData,
       mixHash = genesisData.mixHash.getOrElse(zeros(hashLength)),
-      nonce = genesisData.nonce,
-      treasuryOptOut = None
+      nonce = genesisData.nonce
     )
 
   private def zeros(length: Int) =

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

@@ -11,6 +11,7 @@ import io.iohk.ethereum.crypto.kec256
 import io.iohk.ethereum.db.dataSource.EphemDataSource
 import io.iohk.ethereum.db.storage.StateStorage
 import io.iohk.ethereum.domain._
+import io.iohk.ethereum.domain.BlockHeader.HeaderExtraFields._
 import io.iohk.ethereum.consensus.ethash.blocks.OmmersSeqEnc
 import io.iohk.ethereum.ledger.Ledger.{BlockPreparationResult, BlockResult}
 import io.iohk.ethereum.ledger.{BlockPreparator, BloomFilter}
@@ -51,7 +52,11 @@ abstract class BlockGeneratorSkeleton(
     blockTimestamp: Long,
     x: Ommers
   ): BlockHeader = {
-    val optOut = if(blockNumber >= blockchainConfig.ecip1098BlockNumber) Some(consensusConfig.treasuryOptOut) else None
+    val extraFields =
+      if(blockNumber >= blockchainConfig.ecip1098BlockNumber)
+        HefPostEcip1098(consensusConfig.treasuryOptOut)
+      else
+        HefEmpty
 
     BlockHeader(
       parentHash = parent.header.hash,
@@ -70,7 +75,7 @@ abstract class BlockGeneratorSkeleton(
       extraData = blockchainConfig.daoForkConfig.flatMap(daoForkConfig => daoForkConfig.getExtraData(blockNumber)).getOrElse(headerExtraData),
       mixHash = ByteString.empty,
       nonce = ByteString.empty,
-      treasuryOptOut = optOut
+      extraFields = extraFields
     )
   }
 

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

@@ -2,6 +2,7 @@ package io.iohk.ethereum.consensus.ethash
 
 import io.iohk.ethereum.consensus.ethash.validators.OmmersValidator.OmmersError
 import io.iohk.ethereum.domain.BlockHeader
+import io.iohk.ethereum.domain.BlockHeaderImplicits._
 import io.iohk.ethereum.ledger.BlockPreparationError
 import io.iohk.ethereum.rlp.{RLPEncodeable, RLPList, RLPSerializable}
 

src/main/scala/io/iohk/ethereum/consensus/validators/BlockHeaderValidator.scala

@@ -3,6 +3,7 @@ package validators
 
 import io.iohk.ethereum.crypto.ECDSASignature
 import io.iohk.ethereum.domain.BlockHeader
+import io.iohk.ethereum.domain.BlockHeader.HeaderExtraFields
 
 /**
  * Validates a [[io.iohk.ethereum.domain.BlockHeader BlockHeader]].
@@ -33,13 +34,13 @@ object BlockHeaderError {
   case object HeaderGasLimitError extends BlockHeaderError
   case object HeaderNumberError extends BlockHeaderError
   case object HeaderPoWError extends BlockHeaderError
-  case class HeaderOptOutError(ecip1098Activated: Boolean, optOutDefined: Boolean) extends BlockHeaderError
+  case class HeaderExtraFieldsError(extraFields: HeaderExtraFields, ecip1097Activated: Boolean, ecip1098Activated: Boolean) extends BlockHeaderError
   case class HeaderWrongNumberOfCheckpointSignatures(sigCount: Int) extends BlockHeaderError
   case class HeaderInvalidCheckpointSignatures(invalidSignaturesWithPublics: Seq[(ECDSASignature, Option[String])])
     extends BlockHeaderError
-  case object HeaderCheckpointTooEarly extends BlockHeaderError
   case class HeaderFieldNotEmptyError(msg: String) extends BlockHeaderError
   case class HeaderNotMatchParentError(msg: String) extends BlockHeaderError
+  case object CheckpointHeaderTreasuryOptOutError extends BlockHeaderError
 
   case class HeaderUnexpectedError(msg: String) extends BlockHeaderError
 }

src/main/scala/io/iohk/ethereum/consensus/validators/BlockHeaderValidatorSkeleton.scala

@@ -4,6 +4,7 @@ import io.iohk.ethereum.consensus.GetBlockHeaderByHash
 import io.iohk.ethereum.consensus.difficulty.DifficultyCalculator
 import io.iohk.ethereum.consensus.validators.BlockHeaderError._
 import io.iohk.ethereum.domain.BlockHeader
+import io.iohk.ethereum.domain.BlockHeader.HeaderExtraFields.{HefEmpty, HefPostEcip1097, HefPostEcip1098}
 import io.iohk.ethereum.utils.{BlockchainConfig, DaoForkConfig}
 
 /**
@@ -77,7 +78,7 @@ abstract class BlockHeaderValidatorSkeleton(blockchainConfig: BlockchainConfig)
       _ <- validateGasUsed(blockHeader)
       _ <- validateGasLimit(blockHeader, parentHeader)
       _ <- validateNumber(blockHeader, parentHeader)
-      _ <- validateOptOut(blockHeader)
+      _ <- validateExtraFields(blockHeader)
       _ <- validateEvenMore(blockHeader, parentHeader)
     } yield BlockHeaderValid
   }
@@ -95,6 +96,7 @@ abstract class BlockHeaderValidatorSkeleton(blockchainConfig: BlockchainConfig)
     for {
       _ <- blockWithCheckpointHeaderValidator.validate(blockHeader, parentHeader)
       _ <- validateNumber(blockHeader, parentHeader)
+      _ <- validateExtraFields(blockHeader)
     } yield BlockHeaderValid
   }
 
@@ -197,18 +199,23 @@ abstract class BlockHeaderValidatorSkeleton(blockchainConfig: BlockchainConfig)
     else Left(HeaderNumberError)
 
   /**
-    * Validates [[io.iohk.ethereum.domain.BlockHeader.treasuryOptOut]] is only defined if ECIP1098 is enabled at the block's number
+    * Validates [[io.iohk.ethereum.domain.BlockHeader.extraFields]] match the ECIP1097 and ECIP1098 enabling configuration
     *
     * @param blockHeader BlockHeader to validate.
-    * @return BlockHeader if valid, an [[HeaderOptOutError]] otherwise
+    * @return BlockHeader if valid, an [[HeaderExtraFieldsError]] otherwise
     */
-  private def validateOptOut(blockHeader: BlockHeader): Either[BlockHeaderError, BlockHeaderValid] = {
-    val isEcip1098Activated = blockHeader.number >= blockchainConfig.ecip1098BlockNumber
-    val isOptOutDefined = blockHeader.treasuryOptOut.isDefined
-
-    if (isEcip1098Activated && isOptOutDefined) Right(BlockHeaderValid)
-    else if (!isEcip1098Activated && !isOptOutDefined) Right(BlockHeaderValid)
-    else Left(HeaderOptOutError(isEcip1098Activated, isOptOutDefined))
+  private def validateExtraFields(blockHeader: BlockHeader): Either[BlockHeaderError, BlockHeaderValid] = {
+    val isECIP1098Activated = blockHeader.number >= blockchainConfig.ecip1098BlockNumber
+    val isECIP1097Activated = blockHeader.number >= blockchainConfig.ecip1097BlockNumber
+
+    blockHeader.extraFields match {
+      case HefPostEcip1097(_, _) if isECIP1097Activated && isECIP1098Activated => Right(BlockHeaderValid)
+      case HefPostEcip1098(_) if !isECIP1097Activated && isECIP1098Activated => Right(BlockHeaderValid)
+      case HefEmpty if !isECIP1097Activated && !isECIP1098Activated => Right(BlockHeaderValid)
+      case _ =>
+        val error = HeaderExtraFieldsError(blockHeader.extraFields, isECIP1097Activated, isECIP1098Activated)
+        Left(error)
+    }
   }
 
 }