Struct SimulationDB 

pub struct SimulationDB<P: Provider + Debug> {
    pub runtime: Option<Arc<Runtime>>,
    /* private fields */
}

A wrapper over an Alloy Provider with local storage cache and overrides.

Fields

runtime: Option<Arc<Runtime>>

Tokio runtime to execute async code

Implementations

impl<P: Provider + Debug + 'static> SimulationDB<P>

pub fn new( client: Arc<P>, runtime: Option<Arc<Runtime>>, block: Option<BlockHeader>, ) -> Self

pub fn set_block(&mut self, block: Option<BlockHeader>)

Set the block that will be used when querying a node

pub fn update_state( &mut self, updates: &HashMap<Address, StateUpdate>, block: BlockHeader, ) -> Result<HashMap<Address, StateUpdate>, SimulationDBError>

Update the simulation state.

Updates the underlying smart contract storage. Any previously missed account, which was queried and whose state now is in the account_storage will be cleared.

Arguments

• updates - Values for the updates that should be applied to the accounts
• block - The newest block

Returns a state update struct to revert this update.

pub fn query_storage( &self, address: Address, index: U256, ) -> Result<StorageValue, <SimulationDB<P> as DatabaseRef>::Error>

Queries a value from storage at the specified index for a given Ethereum account.

Arguments

• address - The Ethereum address of the account.
• index - The index of the storage value to query.

Returns

Returns a Result containing the value from storage at the specified index as an U256, or an error of type SimulationDB<M>::Error if the query fails.

Trait Implementations

impl<P: Clone + Provider + Debug> Clone for SimulationDB<P>

fn clone(&self) -> SimulationDB<P>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<P> DatabaseRef for SimulationDB<P>

where P: Provider + Debug + Send + Sync + 'static,

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

Retrieves basic information about an account.

This function retrieves the basic account information for the specified address. If the account is present in the storage, the stored account information is returned. If the account is not present in the storage, the function queries the account information from the contract and initializes the account in the storage with the retrieved information.

Arguments

• address: The address of the account to retrieve the information for.

Returns

Returns a Result containing an Option that holds the account information if it exists. If the account is not found, None is returned.

Errors

Returns an error if there was an issue querying the account information from the contract or accessing the storage.

Notes

• If the account is present in the storage, the function returns a clone of the stored account information.

• If the account is not present in the storage, the function queries the account information from the contract, initializes the account in the storage with the retrieved information, and returns a clone of the account information.

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

Retrieves the storage value at the specified address and index.

If we don’t know the value, and the accessed contract is mocked, the function returns an empty slot instead of querying a node, to avoid potentially returning garbage values.

Arguments

• address: The address of the contract to retrieve the storage value from.
• index: The index of the storage value to retrieve.

Returns

Returns a Result containing the storage value if it exists. If the contract is mocked and the storage value is not found locally, an empty slot is returned as U256::ZERO.

Errors

Returns an error if there was an issue querying the storage value from the contract or accessing the storage.

Notes

• If the contract is present locally and is mocked, the function first checks if the storage value exists locally. If found, it returns the stored value. If not found, it returns an empty slot. Mocked contracts are not expected to have valid storage values, so the function does not query a node in this case.

• If the contract is present locally and is not mocked, the function checks if the storage value exists locally. If found, it returns the stored value. If not found, it queries the storage value from a node, stores it locally, and returns it.

• If the contract is not present locally, the function queries the account info and storage value from a node, initializes the account locally with the retrieved information, and returns the storage value.

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

If block header is set, returns the hash. Otherwise returns a zero hash instead of querying a node.

type Error = SimulationDBError

The database error type.

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

Gets account code by its hash.

impl<P: Debug + Provider + Debug> Debug for SimulationDB<P>

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

Formats the value using the given formatter.

impl<P> EngineDatabaseInterface for SimulationDB<P>

where P: Provider + Send + Sync + 'static + Debug,

fn init_account( &self, address: Address, account: AccountInfo, permanent_storage: Option<HashMap<U256, U256>>, mocked: bool, ) -> Result<(), <Self as EngineDatabaseInterface>::Error>

Sets up a single account

Full control over setting up an accounts. Allows to set up EOAs as well as smart contracts.

Arguments

• address - Address of the account
• account - The account information
• permanent_storage - Storage to init the account with this storage can only be updated manually.
• mocked - Whether this account should be considered mocked. For mocked accounts, nothing is downloaded from a node; all data must be inserted manually.

fn clear_temp_storage( &mut self, ) -> Result<(), <Self as EngineDatabaseInterface>::Error>

Clears temp storage

It is recommended to call this after a new block is received, to avoid stored state leading to wrong results.

type Error = SimulationDBError

fn get_current_block(&self) -> Option<BlockHeader>

Gets the block header that this database is operating at.