pub struct Journal<DB, ENTRY = JournalEntry>where
ENTRY: JournalEntryTr,{
pub database: DB,
pub inner: JournalInner<ENTRY>,
}
Expand description
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§
Source§impl<DB, ENTRY: JournalEntryTr> Journal<DB, ENTRY>
impl<DB, ENTRY: JournalEntryTr> Journal<DB, ENTRY>
Sourcepub fn new_with_inner(database: DB, inner: JournalInner<ENTRY>) -> Self
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.
Sourcepub fn into_init(self) -> JournalInner<ENTRY>
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.
Source§impl<DB, ENTRY: JournalEntryTr + Clone> Journal<DB, ENTRY>
impl<DB, ENTRY: JournalEntryTr + Clone> Journal<DB, ENTRY>
Sourcepub fn to_inner(&self) -> JournalInner<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>>§
Sourcepub fn clear_and_take_output(&mut self) -> JournalOutput
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
Sourcepub fn set_spec_id(&mut self, spec: SpecId)
pub fn set_spec_id(&mut self, spec: SpecId)
Sets SpecId.
Sourcepub fn touch(&mut self, address: Address)
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.
Sourcepub fn account(&self, address: Address) -> &Account
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.
Sourcepub fn set_code_with_hash(
&mut self,
address: Address,
code: Bytecode,
hash: B256,
)
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.
Sourcepub fn set_code(&mut self, address: Address, code: Bytecode)
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>
Sourcepub fn transfer<DB: Database>(
&mut self,
db: &mut DB,
from: Address,
to: Address,
balance: U256,
) -> Result<Option<TransferError>, DB::Error>
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.
Sourcepub fn create_account_checkpoint(
&mut self,
caller: Address,
target_address: Address,
balance: U256,
spec_id: SpecId,
) -> Result<JournalCheckpoint, TransferError>
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:
- Make created account warm loaded (AccessList) and this should be done before subroutine checkpoint is created.
- Check if there is collision of newly created account with existing one.
- Mark created account as created.
- Add fund to created account
- Increment nonce of created account if SpuriousDragon is active
- 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
.
Sourcepub fn checkpoint(&mut self) -> JournalCheckpoint
pub fn checkpoint(&mut self) -> JournalCheckpoint
Makes a checkpoint that in case of Revert can bring back state to this point.
Sourcepub fn checkpoint_commit(&mut self)
pub fn checkpoint_commit(&mut self)
Commits the checkpoint.
Sourcepub fn checkpoint_revert(&mut self, checkpoint: JournalCheckpoint)
pub fn checkpoint_revert(&mut self, checkpoint: JournalCheckpoint)
Reverts all changes to state until given checkpoint.
Sourcepub fn selfdestruct<DB: Database>(
&mut self,
db: &mut DB,
address: Address,
target: Address,
) -> Result<StateLoad<SelfDestructResult>, DB::Error>
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:
Sourcepub fn initial_account_load<DB: Database>(
&mut self,
db: &mut DB,
address: Address,
storage_keys: impl IntoIterator<Item = U256>,
) -> Result<&mut Account, DB::Error>
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
Sourcepub fn load_account<DB: Database>(
&mut self,
db: &mut DB,
address: Address,
) -> Result<StateLoad<&mut Account>, DB::Error>
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>
pub fn load_code<DB: Database>( &mut self, db: &mut DB, address: Address, ) -> Result<StateLoad<&mut Account>, DB::Error>
Sourcepub fn load_account_optional<DB: Database>(
&mut self,
db: &mut DB,
address: Address,
load_code: bool,
) -> Result<StateLoad<&mut Account>, DB::Error>
pub fn load_account_optional<DB: Database>( &mut self, db: &mut DB, address: Address, load_code: bool, ) -> Result<StateLoad<&mut Account>, DB::Error>
Loads code
Sourcepub fn sload<DB: Database>(
&mut self,
db: &mut DB,
address: Address,
key: U256,
) -> Result<StateLoad<U256>, DB::Error>
pub fn sload<DB: Database>( &mut self, db: &mut DB, address: Address, key: U256, ) -> Result<StateLoad<U256>, DB::Error>
Sourcepub fn sstore<DB: Database>(
&mut self,
db: &mut DB,
address: Address,
key: U256,
new: U256,
) -> Result<StateLoad<SStoreResult>, DB::Error>
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.
Sourcepub fn tload(&mut self, address: Address, key: U256) -> U256
pub fn tload(&mut self, address: Address, key: U256) -> U256
Read transient storage tied to the account.
EIP-1153: Transient storage opcodes
Trait Implementations§
Source§impl<DB, ENTRY> Deref for Journal<DB, ENTRY>where
ENTRY: JournalEntryTr,
impl<DB, ENTRY> Deref for Journal<DB, ENTRY>where
ENTRY: JournalEntryTr,
Source§impl<DB, ENTRY> DerefMut for Journal<DB, ENTRY>where
ENTRY: JournalEntryTr,
impl<DB, ENTRY> DerefMut for Journal<DB, ENTRY>where
ENTRY: JournalEntryTr,
Source§impl<'de, DB, ENTRY> Deserialize<'de> for Journal<DB, ENTRY>
impl<'de, DB, ENTRY> Deserialize<'de> for Journal<DB, ENTRY>
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl<DB: Database, ENTRY: JournalEntryTr> JournalTr for Journal<DB, ENTRY>
impl<DB: Database, ENTRY: JournalEntryTr> JournalTr for Journal<DB, ENTRY>
type Database = DB
type FinalOutput = JournalOutput
Source§fn sload(
&mut self,
address: Address,
key: U256,
) -> Result<StateLoad<U256>, <Self::Database as Database>::Error>
fn sload( &mut self, address: Address, key: U256, ) -> Result<StateLoad<U256>, <Self::Database as Database>::Error>
Source§fn sstore(
&mut self,
address: Address,
key: U256,
value: U256,
) -> Result<StateLoad<SStoreResult>, <Self::Database as Database>::Error>
fn sstore( &mut self, address: Address, key: U256, value: U256, ) -> Result<StateLoad<SStoreResult>, <Self::Database as Database>::Error>
Source§fn tstore(&mut self, address: Address, key: U256, value: U256)
fn tstore(&mut self, address: Address, key: U256, value: U256)
Source§fn selfdestruct(
&mut self,
address: Address,
target: Address,
) -> Result<StateLoad<SelfDestructResult>, DB::Error>
fn selfdestruct( &mut self, address: Address, target: Address, ) -> Result<StateLoad<SelfDestructResult>, DB::Error>
Source§fn warm_account(&mut self, address: Address)
fn warm_account(&mut self, address: Address)
Source§fn warm_precompiles(&mut self, address: HashSet<Address>)
fn warm_precompiles(&mut self, address: HashSet<Address>)
Source§fn precompile_addresses(&self) -> &HashSet<Address>
fn precompile_addresses(&self) -> &HashSet<Address>
Source§fn warm_account_and_storage(
&mut self,
address: Address,
storage_keys: impl IntoIterator<Item = U256>,
) -> Result<(), <Self::Database as Database>::Error>
fn warm_account_and_storage( &mut self, address: Address, storage_keys: impl IntoIterator<Item = U256>, ) -> Result<(), <Self::Database as Database>::Error>
Source§fn set_spec_id(&mut self, spec_id: SpecId)
fn set_spec_id(&mut self, spec_id: SpecId)
Source§fn transfer(
&mut self,
from: Address,
to: Address,
balance: U256,
) -> Result<Option<TransferError>, DB::Error>
fn transfer( &mut self, from: Address, to: Address, balance: U256, ) -> Result<Option<TransferError>, DB::Error>
Source§fn touch_account(&mut self, address: Address)
fn touch_account(&mut self, address: Address)
Source§fn inc_account_nonce(
&mut self,
address: Address,
) -> Result<Option<u64>, DB::Error>
fn inc_account_nonce( &mut self, address: Address, ) -> Result<Option<u64>, DB::Error>
Source§fn load_account(
&mut self,
address: Address,
) -> Result<StateLoad<&mut Account>, DB::Error>
fn load_account( &mut self, address: Address, ) -> Result<StateLoad<&mut Account>, DB::Error>
Source§fn load_account_code(
&mut self,
address: Address,
) -> Result<StateLoad<&mut Account>, DB::Error>
fn load_account_code( &mut self, address: Address, ) -> Result<StateLoad<&mut Account>, DB::Error>
Source§fn load_account_delegated(
&mut self,
address: Address,
) -> Result<StateLoad<AccountLoad>, DB::Error>
fn load_account_delegated( &mut self, address: Address, ) -> Result<StateLoad<AccountLoad>, DB::Error>
Source§fn checkpoint(&mut self) -> JournalCheckpoint
fn checkpoint(&mut self) -> JournalCheckpoint
Source§fn checkpoint_commit(&mut self)
fn checkpoint_commit(&mut self)
Source§fn checkpoint_revert(&mut self, checkpoint: JournalCheckpoint)
fn checkpoint_revert(&mut self, checkpoint: JournalCheckpoint)
Source§fn set_code_with_hash(&mut self, address: Address, code: Bytecode, hash: B256)
fn set_code_with_hash(&mut self, address: Address, code: Bytecode, hash: B256)
Source§fn clear(&mut self)
fn clear(&mut self)
Source§fn create_account_checkpoint(
&mut self,
caller: Address,
address: Address,
balance: U256,
spec_id: SpecId,
) -> Result<JournalCheckpoint, TransferError>
fn create_account_checkpoint( &mut self, caller: Address, address: Address, balance: U256, spec_id: SpecId, ) -> Result<JournalCheckpoint, TransferError>
Source§fn finalize(&mut self) -> Self::FinalOutput
fn finalize(&mut self) -> Self::FinalOutput
§fn set_code(&mut self, address: Address, code: Bytecode)
fn set_code(&mut self, address: Address, code: Bytecode)
Source§impl<DB: PartialEq, ENTRY> PartialEq for Journal<DB, ENTRY>where
ENTRY: JournalEntryTr + PartialEq,
impl<DB: PartialEq, ENTRY> PartialEq for Journal<DB, ENTRY>where
ENTRY: JournalEntryTr + PartialEq,
impl<DB: Eq, ENTRY> Eq for Journal<DB, ENTRY>where
ENTRY: JournalEntryTr + Eq,
impl<DB, ENTRY> StructuralPartialEq for Journal<DB, ENTRY>where
ENTRY: JournalEntryTr,
Auto Trait Implementations§
impl<DB, ENTRY> Freeze for Journal<DB, ENTRY>where
DB: Freeze,
impl<DB, ENTRY> RefUnwindSafe for Journal<DB, ENTRY>where
DB: RefUnwindSafe,
ENTRY: RefUnwindSafe,
impl<DB, ENTRY> Send for Journal<DB, ENTRY>
impl<DB, ENTRY> Sync for Journal<DB, ENTRY>
impl<DB, ENTRY> Unpin for Journal<DB, ENTRY>
impl<DB, ENTRY> UnwindSafe for Journal<DB, ENTRY>where
DB: UnwindSafe,
ENTRY: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.