reth_eth_wire/errors/
eth.rs

1//! Error handling for (`EthStream`)[`crate::EthStream`]
2
3use crate::{
4    errors::P2PStreamError, message::MessageError, version::ParseVersionError, DisconnectReason,
5};
6use alloy_chains::Chain;
7use alloy_primitives::B256;
8use reth_eth_wire_types::{snap::SnapProtocolError, EthVersion};
9use reth_ethereum_forks::ValidationError;
10use reth_primitives_traits::{GotExpected, GotExpectedBoxed};
11use std::io;
12
13/// Errors when sending/receiving messages
14#[derive(thiserror::Error, Debug)]
15pub enum EthStreamError {
16    #[error(transparent)]
17    /// Error of the underlying P2P connection.
18    P2PStreamError(#[from] P2PStreamError),
19    #[error(transparent)]
20    /// Failed to parse peer's version.
21    ParseVersionError(#[from] ParseVersionError),
22    #[error(transparent)]
23    /// Failed Ethereum handshake.
24    EthHandshakeError(#[from] EthHandshakeError),
25    /// Thrown when decoding a message failed.
26    #[error(transparent)]
27    InvalidMessage(#[from] MessageError),
28    /// Thrown when decoding an inbound `snap` protocol message failed.
29    #[error(transparent)]
30    InvalidSnapMessage(#[from] SnapProtocolError),
31    #[error("message size ({0}) exceeds max length (10MB)")]
32    /// Received a message whose size exceeds the standard limit.
33    MessageTooBig(usize),
34    #[error(
35        "TransactionHashes invalid len of fields: hashes_len={hashes_len} types_len={types_len} sizes_len={sizes_len}"
36    )]
37    /// Received malformed transaction hashes message with discrepancies in field lengths.
38    TransactionHashesInvalidLenOfFields {
39        /// The number of transaction hashes.
40        hashes_len: usize,
41        /// The number of transaction types.
42        types_len: usize,
43        /// The number of transaction sizes.
44        sizes_len: usize,
45    },
46    /// Error when data is not received from peer for a prolonged period.
47    #[error("never received data from remote peer")]
48    StreamTimeout,
49    /// Error triggered when an unknown or unsupported Ethereum message ID is received.
50    #[error("Received unknown ETH message ID: 0x{message_id:X}")]
51    UnsupportedMessage {
52        /// The identifier of the unknown Ethereum message.
53        message_id: u8,
54    },
55}
56
57// === impl EthStreamError ===
58
59impl EthStreamError {
60    /// Returns the [`DisconnectReason`] if the error is a disconnect message
61    pub const fn as_disconnected(&self) -> Option<DisconnectReason> {
62        if let Self::P2PStreamError(err) = self {
63            err.as_disconnected()
64        } else {
65            None
66        }
67    }
68
69    /// Returns whether this error indicates a protocol breach on the receive side.
70    ///
71    /// These are errors caused by the remote peer sending invalid or malformed data
72    /// that warrant disconnecting with [`DisconnectReason::ProtocolBreach`].
73    pub const fn is_protocol_breach(&self) -> bool {
74        matches!(
75            self,
76            Self::InvalidMessage(_) |
77                Self::InvalidSnapMessage(_) |
78                Self::MessageTooBig(_) |
79                Self::TransactionHashesInvalidLenOfFields { .. } |
80                Self::UnsupportedMessage { .. } |
81                Self::P2PStreamError(
82                    P2PStreamError::Rlp(_) |
83                        P2PStreamError::Snap(_) |
84                        P2PStreamError::MessageTooBig { .. } |
85                        P2PStreamError::UnknownReservedMessageId(_) |
86                        P2PStreamError::UnknownSubprotocolMessageId(_) |
87                        P2PStreamError::EmptyProtocolMessage |
88                        P2PStreamError::InvalidPingPongPayload(_) |
89                        P2PStreamError::TooManyPings |
90                        P2PStreamError::UnknownDisconnectReason(_)
91                )
92        )
93    }
94
95    /// Returns the [`io::Error`] if it was caused by IO
96    pub const fn as_io(&self) -> Option<&io::Error> {
97        if let Self::P2PStreamError(P2PStreamError::Io(io)) = self {
98            return Some(io)
99        }
100        None
101    }
102}
103
104impl From<io::Error> for EthStreamError {
105    fn from(err: io::Error) -> Self {
106        P2PStreamError::from(err).into()
107    }
108}
109
110/// Error  that can occur during the `eth` sub-protocol handshake.
111#[derive(thiserror::Error, Debug)]
112pub enum EthHandshakeError {
113    /// Status message received or sent outside of the handshake process.
114    #[error("status message can only be recv/sent in handshake")]
115    StatusNotInHandshake,
116    /// Receiving a non-status message during the handshake phase.
117    #[error("received non-status message when trying to handshake")]
118    NonStatusMessageInHandshake,
119    #[error("no response received when sending out handshake")]
120    /// No response received during the handshake process.
121    NoResponse,
122    #[error(transparent)]
123    /// Invalid fork data.
124    InvalidFork(#[from] ValidationError),
125    #[error("mismatched genesis in status message: {0}")]
126    /// Mismatch in the genesis block during status exchange.
127    MismatchedGenesis(GotExpectedBoxed<B256>),
128    #[error("mismatched protocol version in status message: {0}")]
129    /// Mismatched protocol versions in status messages.
130    MismatchedProtocolVersion(GotExpected<EthVersion>),
131    #[error("mismatched chain in status message: {0}")]
132    /// Mismatch in chain details in status messages.
133    MismatchedChain(GotExpected<Chain>),
134    #[error("total difficulty bitlen is too large: got {got}, maximum {maximum}")]
135    /// Excessively large total difficulty bit lengths.
136    TotalDifficultyBitLenTooLarge {
137        /// The actual bit length of the total difficulty.
138        got: usize,
139        /// The maximum allowed bit length for the total difficulty.
140        maximum: usize,
141    },
142    #[error("earliest block > latest block: got {got}, latest {latest}")]
143    /// Earliest block > latest block.
144    EarliestBlockGreaterThanLatestBlock {
145        /// The earliest block.
146        got: u64,
147        /// The latest block.
148        latest: u64,
149    },
150    #[error("blockhash is zero")]
151    /// Blockhash is zero.
152    BlockhashZero,
153}
reth_eth_wire/errors/eth.rs

reth_eth_wire/errors/
eth.rs
