[ETCM-143] Redefine block header structure and encoding

Author: Nicolas 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.buildPreECIP1098Header(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

@@ -36,7 +36,7 @@ object ScenarioBuilder {
   }
 
   def prepareHeader(env: Env): BlockHeader =
-    BlockHeader(
+    BlockHeader.buildPreECIP1098Header(
       env.previousHash.getOrElse(bEmpty),
       bEmpty,
       env.currentCoinbase.bytes,
@@ -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.HefPreEcip1098
 
 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, HefPreEcip1098) {
       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

@@ -119,7 +119,7 @@ class GenesisDataLoader(
   }
 
   private def prepareHeader(genesisData: GenesisData, stateMptRootHash: Array[Byte]) =
-    BlockHeader(
+    BlockHeader.buildPreECIP1098Header(
       parentHash = zeros(hashLength),
       ommersHash = ByteString(crypto.kec256(rlp.encode(RLPList()))),
       beneficiary = genesisData.coinbase,
@@ -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
+        HefPreEcip1098
 
     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/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.HefPreEcip1098
 import io.iohk.ethereum.utils.{BlockchainConfig, DaoForkConfig}
 
 /**
@@ -172,7 +173,7 @@ abstract class BlockHeaderValidatorSkeleton(blockchainConfig: BlockchainConfig)
     */
   private def validateOptOut(blockHeader: BlockHeader): Either[BlockHeaderError, BlockHeaderValid] = {
     val isEcip1098Activated = blockHeader.number >= blockchainConfig.ecip1098BlockNumber
-    val isOptOutDefined = blockHeader.treasuryOptOut.isDefined
+    val isOptOutDefined = blockHeader.extraFields != HefPreEcip1098
 
     if (isEcip1098Activated && isOptOutDefined) Right(BlockHeaderValid)
     else if (!isEcip1098Activated && !isOptOutDefined) Right(BlockHeaderValid)

src/main/scala/io/iohk/ethereum/db/storage/BlockBodiesStorage.scala

@@ -4,11 +4,11 @@ import java.nio.ByteBuffer
 
 import akka.util.ByteString
 import boopickle.Default.{Pickle, Unpickle}
-import io.iohk.ethereum.crypto.ECDSASignature
 import io.iohk.ethereum.db.dataSource.DataSource
 import io.iohk.ethereum.db.storage.BlockBodiesStorage.BlockBodyHash
-import io.iohk.ethereum.domain.{Address, BlockBody, BlockHeader, Checkpoint, SignedTransaction, Transaction}
+import io.iohk.ethereum.domain.BlockBody
 import io.iohk.ethereum.utils.ByteUtils.compactPickledBytes
+import io.iohk.ethereum.utils.Picklers._
 
 /**
   * This class is used to store the BlockBody, by using:
@@ -30,20 +30,4 @@ class BlockBodiesStorage(val dataSource: DataSource) extends TransactionalKeyVal
 
 object BlockBodiesStorage {
   type BlockBodyHash = ByteString
-
-  import boopickle.DefaultBasic._
-
-  implicit val byteStringPickler: Pickler[ByteString] = transformPickler[ByteString, Array[Byte]](ByteString(_))(_.toArray[Byte])
-  implicit val addressPickler: Pickler[Address] =
-    transformPickler[Address, ByteString](bytes => Address(bytes))(address => address.bytes)
-  implicit val transactionPickler: Pickler[Transaction] = generatePickler[Transaction]
-  implicit val ecdsaSignaturePickler: Pickler[ECDSASignature] = generatePickler[ECDSASignature]
-  implicit val checkpointPickler: Pickler[Checkpoint] = generatePickler[Checkpoint]
-  implicit val signedTransactionPickler: Pickler[SignedTransaction] = transformPickler[SignedTransaction, (Transaction, ECDSASignature)]
-  { case (tx, signature) => new SignedTransaction(tx, signature) }{ stx => (stx.tx, stx.signature)}
-
-  implicit val blockHeaderPickler: Pickler[BlockHeader] = generatePickler[BlockHeader]
-  implicit val blockBodyPickler: Pickler[BlockBody] = transformPickler[BlockBody, (Seq[SignedTransaction], Seq[BlockHeader])]
-  {case (stx, nodes) => BlockBody(stx, nodes) }{ blockBody => (blockBody.transactionList, blockBody.uncleNodesList) }
-
 }