Struct fuel_vm::storage::MemoryStorage

pub struct MemoryStorage { /* private fields */ }

In-memory storage implementation for the interpreter.

It tracks 3 states:

• memory: the transactions will be applied to this state.
• transacted: will receive the committed memory state.
• persisted: will receive the persisted transacted state.

Implementations

impl MemoryStorage

pub fn new(block_height: BlockHeight, coinbase: ContractId) -> Self

Create a new memory storage.

pub fn new_with_versions( block_height: BlockHeight, coinbase: ContractId, consensus_parameters_version: u32, state_transition_version: u32, ) -> Self

Create a new memory storage with versions.

pub fn all_contract_state( &self, ) -> impl Iterator<Item = (&ContractsStateKey, &ContractsStateData)>

Iterate over all contract state in storage

pub fn contract_state( &self, contract: &ContractId, key: &Bytes32, ) -> Cow<'_, ContractsStateData>

Fetch a mapping from the contract state.

pub fn commit(&mut self)

Set the transacted state to the memory state.

pub fn revert(&mut self)

Revert the memory state to the transacted state.

pub fn rollback(&mut self)

Revert the memory and transacted changes to the persisted state.

pub fn persist(&mut self)

Persist the changes from transacted to memory+persisted state.

Trait Implementations

impl<M, Ecal: EcalHandler> AsMut<MemoryStorage> for MemoryClient<M, Ecal>

fn as_mut(&mut self) -> &mut MemoryStorage

Converts this type into a mutable reference of the (usually inferred) input type.

impl<M, Ecal: EcalHandler> AsRef<MemoryStorage> for MemoryClient<M, Ecal>

fn as_ref(&self) -> &MemoryStorage

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for MemoryStorage

fn clone(&self) -> MemoryStorage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContractsAssetsStorage for MemoryStorage

fn contract_asset_id_balance( &self, id: &ContractId, asset_id: &AssetId, ) -> Result<Option<Word>, Self::Error>

Fetch the balance of an asset ID in a contract storage.

fn contract_asset_id_balance_insert( &mut self, contract: &ContractId, asset_id: &AssetId, value: Word, ) -> Result<Option<Word>, Self::Error>

Update the balance of an asset ID in a contract storage. Returns the old balance, if any.

impl Debug for MemoryStorage

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

Formats the value using the given formatter.

impl Default for MemoryStorage

fn default() -> Self

Returns the “default value” for a type.

impl InterpreterStorage for MemoryStorage

type DataError = Infallible

Error implementation for reasons unspecified in the protocol.

fn block_height(&self) -> Result<BlockHeight, Infallible>

Provide the current block height in which the transactions should be executed.

fn consensus_parameters_version(&self) -> Result<u32, Self::DataError>

Provide the current version of consensus parameters used to execute transaction.

fn state_transition_version(&self) -> Result<u32, Self::DataError>

Provide the current version of state transition function used to execute transaction.

fn timestamp(&self, height: BlockHeight) -> Result<Word, Self::DataError>

Return the timestamp of a given block

fn block_hash(&self, block_height: BlockHeight) -> Result<Bytes32, Infallible>

Provide the block hash from a given height.

fn coinbase(&self) -> Result<ContractId, Infallible>

Provide the coinbase address for the VM instructions implementation.

fn set_consensus_parameters( &mut self, version: u32, consensus_parameters: &ConsensusParameters, ) -> Result<Option<ConsensusParameters>, Self::DataError>

Set the consensus parameters in the storage under the version.

fn set_state_transition_bytecode( &mut self, version: u32, bytecode: &Bytes32, ) -> Result<Option<Bytes32>, Self::DataError>

Set the state transition bytecode in the storage under the version.

fn contract_state_range( &self, id: &ContractId, start_key: &Bytes32, range: usize, ) -> Result<Vec<Option<Cow<'_, ContractsStateData>>>, Self::DataError>

Fetch a range of values from a key-value mapping in a contract storage. Returns the full range requested using optional values in case a requested slot is unset.

fn contract_state_insert_range<'a, I>( &mut self, contract: &ContractId, start_key: &Bytes32, values: I, ) -> Result<usize, Self::DataError>

