anvil_core/eth/
block.rs

1use super::transaction::TransactionInfo;
2use alloy_consensus::{
3    BlockBody, EMPTY_OMMER_ROOT_HASH, Header, proofs::calculate_transaction_root,
4};
5use alloy_eips::eip2718::Encodable2718;
6use alloy_network::Network;
7use foundry_primitives::FoundryTxEnvelope;
8
9use crate::eth::transaction::MaybeImpersonatedTransaction;
10
11/// Type alias for a block containing potentially impersonated transactions.
12pub type Block<T = FoundryTxEnvelope> = alloy_consensus::Block<MaybeImpersonatedTransaction<T>>;
13
14/// Container type that gathers all block data, generic over a [`Network`].
15#[derive(Clone, Debug)]
16pub struct BlockInfo<N: Network> {
17    pub block: Block<N::TxEnvelope>,
18    pub transactions: Vec<TransactionInfo>,
19    pub receipts: Vec<N::ReceiptEnvelope>,
20}
21
22/// Helper function to create a new block with Header and Anvil transactions, generic over the
23/// transaction envelope with a default of [`FoundryTxEnvelope`].
24///
25/// Note: if the `impersonate-tx` feature is enabled this will also accept
26/// `MaybeImpersonatedTransaction`.
27pub fn create_block<T, Tx>(
28    mut header: Header,
29    transactions: impl IntoIterator<Item = T>,
30) -> Block<Tx>
31where
32    Tx: Encodable2718,
33    T: Into<MaybeImpersonatedTransaction<Tx>>,
34{
35    let transactions: Vec<_> = transactions.into_iter().map(Into::into).collect();
36    let transactions_root = calculate_transaction_root(&transactions);
37
38    header.transactions_root = transactions_root;
39    header.ommers_hash = EMPTY_OMMER_ROOT_HASH;
40
41    let body = BlockBody { transactions, ommers: Vec::new(), withdrawals: None };
42    Block::new(header, body)
43}
44
45#[cfg(test)]
46mod tests {
47    use alloy_primitives::{
48        Address, B64, B256, Bloom, U256, b256,
49        hex::{self, FromHex},
50    };
51    use alloy_rlp::Decodable;
52
53    use super::*;
54    use std::str::FromStr;
55
56    #[test]
57    fn header_rlp_roundtrip() {
58        let mut header = Header {
59            parent_hash: Default::default(),
60            ommers_hash: Default::default(),
61            beneficiary: Default::default(),
62            state_root: Default::default(),
63            transactions_root: Default::default(),
64            receipts_root: Default::default(),
65            logs_bloom: Default::default(),
66            difficulty: Default::default(),
67            number: 124u64,
68            gas_limit: Default::default(),
69            gas_used: 1337u64,
70            timestamp: 0,
71            extra_data: Default::default(),
72            mix_hash: Default::default(),
73            nonce: B64::with_last_byte(99),
74            withdrawals_root: Default::default(),
75            blob_gas_used: Default::default(),
76            excess_blob_gas: Default::default(),
77            parent_beacon_block_root: Default::default(),
78            base_fee_per_gas: None,
79            requests_hash: None,
80        };
81
82        let encoded = alloy_rlp::encode(&header);
83        let decoded: Header = Header::decode(&mut encoded.as_ref()).unwrap();
84        assert_eq!(header, decoded);
85
86        header.base_fee_per_gas = Some(12345u64);
87
88        let encoded = alloy_rlp::encode(&header);
89        let decoded: Header = Header::decode(&mut encoded.as_ref()).unwrap();
90        assert_eq!(header, decoded);
91    }
92
93    #[test]
94    fn test_encode_block_header() {
95        use alloy_rlp::Encodable;
96
97        let expected = hex::decode("f901f9a00000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000940000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000b90100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008208ae820d0582115c8215b3821a0a827788a00000000000000000000000000000000000000000000000000000000000000000880000000000000000").unwrap();
98        let mut data = vec![];
99        let header = Header {
100            parent_hash: B256::from_str("0000000000000000000000000000000000000000000000000000000000000000").unwrap(),
101            ommers_hash: B256::from_str("0000000000000000000000000000000000000000000000000000000000000000").unwrap(),
102            beneficiary: Address::from_str("0000000000000000000000000000000000000000").unwrap(),
103            state_root: B256::from_str("0000000000000000000000000000000000000000000000000000000000000000").unwrap(),
104            transactions_root: B256::from_str("0000000000000000000000000000000000000000000000000000000000000000").unwrap(),
105            receipts_root: B256::from_str("0000000000000000000000000000000000000000000000000000000000000000").unwrap(),
106            logs_bloom: Bloom::from_hex("00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap(),
107            difficulty: U256::from(2222),
108            number: 0xd05u64,
109            gas_limit: 0x115cu64,
110            gas_used: 0x15b3u64,
111            timestamp: 0x1a0au64,
112            extra_data: hex::decode("7788").unwrap().into(),
113            mix_hash: B256::from_str("0000000000000000000000000000000000000000000000000000000000000000").unwrap(),
114            withdrawals_root: None,
115            blob_gas_used: None,
116            excess_blob_gas: None,
117            parent_beacon_block_root: None,
118            nonce: B64::ZERO,
119            base_fee_per_gas: None,
120            requests_hash: None,
121        };
122
123        header.encode(&mut data);
124        assert_eq!(hex::encode(&data), hex::encode(expected));
125        assert_eq!(header.length(), data.len());
126    }
127
128    #[test]
129    // Test vector from: https://eips.ethereum.org/EIPS/eip-2481
130    fn test_decode_block_header() {
131        let data = hex::decode("f901f9a00000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000940000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000000b90100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008208ae820d0582115c8215b3821a0a827788a00000000000000000000000000000000000000000000000000000000000000000880000000000000000").unwrap();
132        let expected = Header {
133            parent_hash: B256::from_str("0000000000000000000000000000000000000000000000000000000000000000").unwrap(),
134            ommers_hash: B256::from_str("0000000000000000000000000000000000000000000000000000000000000000").unwrap(),
135            beneficiary: Address::from_str("0000000000000000000000000000000000000000").unwrap(),
136            state_root: B256::from_str("0000000000000000000000000000000000000000000000000000000000000000").unwrap(),
137            transactions_root: B256::from_str("0000000000000000000000000000000000000000000000000000000000000000").unwrap(),
138            receipts_root: B256::from_str("0000000000000000000000000000000000000000000000000000000000000000").unwrap(),
139            logs_bloom: <[u8; 256]>::from_hex("00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap().into(),
140            difficulty: U256::from(2222),
141            number: 0xd05u64,
142            gas_limit: 0x115cu64,
143            gas_used: 0x15b3u64,
144            timestamp: 0x1a0au64,
145            extra_data: hex::decode("7788").unwrap().into(),
146            mix_hash: B256::from_str("0000000000000000000000000000000000000000000000000000000000000000").unwrap(),
147            nonce: B64::ZERO,
148            withdrawals_root: None,
149            blob_gas_used: None,
150            excess_blob_gas: None,
151            parent_beacon_block_root: None,
152            base_fee_per_gas: None,
153            requests_hash: None,
154        };
155        let header = Header::decode(&mut data.as_slice()).unwrap();
156        assert_eq!(header, expected);
157    }
158
159    #[test]
160    // Test vector from: https://github.com/ethereum/tests/blob/f47bbef4da376a49c8fc3166f09ab8a6d182f765/BlockchainTests/ValidBlocks/bcEIP1559/baseFee.json#L15-L36
161    fn test_eip1559_block_header_hash() {
162        let expected_hash =
163            b256!("0x6a251c7c3c5dca7b42407a3752ff48f3bbca1fab7f9868371d9918daf1988d1f");
164        let header = Header {
165            parent_hash: B256::from_str("e0a94a7a3c9617401586b1a27025d2d9671332d22d540e0af72b069170380f2a").unwrap(),
166            ommers_hash: B256::from_str("1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347").unwrap(),
167            beneficiary: Address::from_str("ba5e000000000000000000000000000000000000").unwrap(),
168            state_root: B256::from_str("ec3c94b18b8a1cff7d60f8d258ec723312932928626b4c9355eb4ab3568ec7f7").unwrap(),
169            transactions_root: B256::from_str("50f738580ed699f0469702c7ccc63ed2e51bc034be9479b7bff4e68dee84accf").unwrap(),
170            receipts_root: B256::from_str("29b0562f7140574dd0d50dee8a271b22e1a0a7b78fca58f7c60370d8317ba2a9").unwrap(),
171            logs_bloom: Bloom::from_hex("00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap(),
172            difficulty: U256::from(0x020000),
173            number: 1u64,
174            gas_limit: U256::from(0x016345785d8a0000u128).to::<u64>(),
175            gas_used: U256::from(0x015534).to::<u64>(),
176            timestamp: 0x079e,
177            extra_data: hex::decode("42").unwrap().into(),
178            mix_hash: B256::from_str("0000000000000000000000000000000000000000000000000000000000000000").unwrap(),
179            nonce: B64::ZERO,
180            base_fee_per_gas: Some(875),
181            withdrawals_root: None,
182            blob_gas_used: None,
183            excess_blob_gas: None,
184            parent_beacon_block_root: None,
185            requests_hash: None,
186        };
187        assert_eq!(header.hash_slow(), expected_hash);
188    }
189
190    #[test]
191    // Test vector from network
192    fn block_network_roundtrip() {
193        use alloy_rlp::Encodable;
194
195        let data = hex::decode("f9034df90348a0fbdbd8d2d0ac5f14bd5fa90e547fe6f1d15019c724f8e7b60972d381cd5d9cf8a01dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d4934794c9577e7945db22e38fc060909f2278c7746b0f9ba05017cfa3b0247e35197215ae8d610265ffebc8edca8ea66d6567eb0adecda867a056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421a056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421b9010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000018355bb7b871fffffffffffff808462bd0e1ab9014bf90148a00000000000000000000000000000000000000000000000000000000000000000f85494319fa8f1bc4e53410e92d10d918659b16540e60a945a573efb304d04c1224cd012313e827eca5dce5d94a9c831c5a268031176ebf5f3de5051e8cba0dbfe94c9577e7945db22e38fc060909f2278c7746b0f9b808400000000f8c9b841a6946f2d16f68338cbcbd8b117374ab421128ce422467088456bceba9d70c34106128e6d4564659cf6776c08a4186063c0a05f7cffd695c10cf26a6f301b67f800b8412b782100c18c35102dc0a37ece1a152544f04ad7dc1868d18a9570f744ace60870f822f53d35e89a2ea9709ccbf1f4a25ee5003944faa845d02dde0a41d5704601b841d53caebd6c8a82456e85c2806a9e08381f959a31fb94a77e58f00e38ad97b2e0355b8519ab2122662cbe022f2a4ef7ff16adc0b2d5dcd123181ec79705116db300a063746963616c2062797a616e74696e65206661756c7420746f6c6572616e6365880000000000000000c0c0").unwrap();
196
197        let block = <Block>::decode(&mut data.as_slice()).unwrap();
198
199        // encode and check that it matches the original data
200        let mut encoded = Vec::new();
201        block.encode(&mut encoded);
202        assert_eq!(data, encoded);
203
204        // check that length of encoding is the same as the output of `length`
205        assert_eq!(block.length(), encoded.len());
206    }
207}
anvil_core/eth/block.rs

anvil_core/eth/
block.rs
