Module backend

Foundry’s main executor backend abstraction and implementation.

Modules

• cow 🔒
  A wrapper around Backend that is clone-on-write used for fuzzing.
• diagnostic 🔒
• error 🔒
• in_memory_db 🔒
  In-memory database.
• snapshot 🔒

Structs

• Backend
  Provides the underlying revm::Database implementation.
• BackendInner
  Container type for various Backend related data
• BackendStateSnapshot
  Represents a state snapshot taken during evm execution
• BlockchainDb
  A shareable Block database
• BlockchainDbMeta
  relevant identifying markers in the context of BlockchainDb
• CowBackend
  A wrapper around Backend that ensures only revm::DatabaseRef functions are called.
• EmptyDBWrapper
  An empty database that always returns default values when queried.
• Fork
  Represents a fork
• MemDb
  In-memory [Database] for Anvil.
• SharedBackend
  A cloneable backend type that shares access to the backend data with all its clones.
• StateSnapshot
  A minimal abstraction of a state at a certain point in time
• _ObjectSafe 🔒

Enums

• BackendDatabaseSnapshot
  Variants of a [revm::Database]
• BackendError
  Errors that can happen when working with [revm::Database]
• DatabaseError
  Errors that can happen when working with [revm::Database]
• RevertDiagnostic
  Represents possible diagnostic cases on revert
• RevertStateSnapshotAction
  What to do when reverting a state snapshot.

Constants

• DEFAULT_PERSISTENT_ACCOUNTS 🔒
  All accounts that will have persistent storage across fork swaps.
• GLOBAL_FAIL_SLOT
  bytes32("failed"), as a storage slot key into CHEATCODE_ADDRESS.

Traits

• DatabaseExt
  An extension trait that allows us to easily extend the revm::Inspector capabilities

Functions

• apply_state_changeset 🔒
  Applies the changeset of a transaction to the active journaled state and also commits it in the forked db
• commit_transaction 🔒
  Executes the given transaction and commits state changes to the database and the journaled state, with an inspector.
• is_contract_in_state 🔒
  Returns true of the address is a contract
• merge_account_data 🔒
  Clones the data of the given accounts from the active database into the fork_db This includes the data held in storage (CacheDB) and kept in the JournaledState.
• merge_db_account_data 🔒
  Clones the account data from the active db into the ForkDB
• merge_journaled_state_data 🔒
  Clones the account data from the active_journaled_state into the fork_journaled_state
• update_current_env_with_fork_env 🔒
  This updates the currently used env with the fork’s environment
• update_env_block 🔒
  Updates the env’s block with the block’s data
• update_state
  Helper method which updates data in the state with the data from the database. Does not change state for persistent accounts (for roll fork to transaction and transact).

Type Aliases

• BackendResult
• DatabaseResult
  Result alias with DatabaseError as error
• ForkDB 🔒
• ForkLookupIndex 🔒
  Represents the index of a fork in the created forks vector This is used for fast lookup
• FoundryEvmInMemoryDB
  Type alias for an in-memory database.
• LocalForkId
  Represents a numeric ForkId valid only for the existence of the Backend.