Struct fuel_vm::storage::PredicateStorage

pub struct PredicateStorage;

No-op storage used for predicate operations.

The storage implementations are expected to provide KV-like operations for contract operations. However, predicates, as defined in the protocol, cannot execute contract opcodes. This means its storage backend for predicate execution shouldn’t provide any functionality.

Trait Implementations

impl Clone for PredicateStorage

fn clone(&self) -> PredicateStorage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContractsAssetsStorage for PredicateStorage

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 PredicateStorage

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

Formats the value using the given formatter.

impl Default for PredicateStorage

fn default() -> PredicateStorage

Returns the “default value” for a type.

impl InterpreterStorage for PredicateStorage

type DataError = StorageUnavailable

Error implementation for reasons unspecified in the protocol.

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

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, StorageUnavailable>

Return the timestamp of a given block

fn block_hash( &self, _block_height: BlockHeight, ) -> Result<Bytes32, StorageUnavailable>

Provide the block hash from a given height.

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

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, _hash: &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>>>, StorageUnavailable>

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, _: &ContractId, _: &Bytes32, _: 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<()>, StorageUnavailable>

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<Type: Mappable> StorageInspect<Type> for PredicateStorage

type Error = StorageUnavailable

fn get( &self, _key: &Type::Key, ) -> Result<Option<Cow<'_, Type::OwnedValue>>, StorageUnavailable>

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

fn contains_key(&self, _key: &Type::Key) -> Result<bool, StorageUnavailable>

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

impl<Type: Mappable> StorageMutate<Type> for PredicateStorage

fn insert( &mut self, _key: &Type::Key, _value: &Type::Value, ) -> Result<Option<Type::OwnedValue>, StorageUnavailable>

Append Key->Value mapping to the storage.

fn remove( &mut self, _key: &Type::Key, ) -> Result<Option<Type::OwnedValue>, StorageUnavailable>

Remove Key->Value mapping from the storage.

impl StorageRead<ContractsRawCode> for PredicateStorage

fn read( &self, _key: &<ContractsRawCode as Mappable>::Key, _buf: &mut [u8], ) -> Result<Option<usize>, StorageUnavailable>

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

fn read_alloc( &self, _key: &<ContractsRawCode as Mappable>::Key, ) -> Result<Option<Vec<u8>>, StorageUnavailable>

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

impl StorageRead<ContractsState> for PredicateStorage

fn read( &self, _key: &<ContractsState as Mappable>::Key, _buf: &mut [u8], ) -> Result<Option<usize>, StorageUnavailable>

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>>, StorageUnavailable>

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

impl StorageSize<ContractsRawCode> for PredicateStorage

fn size_of_value( &self, _key: &ContractId, ) -> Result<Option<usize>, StorageUnavailable>

Return the number of bytes stored at this key.

impl StorageSize<ContractsState> for PredicateStorage

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

Return the number of bytes stored at this key.

impl StorageWrite<ContractsRawCode> for PredicateStorage

fn write( &mut self, _key: &<ContractsRawCode as Mappable>::Key, _buf: &[u8], ) -> Result<usize, Self::Error>

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

fn replace( &mut self, _key: &<ContractsRawCode as Mappable>::Key, _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: &<ContractsRawCode as Mappable>::Key, ) -> Result<Option<Vec<u8>>, Self::Error>

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

impl StorageWrite<ContractsState> for PredicateStorage

fn write( &mut self, _key: &<ContractsState as Mappable>::Key, _buf: &[u8], ) -> Result<usize, Self::Error>

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>

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.

impl Copy for PredicateStorage