Struct Journal

pub struct Journal<DB, ENTRY = JournalEntry>
where
    ENTRY: JournalEntryTr,
{
    pub database: DB,
    pub inner: JournalInner<ENTRY>,
}

A journal of state changes internal to the EVM

On each additional call, the depth of the journaled state is increased (depth) and a new journal is added.

The journal contains every state change that happens within that call, making it possible to revert changes made in a specific call.

Fields

database: DB

Database

inner: JournalInner<ENTRY>

Inner journal state.

Implementations

impl<DB, ENTRY: JournalEntryTr> Journal<DB, ENTRY>

pub fn new_with_inner(database: DB, inner: JournalInner<ENTRY>) -> Self

Creates a new JournaledState by copying state data from a JournalInit and provided database. This allows reusing the state, logs, and other data from a previous execution context while connecting it to a different database backend.

pub fn into_init(self) -> JournalInner<ENTRY>

Consumes the Journal and returns JournalInner.

If you need to preserve the original journal, use Self::to_inner instead which clones the state.

impl<DB, ENTRY: JournalEntryTr + Clone> Journal<DB, ENTRY>

pub fn to_inner(&self) -> JournalInner<ENTRY>

Creates a new JournalInner by cloning all internal state data (state, storage, logs, etc) This allows creating a new journaled state with the same state data but without carrying over the original database.

This is useful when you want to reuse the current state for a new transaction or execution context, but want to start with a fresh database.

Methods from Deref<Target = JournalInner<ENTRY>>

pub fn clear_and_take_output(&mut self) -> JournalOutput

Take the JournalOutput and clears the journal by resetting it to initial state.

Note: Precompile addresses and spec are preserved and initial state of warm_preloaded_addresses will contain precompiles addresses. Precompile addresses

pub fn state(&mut self) -> &mut EvmState

Return reference to state.

pub fn set_spec_id(&mut self, spec: SpecId)

Sets SpecId.

pub fn touch(&mut self, address: Address)

Mark account as touched as only touched accounts will be added to state. This is especially important for state clear where touched empty accounts needs to be removed from state.

pub fn account(&self, address: Address) -> &Account

Returns the loaded Account for the given address.

This assumes that the account has already been loaded.

Panics

Panics if the account has not been loaded and is missing from the state set.

pub fn set_code_with_hash( &mut self, address: Address, code: Bytecode, hash: B256, )

Set code and its hash to the account.

Note: Assume account is warm and that hash is calculated from code.

pub fn set_code(&mut self, address: Address, code: Bytecode)

Use it only if you know that acc is warm.

Assume account is warm.

pub fn inc_nonce(&mut self, address: Address) -> Option<u64>

Increments the nonce of the account.

Returns

Returns the new nonce if it did not overflow, otherwise returns None.

pub fn transfer<DB: Database>( &mut self, db: &mut DB, from: Address, to: Address, balance: U256, ) -> Result<Option<TransferError>, DB::Error>

Transfers balance from two accounts. Returns error if sender balance is not enough.

pub fn create_account_checkpoint( &mut self, caller: Address, target_address: Address, balance: U256, spec_id: SpecId, ) -> Result<JournalCheckpoint, TransferError>

Creates account or returns false if collision is detected.

There are few steps done:

1. Make created account warm loaded (AccessList) and this should be done before subroutine checkpoint is created.
2. Check if there is collision of newly created account with existing one.
3. Mark created account as created.
4. Add fund to created account
5. Increment nonce of created account if SpuriousDragon is active
6. Decrease balance of caller account.

Panics

Panics if the caller is not loaded inside the EVM state. This should have been done inside create_inner.

pub fn checkpoint(&mut self) -> JournalCheckpoint

Makes a checkpoint that in case of Revert can bring back state to this point.

pub fn checkpoint_commit(&mut self)

Commits the checkpoint.

pub fn checkpoint_revert(&mut self, checkpoint: JournalCheckpoint)

Reverts all changes to state until given checkpoint.

pub fn selfdestruct<DB: Database>( &mut self, db: &mut DB, address: Address, target: Address, ) -> Result<StateLoad<SelfDestructResult>, DB::Error>

