Struct sov_chain_state::ChainState

pub struct ChainState<C: Context, Da: DaSpec> { /* private fields */ }

A new module:

• Must derive ModuleInfo
• Must contain [address] field
• Can contain any number of #[state] or [module] fields

Implementations

impl<C: Context, Da: DaSpec> ChainState<C, Da>

pub fn get_slot_height( &self, working_set: &mut WorkingSet<C::Storage> ) -> TransitionHeight

Returns transition height in the current slot

pub fn get_genesis_hash( &self, working_set: &mut WorkingSet<C::Storage> ) -> Option<[u8; 32]>

Return the genesis hash of the module.

pub fn get_genesis_height( &self, working_set: &mut WorkingSet<C::Storage> ) -> Option<TransitionHeight>

Returns the genesis height of the module.

pub fn get_in_progress_transition( &self, working_set: &mut WorkingSet<C::Storage> ) -> Option<TransitionInProgress<Da>>

Returns the transition in progress of the module.

pub fn get_historical_transitions( &self, transition_num: TransitionHeight, working_set: &mut WorkingSet<C::Storage> ) -> Option<StateTransitionId<Da>>

Returns the completed transition associated with the provided transition_num.

Trait Implementations

impl<C: Clone + Context, Da: Clone + DaSpec> Clone for ChainState<C, Da>where C::Address: Clone,

fn clone(&self) -> ChainState<C, Da>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Context, Da: DaSpec> Default for ChainState<C, Da>

fn default() -> Self

Returns the “default value” for a type.

impl<C: Context, Da: DaSpec> Module for ChainState<C, Da>

type Context = C

Execution context.

type Config = ChainStateConfig

Configuration for the genesis method.

type CallMessage = NonInstantiable

Module defined argument to the call method.

fn genesis( &self, config: &Self::Config, working_set: &mut WorkingSet<C::Storage> ) -> Result<(), Error>

Genesis is called when a rollup is deployed and can be used to set initial state values in the module.

fn call( &self, _message: Self::CallMessage, _context: &Self::Context, _working_set: &mut WorkingSet<<Self::Context as Spec>::Storage> ) -> Result<CallResponse, Error>

Call allows interaction with the module and invokes state changes. It takes a module defined type and a context as parameters.

impl<C: Context, Da: DaSpec> ModuleInfo for ChainState<C, Da>

type Context = C

fn prefix(&self) -> Prefix

Returns the prefix of the module.

fn address(&self) -> &<Self::Context as Spec>::Address

Returns address of the module.

fn dependencies(&self) -> Vec<&<Self::Context as Spec>::Address>

Returns addresses of all the other modules this module is dependent on

impl<C: Context, Da: DaSpec> SlotHooks<Da> for ChainState<C, Da>

type Context = C

fn begin_slot_hook( &self, slot_header: &Da::BlockHeader, validity_condition: &Da::ValidityCondition, working_set: &mut WorkingSet<<Self::Context as Spec>::Storage> )

fn end_slot_hook( &self, _working_set: &mut WorkingSet<<Self::Context as Spec>::Storage> )

fn finalize_slot_hook( &self, _root_hash: [u8; 32], _accesorry_working_set: &mut AccessoryWorkingSet<'_, <Self::Context as Spec>::Storage> )