Struct rusk_vm::NetworkState

pub struct NetworkState { /* private fields */ }

The main network state.

It keeps two different states, the origin and the head. The origin is the starting state, and head is origin with all the received transactions applied.

It is possible to either commit to the head state, turning it into the new origin, or reset it back to origin.

Implementations

impl NetworkState

pub fn new() -> Self

Returns a new empty NetworkState.

pub fn with_schedule(schedule: &Schedule) -> Self

Returns a NetworkState based on a schedule

pub fn get_contract<'a>(
    &'a self,
    contract_id: &ContractId
) -> Result<impl Deref<Target = Contract> + 'a, VMError>

Returns a reference to the specified contracts state in the head state.

pub fn get_contract_mut<'a>(
    &'a mut self,
    contract_id: &ContractId
) -> Result<impl DerefMut<Target = Contract> + 'a, VMError>

Returns a mutable reference to the specified contracts state in the origin state.

pub fn deploy(&mut self, contract: Contract) -> Result<ContractId, VMError>

Deploys a contract to the head state, returning the address of the created contract or an error.

pub fn deploy_with_id(
    &mut self,
    id: ContractId,
    contract: Contract
) -> Result<ContractId, VMError>

Deploys a contract to the head state with the given id / address.

pub fn query<A, R>(
    &mut self,
    target: ContractId,
    block_height: u64,
    query: A,
    gas_meter: &mut GasMeter
) -> Result<R, VMError> where
    A: Canon,
    R: Canon, 

Query the contract at target address in the head state.

pub fn transact<A, R>(
    &mut self,
    target: ContractId,
    block_height: u64,
    transaction: A,
    gas_meter: &mut GasMeter
) -> Result<R, VMError> where
    A: Canon,
    R: Canon, 

Transact with the contract at target address in the head state, returning the result of the transaction.

This will advance the head to the resultant state.

pub fn root(&self) -> [u8; 32]

Returns the root of the tree in the head state.

pub fn reset(&mut self)

Resets the head state to origin.

pub fn commit(&mut self)

Commits to the head state, making it the new origin.

pub fn register_host_module<M>(&mut self, module: M) where
    M: HostModule + 'static + Sync + Send, 

Register a host function handler.

pub fn get_contract_cast_state<C>(
    &self,
    contract_id: &ContractId
) -> Result<C, VMError> where
    C: Canon, 

Gets the state of the given contract in the head state.

pub fn get_module_config(&self) -> &ModuleConfig

Gets module config

Trait Implementations

impl Canon for NetworkState

Custom implementation of Canon ensuring only the head state is encoded. When restored, head is set to be a copy of origin and the modules are to be set by the caller.

fn encode(&self, sink: &mut Sink<'_>)

Write the encoded value as bytes to a Sink

fn decode(source: &mut Source<'_>) -> Result<Self, CanonError>

Return the decoded value from bytes in a Source

fn encoded_len(&self) -> usize

Returns the number of bytes needed to encode this value

impl Clone for NetworkState

fn clone(&self) -> NetworkState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for NetworkState

fn default() -> NetworkState

Returns the “default value” for a type.