where I: Iterator<Item = &'a [u8]>,

Insert a range of key-value mappings into contract storage. Returns the number of keys that were previously unset but are now set.

fn contract_state_remove_range( &mut self, contract: &ContractId, start_key: &Bytes32, range: usize, ) -> Result<Option<()>, Self::DataError>

Remove a range of key-values from contract storage. Returns None if any of the keys in the range were already unset.

fn contains_state_transition_bytecode_root( &self, root: &Bytes32, ) -> Result<bool, Self::DataError>

Returns true if the fully uploaded state transition bytecode is present in the storage.

fn deploy_contract_with_id( &mut self, slots: &[StorageSlot], contract: &Contract, id: &ContractId, ) -> Result<(), Self::DataError>

Deploy a contract into the storage with contract id

fn storage_contract( &self, id: &ContractId, ) -> Result<Option<Cow<'_, Contract>>, Self::DataError>

Fetch a previously inserted contract code from the chain state for a given contract.

fn storage_contract_size( &self, id: &ContractId, ) -> Result<Option<usize>, Self::DataError>

Fetch the size of a previously inserted contract code from the chain state for a given contract.

fn read_contract( &self, id: &ContractId, writer: &mut [u8], ) -> Result<Option<Word>, Self::DataError>

Read contract bytes from storage into the buffer.

fn storage_contract_insert( &mut self, id: &ContractId, contract: &Contract, ) -> Result<Option<Contract>, Self::DataError>

Append a contract to the chain, provided its identifier.

fn storage_contract_exists( &self, id: &ContractId, ) -> Result<bool, Self::DataError>

Check if a provided contract exists in the chain.

fn contract_state( &self, id: &ContractId, key: &Bytes32, ) -> Result<Option<Cow<'_, ContractsStateData>>, Self::DataError>

Fetch the value form a key-value mapping in a contract storage.

fn contract_state_insert( &mut self, contract: &ContractId, key: &Bytes32, value: &[u8], ) -> Result<(usize, Option<Vec<u8>>), Self::DataError>

Insert a key-value mapping in a contract storage.

fn contract_state_remove( &mut self, contract: &ContractId, key: &Bytes32, ) -> Result<Option<ContractsStateData>, Self::DataError>

Remove a key-value mapping from a contract storage.

impl StorageInspect<ContractsAssets> for MemoryStorage

type Error = Infallible

fn get( &self, key: &<ContractsAssets as Mappable>::Key, ) -> Result<Option<Cow<'_, Word>>, Infallible>

Retrieve Cow<Value> such as Key->Value.

fn contains_key( &self, key: &<ContractsAssets as Mappable>::Key, ) -> Result<bool, Infallible>

Return true if there is a Key mapping to a value in the storage.

impl StorageInspect<ContractsRawCode> for MemoryStorage

type Error = Infallible

fn get(&self, key: &ContractId) -> Result<Option<Cow<'_, Contract>>, Infallible>

Retrieve Cow<Value> such as Key->Value.

fn contains_key(&self, key: &ContractId) -> Result<bool, Infallible>

Return true if there is a Key mapping to a value in the storage.

impl StorageInspect<ContractsState> for MemoryStorage

type Error = Infallible

fn get( &self, key: &<ContractsState as Mappable>::Key, ) -> Result<Option<Cow<'_, <ContractsState as Mappable>::OwnedValue>>, Infallible>

Retrieve Cow<Value> such as Key->Value.

fn contains_key( &self, key: &<ContractsState as Mappable>::Key, ) -> Result<bool, Infallible>

Return true if there is a Key mapping to a value in the storage.

impl StorageInspect<UploadedBytecodes> for MemoryStorage

type Error = Infallible

fn get( &self, key: &<UploadedBytecodes as Mappable>::Key, ) -> Result<Option<Cow<'_, UploadedBytecode>>, Infallible>

Retrieve Cow<Value> such as Key->Value.

fn contains_key( &self, key: &<UploadedBytecodes as Mappable>::Key, ) -> Result<bool, Infallible>

Return true if there is a Key mapping to a value in the storage.

impl StorageMutate<ContractsAssets> for MemoryStorage

fn insert( &mut self, key: &<ContractsAssets as Mappable>::Key, value: &Word, ) -> Result<Option<Word>, Infallible>

