feat: JournalDb trait

Author: prestwich

Cargo.toml

@@ -53,7 +53,7 @@ signet-zenith = "0.9.0"
 ajj = { version = "0.3.4" }
 
 # trevm
-trevm = { version = "0.27.0", features = ["full_env_cfg"] }
+trevm = { version = "0.27.1", features = ["full_env_cfg"] }
 
 # Alloy periphery crates
 alloy = { version = "1.0.19", features = [

crates/db/Cargo.toml

@@ -11,11 +11,12 @@ repository.workspace = true
 [dependencies]
 signet-node-types.workspace = true
 
-
 signet-evm.workspace = true
 signet-types.workspace = true
 signet-zenith.workspace = true
 
+trevm.workspace = true
+
 alloy.workspace = true
 
 reth.workspace = true

crates/db/src/journal/mod.rs

@@ -0,0 +1,4 @@
+//! Utilities for working with Signet journals in a reth database.
+
+mod r#trait;
+pub use r#trait::JournalDb;

crates/db/src/journal/trait.rs

@@ -0,0 +1,47 @@
+use crate::RuWriter;
+use alloy::consensus::{BlockHeader, Header};
+use reth::{providers::ProviderResult, revm::db::BundleState};
+use signet_evm::{BlockResult, ExecutionOutcome};
+use signet_types::primitives::{RecoveredBlock, SealedBlock, SealedHeader, TransactionSigned};
+use trevm::journal::BlockUpdate;
+
+/// A database that can be updated with journals.
+pub trait JournalDb: RuWriter {
+    /// Ingest a journal into the database.
+    ///
+    /// This will create a [`BlockResult`] from the provided header and update,
+    /// and append it to the database using [`RuWriter::append_host_block`].
+    ///
+    /// This DOES NOT update tables containing historical transactions,
+    /// receipts, events, etc. It only updates tables related to headers,
+    /// and state.
+    ///
+    /// This is intended to be used for tx simulation, and other purposes that
+    /// need fast state access WITHTOUT needing to retrieve historical data.
+    fn ingest(&self, header: &Header, update: BlockUpdate<'_>) -> ProviderResult<()> {
+        let journal_hash = update.journal_hash();
+
+        // TODO: remove the clone in future versions. This can be achieved by
+        // _NOT_ making a `BlockResult` and instead manually updating relevan
+        // tables. However, this means diverging more fro the underlying reth
+        // logic that we are currently re-using.
+        let bundle_state: BundleState = update.journal().clone().into();
+        let execution_outcome = ExecutionOutcome::new(bundle_state, vec![], header.number());
+
+        let block: SealedBlock<TransactionSigned, Header> =
+            SealedBlock { header: SealedHeader::new(header.to_owned()), body: Default::default() };
+        let block_result =
+            BlockResult { sealed_block: RecoveredBlock::new(block, vec![]), execution_outcome };
+
+        self.append_host_block(
+            None,
+            std::iter::empty(),
+            std::iter::empty(),
+            std::iter::empty(),
+            &block_result,
+            journal_hash,
+        )
+    }
+}
+
+impl<T> JournalDb for T where T: RuWriter {}

crates/db/src/lib.rs

@@ -17,6 +17,8 @@ pub use chain::{DbExtractionResults, RuChain};
 mod convert;
 pub use convert::DataCompat;
 
+pub mod journal;
+
 mod provider;
 
 mod tables;

crates/db/src/provider.rs

@@ -430,7 +430,6 @@ where
     /// see the documentation for each function.
     fn append_host_block(
         &self,
-        host_height: u64,
         header: Option<Zenith::BlockHeader>,
         transacts: impl IntoIterator<Item = Transact>,
         enters: impl IntoIterator<Item = Passage::Enter>,
@@ -480,7 +479,7 @@ where
 
         self.update_pipeline_stages(ru_height, false)?;
 
-        debug!(target: "signet_db_lifecycle", host_height, ru_height, "Appended blocks");
+        debug!(target: "signet_db_lifecycle", ru_height, "Appended blocks");
 
         Ok(())
     }

crates/db/src/traits.rs

@@ -254,7 +254,6 @@ pub trait RuWriter {
     #[allow(clippy::too_many_arguments)]
     fn append_host_block(
         &self,
-        host_height: u64,
         header: Option<Zenith::BlockHeader>,
         transacts: impl IntoIterator<Item = Transactor::Transact>,
         enters: impl IntoIterator<Item = Passage::Enter>,