reth_chain_state/
memory_overlay.rs

1use super::ExecutedBlockWithTrieUpdates;
2use alloy_consensus::BlockHeader;
3use alloy_primitives::{keccak256, Address, BlockNumber, Bytes, StorageKey, StorageValue, B256};
4use reth_errors::ProviderResult;
5use reth_primitives_traits::{Account, Bytecode, NodePrimitives};
6use reth_storage_api::{
7    AccountReader, BlockHashReader, BytecodeReader, HashedPostStateProvider, StateProofProvider,
8    StateProvider, StateRootProvider, StorageRootProvider,
9};
10use reth_trie::{
11    updates::TrieUpdates, AccountProof, HashedPostState, HashedStorage, MultiProof,
12    MultiProofTargets, StorageMultiProof, TrieInput,
13};
14use revm_database::BundleState;
15use std::sync::OnceLock;
16
17/// A state provider that stores references to in-memory blocks along with their state as well as a
18/// reference of the historical state provider for fallback lookups.
19#[expect(missing_debug_implementations)]
20pub struct MemoryOverlayStateProviderRef<
21    'a,
22    N: NodePrimitives = reth_ethereum_primitives::EthPrimitives,
23> {
24    /// Historical state provider for state lookups that are not found in in-memory blocks.
25    pub(crate) historical: Box<dyn StateProvider + 'a>,
26    /// The collection of executed parent blocks. Expected order is newest to oldest.
27    pub(crate) in_memory: Vec<ExecutedBlockWithTrieUpdates<N>>,
28    /// Lazy-loaded in-memory trie data.
29    pub(crate) trie_input: OnceLock<TrieInput>,
30}
31
32/// A state provider that stores references to in-memory blocks along with their state as well as
33/// the historical state provider for fallback lookups.
34pub type MemoryOverlayStateProvider<N> = MemoryOverlayStateProviderRef<'static, N>;
35
36impl<'a, N: NodePrimitives> MemoryOverlayStateProviderRef<'a, N> {
37    /// Create new memory overlay state provider.
38    ///
39    /// ## Arguments
40    ///
41    /// - `in_memory` - the collection of executed ancestor blocks in reverse.
42    /// - `historical` - a historical state provider for the latest ancestor block stored in the
43    ///   database.
44    pub fn new(
45        historical: Box<dyn StateProvider + 'a>,
46        in_memory: Vec<ExecutedBlockWithTrieUpdates<N>>,
47    ) -> Self {
48        Self { historical, in_memory, trie_input: OnceLock::new() }
49    }
50
51    /// Turn this state provider into a state provider
52    pub fn boxed(self) -> Box<dyn StateProvider + 'a> {
53        Box::new(self)
54    }
55
56    /// Return lazy-loaded trie state aggregated from in-memory blocks.
57    fn trie_input(&self) -> &TrieInput {
58        self.trie_input.get_or_init(|| {
59            TrieInput::from_blocks(
60                self.in_memory
61                    .iter()
62                    .rev()
63                    .map(|block| (block.hashed_state.as_ref(), block.trie.as_ref())),
64            )
65        })
66    }
67}
68
69impl<N: NodePrimitives> BlockHashReader for MemoryOverlayStateProviderRef<'_, N> {
70    fn block_hash(&self, number: BlockNumber) -> ProviderResult<Option<B256>> {
71        for block in &self.in_memory {
72            if block.recovered_block().number() == number {
73                return Ok(Some(block.recovered_block().hash()));
74            }
75        }
76
77        self.historical.block_hash(number)
78    }
79
80    fn canonical_hashes_range(
81        &self,
82        start: BlockNumber,
83        end: BlockNumber,
84    ) -> ProviderResult<Vec<B256>> {
85        let range = start..end;
86        let mut earliest_block_number = None;
87        let mut in_memory_hashes = Vec::new();
88
89        for block in &self.in_memory {
90            if range.contains(&block.recovered_block().number()) {
91                in_memory_hashes.push(block.recovered_block().hash());
92                earliest_block_number = Some(block.recovered_block().number());
93            }
94        }
95
96        // `self.in_memory` stores executed blocks in ascending order (oldest to newest).
97        // However, `in_memory_hashes` should be constructed in descending order (newest to oldest),
98        // so we reverse the vector after collecting the hashes.
99        in_memory_hashes.reverse();
100
101        let mut hashes =
102            self.historical.canonical_hashes_range(start, earliest_block_number.unwrap_or(end))?;
103        hashes.append(&mut in_memory_hashes);
104        Ok(hashes)
105    }
106}
107
108impl<N: NodePrimitives> AccountReader for MemoryOverlayStateProviderRef<'_, N> {
109    fn basic_account(&self, address: &Address) -> ProviderResult<Option<Account>> {
110        for block in &self.in_memory {
111            if let Some(account) = block.execution_output.account(address) {
112                return Ok(account);
113            }
114        }
115
116        self.historical.basic_account(address)
117    }
118}
119
120impl<N: NodePrimitives> StateRootProvider for MemoryOverlayStateProviderRef<'_, N> {
121    fn state_root(&self, state: HashedPostState) -> ProviderResult<B256> {
122        self.state_root_from_nodes(TrieInput::from_state(state))
123    }
124
125    fn state_root_from_nodes(&self, mut input: TrieInput) -> ProviderResult<B256> {
126        input.prepend_self(self.trie_input().clone());
127        self.historical.state_root_from_nodes(input)
128    }
129
130    fn state_root_with_updates(
131        &self,
132        state: HashedPostState,
133    ) -> ProviderResult<(B256, TrieUpdates)> {
134        self.state_root_from_nodes_with_updates(TrieInput::from_state(state))
135    }
136
137    fn state_root_from_nodes_with_updates(
138        &self,
139        mut input: TrieInput,
140    ) -> ProviderResult<(B256, TrieUpdates)> {
141        input.prepend_self(self.trie_input().clone());
142        self.historical.state_root_from_nodes_with_updates(input)
143    }
144}
145
146impl<N: NodePrimitives> StorageRootProvider for MemoryOverlayStateProviderRef<'_, N> {
147    // TODO: Currently this does not reuse available in-memory trie nodes.
148    fn storage_root(&self, address: Address, storage: HashedStorage) -> ProviderResult<B256> {
149        let state = &self.trie_input().state;
150        let mut hashed_storage =
151            state.storages.get(&keccak256(address)).cloned().unwrap_or_default();
152        hashed_storage.extend(&storage);
153        self.historical.storage_root(address, hashed_storage)
154    }
155
156    // TODO: Currently this does not reuse available in-memory trie nodes.
157    fn storage_proof(
158        &self,
159        address: Address,
160        slot: B256,
161        storage: HashedStorage,
162    ) -> ProviderResult<reth_trie::StorageProof> {
163        let state = &self.trie_input().state;
164        let mut hashed_storage =
165            state.storages.get(&keccak256(address)).cloned().unwrap_or_default();
166        hashed_storage.extend(&storage);
167        self.historical.storage_proof(address, slot, hashed_storage)
168    }
169
170    // TODO: Currently this does not reuse available in-memory trie nodes.
171    fn storage_multiproof(
172        &self,
173        address: Address,
174        slots: &[B256],
175        storage: HashedStorage,
176    ) -> ProviderResult<StorageMultiProof> {
177        let state = &self.trie_input().state;
178        let mut hashed_storage =
179            state.storages.get(&keccak256(address)).cloned().unwrap_or_default();
180        hashed_storage.extend(&storage);
181        self.historical.storage_multiproof(address, slots, hashed_storage)
182    }
183}
184
185impl<N: NodePrimitives> StateProofProvider for MemoryOverlayStateProviderRef<'_, N> {
186    fn proof(
187        &self,
188        mut input: TrieInput,
189        address: Address,
190        slots: &[B256],
191    ) -> ProviderResult<AccountProof> {
192        input.prepend_self(self.trie_input().clone());
193        self.historical.proof(input, address, slots)
194    }
195
196    fn multiproof(
197        &self,
198        mut input: TrieInput,
199        targets: MultiProofTargets,
200    ) -> ProviderResult<MultiProof> {
201        input.prepend_self(self.trie_input().clone());
202        self.historical.multiproof(input, targets)
203    }
204
205    fn witness(&self, mut input: TrieInput, target: HashedPostState) -> ProviderResult<Vec<Bytes>> {
206        input.prepend_self(self.trie_input().clone());
207        self.historical.witness(input, target)
208    }
209}
210
211impl<N: NodePrimitives> HashedPostStateProvider for MemoryOverlayStateProviderRef<'_, N> {
212    fn hashed_post_state(&self, bundle_state: &BundleState) -> HashedPostState {
213        self.historical.hashed_post_state(bundle_state)
214    }
215}
216
217impl<N: NodePrimitives> StateProvider for MemoryOverlayStateProviderRef<'_, N> {
218    fn storage(
219        &self,
220        address: Address,
221        storage_key: StorageKey,
222    ) -> ProviderResult<Option<StorageValue>> {
223        for block in &self.in_memory {
224            if let Some(value) = block.execution_output.storage(&address, storage_key.into()) {
225                return Ok(Some(value));
226            }
227        }
228
229        self.historical.storage(address, storage_key)
230    }
231}
232
233impl<N: NodePrimitives> BytecodeReader for MemoryOverlayStateProviderRef<'_, N> {
234    fn bytecode_by_hash(&self, code_hash: &B256) -> ProviderResult<Option<Bytecode>> {
235        for block in &self.in_memory {
236            if let Some(contract) = block.execution_output.bytecode(code_hash) {
237                return Ok(Some(contract));
238            }
239        }
240
241        self.historical.bytecode_by_hash(code_hash)
242    }
243}
reth_chain_state/memory_overlay.rs

reth_chain_state/
memory_overlay.rs
