Add example/test

Author: cakevm

README.md

@@ -1,11 +1,23 @@
 # Alloy Reth State DB provider
-To test reth ExEx, it can be useful to not be dependent on a real database. This repository illustrates how the reth traits for the state can be implemented to forward the request to an RPC.
+This repository illustrates how the `StateProviderFactory` from [reth](https://github.com/paradigmxyz/reth) can be implemented with [alloy-rs](https://github.com/alloy-rs/alloy) to fetch all state using RPC. This can be useful to not be dependent on a real database when testing reth ExEx.
 
 ## Remarks
 There is no `debug_codeByHash` implemented currently (see [feat(rpc): debug_codeByHash #14479](https://github.com/paradigmxyz/reth/issues/14479)). But since revm will first call `basic_account`, we can cache it and return it when `bytecode_by_hash` is called.
 
 Currently, this repos purpose as copy/paste reference and not as library. Not all functions are implemented.
 
+## Example
+See tests in `src/alloy_reth_provider.rs` for an example.
+
+```rust
+// Init the provider
+let provider = ProviderBuilder::new().on_http("https://eth.merkle.io".parse().unwrap());
+// Init the db provider
+let db_provider = AlloyRethProvider::new(provider.clone());
+// Use the StateProviderFactory
+let state = db_provider.state_by_block_id(BlockId::number(16148323)).unwrap();
+```
+
 ## Acknowledgements
 Many, many thanks to the team of [reth](https://github.com/paradigmxyz/reth) and [alloy-rs](https://github.com/alloy-rs/alloy) for the awesome work they do. Some parts of the trait implementation are taken from reth. Also, many thanks to [revm](https://github.com/bluealloy/revm). The `alloy_db` part is a copy/paste from revm because this part is not included in the latest revm version, and it makes it easier to be in sync with the latest Alloy version.
 

src/alloy_db/alloy_db_fork.rs

@@ -76,19 +76,18 @@ impl<N: Network, P: Provider<N>> DatabaseAsyncRef for AlloyDBFork<N, P> {
 mod tests {
     use super::*;
     use crate::alloy_db::async_db::WrapDatabaseAsync;
+    use alloy_primitives::address;
     use alloy_primitives::ruint::__private::ruint_macro::uint;
     use alloy_provider::ProviderBuilder;
     use revm::DatabaseRef;
 
     #[tokio::test(flavor = "multi_thread", worker_threads = 1)]
     async fn can_get_basic() {
         let client = ProviderBuilder::new().on_http("https://eth.merkle.io".parse().unwrap());
-        let alloydb = AlloyDBFork::new(client, BlockId::from(16148323));
+        let alloydb = AlloyDBFork::new(client, BlockId::number(16148323));
         let wrapped_alloydb = WrapDatabaseAsync::new(alloydb).unwrap();
 
-        let address: Address = "0x220866b1a2219f40e72f5c628b65d54268ca3a9d".parse().unwrap();
-
-        let acc_info = wrapped_alloydb.basic_ref(address).unwrap().unwrap();
+        let acc_info = wrapped_alloydb.basic_ref(address!("220866b1a2219f40e72f5c628b65d54268ca3a9d")).unwrap().unwrap();
         assert!(acc_info.exists());
         assert_eq!(acc_info.nonce, 1);
         assert_eq!(acc_info.balance, uint!(250001010477701567100010_U256));

src/alloy_reth_provider.rs

@@ -363,3 +363,24 @@ where
         todo!()
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use alloy_eips::BlockId;
+    use alloy_primitives::address;
+    use alloy_provider::ProviderBuilder;
+    use reth_provider::AccountReader;
+    use ruint::__private::ruint_macro::uint;
+
+    #[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+    async fn test_alloy_reth_state_provider_factory() {
+        let provider = ProviderBuilder::new().on_http("https://eth.merkle.io".parse().unwrap());
+        let db_provider = AlloyRethProvider::new(provider.clone());
+        let state = db_provider.state_by_block_id(BlockId::number(16148323)).unwrap();
+        let acc_info = state.basic_account(&address!("220866b1a2219f40e72f5c628b65d54268ca3a9d")).unwrap().unwrap();
+
+        assert_eq!(acc_info.nonce, 1);
+        assert_eq!(acc_info.balance, uint!(250001010477701567100010_U256));
+    }
+}