Performs selfdestruct action. Transfers balance from address to target. Check if target exist/is_cold

Note: Balance will be lost if address and target are the same BUT when current spec enables Cancun, this happens only when the account associated to address is created in the same tx

References:

• https://github.com/ethereum/go-ethereum/blob/141cd425310b503c5678e674a8c3872cf46b7086/core/vm/instructions.go#L832-L833
• https://github.com/ethereum/go-ethereum/blob/141cd425310b503c5678e674a8c3872cf46b7086/core/state/statedb.go#L449
• https://eips.ethereum.org/EIPS/eip-6780

pub fn initial_account_load<DB: Database>( &mut self, db: &mut DB, address: Address, storage_keys: impl IntoIterator<Item = U256>, ) -> Result<&mut Account, DB::Error>

Initial load of account. This load will not be tracked inside journal

pub fn load_account<DB: Database>( &mut self, db: &mut DB, address: Address, ) -> Result<StateLoad<&mut Account>, DB::Error>

Loads account into memory. return if it is cold or warm accessed

pub fn load_account_delegated<DB: Database>( &mut self, db: &mut DB, address: Address, ) -> Result<StateLoad<AccountLoad>, DB::Error>

Loads account into memory. If account is EIP-7702 type it will additionally load delegated account.

It will mark both this and delegated account as warm loaded.

Returns information about the account (If it is empty or cold loaded) and if present the information about the delegated account (If it is cold loaded).

pub fn load_code<DB: Database>( &mut self, db: &mut DB, address: Address, ) -> Result<StateLoad<&mut Account>, DB::Error>

Loads account and its code. If account is already loaded it will load its code.

It will mark account as warm loaded. If not existing Database will be queried for data.

In case of EIP-7702 delegated account will not be loaded, Self::load_account_delegated should be used instead.

pub fn load_account_optional<DB: Database>( &mut self, db: &mut DB, address: Address, load_code: bool, ) -> Result<StateLoad<&mut Account>, DB::Error>

Loads account. If account is already loaded it will be marked as warm.

pub fn sload<DB: Database>( &mut self, db: &mut DB, address: Address, key: U256, ) -> Result<StateLoad<U256>, DB::Error>

Loads storage slot.

Panics

Panics if the account is not present in the state.

pub fn sstore<DB: Database>( &mut self, db: &mut DB, address: Address, key: U256, new: U256, ) -> Result<StateLoad<SStoreResult>, DB::Error>

Stores storage slot.

And returns (original,present,new) slot value.

Note: Account should already be present in our state.

pub fn tload(&mut self, address: Address, key: U256) -> U256

Read transient storage tied to the account.

EIP-1153: Transient storage opcodes

pub fn tstore(&mut self, address: Address, key: U256, new: U256)

Store transient storage tied to the account.

If values is different add entry to the journal so that old state can be reverted if that action is needed.

EIP-1153: Transient storage opcodes

pub fn log(&mut self, log: Log)

Pushes log into subroutine.

Trait Implementations

impl<DB: Clone, ENTRY> Clone for Journal<DB, ENTRY>

where ENTRY: JournalEntryTr + Clone,

fn clone(&self) -> Journal<DB, ENTRY>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<DB: Debug, ENTRY> Debug for Journal<DB, ENTRY>

where ENTRY: JournalEntryTr + Debug,

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

Formats the value using the given formatter.

impl<DB, ENTRY> Deref for Journal<DB, ENTRY>

where ENTRY: JournalEntryTr,

type Target = JournalInner<ENTRY>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<DB, ENTRY> DerefMut for Journal<DB, ENTRY>

where ENTRY: JournalEntryTr,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, DB, ENTRY> Deserialize<'de> for Journal<DB, ENTRY>

where ENTRY: JournalEntryTr + Deserialize<'de>, DB: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<DB: Database, ENTRY: JournalEntryTr> JournalTr for Journal<DB, ENTRY>

fn depth(&self) -> usize

Returns call depth.

type Database = DB

type FinalOutput = JournalOutput

fn new(database: DB) -> Journal<DB, ENTRY>

Creates new Journaled state.

fn db_ref(&self) -> &Self::Database

