reth_network/
message.rs

1//! Capability messaging
2//!
3//! An `RLPx` stream is multiplexed via the prepended message-id of a framed message.
4//! Capabilities are exchanged via the `RLPx` `Hello` message as pairs of `(id, version)`, <https://github.com/ethereum/devp2p/blob/master/rlpx.md#capability-messaging>
5
6use crate::types::{BlockAccessLists, Receipts69, Receipts70};
7use alloy_consensus::{BlockHeader, ReceiptWithBloom};
8use alloy_primitives::{Bytes, B256};
9use futures::FutureExt;
10use reth_eth_wire::{
11    message::RequestPair, BlockBodies, BlockHeaders, BlockRangeUpdate, EthMessage,
12    EthNetworkPrimitives, GetBlockAccessLists, GetBlockBodies, GetBlockHeaders, GetReceipts,
13    NetworkPrimitives, NewBlock, NewBlockHashes, NewBlockPayload, NewPooledTransactionHashes,
14    NodeData, PooledTransactions, Receipts, SharedTransactions, Transactions,
15};
16use reth_eth_wire_types::RawCapabilityMessage;
17use reth_network_api::PeerRequest;
18use reth_network_p2p::error::{RequestError, RequestResult};
19use reth_primitives_traits::Block;
20use std::{
21    sync::Arc,
22    task::{ready, Context, Poll},
23};
24use tokio::sync::oneshot;
25
26/// Internal form of a `NewBlock` message
27#[derive(Debug, Clone)]
28pub struct NewBlockMessage<P = NewBlock<reth_ethereum_primitives::Block>> {
29    /// Hash of the block
30    pub hash: B256,
31    /// Raw received message
32    pub block: Arc<P>,
33}
34
35// === impl NewBlockMessage ===
36
37impl<P: NewBlockPayload> NewBlockMessage<P> {
38    /// Returns the block number of the block
39    pub fn number(&self) -> u64 {
40        self.block.block().header().number()
41    }
42}
43
44/// All Bi-directional eth-message variants that can be sent to a session or received from a
45/// session.
46#[derive(Debug)]
47pub enum PeerMessage<N: NetworkPrimitives = EthNetworkPrimitives> {
48    /// Announce new block hashes
49    NewBlockHashes(NewBlockHashes),
50    /// Broadcast new block.
51    NewBlock(NewBlockMessage<N::NewBlockPayload>),
52    /// Received transactions _from_ the peer
53    ReceivedTransaction(Transactions<N::BroadcastedTransaction>),
54    /// Broadcast transactions _from_ local _to_ a peer.
55    SendTransactions(SharedTransactions<N::BroadcastedTransaction>),
56    /// Send new pooled transactions
57    PooledTransactions(NewPooledTransactionHashes),
58    /// All `eth` request variants.
59    EthRequest(PeerRequest<N>),
60    /// Announces when `BlockRange` is updated.
61    BlockRangeUpdated(BlockRangeUpdate),
62    /// Any other or manually crafted eth message.
63    ///
64    /// Caution: It is expected that this is a valid `eth_` capability message.
65    Other(RawCapabilityMessage),
66}
67
68impl<N: NetworkPrimitives> PeerMessage<N> {
69    /// Returns a static string identifying the message variant for logging.
70    pub const fn message_kind(&self) -> &'static str {
71        match self {
72            Self::NewBlockHashes(_) => "NewBlockHashes",
73            Self::NewBlock(_) => "NewBlock",
74            Self::ReceivedTransaction(_) => "ReceivedTransaction",
75            Self::SendTransactions(_) => "SendTransactions",
76            Self::PooledTransactions(_) => "PooledTransactions",
77            Self::EthRequest(_) => "EthRequest",
78            Self::BlockRangeUpdated(_) => "BlockRangeUpdated",
79            Self::Other(_) => "Other",
80        }
81    }
82
83    /// Returns `true` if this message is a broadcast (block/transaction announcement or
84    /// propagation) rather than a request/response.
85    pub const fn is_broadcast(&self) -> bool {
86        matches!(
87            self,
88            Self::NewBlockHashes(_) |
89                Self::NewBlock(_) |
90                Self::SendTransactions(_) |
91                Self::PooledTransactions(_)
92        )
93    }
94
95    /// Returns the number of items in the message payload, if applicable.
96    pub fn message_item_count(&self) -> usize {
97        match self {
98            Self::NewBlockHashes(msg) => msg.len(),
99            Self::ReceivedTransaction(msg) => msg.len(),
100            Self::SendTransactions(msg) => msg.len(),
101            Self::PooledTransactions(msg) => msg.len(),
102            Self::NewBlock(_) |
103            Self::EthRequest(_) |
104            Self::BlockRangeUpdated(_) |
105            Self::Other(_) => 1,
106        }
107    }
108}
109
110/// Request Variants that only target block related data.
111#[derive(Debug, Clone, PartialEq, Eq)]
112pub enum BlockRequest {
113    /// Requests block headers from the peer.
114    ///
115    /// The response should be sent through the channel.
116    GetBlockHeaders(GetBlockHeaders),
117
118    /// Requests block bodies from the peer.
119    ///
120    /// The response should be sent through the channel.
121    GetBlockBodies(GetBlockBodies),
122    /// Requests block access lists from the peer.
123    ///
124    /// The response should be sent through the channel.
125    GetBlockAccessLists(GetBlockAccessLists),
126
127    /// Requests receipts from the peer.
128    ///
129    /// The response should be sent through the channel.
130    GetReceipts(GetReceipts),
131}
132
133/// Corresponding variant for [`PeerRequest`].
134#[derive(Debug)]
135pub enum PeerResponse<N: NetworkPrimitives = EthNetworkPrimitives> {
136    /// Represents a response to a request for block headers.
137    BlockHeaders {
138        /// The receiver channel for the response to a block headers request.
139        response: oneshot::Receiver<RequestResult<BlockHeaders<N::BlockHeader>>>,
140    },
141    /// Represents a response to a request for block bodies.
142    BlockBodies {
143        /// The receiver channel for the response to a block bodies request.
144        response: oneshot::Receiver<RequestResult<BlockBodies<N::BlockBody>>>,
145    },
146    /// Represents a response to a request for pooled transactions.
147    PooledTransactions {
148        /// The receiver channel for the response to a pooled transactions request.
149        response: oneshot::Receiver<RequestResult<PooledTransactions<N::PooledTransaction>>>,
150    },
151    /// Represents a response to a request for `NodeData`.
152    NodeData {
153        /// The receiver channel for the response to a `NodeData` request.
154        response: oneshot::Receiver<RequestResult<NodeData>>,
155    },
156    /// Represents a response to a request for receipts.
157    Receipts {
158        /// The receiver channel for the response to a receipts request.
159        response: oneshot::Receiver<RequestResult<Receipts<N::Receipt>>>,
160    },
161    /// Represents a response to a request for receipts.
162    ///
163    /// This is a variant of `Receipts` that was introduced in `eth/69`.
164    /// The difference is that this variant does not require the inclusion of bloom filters in the
165    /// response, making it more lightweight.
166    Receipts69 {
167        /// The receiver channel for the response to a receipts request.
168        response: oneshot::Receiver<RequestResult<Receipts69<N::Receipt>>>,
169    },
170    /// Represents a response to a request for receipts using eth/70.
171    Receipts70 {
172        /// The receiver channel for the response to a receipts request.
173        response: oneshot::Receiver<RequestResult<Receipts70<N::Receipt>>>,
174    },
175    /// Represents a response to a request for block access lists.
176    BlockAccessLists {
177        /// The receiver channel for the response to a block access lists request.
178        response: oneshot::Receiver<RequestResult<BlockAccessLists>>,
179    },
180}
181
182// === impl PeerResponse ===
183
184impl<N: NetworkPrimitives> PeerResponse<N> {
185    /// Polls the type to completion.
186    pub(crate) fn poll(&mut self, cx: &mut Context<'_>) -> Poll<PeerResponseResult<N>> {
187        macro_rules! poll_request {
188            ($response:ident, $item:ident, $cx:ident) => {
189                match ready!($response.poll_unpin($cx)) {
190                    Ok(res) => PeerResponseResult::$item(res.map(|item| item.0)),
191                    Err(err) => PeerResponseResult::$item(Err(err.into())),
192                }
193            };
194        }
195
196        let res = match self {
197            Self::BlockHeaders { response } => {
198                poll_request!(response, BlockHeaders, cx)
199            }
200            Self::BlockBodies { response } => {
201                poll_request!(response, BlockBodies, cx)
202            }
203            Self::PooledTransactions { response } => {
204                poll_request!(response, PooledTransactions, cx)
205            }
206            Self::NodeData { response } => {
207                poll_request!(response, NodeData, cx)
208            }
209            Self::Receipts { response } => {
210                poll_request!(response, Receipts, cx)
211            }
212            Self::Receipts69 { response } => {
213                poll_request!(response, Receipts69, cx)
214            }
215            Self::Receipts70 { response } => match ready!(response.poll_unpin(cx)) {
216                Ok(res) => PeerResponseResult::Receipts70(res),
217                Err(err) => PeerResponseResult::Receipts70(Err(err.into())),
218            },
219            Self::BlockAccessLists { response } => match ready!(response.poll_unpin(cx)) {
220                Ok(res) => PeerResponseResult::BlockAccessLists(res),
221                Err(err) => PeerResponseResult::BlockAccessLists(Err(err.into())),
222            },
223        };
224        Poll::Ready(res)
225    }
226}
227
228/// All response variants for [`PeerResponse`]
229#[derive(Debug)]
230pub enum PeerResponseResult<N: NetworkPrimitives = EthNetworkPrimitives> {
231    /// Represents a result containing block headers or an error.
232    BlockHeaders(RequestResult<Vec<N::BlockHeader>>),
233    /// Represents a result containing block bodies or an error.
234    BlockBodies(RequestResult<Vec<N::BlockBody>>),
235    /// Represents a result containing pooled transactions or an error.
236    PooledTransactions(RequestResult<Vec<N::PooledTransaction>>),
237    /// Represents a result containing node data or an error.
238    NodeData(RequestResult<Vec<Bytes>>),
239    /// Represents a result containing receipts or an error.
240    Receipts(RequestResult<Vec<Vec<ReceiptWithBloom<N::Receipt>>>>),
241    /// Represents a result containing receipts or an error for eth/69.
242    Receipts69(RequestResult<Vec<Vec<N::Receipt>>>),
243    /// Represents a result containing receipts or an error for eth/70.
244    Receipts70(RequestResult<Receipts70<N::Receipt>>),
245    /// Represents a result containing block access lists or an error.
246    BlockAccessLists(RequestResult<BlockAccessLists>),
247}
248
249// === impl PeerResponseResult ===
250
251impl<N: NetworkPrimitives> PeerResponseResult<N> {
252    /// Converts this response into an [`EthMessage`]
253    pub fn try_into_message(self, id: u64) -> RequestResult<EthMessage<N>> {
254        macro_rules! to_message {
255            ($response:ident, $item:ident, $request_id:ident) => {
256                match $response {
257                    Ok(res) => {
258                        let request = RequestPair { request_id: $request_id, message: $item(res) };
259                        Ok(EthMessage::$item(request))
260                    }
261                    Err(err) => Err(err),
262                }
263            };
264        }
265        match self {
266            Self::BlockHeaders(resp) => {
267                to_message!(resp, BlockHeaders, id)
268            }
269            Self::BlockBodies(resp) => {
270                to_message!(resp, BlockBodies, id)
271            }
272            Self::PooledTransactions(resp) => {
273                to_message!(resp, PooledTransactions, id)
274            }
275            Self::NodeData(resp) => {
276                to_message!(resp, NodeData, id)
277            }
278            Self::Receipts(resp) => {
279                to_message!(resp, Receipts, id)
280            }
281            Self::Receipts69(resp) => {
282                to_message!(resp, Receipts69, id)
283            }
284            Self::Receipts70(resp) => match resp {
285                Ok(res) => {
286                    let request = RequestPair { request_id: id, message: res };
287                    Ok(EthMessage::Receipts70(request))
288                }
289                Err(err) => Err(err),
290            },
291            Self::BlockAccessLists(resp) => match resp {
292                Ok(res) => {
293                    let request = RequestPair { request_id: id, message: res };
294                    Ok(EthMessage::BlockAccessLists(request))
295                }
296                Err(err) => Err(err),
297            },
298        }
299    }
300
301    /// Returns the `Err` value if the result is an error.
302    pub fn err(&self) -> Option<&RequestError> {
303        match self {
304            Self::BlockHeaders(res) => res.as_ref().err(),
305            Self::BlockBodies(res) => res.as_ref().err(),
306            Self::PooledTransactions(res) => res.as_ref().err(),
307            Self::NodeData(res) => res.as_ref().err(),
308            Self::Receipts(res) => res.as_ref().err(),
309            Self::Receipts69(res) => res.as_ref().err(),
310            Self::Receipts70(res) => res.as_ref().err(),
311            Self::BlockAccessLists(res) => res.as_ref().err(),
312        }
313    }
314
315    /// Returns whether this result is an error.
316    pub fn is_err(&self) -> bool {
317        self.err().is_some()
318    }
319}
reth_network/message.rs

reth_network/
message.rs
