Keep record of events from L1 in Block Header (#1769)

closes FuelLabs/fuel-core#1741 This PR introduces a new field on the block header generated section called `event_inbox_root`. This is calculated after execution by adding all the hashes of the events from the L1 relayer to a merkle tree and generating the root. Also renamed the message receipt root to `message_outbox_root` to keep up the theme.
crypto523 · Mar 22, 2024 · 380dd0d · 380dd0d
1 parent 45fafe5
commit 380dd0d
Show file tree

Hide file tree

Showing 22 changed files with 141 additions and 45 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,6 +21,7 @@ Description of the upcoming release here.
 ### Changed
 
 #### Breaking
+- [#1769](https://github.com/FuelLabs/fuel-core/pull/1769): Include new field on header for the merkle root of imported events. Rename other message root field.
 - [#1768](https://github.com/FuelLabs/fuel-core/pull/1768): Moved `ContractsInfo` table to the off-chain database. Removed `salt` field from the `ContractConfig`.
 - [#1761](https://github.com/FuelLabs/fuel-core/pull/1761): Adjustments to the upcoming testnet configs:
   - Decreased the max size of the contract/predicate/script to be 100KB.

diff --git a/crates/client/assets/schema.sdl b/crates/client/assets/schema.sdl
@@ -469,7 +469,11 @@ type Header {
 	"""
 	Merkle root of message receipts in this block.
 	"""
-	messageReceiptRoot: Bytes32!
+	messageOutboxRoot: Bytes32!
+	"""
+	Merkle root of inbox events in this block.
+	"""
+	eventInboxRoot: Bytes32!
 	"""
 	Fuel block height.
 	"""

diff --git a/crates/client/src/client/schema/block.rs b/crates/client/src/client/schema/block.rs
@@ -124,7 +124,8 @@ pub struct Header {
     pub transactions_count: U64,
     pub message_receipt_count: U64,
     pub transactions_root: Bytes32,
-    pub message_receipt_root: Bytes32,
+    pub message_outbox_root: Bytes32,
+    pub event_inbox_root: Bytes32,
     pub height: U32,
     pub prev_root: Bytes32,
     pub time: Tai64Timestamp,

diff --git a/...ots/fuel_core_client__client__schema__block__tests__block_by_height_query_gql_output.snap b/...ots/fuel_core_client__client__schema__block__tests__block_by_height_query_gql_output.snap
@@ -13,7 +13,8 @@ query($height: U32) {
       transactionsCount
       messageReceiptCount
       transactionsRoot
-      messageReceiptRoot
+      messageOutboxRoot
+      eventInboxRoot
       height
       prevRoot
       time

diff --git a/...apshots/fuel_core_client__client__schema__block__tests__block_by_id_query_gql_output.snap b/...apshots/fuel_core_client__client__schema__block__tests__block_by_id_query_gql_output.snap
@@ -13,7 +13,8 @@ query($id: BlockId) {
       transactionsCount
       messageReceiptCount
       transactionsRoot
-      messageReceiptRoot
+      messageOutboxRoot
+      eventInboxRoot
       height
       prevRoot
       time

diff --git a/...s/fuel_core_client__client__schema__block__tests__blocks_connection_query_gql_output.snap b/...s/fuel_core_client__client__schema__block__tests__blocks_connection_query_gql_output.snap
@@ -16,7 +16,8 @@ query($after: String, $before: String, $first: Int, $last: Int) {
           transactionsCount
           messageReceiptCount
           transactionsRoot
-          messageReceiptRoot
+          messageOutboxRoot
+          eventInboxRoot
           height
           prevRoot
           time

diff --git a/...ema/snapshots/fuel_core_client__client__schema__chain__tests__chain_gql_query_output.snap b/...ema/snapshots/fuel_core_client__client__schema__chain__tests__chain_gql_query_output.snap
@@ -16,7 +16,8 @@ query {
         transactionsCount
         messageReceiptCount
         transactionsRoot
-        messageReceiptRoot
+        messageOutboxRoot
+        eventInboxRoot
         height
         prevRoot
         time

diff --git a/crates/client/src/client/types/block.rs b/crates/client/src/client/types/block.rs
@@ -36,7 +36,8 @@ pub struct Header {
     pub transactions_count: u64,
     pub message_receipt_count: u64,
     pub transactions_root: MerkleRoot,
-    pub message_receipt_root: MerkleRoot,
+    pub message_outbox_root: MerkleRoot,
+    pub event_inbox_root: MerkleRoot,
     pub height: u32,
     pub prev_root: MerkleRoot,
     pub time: Tai64,
@@ -77,7 +78,8 @@ impl From<schema::block::Header> for Header {
             transactions_count: value.transactions_count.into(),
             message_receipt_count: value.message_receipt_count.into(),
             transactions_root: value.transactions_root.into(),
-            message_receipt_root: value.message_receipt_root.into(),
+            message_outbox_root: value.message_outbox_root.into(),
+            event_inbox_root: value.event_inbox_root.into(),
             height: value.height.into(),
             prev_root: value.prev_root.into(),
             time: value.time.0,

diff --git a/crates/fuel-core/src/database/block.rs b/crates/fuel-core/src/database/block.rs
@@ -166,7 +166,7 @@ mod tests {
                     },
                 };
                 let block = PartialFuelBlock::new(header, vec![]);
-                block.generate(&[])
+                block.generate(&[], Default::default())
             })
             .collect::<Vec<_>>();
 

diff --git a/crates/fuel-core/src/executor.rs b/crates/fuel-core/src/executor.rs
@@ -1,5 +1,6 @@
 #[allow(clippy::arithmetic_side_effects)]
 #[allow(clippy::cast_possible_truncation)]
+#[allow(non_snake_case)]
 #[cfg(test)]
 mod tests {
     use crate as fuel_core;
@@ -2953,6 +2954,7 @@ mod tests {
             },
             StorageAsMut,
         };
+        use fuel_core_types::fuel_merkle::binary::root_calculator::MerkleRootCalculator;
 
         fn database_with_genesis_block(da_block_height: u64) -> Database<OnChain> {
             let mut db = Database::default();
@@ -3099,6 +3101,41 @@ mod tests {
             Ok(())
         }
 
+        #[test]
+        fn execute_without_commit__block_producer_includes_correct_inbox_event_merkle_root(
+        ) {
+            // given
+            let genesis_da_height = 3u64;
+            let on_chain_db = database_with_genesis_block(genesis_da_height);
+            let mut relayer_db = Database::<Relayer>::default();
+            let block_height = 1u32;
+            let relayer_da_height = 10u64;
+            let mut root_calculator = MerkleRootCalculator::new();
+            for da_height in (genesis_da_height + 1)..=relayer_da_height {
+                let mut message = Message::default();
+                message.set_da_height(da_height.into());
+                message.set_nonce(da_height.into());
+                root_calculator.push(message.id().as_ref());
+                add_message_to_relayer(&mut relayer_db, message);
+            }
+            let producer = create_relayer_executor(on_chain_db, relayer_db);
+            let block = test_block(block_height.into(), relayer_da_height.into(), 0);
+
+            // when
+            let (result, _) = producer
+                .execute_without_commit(
+                    ExecutionTypes::Production(block.into()),
+                    Default::default(),
+                )
+                .unwrap()
+                .into();
+
+            // then
+            let expected = root_calculator.root().into();
+            let actual = result.block.header().application().event_inbox_root;
+            assert_eq!(actual, expected);
+        }
+
         #[test]
         fn block_producer_does_not_take_messages_for_the_same_height() {
             let genesis_da_height = 1u64;

diff --git a/crates/fuel-core/src/query/message/test.rs b/crates/fuel-core/src/query/message/test.rs
@@ -141,7 +141,7 @@ async fn can_build_message_proof() {
             generated: Default::default(),
         },
     }
-    .generate(&[], &[]);
+    .generate(&[], &[], Default::default());
     let commit_block = CompressedBlock::test(commit_block_header, vec![]);
     let message_block_header = PartialBlockHeader {
         application: ApplicationHeader {
@@ -157,7 +157,7 @@ async fn can_build_message_proof() {
             generated: Default::default(),
         },
     }
-    .generate(&[], &message_ids);
+    .generate(&[], &message_ids, Default::default());
     let message_block = CompressedBlock::test(message_block_header, TXNS.to_vec());
 
     let block_proof = MerkleProof {
@@ -213,8 +213,8 @@ async fn can_build_message_proof() {
     .unwrap()
     .unwrap();
     assert_eq!(
-        proof.message_block_header.message_receipt_root,
-        message_block.header().message_receipt_root
+        proof.message_block_header.message_outbox_root,
+        message_block.header().message_outbox_root
     );
     assert_eq!(
         proof.message_block_header.height(),

diff --git a/crates/fuel-core/src/schema/block.rs b/crates/fuel-core/src/schema/block.rs
@@ -164,8 +164,13 @@ impl Header {
     }
 
     /// Merkle root of message receipts in this block.
-    async fn message_receipt_root(&self) -> Bytes32 {
-        self.0.message_receipt_root.into()
+    async fn message_outbox_root(&self) -> Bytes32 {
+        self.0.message_outbox_root.into()
+    }
+
+    /// Merkle root of inbox events in this block.
+    async fn event_inbox_root(&self) -> Bytes32 {
+        self.0.event_inbox_root.into()
     }
 
     /// Fuel block height.

diff --git a/crates/fuel-core/src/service/genesis.rs b/crates/fuel-core/src/service/genesis.rs
@@ -158,6 +158,9 @@ fn cleanup_genesis_progress(
 pub fn create_genesis_block(config: &Config) -> Block {
     let block_height = config.state_reader.block_height();
     let da_block_height = config.state_reader.da_block_height();
+    let transactions = vec![];
+    let message_ids = &[];
+    let events = Default::default();
     Block::new(
         PartialBlockHeader {
             application: ApplicationHeader::<Empty> {
@@ -171,17 +174,15 @@ pub fn create_genesis_block(config: &Config) -> Block {
                 generated: Empty,
             },
             consensus: ConsensusHeader::<Empty> {
-                // The genesis is a first block, so previous root is zero.
                 prev_root: Bytes32::zeroed(),
-                // The block height at genesis.
                 height: block_height,
                 time: fuel_core_types::tai64::Tai64::UNIX_EPOCH,
                 generated: Empty,
             },
         },
-        // Genesis block doesn't have any transaction.
-        vec![],
-        &[],
+        transactions,
+        message_ids,
+        events,
     )
 }
 

diff --git a/crates/services/consensus_module/poa/src/verifier/tests.rs b/crates/services/consensus_module/poa/src/verifier/tests.rs
@@ -36,7 +36,7 @@ fn correct() -> Input {
             ..Default::default()
         },
     };
-    let block_header = partial_header.generate(&txs, &[]);
+    let block_header = partial_header.generate(&txs, &[], Default::default());
 
     Input {
         block_header_merkle_root: [2u8; 32],

diff --git a/crates/services/executor/src/executor.rs b/crates/services/executor/src/executor.rs
@@ -53,6 +53,7 @@ use fuel_core_types::{
         RegId,
         Word,
     },
+    fuel_merkle::binary::root_calculator::MerkleRootCalculator,
     fuel_tx::{
         field::{
             InputContract,
@@ -304,6 +305,7 @@ pub struct ExecutionData {
     events: Vec<ExecutorEvent>,
     changes: Changes,
     pub skipped_transactions: Vec<(TxId, ExecutorError)>,
+    event_inbox_root: Bytes32,
 }
 
 /// Per-block execution options
@@ -499,12 +501,13 @@ where
             skipped_transactions,
             events,
             changes,
+            event_inbox_root,
             ..
         } = execution_data;
 
         // Now that the transactions have been executed, generate the full header.
 
-        let block = block.generate(&message_ids[..]);
+        let block = block.generate(&message_ids[..], event_inbox_root);
 
         let finalized_block_id = block.id();
 
@@ -557,6 +560,7 @@ where
             events: Vec::new(),
             changes: Default::default(),
             skipped_transactions: Vec::new(),
+            event_inbox_root: Default::default(),
         };
         let execution_data = &mut data;
 
@@ -724,13 +728,16 @@ where
             return Err(ExecutorError::DaHeightExceededItsLimit)
         };
 
+        let mut root_calculator = MerkleRootCalculator::new();
+
         for da_height in next_unprocessed_da_height..=header.da_height.0 {
             let da_height = da_height.into();
             let events = self
                 .relayer
                 .get_events(&da_height)
                 .map_err(|err| ExecutorError::RelayerError(err.into()))?;
             for event in events {
+                root_calculator.push(event.hash().as_ref());
                 match event {
                     Event::Message(message) => {
                         if message.da_height() != da_height {
@@ -747,6 +754,8 @@ where
             }
         }
 
+        execution_data.event_inbox_root = root_calculator.root().into();
+
         Ok(())
     }
 

diff --git a/crates/services/producer/src/block_producer/tests.rs b/crates/services/producer/src/block_producer/tests.rs
@@ -120,7 +120,7 @@ mod produce_and_execute_block_txpool {
             },
             transactions: vec![],
         }
-        .generate(&[])
+        .generate(&[], Default::default())
         .compress(&Default::default());
 
         let db = MockDb {
@@ -162,7 +162,7 @@ mod produce_and_execute_block_txpool {
             },
             transactions: vec![],
         }
-        .generate(&[])
+        .generate(&[], Default::default())
         .compress(&Default::default());
 
         // Given
@@ -215,7 +215,7 @@ mod produce_and_execute_block_txpool {
             },
             transactions: vec![],
         }
-        .generate(&[])
+        .generate(&[], Default::default())
         .compress(&Default::default());
 
         // Given
@@ -284,7 +284,7 @@ mod produce_and_execute_block_txpool {
             },
             transactions: vec![],
         }
-        .generate(&[])
+        .generate(&[], Default::default())
         .compress(&Default::default());
 
         let db = MockDb {

diff --git a/crates/services/producer/src/mocks.rs b/crates/services/producer/src/mocks.rs
@@ -121,7 +121,12 @@ fn to_block(component: &Components<Vec<ArcPoolTx>>) -> Block {
         .into_iter()
         .map(|tx| tx.as_ref().into())
         .collect();
-    Block::new(component.header_to_produce.clone(), transactions, &[])
+    Block::new(
+        component.header_to_produce.clone(),
+        transactions,
+        &[],
+        Default::default(),
+    )
 }
 
 impl Executor<Vec<ArcPoolTx>> for MockExecutor {

diff --git a/crates/storage/src/structured_storage/blocks.rs b/crates/storage/src/structured_storage/blocks.rs
@@ -100,7 +100,7 @@ mod tests {
                     },
                 };
                 let block = PartialFuelBlock::new(header, vec![]);
-                block.generate(&[])
+                block.generate(&[], Default::default())
             })
             .collect::<Vec<_>>();