Struct AlloyDB

pub struct AlloyDB<T: Transport + Clone, N: Network, P: Provider<T, N>> {
    provider: P,
    block_number: BlockId,
    rt: HandleOrRuntime,
    _marker: PhantomData<fn() -> (T, N)>,
}

An alloy-powered REVM [Database].

When accessing the database, it’ll use the given provider to fetch the corresponding account’s data.

Fields

provider: P

The provider to fetch the data from.

block_number: BlockId

The block number on which the queries will be based on.

rt: HandleOrRuntime

handle to the tokio runtime

_marker: PhantomData<fn() -> (T, N)>

Implementations

impl<T: Transport + Clone, N: Network, P: Provider<T, N>> AlloyDB<T, N, P>

pub fn new(provider: P, block_number: BlockId) -> Option<Self>

Create a new AlloyDB instance, with a [Provider] and a block.

Returns None if no tokio runtime is available or if the current runtime is a current-thread runtime.

pub fn with_runtime( provider: P, block_number: BlockId, runtime: Runtime, ) -> Self

Create a new AlloyDB instance, with a provider and a block and a runtime.

Refer to [tokio::runtime::Builder] on how to create a runtime if you are in synchronous world. If you are already using something like [tokio::main], call AlloyDB::new instead.

pub fn with_handle(provider: P, block_number: BlockId, handle: Handle) -> Self

Create a new AlloyDB instance, with a provider and a block and a runtime handle.

This generally allows you to pass any valid runtime handle, refer to [tokio::runtime::Handle] on how to obtain a handle. If you are already in asynchronous world, like [tokio::main], use AlloyDB::new instead.

fn block_on<F>(&self, f: F) -> F::Output

where F: Future + Send, F::Output: Send,

Internal utility function that allows us to block on a future regardless of the runtime flavor.

pub fn set_block_number(&mut self, block_number: BlockId)

Set the block number on which the queries will be based on.

Trait Implementations

impl<T: Transport + Clone, N: Network, P: Provider<T, N>> Database for AlloyDB<T, N, P>

type Error = Report

The database error type.

fn basic( &mut self, address: Address, ) -> Result<Option<AccountInfo>, Self::Error>

Get basic account information.

fn code_by_hash(&mut self, code_hash: B256) -> Result<Bytecode, Self::Error>

Get account code by its hash.

fn storage( &mut self, address: Address, index: U256, ) -> Result<U256, Self::Error>

Get storage value of address at index.

fn block_hash(&mut self, number: u64) -> Result<B256, Self::Error>

Get block hash by block number.

impl<T: Transport + Clone, N: Network, P: Provider<T, N>> DatabaseRef for AlloyDB<T, N, P>

type Error = Report

The database error type.

fn basic_ref( &self, address: Address, ) -> Result<Option<AccountInfo>, Self::Error>

Get basic account information.

fn code_by_hash_ref(&self, _code_hash: B256) -> Result<Bytecode, Self::Error>

Get account code by its hash.

fn storage_ref( &self, address: Address, index: U256, ) -> Result<U256, Self::Error>

Get storage value of address at index.

fn block_hash_ref(&self, number: u64) -> Result<B256, Self::Error>

Get block hash by block number.

impl<T: Debug + Transport + Clone, N: Debug + Network, P: Debug + Provider<T, N>> Debug for AlloyDB<T, N, P>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.