revm-state 41.0.0

Revm state types
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

use super::{Account, EvmStorageSlot};
use core::ops::{Deref, DerefMut};
use primitives::{Address, AddressMap, StorageKey, StorageKeyMap, StorageValue};

/// EVM State is a mapping from addresses to accounts.
pub type EvmState = AddressMap<Account>;

/// An account's Storage is a mapping from 256-bit integer keys to [EvmStorageSlot]s.
pub type EvmStorage = StorageKeyMap<EvmStorageSlot>;

/// Structure used for EIP-1153 transient storage.
///
/// Maps each account [`Address`] to its transient storage slots, a mapping from
/// storage [`StorageKey`]s to [`StorageValue`]s. Transient storage is discarded
/// after every transaction.
///
/// See [EIP-1153](https://eips.ethereum.org/EIPS/eip-1153).
///
/// This is a thin wrapper around an [`AddressMap`] of [`StorageKeyMap`]s. It
/// implements [`Deref`]/[`DerefMut`] to the inner map so all map operations are
/// available, and provides [`get_value`](Self::get_value),
/// [`insert_value`](Self::insert_value) and [`remove_value`](Self::remove_value)
/// helpers for accessing individual slots without manually traversing the two
/// levels of maps.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TransientStorage(pub AddressMap<StorageKeyMap<StorageValue>>);

impl Deref for TransientStorage {
    type Target = AddressMap<StorageKeyMap<StorageValue>>;

    #[inline]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl DerefMut for TransientStorage {
    #[inline]
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl TransientStorage {
    /// Returns the transient storage value for the given account `address` and
    /// storage `key`.
    ///
    /// Returns [`StorageValue::ZERO`](primitives::StorageValue) (the default) if
    /// the slot was never set.
    #[inline]
    pub fn get_value(&self, address: Address, key: StorageKey) -> StorageValue {
        self.0
            .get(&address)
            .and_then(|slots| slots.get(&key))
            .copied()
            .unwrap_or_default()
    }

    /// Inserts a transient storage `value` for the given account `address` and
    /// storage `key`, creating the account's slot map if it does not exist yet.
    ///
    /// Returns the previous value if the slot was already set.
    #[inline]
    pub fn insert_value(
        &mut self,
        address: Address,
        key: StorageKey,
        value: StorageValue,
    ) -> Option<StorageValue> {
        self.0.entry(address).or_default().insert(key, value)
    }

    /// Removes the transient storage slot for the given account `address` and
    /// storage `key`.
    ///
    /// Returns the removed value if the slot was set.
    #[inline]
    pub fn remove_value(&mut self, address: Address, key: StorageKey) -> Option<StorageValue> {
        self.0.get_mut(&address)?.remove(&key)
    }
}