Make BlockHeader a versionable enum

CHANGELOG.md

@@ -21,6 +21,7 @@ Description of the upcoming release here.
 - [#1601](https://github.com/FuelLabs/fuel-core/pull/1601): Fix formatting in docs and check that `cargo doc` passes in the CI.
 
 #### Breaking
+- [#1616](https://github.com/FuelLabs/fuel-core/pull/1616) Make `BlockHeader` type a version-able enum
 - [#1596](https://github.com/FuelLabs/fuel-core/pull/1596) Make `Consensus` type a version-able enum
 - [#1593](https://github.com/FuelLabs/fuel-core/pull/1593) Make `Block` type a version-able enum
 - [#1576](https://github.com/FuelLabs/fuel-core/pull/1576): The change moves the implementation of the storage traits for required tables from `fuel-core` to `fuel-core-storage` crate. The change also adds a more flexible configuration of the encoding/decoding per the table and allows the implementation of specific behaviors for the table in a much easier way. It unifies the encoding between database, SMTs, and iteration, preventing mismatching bytes representation on the Rust type system level. Plus, it increases the re-usage of the code by applying the same blueprint to other tables.

crates/fuel-core/src/executor.rs

@@ -371,7 +371,7 @@ mod tests {
             let invalid_duplicate_tx = script.clone().into();
 
             let mut block = Block::default();
-            block.header_mut().consensus.height = 1.into();
+            block.header_mut().consensus_mut().height = 1.into();
             *block.transactions_mut() = vec![script.into(), invalid_duplicate_tx];
             block.header_mut().recalculate_metadata();
 
@@ -439,7 +439,7 @@ mod tests {
             .max_fee();
 
             let mut block = Block::default();
-            block.header_mut().consensus.height = 2.into();
+            block.header_mut().consensus_mut().height = 2.into();
             *block.transactions_mut() = vec![script.into()];
             block.header_mut().recalculate_metadata();
 
@@ -1174,7 +1174,11 @@ mod tests {
             .unwrap();
 
         // randomize transaction commitment
-        block.header_mut().application.generated.transactions_root = rng.gen();
+        block
+            .header_mut()
+            .application_mut()
+            .generated
+            .transactions_root = rng.gen();
         block.header_mut().recalculate_metadata();
 
         let verify_result = verifier

crates/fuel-core/src/schema/dap.rs

@@ -163,7 +163,7 @@ impl ConcreteStorage {
 
         let vm_database = VmStorage::new(
             storage.as_ref().clone(),
-            &block.header().consensus,
+            block.header().consensus(),
             // TODO: Use a real coinbase address
             Default::default(),
         );

crates/fuel-core/src/service/adapters/p2p.rs

@@ -55,7 +55,7 @@ impl BlockHeightImporter for BlockImporterAdapter {
         Box::pin(
             BroadcastStream::new(self.block_importer.subscribe())
                 .filter_map(|result| result.ok())
-                .map(|result| result.sealed_block.entity.header().consensus.height),
+                .map(|result| result.sealed_block.entity.header().consensus().height),
         )
     }
 }

crates/services/consensus_module/poa/src/service_test/manually_produce_tests.rs

@@ -85,7 +85,7 @@ async fn can_manually_produce_block(
         .expect_produce_and_execute_block()
         .returning(|_, time, _, _| {
             let mut block = Block::default();
-            block.header_mut().consensus.time = time;
+            block.header_mut().consensus_mut().time = time;
             block.header_mut().recalculate_metadata();
             Ok(UncommittedResult::new(
                 ExecutionResult {

crates/services/consensus_module/poa/src/verifier.rs

@@ -62,7 +62,7 @@ pub fn verify_block_fields<D: Database>(
     );
 
     ensure!(
-        header.consensus.application_hash == header.application.hash(),
+        header.consensus().application_hash == header.application().hash(),
         "The application hash mismatch."
     );
 

crates/services/consensus_module/poa/src/verifier/tests.rs

@@ -97,12 +97,12 @@ fn test_verify_genesis_block_fields(input: Input) -> anyhow::Result<()> {
         .returning(move |_| Ok(block_header_merkle_root.into()));
     d.expect_block_header().returning(move |_| {
         let mut h = BlockHeader::default();
-        h.consensus.time = prev_header_time;
-        h.application.da_height = prev_header_da_height.into();
+        h.consensus_mut().time = prev_header_time;
+        h.application_mut().da_height = prev_header_da_height.into();
         Ok(h)
     });
     let mut b = Block::default();
-    b.header_mut().consensus = ch;
-    b.header_mut().application = ah;
+    *b.header_mut().consensus_mut() = ch;
+    *b.header_mut().application_mut() = ah;
     verify_block_fields(&d, &b)
 }

crates/services/consensus_module/src/block_verifier/tests.rs

@@ -4,59 +4,59 @@ use test_case::test_case;
 #[test_case(
     {
         let mut h = BlockHeader::default();
-        h.consensus.prev_root = Bytes32::zeroed();
-        h.consensus.time = Tai64::UNIX_EPOCH;
-        h.consensus.height = 0u32.into();
+        h.consensus_mut().prev_root = Bytes32::zeroed();
+        h.consensus_mut().time = Tai64::UNIX_EPOCH;
+        h.consensus_mut().height = 0u32.into();
         h
     },
     0 => matches Ok(_) ; "Correct header at `0`"
 )]
 #[test_case(
     {
         let mut h = BlockHeader::default();
-        h.consensus.prev_root = Bytes32::zeroed();
-        h.consensus.time = Tai64::UNIX_EPOCH;
-        h.consensus.height = 113u32.into();
+        h.consensus_mut().prev_root = Bytes32::zeroed();
+        h.consensus_mut().time = Tai64::UNIX_EPOCH;
+        h.consensus_mut().height = 113u32.into();
         h
     },
     113 => matches Ok(_) ; "Correct header at `113`"
 )]
 #[test_case(
     {
         let mut h = BlockHeader::default();
-        h.consensus.prev_root = Bytes32::zeroed();
-        h.consensus.time = Tai64::UNIX_EPOCH;
-        h.consensus.height = 0u32.into();
+        h.consensus_mut().prev_root = Bytes32::zeroed();
+        h.consensus_mut().time = Tai64::UNIX_EPOCH;
+        h.consensus_mut().height = 0u32.into();
         h
     },
     10 => matches Err(_) ; "wrong expected height"
 )]
 #[test_case(
     {
         let mut h = BlockHeader::default();
-        h.consensus.prev_root = Bytes32::zeroed();
-        h.consensus.time = Tai64::UNIX_EPOCH;
-        h.consensus.height = 5u32.into();
+        h.consensus_mut().prev_root = Bytes32::zeroed();
+        h.consensus_mut().time = Tai64::UNIX_EPOCH;
+        h.consensus_mut().height = 5u32.into();
         h
     },
     0 => matches Err(_) ; "wrong header height"
 )]
 #[test_case(
     {
         let mut h = BlockHeader::default();
-        h.consensus.prev_root = Bytes32::zeroed();
-        h.consensus.time = Tai64(0);
-        h.consensus.height = 0u32.into();
+        h.consensus_mut().prev_root = Bytes32::zeroed();
+        h.consensus_mut().time = Tai64(0);
+        h.consensus_mut().height = 0u32.into();
         h
     },
     0 => matches Err(_) ; "wrong time"
 )]
 #[test_case(
     {
         let mut h = BlockHeader::default();
-        h.consensus.prev_root = Bytes32::from([1u8; 32]);
-        h.consensus.time = Tai64::UNIX_EPOCH;
-        h.consensus.height = 0u32.into();
+        h.consensus_mut().prev_root = Bytes32::from([1u8; 32]);
+        h.consensus_mut().time = Tai64::UNIX_EPOCH;
+        h.consensus_mut().height = 0u32.into();
         h
     },
     0 => matches Err(_) ; "wrong root"

crates/services/importer/src/importer/test.rs

@@ -88,7 +88,7 @@ struct MockExecutionResult {
 
 fn genesis(height: u32) -> SealedBlock {
     let mut block = Block::default();
-    block.header_mut().consensus.height = height.into();
+    block.header_mut().consensus_mut().height = height.into();
     block.header_mut().recalculate_metadata();
 
     SealedBlock {
@@ -99,7 +99,7 @@ fn genesis(height: u32) -> SealedBlock {
 
 fn poa_block(height: u32) -> SealedBlock {
     let mut block = Block::default();
-    block.header_mut().consensus.height = height.into();
+    block.header_mut().consensus_mut().height = height.into();
     block.header_mut().recalculate_metadata();
 
     SealedBlock {
@@ -514,7 +514,7 @@ where
 
     // We tested commit part in the `commit_result_and_execute_and_commit_poa` so setup the
     // databases to always pass the committing part.
-    let expected_height: u32 = sealed_block.entity.header().consensus.height.into();
+    let expected_height: u32 = sealed_block.entity.header().consensus().height.into();
     let previous_height = expected_height.checked_sub(1).unwrap_or_default();
     let execute_and_commit_result = execute_and_commit_assert(
         sealed_block,

crates/services/p2p/src/p2p_service.rs

@@ -1463,7 +1463,7 @@ mod tests {
         let mut blocks = Vec::new();
         for i in range {
             let mut header: BlockHeader = Default::default();
-            header.consensus.height = i.into();
+            header.consensus_mut().height = i.into();
 
             let sealed_block = SealedBlockHeader {
                 entity: header,
@@ -1476,8 +1476,8 @@ mod tests {
 
     // Metadata gets skipped during serialization, so this is the fuzzy way to compare blocks
     fn eq_except_metadata(a: &SealedBlockHeader, b: &SealedBlockHeader) -> bool {
-        a.entity.application == b.entity.application
-            && a.entity.consensus == b.entity.consensus
+        a.entity.application() == b.entity.application()
+            && a.entity.consensus() == b.entity.consensus()
     }
 
     async fn request_response_works_with(request_msg: RequestMessage) {

crates/services/sync/src/import.rs

@@ -552,7 +552,7 @@ where
     skip_all,
     fields(
         height = **block.entity.header().height(),
-        id = %block.entity.header().consensus.generated.application_hash
+        id = %block.entity.header().consensus().generated.application_hash
     ),
     err
 )]

crates/services/sync/src/import/test_helpers.rs

@@ -42,11 +42,11 @@ pub fn random_peer() -> PeerId {
 pub fn empty_header<I: Into<BlockHeight>>(i: I) -> SealedBlockHeader {
     let mut header = BlockHeader::default();
     let height = i.into();
-    header.consensus.height = height;
+    header.consensus_mut().height = height;
     let transaction_tree =
         fuel_core_types::fuel_merkle::binary::root_calculator::MerkleRootCalculator::new(
         );
-    header.application.generated.transactions_root = transaction_tree.root().into();
+    header.application_mut().generated.transactions_root = transaction_tree.root().into();
 
     let consensus = Consensus::default();
     Sealed {

crates/types/src/blockchain/block.rs

@@ -14,6 +14,7 @@ use super::{
     },
 };
 use crate::{
+    blockchain::header::BlockHeaderV1,
     fuel_tx::{
         Transaction,
         TxId,
@@ -227,7 +228,7 @@ impl From<Block> for PartialFuelBlock {
         match block {
             Block::V1(BlockV1 {
                 header:
-                    BlockHeader {
+                    BlockHeader::V1(BlockHeaderV1 {
                         application: ApplicationHeader { da_height, .. },
                         consensus:
                             ConsensusHeader {
@@ -237,7 +238,7 @@ impl From<Block> for PartialFuelBlock {
                                 ..
                             },
                         ..
-                    },
+                    }),
                 transactions,
             }) => Self {
                 header: PartialBlockHeader {