pub struct StorageView<S> {
    pub storage_handle: S,
    pub modified_storage_keys: HashMap<StorageKey, StorageValue>,
    /* private fields */
}
Expand description

StorageView is a buffer for StorageLogs between storage and transaction execution code. In order to commit transactions logs should be submitted to the underlying storage after a transaction is executed.

When executing transactions as a part of miniblock / L1 batch creation, a single StorageView is used for the entire L1 batch. One StorageView must not be used for multiple L1 batches; otherwise, Self::is_write_initial() will return incorrect values because of the caching.

When executing transactions in the API sandbox, a dedicated view is used for each transaction; the only shared part is the read storage keys cache.

Fields§

§storage_handle: S§modified_storage_keys: HashMap<StorageKey, StorageValue>

Implementations§

source§

impl<S: ReadStorage + Debug> StorageView<S>

source

pub fn new(storage_handle: S) -> Self

Creates a new storage view based on the underlying storage.

source

pub fn clean_cache(&mut self)

source

pub fn into_rc_ptr(self) -> Rc<RefCell<Self>>

Make a Rc RefCell ptr to the storage

Trait Implementations§

source§

impl<S: Debug> Debug for StorageView<S>

source§

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

Formats the value using the given formatter. Read more
source§

impl<S: ReadStorage + Debug> ReadStorage for StorageView<S>

source§

fn is_write_initial(&mut self, key: &StorageKey) -> bool

Only keys contained in the underlying storage will return false. If a key was inserted using Self::set_value(), it will still return true.

source§

fn read_value(&mut self, key: &StorageKey) -> StorageValue

Read value of the key.
source§

fn load_factory_dep(&mut self, hash: H256) -> Option<Vec<u8>>

Load the factory dependency code by its hash.
source§

fn get_enumeration_index(&mut self, key: &StorageKey) -> Option<u64>

Retrieves the enumeration index for a given key.
§

fn is_bytecode_known(&mut self, bytecode_hash: &H256) -> bool

Returns whether a bytecode hash is “known” to the system.
source§

impl<S: ReadStorage + Debug> WriteStorage for StorageView<S>

source§

fn set_value(&mut self, key: StorageKey, value: StorageValue) -> StorageValue

Sets the new value under a given key and returns the previous value.
source§

fn read_storage_keys(&self) -> &HashMap<StorageKey, StorageValue>

Returns the map with the key–value pairs read by this batch.
source§

fn modified_storage_keys(&self) -> &HashMap<StorageKey, StorageValue>

Returns a map with the key–value pairs updated by this batch.
source§

fn missed_storage_invocations(&self) -> usize

Returns the number of read / write ops for which the value was read from the underlying storage.

Auto Trait Implementations§

§

impl<S> RefUnwindSafe for StorageView<S>
where S: RefUnwindSafe,

§

impl<S> Send for StorageView<S>
where S: Send,

§

impl<S> Sync for StorageView<S>
where S: Sync,

§

impl<S> Unpin for StorageView<S>
where S: Unpin,

§

impl<S> UnwindSafe for StorageView<S>
where S: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T, U> Cast<U> for T
where U: FromCast<T>,

§

fn cast(self) -> U

Numeric cast from self to T.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromCast<T> for T

§

fn from_cast(t: T) -> T

Numeric cast from T to Self.
§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<T> PipeOp<T> for T

§

fn to<F, U>(self, f: F) -> U
where F: FnOnce(T) -> U,

§

fn op<F>(self, f: F) -> T
where F: FnOnce(&mut T),

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<T> Storage for T
where T: WriteStorage,

§

fn set_value(&mut self, key: &StorageKey, value: H256) -> H256

Returns the original value.

§

fn get_value(&mut self, key: &StorageKey) -> H256

Returns a value from a given key. If value never existed, returns 0.
§

fn is_write_initial(&mut self, key: &StorageKey) -> bool

The function returns true if it’s the first time writing to this storage slot. The initial write uses 64 gas, while subsequent writes use only 40.
§

fn load_factory_dep(&mut self, hash: H256) -> Option<Vec<u8>>

§

fn get_modified_storage_keys(&self) -> &HashMap<StorageKey, H256>

§

fn missed_storage_invocations(&self) -> usize

§

fn number_of_updated_storage_slots(&self) -> usize

§

fn is_bytecode_exists(&mut self, bytecode_hash: &H256) -> bool

Returns whether a bytecode hash is “known”, i.e. whether it has been published on L1
§

impl<T> Storage for T
where T: WriteStorage,

§

fn set_value(&mut self, key: &StorageKey, value: H256) -> H256

Returns the original value.

§

fn get_value(&mut self, key: &StorageKey) -> H256

§

fn is_write_initial(&mut self, key: &StorageKey) -> bool

§

fn load_factory_dep(&mut self, hash: H256) -> Option<Vec<u8>>

§

fn number_of_updated_storage_slots(&self) -> usize

§

fn get_modified_storage_keys(&self) -> &HashMap<StorageKey, H256>

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> JsonSchemaMaybe for T

§

impl<T> MaybeSend for T
where T: Send,