Type Alias JournaledState
pub type JournaledState = JournalInner<JournalEntry>;Aliased Type§
pub struct JournaledState {
pub state: HashMap<Address, Account, RandomState>,
pub transient_storage: HashMap<(Address, Uint<256, 4>), Uint<256, 4>, RandomState>,
pub logs: Vec<Log>,
pub depth: usize,
pub journal: Vec<JournalEntry>,
pub transaction_id: usize,
pub spec: SpecId,
pub warm_addresses: WarmAddresses,
}Fields§
§state: HashMap<Address, Account, RandomState>The current state
transient_storage: HashMap<(Address, Uint<256, 4>), Uint<256, 4>, RandomState>Transient storage that is discarded after every transaction.
See EIP-1153.
logs: Vec<Log>Emitted logs
depth: usizeThe current call stack depth
journal: Vec<JournalEntry>The journal of state changes, one for each transaction
transaction_id: usizeGlobal transaction id that represent number of transactions executed (Including reverted ones).
It can be different from number of journal_history as some transaction could be
reverted or had a error on execution.
This ID is used in Self::state to determine if account/storage is touched/warm/cold.
spec: SpecIdThe spec ID for the EVM. Spec is required for some journal entries and needs to be set for JournalInner to be functional.
If spec is set it assumed that precompile addresses are set as well for this particular spec.
This spec is used for two things:
warm_addresses: WarmAddressesWarm addresses containing both coinbase and current precompiles.
Layout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.
Size: 240 bytes
Implementations
§impl<ENTRY> JournalInner<ENTRY>where
ENTRY: JournalEntryTr,
impl<ENTRY> JournalInner<ENTRY>where
ENTRY: JournalEntryTr,
pub fn new() -> JournalInner<ENTRY>
pub fn new() -> JournalInner<ENTRY>
Creates new [JournalInner].
warm_preloaded_addresses is used to determine if address is considered warm loaded.
In ordinary case this is precompile or beneficiary.
pub fn commit_tx(&mut self)
pub fn commit_tx(&mut self)
Prepare for next transaction, by committing the current journal to history, incrementing the transaction id and returning the logs.
This function is used to prepare for next transaction. It will save the current journal and clear the journal for the next transaction.
commit_tx is used even for discarding transactions so transaction_id will be incremented.
pub fn discard_tx(&mut self)
pub fn discard_tx(&mut self)
Discard the current transaction, by reverting the journal entries and incrementing the transaction id.
pub fn finalize(&mut self) -> HashMap<Address, Account, RandomState>
pub fn finalize(&mut self) -> HashMap<Address, Account, RandomState>
Take the EvmState 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.
pub fn set_spec_id(&mut self, spec: SpecId)
pub fn set_spec_id(&mut self, spec: SpecId)
Sets SpecId.
pub 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.
pub 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.
pub fn set_code_with_hash(
&mut self,
address: Address,
code: Bytecode,
hash: FixedBytes<32>,
)
pub fn set_code_with_hash( &mut self, address: Address, code: Bytecode, hash: FixedBytes<32>, )
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)
pub fn set_code(&mut self, address: Address, code: Bytecode)
Use it only if you know that acc is warm.
Assume account is warm.
In case of EIP-7702 code with zero address, the bytecode will be erased.
pub fn caller_accounting_journal_entry(
&mut self,
address: Address,
old_balance: Uint<256, 4>,
bump_nonce: bool,
)
pub fn caller_accounting_journal_entry( &mut self, address: Address, old_balance: Uint<256, 4>, bump_nonce: bool, )
Add journal entry for caller accounting.
pub fn balance_incr<DB>(
&mut self,
db: &mut DB,
address: Address,
balance: Uint<256, 4>,
) -> Result<(), <DB as Database>::Error>where
DB: Database,
pub fn balance_incr<DB>(
&mut self,
db: &mut DB,
address: Address,
balance: Uint<256, 4>,
) -> Result<(), <DB as Database>::Error>where
DB: Database,
Increments the balance of the account.
Mark account as touched.
pub fn nonce_bump_journal_entry(&mut self, address: Address)
pub fn nonce_bump_journal_entry(&mut self, address: Address)
Increments the nonce of the account.
pub fn transfer<DB>(
&mut self,
db: &mut DB,
from: Address,
to: Address,
balance: Uint<256, 4>,
) -> Result<Option<TransferError>, <DB as Database>::Error>where
DB: Database,
pub fn transfer<DB>(
&mut self,
db: &mut DB,
from: Address,
to: Address,
balance: Uint<256, 4>,
) -> Result<Option<TransferError>, <DB as Database>::Error>where
DB: Database,
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: Uint<256, 4>,
spec_id: SpecId,
) -> Result<JournalCheckpoint, TransferError>
pub fn create_account_checkpoint( &mut self, caller: Address, target_address: Address, balance: Uint<256, 4>, 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.
pub 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.
pub fn checkpoint_commit(&mut self)
pub fn checkpoint_commit(&mut self)
Commits the checkpoint.
pub fn checkpoint_revert(&mut self, checkpoint: JournalCheckpoint)
pub fn checkpoint_revert(&mut self, checkpoint: JournalCheckpoint)
Reverts all changes to state until given checkpoint.
pub fn selfdestruct<DB>(
&mut self,
db: &mut DB,
address: Address,
target: Address,
) -> Result<StateLoad<SelfDestructResult>, <DB as Database>::Error>where
DB: Database,
pub fn selfdestruct<DB>(
&mut self,
db: &mut DB,
address: Address,
target: Address,
) -> Result<StateLoad<SelfDestructResult>, <DB as Database>::Error>where
DB: Database,
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:
pub fn load_account<DB>(
&mut self,
db: &mut DB,
address: Address,
) -> Result<StateLoad<&mut Account>, <DB as Database>::Error>where
DB: Database,
pub fn load_account<DB>(
&mut self,
db: &mut DB,
address: Address,
) -> Result<StateLoad<&mut Account>, <DB as Database>::Error>where
DB: Database,
Loads account into memory. return if it is cold or warm accessed
pub fn load_account_delegated<DB>(
&mut self,
db: &mut DB,
address: Address,
) -> Result<StateLoad<AccountLoad>, <DB as Database>::Error>where
DB: Database,
pub fn load_account_delegated<DB>(
&mut self,
db: &mut DB,
address: Address,
) -> Result<StateLoad<AccountLoad>, <DB as Database>::Error>where
DB: Database,
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>(
&mut self,
db: &mut DB,
address: Address,
) -> Result<StateLoad<&mut Account>, <DB as Database>::Error>where
DB: Database,
pub fn load_code<DB>(
&mut self,
db: &mut DB,
address: Address,
) -> Result<StateLoad<&mut Account>, <DB as Database>::Error>where
DB: Database,
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>(
&mut self,
db: &mut DB,
address: Address,
load_code: bool,
storage_keys: impl IntoIterator<Item = Uint<256, 4>>,
) -> Result<StateLoad<&mut Account>, <DB as Database>::Error>where
DB: Database,
pub fn load_account_optional<DB>(
&mut self,
db: &mut DB,
address: Address,
load_code: bool,
storage_keys: impl IntoIterator<Item = Uint<256, 4>>,
) -> Result<StateLoad<&mut Account>, <DB as Database>::Error>where
DB: Database,
Loads account. If account is already loaded it will be marked as warm.
pub fn sload<DB>(
&mut self,
db: &mut DB,
address: Address,
key: Uint<256, 4>,
) -> Result<StateLoad<Uint<256, 4>>, <DB as Database>::Error>where
DB: Database,
pub fn sload<DB>(
&mut self,
db: &mut DB,
address: Address,
key: Uint<256, 4>,
) -> Result<StateLoad<Uint<256, 4>>, <DB as Database>::Error>where
DB: Database,
pub fn sstore<DB>(
&mut self,
db: &mut DB,
address: Address,
key: Uint<256, 4>,
new: Uint<256, 4>,
) -> Result<StateLoad<SStoreResult>, <DB as Database>::Error>where
DB: Database,
pub fn sstore<DB>(
&mut self,
db: &mut DB,
address: Address,
key: Uint<256, 4>,
new: Uint<256, 4>,
) -> Result<StateLoad<SStoreResult>, <DB as Database>::Error>where
DB: Database,
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: Uint<256, 4>) -> Uint<256, 4>
pub fn tload(&mut self, address: Address, key: Uint<256, 4>) -> Uint<256, 4>
Read transient storage tied to the account.
EIP-1153: Transient storage opcodes
pub fn tstore(&mut self, address: Address, key: Uint<256, 4>, new: Uint<256, 4>)
pub fn tstore(&mut self, address: Address, key: Uint<256, 4>, new: Uint<256, 4>)
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)
pub fn log(&mut self, log: Log)
Pushes log into subroutine.