chore(consensus): Add docs ab soon deprecated BeaconConsensusEngine (…

…paradigmxyz#13439)
ethereum-optimism · Dec 20, 2024 · 0680675 · 0680675
1 parent d1dcc0b
commit 0680675
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/crates/consensus/beacon/src/engine/mod.rs b/crates/consensus/beacon/src/engine/mod.rs
@@ -167,6 +167,8 @@ type PendingForkchoiceUpdate<PayloadAttributes> =
 /// # Panics
 ///
 /// If the future is polled more than once. Leads to undefined state.
+///
+/// Note: soon deprecated. See `reth_engine_service::EngineService`.
 #[must_use = "Future does nothing unless polled"]
 #[allow(missing_debug_implementations)]
 pub struct BeaconConsensusEngine<N, BT, Client>