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

reth_eth_wire/errors/
eth.rs