Append Key->Value mapping to the storage.

fn remove( &mut self, key: &<ContractsAssets as Mappable>::Key, ) -> Result<Option<Word>, Infallible>

Remove Key->Value mapping from the storage.

impl StorageMutate<ContractsRawCode> for MemoryStorage

fn insert( &mut self, key: &ContractId, value: &[u8], ) -> Result<Option<Contract>, Infallible>

Append Key->Value mapping to the storage.

fn remove(&mut self, key: &ContractId) -> Result<Option<Contract>, Infallible>

Remove Key->Value mapping from the storage.

impl StorageMutate<ContractsState> for MemoryStorage

fn insert( &mut self, key: &<ContractsState as Mappable>::Key, value: &<ContractsState as Mappable>::Value, ) -> Result<Option<<ContractsState as Mappable>::OwnedValue>, Infallible>

Append Key->Value mapping to the storage.

fn remove( &mut self, key: &<ContractsState as Mappable>::Key, ) -> Result<Option<ContractsStateData>, Infallible>

Remove Key->Value mapping from the storage.

impl StorageMutate<UploadedBytecodes> for MemoryStorage

fn insert( &mut self, key: &<UploadedBytecodes as Mappable>::Key, value: &<UploadedBytecodes as Mappable>::Value, ) -> Result<Option<UploadedBytecode>, Infallible>

Append Key->Value mapping to the storage.

fn remove( &mut self, key: &<UploadedBytecodes as Mappable>::Key, ) -> Result<Option<UploadedBytecode>, Infallible>

Remove Key->Value mapping from the storage.

impl StorageRead<ContractsRawCode> for MemoryStorage

fn read( &self, key: &ContractId, buf: &mut [u8], ) -> Result<Option<usize>, Self::Error>

Read the value stored at the given key into the provided buffer if the value exists.

fn read_alloc(&self, key: &ContractId) -> Result<Option<Vec<u8>>, Self::Error>

Same as read but allocates a new buffer and returns it.

impl StorageRead<ContractsState> for MemoryStorage

fn read( &self, key: &<ContractsState as Mappable>::Key, buf: &mut [u8], ) -> Result<Option<usize>, Self::Error>

Read the value stored at the given key into the provided buffer if the value exists.

fn read_alloc( &self, key: &<ContractsState as Mappable>::Key, ) -> Result<Option<Vec<u8>>, Self::Error>

Same as read but allocates a new buffer and returns it.

impl StorageSize<ContractsRawCode> for MemoryStorage

fn size_of_value(&self, key: &ContractId) -> Result<Option<usize>, Infallible>

Return the number of bytes stored at this key.

impl StorageSize<ContractsState> for MemoryStorage

fn size_of_value( &self, key: &<ContractsState as Mappable>::Key, ) -> Result<Option<usize>, Infallible>

Return the number of bytes stored at this key.

impl StorageWrite<ContractsRawCode> for MemoryStorage

fn write(&mut self, key: &ContractId, buf: &[u8]) -> Result<usize, Infallible>

Write the value to the given key from the provided buffer.

fn replace( &mut self, key: &ContractId, buf: &[u8], ) -> Result<(usize, Option<Vec<u8>>), Self::Error>

Write the value to the given key from the provided buffer and return the previous value if it existed.

fn take(&mut self, key: &ContractId) -> Result<Option<Vec<u8>>, Self::Error>

Removes a value from the storage and returning it without deserializing it.

impl StorageWrite<ContractsState> for MemoryStorage

fn write( &mut self, key: &<ContractsState as Mappable>::Key, buf: &[u8], ) -> Result<usize, Infallible>

Write the value to the given key from the provided buffer.

fn replace( &mut self, key: &<ContractsState as Mappable>::Key, buf: &[u8], ) -> Result<(usize, Option<Vec<u8>>), Self::Error>

where Self: StorageSize<ContractsState>,

Write the value to the given key from the provided buffer and return the previous value if it existed.

fn take( &mut self, key: &<ContractsState as Mappable>::Key, ) -> Result<Option<Vec<u8>>, Self::Error>

Removes a value from the storage and returning it without deserializing it.