feat: new engine API handler

CODEOWNERS

@@ -6,8 +6,9 @@ crates/chainspec/           @Rjected @joshieDo @mattsse
 crates/cli/                 @onbjerg @mattsse
 crates/config/              @onbjerg
 crates/consensus/           @rkrasiuk @mattsse @Rjected
+crates/engine               @rkrasiuk @mattsse @Rjected
 crates/e2e-test-utils/      @mattsse @Rjected
-crates/engine-primitives/   @rkrasiuk @mattsse @Rjected
+crates/engine/              @rkrasiuk @mattsse @Rjected @fgimenez
 crates/errors/              @mattsse
 crates/ethereum/            @mattsse @Rjected
 crates/ethereum-forks/      @mattsse @Rjected

Cargo.toml

@@ -26,6 +26,7 @@ members = [
     "crates/ethereum-forks/",
     "crates/e2e-test-utils/",
     "crates/engine/primitives/",
+    "crates/engine/tree/",
     "crates/engine/util/",
     "crates/errors/",
     "crates/ethereum-forks/",
@@ -287,6 +288,7 @@ reth-downloaders = { path = "crates/net/downloaders" }
 reth-e2e-test-utils = { path = "crates/e2e-test-utils" }
 reth-ecies = { path = "crates/net/ecies" }
 reth-engine-primitives = { path = "crates/engine/primitives" }
+reth-engine-tree = { path = "crates/engine/tree" }
 reth-engine-util = { path = "crates/engine/util" }
 reth-errors = { path = "crates/errors" }
 reth-eth-wire = { path = "crates/net/eth-wire" }

crates/consensus/beacon/src/engine/forkchoice.rs

@@ -3,7 +3,7 @@ use reth_rpc_types::engine::{ForkchoiceState, PayloadStatusEnum};
 
 /// The struct that keeps track of the received forkchoice state and their status.
 #[derive(Debug, Clone, Default)]
-pub(crate) struct ForkchoiceStateTracker {
+pub struct ForkchoiceStateTracker {
     /// The latest forkchoice state that we received.
     ///
     /// Caution: this can be invalid.
@@ -76,7 +76,7 @@ impl ForkchoiceStateTracker {
     }
 
     /// Returns the last received `ForkchoiceState` to which we need to sync.
-    pub(crate) const fn sync_target_state(&self) -> Option<ForkchoiceState> {
+    pub const fn sync_target_state(&self) -> Option<ForkchoiceState> {
         self.last_syncing
     }
 
@@ -139,9 +139,12 @@ impl From<PayloadStatusEnum> for ForkchoiceStatus {
 
 /// A helper type to check represent hashes of a [`ForkchoiceState`]
 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
-pub(crate) enum ForkchoiceStateHash {
+pub enum ForkchoiceStateHash {
+    /// Head hash of the [`ForkchoiceState`].
     Head(B256),
+    /// Safe hash of the [`ForkchoiceState`].
     Safe(B256),
+    /// Finalized hash of the [`ForkchoiceState`].
     Finalized(B256),
 }
 

crates/consensus/beacon/src/engine/invalid_headers.rs

@@ -14,7 +14,8 @@ use tracing::warn;
 const INVALID_HEADER_HIT_EVICTION_THRESHOLD: u8 = 128;
 
 /// Keeps track of invalid headers.
-pub(crate) struct InvalidHeaderCache {
+#[derive(Debug)]
+pub struct InvalidHeaderCache {
     /// This maps a header hash to a reference to its invalid ancestor.
     headers: LruMap<B256, HeaderEntry>,
     /// Metrics for the cache.
@@ -34,7 +35,7 @@ impl InvalidHeaderCache {
     ///
     /// If this is called, the hit count for the entry is incremented.
     /// If the hit count exceeds the threshold, the entry is evicted and `None` is returned.
-    pub(crate) fn get(&mut self, hash: &B256) -> Option<Arc<Header>> {
+    pub fn get(&mut self, hash: &B256) -> Option<Arc<Header>> {
         {
             let entry = self.headers.get(hash)?;
             entry.hit_count += 1;
@@ -49,7 +50,7 @@ impl InvalidHeaderCache {
     }
 
     /// Inserts an invalid block into the cache, with a given invalid ancestor.
-    pub(crate) fn insert_with_invalid_ancestor(
+    pub fn insert_with_invalid_ancestor(
         &mut self,
         header_hash: B256,
         invalid_ancestor: Arc<Header>,

crates/consensus/beacon/src/engine/mod.rs

@@ -53,7 +53,7 @@ pub use error::{
 };
 
 mod invalid_headers;
-use invalid_headers::InvalidHeaderCache;
+pub use invalid_headers::InvalidHeaderCache;
 
 mod event;
 pub use event::{BeaconConsensusEngineEvent, ConsensusEngineLiveSyncProgress};
@@ -62,13 +62,12 @@ mod handle;
 pub use handle::BeaconConsensusEngineHandle;
 
 mod forkchoice;
-pub use forkchoice::ForkchoiceStatus;
-use forkchoice::{ForkchoiceStateHash, ForkchoiceStateTracker};
+pub use forkchoice::{ForkchoiceStateHash, ForkchoiceStateTracker, ForkchoiceStatus};
 
 mod metrics;
 use metrics::EngineMetrics;
 
-pub(crate) mod sync;
+pub mod sync;
 use sync::{EngineSyncController, EngineSyncEvent};
 
 /// Hooks for running during the main loop of

crates/engine/tree/Cargo.toml

@@ -0,0 +1,64 @@
+[package]
+name = "reth-engine-tree"
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+homepage.workspace = true
+repository.workspace = true
+
+[lints]
+workspace = true
+
+[dependencies]
+# reth
+reth-beacon-consensus.workspace = true
+reth-blockchain-tree.workspace = true
+reth-blockchain-tree-api.workspace = true
+reth-chainspec.workspace = true
+reth-consensus.workspace = true
+reth-db.workspace = true
+reth-db-api.workspace = true
+reth-engine-primitives.workspace = true
+reth-errors.workspace = true
+reth-ethereum-consensus.workspace = true
+reth-evm.workspace = true
+reth-network-p2p.workspace = true
+reth-payload-builder.workspace = true
+reth-payload-primitives.workspace = true
+reth-payload-validator.workspace = true
+reth-primitives.workspace = true
+reth-provider.workspace = true
+reth-prune.workspace = true
+reth-revm.workspace = true
+reth-rpc-types.workspace = true
+reth-stages-api.workspace = true
+reth-static-file.workspace = true
+reth-tasks.workspace = true
+reth-tokio-util.workspace = true
+reth-trie.workspace = true
+revm.workspace = true
+
+# common
+futures.workspace = true
+tokio = { workspace = true, features = ["macros", "sync"] }
+tokio-stream = { workspace = true, features = ["sync"] }
+
+
+# metrics
+metrics.workspace = true
+reth-metrics = { workspace = true, features = ["common"] }
+
+# misc
+aquamarine.workspace = true
+parking_lot.workspace = true
+tracing.workspace = true
+
+[dev-dependencies]
+# reth
+reth-network-p2p = { workspace = true, features = ["test-utils"] }
+reth-prune-types.workspace = true
+reth-stages = { workspace = true, features = ["test-utils"] }
+reth-tracing.workspace = true
+
+assert_matches.workspace = true