Struct CacheDB

pub struct CacheDB<ExtDB> {
    pub accounts: HashMap<Address, DbAccount>,
    pub contracts: HashMap<B256, Bytecode>,
    pub logs: Vec<Log>,
    pub block_hashes: HashMap<U256, B256>,
    pub db: ExtDB,
}

A Database implementation that stores all state changes in memory.

This implementation wraps a DatabaseRef that is used to load data (AccountInfo).

Accounts and code are stored in two separate maps, the accounts map maps addresses to DbAccount, whereas contracts are identified by their code hash, and are stored in the contracts map. The DbAccount holds the code hash of the contract, which is used to look up the contract in the contracts map.

Fields

accounts: HashMap<Address, DbAccount>

Account info where None means it is not existing. Not existing state is needed for Pre TANGERINE forks. code is always None, and bytecode can be found in contracts.

contracts: HashMap<B256, Bytecode>

Tracks all contracts by their code hash.

logs: Vec<Log>

All logs that were committed via DatabaseCommit::commit.

block_hashes: HashMap<U256, B256>

All cached block hashes from the DatabaseRef.

db: ExtDB

The underlying database (DatabaseRef) that is used to load data.

Note: this is read-only, data is never written to this database.

Implementations

impl<ExtDb> CacheDB<CacheDB<ExtDb>>

pub fn flatten(self) -> CacheDB<ExtDb>

Flatten a nested cache by applying the outer cache to the inner cache.

The behavior is as follows:

• Accounts are overridden with outer accounts
• Contracts are overridden with outer contracts
• Logs are appended
• Block hashes are overridden with outer block hashes

pub fn discard_outer(self) -> CacheDB<ExtDb>

Discard the outer cache and return the inner cache.

impl<ExtDB> CacheDB<ExtDB>

pub fn new(db: ExtDB) -> Self

Create a new cache with the given external database.

pub fn insert_contract(&mut self, account: &mut AccountInfo)

Inserts the account’s code into the cache.

Accounts objects and code are stored separately in the cache, this will take the code from the account and instead map it to the code hash.

Note: This will not insert into the underlying external database.

pub fn insert_account_info(&mut self, address: Address, info: AccountInfo)

Insert account info but not override storage

pub fn nest(self) -> CacheDB<Self>

Wrap the cache in a CacheDB, creating a nested cache.

impl<ExtDB: DatabaseRef> CacheDB<ExtDB>

pub fn load_account( &mut self, address: Address, ) -> Result<&mut DbAccount, ExtDB::Error>

Returns the account for the given address.

If the account was not found in the cache, it will be loaded from the underlying database.

pub fn insert_account_storage( &mut self, address: Address, slot: U256, value: U256, ) -> Result<(), ExtDB::Error>

insert account storage without overriding account info

pub fn replace_account_storage( &mut self, address: Address, storage: HashMap<U256, U256>, ) -> Result<(), ExtDB::Error>

replace account storage without overriding account info

Trait Implementations

impl<ExtDB: Clone> Clone for CacheDB<ExtDB>

fn clone(&self) -> CacheDB<ExtDB>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<ExtDB: DatabaseRef> Database for CacheDB<ExtDB>

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

Get the value in an account’s storage slot.

It is assumed that account is already loaded.

type Error = <ExtDB as DatabaseRef>::Error

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 block_hash(&mut self, number: u64) -> Result<B256, Self::Error>

Get block hash by block number.

impl<ExtDB> DatabaseCommit for CacheDB<ExtDB>

fn commit(&mut self, changes: HashMap<Address, Account>)

Commit changes to the database.

impl<ExtDB: DatabaseRef> DatabaseRef for CacheDB<ExtDB>

type Error = <ExtDB as DatabaseRef>::Error

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<ExtDB: Debug> Debug for CacheDB<ExtDB>

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

Formats the value using the given formatter.

impl<ExtDB: Default> Default for CacheDB<ExtDB>

fn default() -> Self

Returns the “default value” for a type.