reth_storage_api/
macros.rs

1//! Helper macros for implementing traits for various `StateProvider`
2//! implementations
3
4/// A macro that delegates trait implementations to the `as_ref` function of the type.
5///
6/// Used to implement provider traits.
7#[macro_export]
8macro_rules! delegate_impls_to_as_ref {
9    (for $target:ty => $($trait:ident $(where [$($generics:tt)*])? {  $(fn $func:ident$(<$($generic_arg:ident: $generic_arg_ty:path),*>)?(&self, $($arg:ident: $argty:ty),*) -> $ret:path;)* })* ) => {
10
11        $(
12          impl<'a, $($($generics)*)?> $trait for $target {
13              $(
14                  fn $func$(<$($generic_arg: $generic_arg_ty),*>)?(&self, $($arg: $argty),*) -> $ret {
15                    self.as_ref().$func($($arg),*)
16                  }
17              )*
18          }
19        )*
20    };
21}
22
23pub use delegate_impls_to_as_ref;
24
25/// Delegates the provider trait implementations to the `as_ref` function of the type:
26///
27/// [`AccountReader`](crate::AccountReader)
28/// [`BlockHashReader`](crate::BlockHashReader)
29/// [`StateProvider`](crate::StateProvider)
30#[macro_export]
31macro_rules! delegate_provider_impls {
32    ($target:ty $(where [$($generics:tt)*])?) => {
33        $crate::macros::delegate_impls_to_as_ref!(
34            for $target =>
35            AccountReader $(where [$($generics)*])? {
36                fn basic_account(&self, address: &alloy_primitives::Address) -> reth_storage_api::errors::provider::ProviderResult<Option<reth_primitives_traits::Account>>;
37            }
38            BlockHashReader $(where [$($generics)*])? {
39                fn block_hash(&self, number: u64) -> reth_storage_api::errors::provider::ProviderResult<Option<alloy_primitives::B256>>;
40                fn canonical_hashes_range(&self, start: alloy_primitives::BlockNumber, end: alloy_primitives::BlockNumber) -> reth_storage_api::errors::provider::ProviderResult<Vec<alloy_primitives::B256>>;
41            }
42            StateProvider $(where [$($generics)*])? {
43                fn storage(&self, account: alloy_primitives::Address, storage_key: alloy_primitives::StorageKey) -> reth_storage_api::errors::provider::ProviderResult<Option<alloy_primitives::StorageValue>>;
44            }
45            BytecodeReader $(where [$($generics)*])? {
46                fn bytecode_by_hash(&self, code_hash: &alloy_primitives::B256) -> reth_storage_api::errors::provider::ProviderResult<Option<reth_primitives_traits::Bytecode>>;
47            }
48            StateRootProvider $(where [$($generics)*])? {
49                fn state_root(&self, state: reth_trie::HashedPostState) -> reth_storage_api::errors::provider::ProviderResult<alloy_primitives::B256>;
50                fn state_root_from_nodes(&self, input: reth_trie::TrieInput) -> reth_storage_api::errors::provider::ProviderResult<alloy_primitives::B256>;
51                fn state_root_with_updates(&self, state: reth_trie::HashedPostState) -> reth_storage_api::errors::provider::ProviderResult<(alloy_primitives::B256, reth_trie::updates::TrieUpdates)>;
52                fn state_root_from_nodes_with_updates(&self, input: reth_trie::TrieInput) -> reth_storage_api::errors::provider::ProviderResult<(alloy_primitives::B256, reth_trie::updates::TrieUpdates)>;
53            }
54            StorageRootProvider $(where [$($generics)*])? {
55                fn storage_root(&self, address: alloy_primitives::Address, storage: reth_trie::HashedStorage) -> reth_storage_api::errors::provider::ProviderResult<alloy_primitives::B256>;
56                fn storage_proof(&self, address: alloy_primitives::Address, slot: alloy_primitives::B256, storage: reth_trie::HashedStorage) -> reth_storage_api::errors::provider::ProviderResult<reth_trie::StorageProof>;
57                fn storage_multiproof(&self, address: alloy_primitives::Address, slots: &[alloy_primitives::B256], storage: reth_trie::HashedStorage) -> reth_storage_api::errors::provider::ProviderResult<reth_trie::StorageMultiProof>;
58            }
59            StateProofProvider $(where [$($generics)*])? {
60                fn proof(&self, input: reth_trie::TrieInput, address: alloy_primitives::Address, slots: &[alloy_primitives::B256]) -> reth_storage_api::errors::provider::ProviderResult<reth_trie::AccountProof>;
61                fn multiproof(&self, input: reth_trie::TrieInput, targets: reth_trie::MultiProofTargets) -> reth_storage_api::errors::provider::ProviderResult<reth_trie::MultiProof>;
62                fn witness(&self, input: reth_trie::TrieInput, target: reth_trie::HashedPostState) -> reth_storage_api::errors::provider::ProviderResult<Vec<alloy_primitives::Bytes>>;
63            }
64            HashedPostStateProvider $(where [$($generics)*])? {
65                fn hashed_post_state(&self, bundle_state: &revm_database::BundleState) -> reth_trie::HashedPostState;
66            }
67        );
68    }
69}
70
71pub use delegate_provider_impls;
reth_storage_api/macros.rs

reth_storage_api/
macros.rs
