reth_engine_primitives/
message.rs

1use crate::{
2    error::BeaconForkChoiceUpdateError, BeaconOnNewPayloadError, ExecutionPayload, ForkchoiceStatus,
3};
4use alloy_rpc_types_engine::{
5    ForkChoiceUpdateResult, ForkchoiceState, ForkchoiceUpdateError, ForkchoiceUpdated, PayloadId,
6    PayloadStatus, PayloadStatusEnum,
7};
8use core::{
9    fmt::{self, Display},
10    future::Future,
11    pin::Pin,
12    task::{ready, Context, Poll},
13};
14use futures::{future::Either, FutureExt, TryFutureExt};
15use reth_errors::RethResult;
16use reth_payload_builder_primitives::PayloadBuilderError;
17use reth_payload_primitives::PayloadTypes;
18use std::time::Duration;
19use tokio::sync::{mpsc::UnboundedSender, oneshot};
20
21/// Type alias for backwards compat
22#[deprecated(note = "Use ConsensusEngineHandle instead")]
23pub type BeaconConsensusEngineHandle<Payload> = ConsensusEngineHandle<Payload>;
24
25/// Represents the outcome of forkchoice update.
26///
27/// This is a future that resolves to [`ForkChoiceUpdateResult`]
28#[must_use = "futures do nothing unless you `.await` or poll them"]
29#[derive(Debug)]
30pub struct OnForkChoiceUpdated {
31    /// Represents the status of the forkchoice update.
32    ///
33    /// Note: This is separate from the response `fut`, because we still can return an error
34    /// depending on the payload attributes, even if the forkchoice update itself is valid.
35    forkchoice_status: ForkchoiceStatus,
36    /// Returns the result of the forkchoice update.
37    fut: Either<futures::future::Ready<ForkChoiceUpdateResult>, PendingPayloadId>,
38}
39
40// === impl OnForkChoiceUpdated ===
41
42impl OnForkChoiceUpdated {
43    /// Returns the determined status of the received `ForkchoiceState`.
44    pub const fn forkchoice_status(&self) -> ForkchoiceStatus {
45        self.forkchoice_status
46    }
47
48    /// Creates a new instance of `OnForkChoiceUpdated` for the `SYNCING` state
49    pub fn syncing() -> Self {
50        let status = PayloadStatus::from_status(PayloadStatusEnum::Syncing);
51        Self {
52            forkchoice_status: ForkchoiceStatus::from_payload_status(&status.status),
53            fut: Either::Left(futures::future::ready(Ok(ForkchoiceUpdated::new(status)))),
54        }
55    }
56
57    /// Creates a new instance of `OnForkChoiceUpdated` if the forkchoice update succeeded and no
58    /// payload attributes were provided.
59    pub fn valid(status: PayloadStatus) -> Self {
60        Self {
61            forkchoice_status: ForkchoiceStatus::from_payload_status(&status.status),
62            fut: Either::Left(futures::future::ready(Ok(ForkchoiceUpdated::new(status)))),
63        }
64    }
65
66    /// Creates a new instance of `OnForkChoiceUpdated` with the given payload status, if the
67    /// forkchoice update failed due to an invalid payload.
68    pub fn with_invalid(status: PayloadStatus) -> Self {
69        Self {
70            forkchoice_status: ForkchoiceStatus::from_payload_status(&status.status),
71            fut: Either::Left(futures::future::ready(Ok(ForkchoiceUpdated::new(status)))),
72        }
73    }
74
75    /// Creates a new instance of `OnForkChoiceUpdated` if the forkchoice update failed because the
76    /// given state is considered invalid
77    pub fn invalid_state() -> Self {
78        Self {
79            forkchoice_status: ForkchoiceStatus::Invalid,
80            fut: Either::Left(futures::future::ready(Err(ForkchoiceUpdateError::InvalidState))),
81        }
82    }
83
84    /// Creates a new instance of `OnForkChoiceUpdated` if the forkchoice update was successful but
85    /// payload attributes were invalid.
86    pub fn invalid_payload_attributes() -> Self {
87        Self {
88            // This is valid because this is only reachable if the state and payload is valid
89            forkchoice_status: ForkchoiceStatus::Valid,
90            fut: Either::Left(futures::future::ready(Err(
91                ForkchoiceUpdateError::UpdatedInvalidPayloadAttributes,
92            ))),
93        }
94    }
95
96    /// If the forkchoice update was successful and no payload attributes were provided, this method
97    pub const fn updated_with_pending_payload_id(
98        payload_status: PayloadStatus,
99        pending_payload_id: oneshot::Receiver<Result<PayloadId, PayloadBuilderError>>,
100    ) -> Self {
101        Self {
102            forkchoice_status: ForkchoiceStatus::from_payload_status(&payload_status.status),
103            fut: Either::Right(PendingPayloadId {
104                payload_status: Some(payload_status),
105                pending_payload_id,
106            }),
107        }
108    }
109}
110
111impl Future for OnForkChoiceUpdated {
112    type Output = ForkChoiceUpdateResult;
113
114    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
115        self.get_mut().fut.poll_unpin(cx)
116    }
117}
118
119/// A future that returns the payload id of a yet to be initiated payload job after a successful
120/// forkchoice update
121#[derive(Debug)]
122struct PendingPayloadId {
123    payload_status: Option<PayloadStatus>,
124    pending_payload_id: oneshot::Receiver<Result<PayloadId, PayloadBuilderError>>,
125}
126
127impl Future for PendingPayloadId {
128    type Output = ForkChoiceUpdateResult;
129
130    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
131        let this = self.get_mut();
132        let res = ready!(this.pending_payload_id.poll_unpin(cx));
133        match res {
134            Ok(Ok(payload_id)) => Poll::Ready(Ok(ForkchoiceUpdated {
135                payload_status: this.payload_status.take().expect("Polled after completion"),
136                payload_id: Some(payload_id),
137            })),
138            Err(_) | Ok(Err(_)) => {
139                // failed to initiate a payload build job
140                Poll::Ready(Err(ForkchoiceUpdateError::UpdatedInvalidPayloadAttributes))
141            }
142        }
143    }
144}
145
146/// Timing breakdown for `reth_newPayload` responses.
147#[derive(Debug, Clone, Copy)]
148pub struct NewPayloadTimings {
149    /// Server-side execution latency.
150    pub latency: Duration,
151    /// Time spent waiting for persistence to complete.
152    ///
153    /// `None` when wasn't asked to wait for persistence.
154    pub persistence_wait: Option<Duration>,
155    /// Time spent waiting for the execution cache lock.
156    ///
157    /// `None` when wasn't asked to wait for execution cache.
158    pub execution_cache_wait: Option<Duration>,
159    /// Time spent waiting for the sparse trie cache lock.
160    ///
161    /// `None` when wasn't asked to wait for sparse trie cache.
162    pub sparse_trie_wait: Option<Duration>,
163}
164
165/// A message for the beacon engine from other components of the node (engine RPC API invoked by the
166/// consensus layer).
167#[derive(Debug)]
168pub enum BeaconEngineMessage<Payload: PayloadTypes> {
169    /// Message with new payload.
170    NewPayload {
171        /// The execution payload received by Engine API.
172        payload: Payload::ExecutionData,
173        /// The sender for returning payload status result.
174        tx: oneshot::Sender<Result<PayloadStatus, BeaconOnNewPayloadError>>,
175    },
176    /// Message with new payload used by `reth_newPayload` endpoint.
177    ///
178    /// Supports independent control over waiting for persistence and cache locks before
179    /// processing, providing unbiased timing measurements when enabled.
180    ///
181    /// Returns detailed timing breakdown alongside the payload status.
182    RethNewPayload {
183        /// The execution payload received by Engine API.
184        payload: Payload::ExecutionData,
185        /// Whether to wait for in-flight persistence to complete before processing.
186        wait_for_persistence: bool,
187        /// Whether to wait for execution cache and sparse trie locks before processing.
188        wait_for_caches: bool,
189        /// The sender for returning payload status result and timing breakdown.
190        tx: oneshot::Sender<Result<(PayloadStatus, NewPayloadTimings), BeaconOnNewPayloadError>>,
191    },
192    /// Message with updated forkchoice state.
193    ForkchoiceUpdated {
194        /// The updated forkchoice state.
195        state: ForkchoiceState,
196        /// The payload attributes for block building.
197        payload_attrs: Option<Payload::PayloadAttributes>,
198        /// The sender for returning forkchoice updated result.
199        tx: oneshot::Sender<RethResult<OnForkChoiceUpdated>>,
200    },
201}
202
203impl<Payload: PayloadTypes> Display for BeaconEngineMessage<Payload> {
204    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
205        match self {
206            Self::NewPayload { payload, .. } => {
207                write!(
208                    f,
209                    "NewPayload(parent: {}, number: {}, hash: {})",
210                    payload.parent_hash(),
211                    payload.block_number(),
212                    payload.block_hash()
213                )
214            }
215            Self::RethNewPayload { payload, .. } => {
216                write!(
217                    f,
218                    "RethNewPayload(parent: {}, number: {}, hash: {})",
219                    payload.parent_hash(),
220                    payload.block_number(),
221                    payload.block_hash()
222                )
223            }
224            Self::ForkchoiceUpdated { state, payload_attrs, .. } => {
225                // we don't want to print the entire payload attributes, because for OP this
226                // includes all txs
227                write!(
228                    f,
229                    "ForkchoiceUpdated {{ state: {state:?}, has_payload_attributes: {} }}",
230                    payload_attrs.is_some()
231                )
232            }
233        }
234    }
235}
236
237/// A cloneable sender type that can be used to send engine API messages.
238///
239/// This type mirrors consensus related functions of the engine API.
240#[derive(Debug, Clone)]
241pub struct ConsensusEngineHandle<Payload>
242where
243    Payload: PayloadTypes,
244{
245    to_engine: UnboundedSender<BeaconEngineMessage<Payload>>,
246}
247
248impl<Payload> ConsensusEngineHandle<Payload>
249where
250    Payload: PayloadTypes,
251{
252    /// Creates a new beacon consensus engine handle.
253    pub const fn new(to_engine: UnboundedSender<BeaconEngineMessage<Payload>>) -> Self {
254        Self { to_engine }
255    }
256
257    /// Sends a new payload message to the beacon consensus engine and waits for a response.
258    ///
259    /// See also <https://github.com/ethereum/execution-apis/blob/3d627c95a4d3510a8187dd02e0250ecb4331d27e/src/engine/shanghai.md#engine_newpayloadv2>
260    pub async fn new_payload(
261        &self,
262        payload: Payload::ExecutionData,
263    ) -> Result<PayloadStatus, BeaconOnNewPayloadError> {
264        let (tx, rx) = oneshot::channel();
265        let _ = self.to_engine.send(BeaconEngineMessage::NewPayload { payload, tx });
266        rx.await.map_err(|_| BeaconOnNewPayloadError::EngineUnavailable)?
267    }
268
269    /// Sends a new payload message used by `reth_newPayload` endpoint.
270    ///
271    /// `wait_for_persistence`: waits for in-flight persistence to complete.
272    /// `wait_for_caches`: waits for execution cache and sparse trie locks.
273    ///
274    /// Returns detailed timing breakdown alongside the payload status.
275    pub async fn reth_new_payload(
276        &self,
277        payload: Payload::ExecutionData,
278        wait_for_persistence: bool,
279        wait_for_caches: bool,
280    ) -> Result<(PayloadStatus, NewPayloadTimings), BeaconOnNewPayloadError> {
281        let (tx, rx) = oneshot::channel();
282        let _ = self.to_engine.send(BeaconEngineMessage::RethNewPayload {
283            payload,
284            wait_for_persistence,
285            wait_for_caches,
286            tx,
287        });
288        rx.await.map_err(|_| BeaconOnNewPayloadError::EngineUnavailable)?
289    }
290
291    /// Sends a forkchoice update message to the beacon consensus engine and waits for a response.
292    ///
293    /// See also <https://github.com/ethereum/execution-apis/blob/3d627c95a4d3510a8187dd02e0250ecb4331d27e/src/engine/shanghai.md#engine_forkchoiceupdatedv2>
294    pub async fn fork_choice_updated(
295        &self,
296        state: ForkchoiceState,
297        payload_attrs: Option<Payload::PayloadAttributes>,
298    ) -> Result<ForkchoiceUpdated, BeaconForkChoiceUpdateError> {
299        Ok(self
300            .send_fork_choice_updated(state, payload_attrs)
301            .map_err(|_| BeaconForkChoiceUpdateError::EngineUnavailable)
302            .await?
303            .map_err(BeaconForkChoiceUpdateError::internal)?
304            .await?)
305    }
306
307    /// Sends a forkchoice update message to the beacon consensus engine and returns the receiver to
308    /// wait for a response.
309    fn send_fork_choice_updated(
310        &self,
311        state: ForkchoiceState,
312        payload_attrs: Option<Payload::PayloadAttributes>,
313    ) -> oneshot::Receiver<RethResult<OnForkChoiceUpdated>> {
314        let (tx, rx) = oneshot::channel();
315        let _ = self.to_engine.send(BeaconEngineMessage::ForkchoiceUpdated {
316            state,
317            payload_attrs,
318            tx,
319        });
320        rx
321    }
322}
reth_engine_primitives/message.rs

reth_engine_primitives/
message.rs
