reth_e2e_test_utils/
payload.rs

1use futures_util::StreamExt;
2use reth_node_api::{PayloadAttributes, PayloadKind};
3use reth_payload_builder::{PayloadBuilderHandle, PayloadId};
4use reth_payload_builder_primitives::Events;
5use reth_payload_primitives::PayloadTypes;
6use tokio_stream::wrappers::BroadcastStream;
7
8/// Helper for payload operations
9#[derive(derive_more::Debug)]
10pub struct PayloadTestContext<T: PayloadTypes> {
11    pub payload_event_stream: BroadcastStream<Events<T>>,
12    payload_builder: PayloadBuilderHandle<T>,
13    pub timestamp: u64,
14    #[debug(skip)]
15    attributes_generator: Box<dyn Fn(u64) -> T::PayloadAttributes + Send + Sync>,
16}
17
18impl<T: PayloadTypes> PayloadTestContext<T> {
19    /// Creates a new payload helper
20    pub async fn new(
21        payload_builder: PayloadBuilderHandle<T>,
22        attributes_generator: impl Fn(u64) -> T::PayloadAttributes + Send + Sync + 'static,
23    ) -> eyre::Result<Self> {
24        let payload_events = payload_builder.subscribe().await?;
25        let payload_event_stream = payload_events.into_stream();
26        // Cancun timestamp
27        Ok(Self {
28            payload_event_stream,
29            payload_builder,
30            timestamp: 1710338135,
31            attributes_generator: Box::new(attributes_generator),
32        })
33    }
34
35    /// Generates the next payload attributes
36    pub fn next_attributes(&mut self) -> T::PayloadAttributes {
37        self.timestamp += 1;
38        (self.attributes_generator)(self.timestamp)
39    }
40
41    /// Asserts that the next event is a payload attributes event
42    pub async fn expect_attr_event(&mut self, attrs: T::PayloadAttributes) -> eyre::Result<()> {
43        let first_event = self.payload_event_stream.next().await.unwrap()?;
44        if let Events::Attributes(attr) = first_event {
45            assert_eq!(attrs.timestamp(), attr.timestamp());
46        } else {
47            panic!("Expect first event as payload attributes.")
48        }
49        Ok(())
50    }
51
52    /// Wait until the best built payload is ready.
53    ///
54    /// Panics if the payload builder does not produce a non-empty payload within 30 seconds.
55    pub async fn wait_for_built_payload(&self, payload_id: PayloadId) {
56        self.payload_builder
57            .resolve_kind(payload_id, PayloadKind::WaitForPending)
58            .await
59            .unwrap()
60            .unwrap();
61    }
62
63    /// Expects the next event to be a built payload event or panics
64    pub async fn expect_built_payload(&mut self) -> eyre::Result<T::BuiltPayload> {
65        let second_event = self.payload_event_stream.next().await.unwrap()?;
66        if let Events::BuiltPayload(payload) = second_event {
67            Ok(payload)
68        } else {
69            panic!("Expect a built payload event.");
70        }
71    }
72}
reth_e2e_test_utils/payload.rs

reth_e2e_test_utils/
payload.rs
