Trait fuel_vm::prelude::InterpreterStorage

pub trait InterpreterStorage: StorageMutate<ContractsRawCode, Error = Self::DataError> + StorageMutate<ContractsInfo, Error = Self::DataError> + MerkleRootStorage<ContractId, ContractsAssets, Error = Self::DataError> + MerkleRootStorage<ContractId, ContractsState, Error = Self::DataError> {
    type DataError: StdError + Into<Error>;

    // Required methods
    fn block_height(&self) -> Result<u32, Self::DataError>;
    fn timestamp(&self, height: u32) -> Result<Word, Self::DataError>;
    fn block_hash(&self, block_height: u32) -> Result<Bytes32, Self::DataError>;
    fn coinbase(&self) -> Result<Address, Self::DataError>;
    fn merkle_contract_state_range(
        &self,
        id: &ContractId,
        start_key: &Bytes32,
        range: Word
    ) -> Result<Vec<Option<Cow<'_, Bytes32>>>, Self::DataError>;
    fn merkle_contract_state_insert_range(
        &mut self,
        contract: &ContractId,
        start_key: &Bytes32,
        values: &[Bytes32]
    ) -> Result<Option<()>, Self::DataError>;
    fn merkle_contract_state_remove_range(
        &mut self,
        contract: &ContractId,
        start_key: &Bytes32,
        range: Word
    ) -> Result<Option<()>, Self::DataError>;

    // Provided methods
    fn deploy_contract(
        &mut self,
        salt: &Salt,
        slots: &[StorageSlot],
        contract: &Contract
    ) -> Result<(), Self::DataError> { ... }
    fn deploy_contract_with_id(
        &mut self,
        salt: &Salt,
        slots: &[StorageSlot],
        contract: &Contract,
        root: &Bytes32,
        id: &ContractId
    ) -> Result<(), Self::DataError> { ... }
    fn storage_contract(
        &self,
        id: &ContractId
    ) -> Result<Option<Cow<'_, Contract>>, Self::DataError> { ... }
    fn storage_contract_insert(
        &mut self,
        id: &ContractId,
        contract: &Contract
    ) -> Result<Option<Contract>, Self::DataError> { ... }
    fn storage_contract_exists(
        &self,
        id: &ContractId
    ) -> Result<bool, Self::DataError> { ... }
    fn storage_contract_root(
        &self,
        id: &ContractId
    ) -> Result<Option<Cow<'_, (Salt, Bytes32)>>, Self::DataError> { ... }
    fn storage_contract_root_insert(
        &mut self,
        id: &ContractId,
        salt: &Salt,
        root: &Bytes32
    ) -> Result<Option<(Salt, Bytes32)>, Self::DataError> { ... }
    fn merkle_contract_state(
        &self,
        id: &ContractId,
        key: &Bytes32
    ) -> Result<Option<Cow<'_, Bytes32>>, Self::DataError> { ... }
    fn merkle_contract_state_insert(
        &mut self,
        contract: &ContractId,
        key: &Bytes32,
        value: &Bytes32
    ) -> Result<Option<Bytes32>, Self::DataError> { ... }
    fn merkle_contract_state_remove(
        &mut self,
        contract: &ContractId,
        key: &Bytes32
    ) -> Result<Option<Bytes32>, Self::DataError> { ... }
    fn merkle_contract_asset_id_balance(
        &self,
        id: &ContractId,
        asset_id: &AssetId
    ) -> Result<Option<Word>, Self::DataError> { ... }
    fn merkle_contract_asset_id_balance_insert(
        &mut self,
        contract: &ContractId,
        asset_id: &AssetId,
        value: Word
    ) -> Result<Option<Word>, Self::DataError> { ... }
}

When this trait is implemented, the underlying interpreter is guaranteed to have full functionality

Required Associated Types

type DataError: StdError + Into<Error>

Error implementation for reasons unspecified in the protocol.

Required Methods

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

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

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

Return the timestamp of a given block

This isn’t optional because the VM is expected to panic if an invalid block height is passed - under the assumption that the block height is consistent, the storage should necessarily have the timestamp for the block, unless some I/O error prevents it from fetching it.

fn block_hash(&self, block_height: u32) -> Result<Bytes32, Self::DataError>

Provide the block hash from a given height.

fn coinbase(&self) -> Result<Address, Self::DataError>

Provide the coinbase address for the VM instructions implementation.

fn merkle_contract_state_range(
&self,
id: &ContractId,
start_key: &Bytes32,
range: Word
) -> Result<Vec<Option<Cow<'_, Bytes32>>>, 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 merkle_contract_state_insert_range(
&mut self,
contract: &ContractId,
start_key: &Bytes32,
values: &[Bytes32]
) -> Result<Option<()>, Self::DataError>

Insert a range of key-value mappings into contract storage. Returns None if any of the keys in the range were previously unset.

fn merkle_contract_state_remove_range(
&mut self,
contract: &ContractId,
start_key: &Bytes32,
range: Word
) -> 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.

Provided Methods

fn deploy_contract(
&mut self,
salt: &Salt,
slots: &[StorageSlot],
contract: &Contract
) -> Result<(), Self::DataError>

Deploy a contract into the storage

fn deploy_contract_with_id(
&mut self,
salt: &Salt,
slots: &[StorageSlot],
contract: &Contract,
root: &Bytes32,
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_insert(
&mut self,
id: &ContractId,
contract: &Contract
) -> Result<Option<Contract>, Self::DataError>

Append a contract to the chain, provided its identifier.

Canonically, the identifier should be Contract::id.

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

Check if a provided contract exists in the chain.

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

Fetch a previously inserted salt+root tuple from the chain state for a given contract.

fn storage_contract_root_insert(
&mut self,
id: &ContractId,
salt: &Salt,
root: &Bytes32
) -> Result<Option<(Salt, Bytes32)>, Self::DataError>

Append the salt+root of a contract that was appended to the chain.

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

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

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

Insert a key-value mapping in a contract storage.

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

Remove a key-value mapping from a contract storage.

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

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

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

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

Implementations on Foreign Types

impl<S> InterpreterStorage for &mut Swhere
S: InterpreterStorage,

type DataError = <S as InterpreterStorage>::DataError

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

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

fn block_hash(&self, block_height: u32) -> Result<Bytes32, Self::DataError>

fn coinbase(&self) -> Result<Address, Self::DataError>

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

fn merkle_contract_state_insert_range(
&mut self,
contract: &ContractId,
start_key: &Bytes32,
values: &[Bytes32]
) -> Result<Option<()>, Self::DataError>

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

Implementors

impl InterpreterStorage for MemoryStorage

type DataError = Infallible

impl InterpreterStorage for PredicateStorage

type DataError = InterpreterError