reth_eth_wire_types/
header.rs

1//! Header types.
2
3use alloy_rlp::{Decodable, Encodable};
4use bytes::BufMut;
5use reth_codecs_derive::add_arbitrary_tests;
6
7/// Represents the direction for a headers request depending on the `reverse` field of the request.
8/// > The response must contain a number of block headers, of rising number when reverse is 0,
9/// > falling when 1
10///
11/// Ref: <https://github.com/ethereum/devp2p/blob/master/caps/eth.md#getblockheaders-0x03>
12///
13/// [`HeadersDirection::Rising`] block numbers for `reverse == 0 == false`
14/// [`HeadersDirection::Falling`] block numbers for `reverse == 1 == true`
15///
16/// See also <https://github.com/ethereum/devp2p/blob/master/caps/eth.md#getblockheaders-0x03>
17#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash, Default)]
18#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
19#[cfg_attr(any(test, feature = "arbitrary"), derive(arbitrary::Arbitrary))]
20#[add_arbitrary_tests(rlp)]
21pub enum HeadersDirection {
22    /// Falling block number.
23    Falling,
24    /// Rising block number.
25    #[default]
26    Rising,
27}
28
29impl HeadersDirection {
30    /// Returns true for rising block numbers
31    pub const fn is_rising(&self) -> bool {
32        matches!(self, Self::Rising)
33    }
34
35    /// Returns true for falling block numbers
36    pub const fn is_falling(&self) -> bool {
37        matches!(self, Self::Falling)
38    }
39
40    /// Converts the bool into a direction.
41    ///
42    /// Returns:
43    ///
44    /// [`HeadersDirection::Rising`] block numbers for `reverse == 0 == false`
45    /// [`HeadersDirection::Falling`] block numbers for `reverse == 1 == true`
46    pub const fn new(reverse: bool) -> Self {
47        if reverse {
48            Self::Falling
49        } else {
50            Self::Rising
51        }
52    }
53}
54
55impl Encodable for HeadersDirection {
56    fn encode(&self, out: &mut dyn BufMut) {
57        bool::from(*self).encode(out)
58    }
59
60    fn length(&self) -> usize {
61        bool::from(*self).length()
62    }
63}
64
65impl Decodable for HeadersDirection {
66    fn decode(buf: &mut &[u8]) -> alloy_rlp::Result<Self> {
67        let value: bool = Decodable::decode(buf)?;
68        Ok(value.into())
69    }
70}
71
72impl From<bool> for HeadersDirection {
73    fn from(reverse: bool) -> Self {
74        Self::new(reverse)
75    }
76}
77
78impl From<HeadersDirection> for bool {
79    fn from(value: HeadersDirection) -> Self {
80        match value {
81            HeadersDirection::Rising => false,
82            HeadersDirection::Falling => true,
83        }
84    }
85}
86
87#[cfg(test)]
88mod tests {
89    use super::*;
90    use alloy_consensus::{Header, EMPTY_OMMER_ROOT_HASH, EMPTY_ROOT_HASH};
91    use alloy_primitives::{address, b256, bloom, bytes, hex, Address, Bytes, B256, U256};
92    use alloy_rlp::{Decodable, Encodable};
93    use std::str::FromStr;
94
95    // Test vector from: https://eips.ethereum.org/EIPS/eip-2481
96    #[test]
97    fn test_encode_block_header() {
98        let expected = hex!("f901f9a00000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000940000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000b90100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008208ae820d0582115c8215b3821a0a827788a00000000000000000000000000000000000000000000000000000000000000000880000000000000000");
99        let header = Header {
100            difficulty: U256::from(0x8ae_u64),
101            number: 0xd05_u64,
102            gas_limit: 0x115c,
103            gas_used: 0x15b3,
104            timestamp: 0x1a0a_u64,
105            extra_data: Bytes::from_str("7788").unwrap(),
106            ommers_hash: B256::ZERO,
107            state_root: B256::ZERO,
108            transactions_root: B256::ZERO,
109            receipts_root: B256::ZERO,
110            ..Default::default()
111        };
112        let mut data = vec![];
113        header.encode(&mut data);
114        assert_eq!(hex::encode(&data), hex::encode(expected));
115        assert_eq!(header.length(), data.len());
116    }
117
118    // Test vector from: https://github.com/ethereum/tests/blob/f47bbef4da376a49c8fc3166f09ab8a6d182f765/BlockchainTests/ValidBlocks/bcEIP1559/baseFee.json#L15-L36
119    #[test]
120    fn test_eip1559_block_header_hash() {
121        let expected_hash =
122            B256::from_str("6a251c7c3c5dca7b42407a3752ff48f3bbca1fab7f9868371d9918daf1988d1f")
123                .unwrap();
124        let header = Header {
125            parent_hash: b256!("e0a94a7a3c9617401586b1a27025d2d9671332d22d540e0af72b069170380f2a"),
126            ommers_hash: EMPTY_OMMER_ROOT_HASH,
127            beneficiary: address!("ba5e000000000000000000000000000000000000"),
128            state_root: b256!("ec3c94b18b8a1cff7d60f8d258ec723312932928626b4c9355eb4ab3568ec7f7"),
129            transactions_root: b256!("50f738580ed699f0469702c7ccc63ed2e51bc034be9479b7bff4e68dee84accf"),
130            receipts_root: b256!("29b0562f7140574dd0d50dee8a271b22e1a0a7b78fca58f7c60370d8317ba2a9"),
131            logs_bloom: bloom!("00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"),
132            difficulty: U256::from(0x020000),
133            number: 0x01_u64,
134            gas_limit: 0x016345785d8a0000,
135            gas_used: 0x015534,
136            timestamp: 0x079e,
137            extra_data: bytes!("42"),
138            mix_hash: b256!("0000000000000000000000000000000000000000000000000000000000000000"),
139            nonce: 0u64.into()  ,
140            base_fee_per_gas: Some(0x036b),
141            withdrawals_root: None,
142            blob_gas_used: None,
143            excess_blob_gas: None,
144            parent_beacon_block_root: None,
145            requests_hash: None,
146            target_blobs_per_block: None,
147        };
148        assert_eq!(header.hash_slow(), expected_hash);
149    }
150
151    // Test vector from: https://eips.ethereum.org/EIPS/eip-2481
152    #[test]
153    fn test_decode_block_header() {
154        let data = hex!("f901f9a00000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000940000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000b90100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008208ae820d0582115c8215b3821a0a827788a00000000000000000000000000000000000000000000000000000000000000000880000000000000000");
155        let expected = Header {
156            difficulty: U256::from(0x8aeu64),
157            number: 0xd05u64,
158            gas_limit: 0x115c,
159            gas_used: 0x15b3,
160            timestamp: 0x1a0au64,
161            extra_data: Bytes::from_str("7788").unwrap(),
162            ommers_hash: B256::ZERO,
163            state_root: B256::ZERO,
164            transactions_root: B256::ZERO,
165            receipts_root: B256::ZERO,
166            ..Default::default()
167        };
168        let header = <Header as Decodable>::decode(&mut data.as_slice()).unwrap();
169        assert_eq!(header, expected);
170
171        // make sure the hash matches
172        let expected_hash =
173            B256::from_str("8c2f2af15b7b563b6ab1e09bed0e9caade7ed730aec98b70a993597a797579a9")
174                .unwrap();
175        assert_eq!(header.hash_slow(), expected_hash);
176    }
177
178    // Test vector from: https://github.com/ethereum/tests/blob/970503935aeb76f59adfa3b3224aabf25e77b83d/BlockchainTests/ValidBlocks/bcExample/shanghaiExample.json#L15-L34
179    #[test]
180    fn test_decode_block_header_with_withdrawals() {
181        let data = hex!("f9021ca018db39e19931515b30b16b3a92c292398039e31d6c267111529c3f2ba0a26c17a01dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347942adc25665018aa1fe0e6bc666dac8fc2697ff9baa095efce3d6972874ca8b531b233b7a1d1ff0a56f08b20c8f1b89bef1b001194a5a071e515dd89e8a7973402c2e11646081b4e2209b2d3a1550df5095289dabcb3fba0ed9c51ea52c968e552e370a77a41dac98606e98b915092fb5f949d6452fce1c4b90100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008001887fffffffffffffff830125b882079e42a056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b42188000000000000000009a027f166f1d7c789251299535cb176ba34116e44894476a7886fe5d73d9be5c973");
182        let expected = Header {
183            parent_hash: B256::from_str(
184                "18db39e19931515b30b16b3a92c292398039e31d6c267111529c3f2ba0a26c17",
185            )
186            .unwrap(),
187            beneficiary: Address::from_str("2adc25665018aa1fe0e6bc666dac8fc2697ff9ba").unwrap(),
188            state_root: B256::from_str(
189                "95efce3d6972874ca8b531b233b7a1d1ff0a56f08b20c8f1b89bef1b001194a5",
190            )
191            .unwrap(),
192            transactions_root: B256::from_str(
193                "71e515dd89e8a7973402c2e11646081b4e2209b2d3a1550df5095289dabcb3fb",
194            )
195            .unwrap(),
196            receipts_root: B256::from_str(
197                "ed9c51ea52c968e552e370a77a41dac98606e98b915092fb5f949d6452fce1c4",
198            )
199            .unwrap(),
200            number: 0x01,
201            gas_limit: 0x7fffffffffffffff,
202            gas_used: 0x0125b8,
203            timestamp: 0x079e,
204            extra_data: Bytes::from_str("42").unwrap(),
205            mix_hash: EMPTY_ROOT_HASH,
206            base_fee_per_gas: Some(0x09),
207            withdrawals_root: Some(
208                B256::from_str("27f166f1d7c789251299535cb176ba34116e44894476a7886fe5d73d9be5c973")
209                    .unwrap(),
210            ),
211            ..Default::default()
212        };
213        let header = <Header as Decodable>::decode(&mut data.as_slice()).unwrap();
214        assert_eq!(header, expected);
215
216        let expected_hash =
217            B256::from_str("85fdec94c534fa0a1534720f167b899d1fc268925c71c0cbf5aaa213483f5a69")
218                .unwrap();
219        assert_eq!(header.hash_slow(), expected_hash);
220    }
221
222    // Test vector from: https://github.com/ethereum/tests/blob/7e9e0940c0fcdbead8af3078ede70f969109bd85/BlockchainTests/ValidBlocks/bcExample/cancunExample.json
223    #[test]
224    fn test_decode_block_header_with_blob_fields_ef_tests() {
225        let data = hex!("f90221a03a9b485972e7353edd9152712492f0c58d89ef80623686b6bf947a4a6dce6cb6a01dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347942adc25665018aa1fe0e6bc666dac8fc2697ff9baa03c837fc158e3e93eafcaf2e658a02f5d8f99abc9f1c4c66cdea96c0ca26406aea04409cc4b699384ba5f8248d92b784713610c5ff9c1de51e9239da0dac76de9cea046cab26abf1047b5b119ecc2dda1296b071766c8b1307e1381fcecc90d513d86b90100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008001887fffffffffffffff8302a86582079e42a056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b42188000000000000000009a056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b4218302000080");
226        let expected = Header {
227            parent_hash: B256::from_str(
228                "3a9b485972e7353edd9152712492f0c58d89ef80623686b6bf947a4a6dce6cb6",
229            )
230            .unwrap(),
231            ommers_hash: EMPTY_OMMER_ROOT_HASH,
232            beneficiary: Address::from_str("2adc25665018aa1fe0e6bc666dac8fc2697ff9ba").unwrap(),
233            state_root: B256::from_str(
234                "3c837fc158e3e93eafcaf2e658a02f5d8f99abc9f1c4c66cdea96c0ca26406ae",
235            )
236            .unwrap(),
237            transactions_root: B256::from_str(
238                "4409cc4b699384ba5f8248d92b784713610c5ff9c1de51e9239da0dac76de9ce",
239            )
240            .unwrap(),
241            receipts_root: B256::from_str(
242                "46cab26abf1047b5b119ecc2dda1296b071766c8b1307e1381fcecc90d513d86",
243            )
244            .unwrap(),
245            logs_bloom: Default::default(),
246            difficulty: U256::from(0),
247            number: 0x1,
248            gas_limit: 0x7fffffffffffffff,
249            gas_used: 0x02a865,
250            timestamp: 0x079e,
251            extra_data: Bytes::from(vec![0x42]),
252            mix_hash: EMPTY_ROOT_HASH,
253            nonce: 0u64.into(),
254            base_fee_per_gas: Some(9),
255            withdrawals_root: Some(EMPTY_ROOT_HASH),
256            blob_gas_used: Some(0x020000),
257            excess_blob_gas: Some(0),
258            parent_beacon_block_root: None,
259            requests_hash: None,
260            target_blobs_per_block: None,
261        };
262
263        let header = Header::decode(&mut data.as_slice()).unwrap();
264        assert_eq!(header, expected);
265
266        let expected_hash =
267            B256::from_str("0x10aca3ebb4cf6ddd9e945a5db19385f9c105ede7374380c50d56384c3d233785")
268                .unwrap();
269        assert_eq!(header.hash_slow(), expected_hash);
270    }
271
272    #[test]
273    fn test_decode_block_header_with_blob_fields() {
274        // Block from devnet-7
275        let data = hex!("f90239a013a7ec98912f917b3e804654e37c9866092043c13eb8eab94eb64818e886cff5a01dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d4934794f97e180c050e5ab072211ad2c213eb5aee4df134a0ec229dbe85b0d3643ad0f471e6ec1a36bbc87deffbbd970762d22a53b35d068aa056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421a056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421b901000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000080830305988401c9c380808464c40d5499d883010c01846765746888676f312e32302e35856c696e7578a070ccadc40b16e2094954b1064749cc6fbac783c1712f1b271a8aac3eda2f232588000000000000000007a056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421808401600000");
276        let expected = Header {
277            parent_hash: B256::from_str(
278                "13a7ec98912f917b3e804654e37c9866092043c13eb8eab94eb64818e886cff5",
279            )
280            .unwrap(),
281            ommers_hash: EMPTY_OMMER_ROOT_HASH,
282            beneficiary: address!("f97e180c050e5ab072211ad2c213eb5aee4df134"),
283            state_root: b256!("ec229dbe85b0d3643ad0f471e6ec1a36bbc87deffbbd970762d22a53b35d068a"),
284            transactions_root: EMPTY_ROOT_HASH,
285            receipts_root: EMPTY_ROOT_HASH,
286            logs_bloom: Default::default(),
287            difficulty: U256::from(0),
288            number: 0x30598,
289            gas_limit: 0x1c9c380,
290            gas_used: 0,
291            timestamp: 0x64c40d54,
292            extra_data: bytes!("d883010c01846765746888676f312e32302e35856c696e7578"),
293            mix_hash: b256!("70ccadc40b16e2094954b1064749cc6fbac783c1712f1b271a8aac3eda2f2325"),
294            nonce: 0u64.into(),
295            base_fee_per_gas: Some(7),
296            withdrawals_root: Some(EMPTY_ROOT_HASH),
297            parent_beacon_block_root: None,
298            blob_gas_used: Some(0),
299            excess_blob_gas: Some(0x1600000),
300            requests_hash: None,
301            target_blobs_per_block: None,
302        };
303
304        let header = Header::decode(&mut data.as_slice()).unwrap();
305        assert_eq!(header, expected);
306
307        let expected_hash =
308            b256!("539c9ea0a3ca49808799d3964b8b6607037227de26bc51073c6926963127087b");
309        assert_eq!(header.hash_slow(), expected_hash);
310    }
311
312    #[test]
313    fn sanity_direction() {
314        let reverse = true;
315        assert_eq!(HeadersDirection::Falling, reverse.into());
316        assert_eq!(reverse, bool::from(HeadersDirection::Falling));
317
318        let reverse = false;
319        assert_eq!(HeadersDirection::Rising, reverse.into());
320        assert_eq!(reverse, bool::from(HeadersDirection::Rising));
321
322        let mut buf = Vec::new();
323        let direction = HeadersDirection::Falling;
324        direction.encode(&mut buf);
325        assert_eq!(direction, HeadersDirection::decode(&mut buf.as_slice()).unwrap());
326
327        let mut buf = Vec::new();
328        let direction = HeadersDirection::Rising;
329        direction.encode(&mut buf);
330        assert_eq!(direction, HeadersDirection::decode(&mut buf.as_slice()).unwrap());
331    }
332}
reth_eth_wire_types/header.rs

reth_eth_wire_types/
header.rs