Returns the database.

fn db(&mut self) -> &mut Self::Database

Returns the mutable database.

fn sload( &mut self, address: Address, key: U256, ) -> Result<StateLoad<U256>, <Self::Database as Database>::Error>

Returns the storage value from Journal state.

fn sstore( &mut self, address: Address, key: U256, value: U256, ) -> Result<StateLoad<SStoreResult>, <Self::Database as Database>::Error>

Stores the storage value in Journal state.

fn tload(&mut self, address: Address, key: U256) -> U256

Loads transient storage value.

fn tstore(&mut self, address: Address, key: U256, value: U256)

Stores transient storage value.

fn log(&mut self, log: Log)

Logs the log in Journal state.

fn selfdestruct( &mut self, address: Address, target: Address, ) -> Result<StateLoad<SelfDestructResult>, DB::Error>

Marks the account for selfdestruction and transfers all the balance to the target.

fn warm_account(&mut self, address: Address)

Warms the account.

fn warm_precompiles(&mut self, address: HashSet<Address>)

Warms the precompiles.

fn precompile_addresses(&self) -> &HashSet<Address>

Returns the addresses of the precompiles.

fn warm_account_and_storage( &mut self, address: Address, storage_keys: impl IntoIterator<Item = U256>, ) -> Result<(), <Self::Database as Database>::Error>

Warms the account and storage.

fn set_spec_id(&mut self, spec_id: SpecId)

Sets the spec id.

fn transfer( &mut self, from: Address, to: Address, balance: U256, ) -> Result<Option<TransferError>, DB::Error>

Transfers the balance from one account to another.

fn touch_account(&mut self, address: Address)

Touches the account.

fn inc_account_nonce( &mut self, address: Address, ) -> Result<Option<u64>, DB::Error>

Increments the nonce of the account.

fn load_account( &mut self, address: Address, ) -> Result<StateLoad<&mut Account>, DB::Error>

Loads the account.

fn load_account_code( &mut self, address: Address, ) -> Result<StateLoad<&mut Account>, DB::Error>

Loads the account code.

fn load_account_delegated( &mut self, address: Address, ) -> Result<StateLoad<AccountLoad>, DB::Error>

Loads the account delegated.

fn checkpoint(&mut self) -> JournalCheckpoint

Creates a checkpoint of the current state. State can be revert to this point if needed.

fn checkpoint_commit(&mut self)

Commits the changes made since the last checkpoint.

fn checkpoint_revert(&mut self, checkpoint: JournalCheckpoint)

Reverts the changes made since the last checkpoint.

fn set_code_with_hash(&mut self, address: Address, code: Bytecode, hash: B256)

Sets bytecode with hash. Assume that account is warm.

fn clear(&mut self)

Called at the end of the transaction to clean all residue data from journal.

fn create_account_checkpoint( &mut self, caller: Address, address: Address, balance: U256, spec_id: SpecId, ) -> Result<JournalCheckpoint, TransferError>

Creates a checkpoint of the account creation.

fn finalize(&mut self) -> Self::FinalOutput

Does cleanup and returns modified state.

fn set_code(&mut self, address: Address, code: Bytecode)

Sets bytecode and calculates hash.

fn code( &mut self, address: Address, ) -> Result<StateLoad<Bytes>, <Self::Database as Database>::Error>

Returns account code bytes and if address is cold loaded.

fn code_hash( &mut self, address: Address, ) -> Result<StateLoad<FixedBytes<32>>, <Self::Database as Database>::Error>

Gets code hash of account.

impl<DB: PartialEq, ENTRY> PartialEq for Journal<DB, ENTRY>

where ENTRY: JournalEntryTr + PartialEq,

fn eq(&self, other: &Journal<DB, ENTRY>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<DB, ENTRY> Serialize for Journal<DB, ENTRY>

where ENTRY: JournalEntryTr + Serialize, DB: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<DB: Eq, ENTRY> Eq for Journal<DB, ENTRY>

where ENTRY: JournalEntryTr + Eq,

impl<DB, ENTRY> StructuralPartialEq for Journal<DB, ENTRY>

where ENTRY: JournalEntryTr,