Trait sov_modules_api::Module

pub trait Module {
    type Context: Context;
    type Config;
    type CallMessage: Debug + BorshSerialize + BorshDeserialize = NonInstantiable;

    // Provided methods
    fn genesis(
        &self,
        _config: &Self::Config,
        _working_set: &mut WorkingSet<<Self::Context as Spec>::Storage>
    ) -> Result<(), Error> { ... }
    fn call(
        &self,
        _message: Self::CallMessage,
        _context: &Self::Context,
        _working_set: &mut WorkingSet<<Self::Context as Spec>::Storage>
    ) -> Result<CallResponse, Error> { ... }
}

Every module has to implement this trait. All the methods have a default implementation that can’t be invoked (because they take NonInstantiable parameter). This allows developers to override only some of the methods in their implementation and safely ignore the others.

Required Associated Types

type Context: Context

Execution context.

type Config

Configuration for the genesis method.

Provided Associated Types

type CallMessage: Debug + BorshSerialize + BorshDeserialize = NonInstantiable

Module defined argument to the call method.

Provided Methods

fn genesis( &self, _config: &Self::Config, _working_set: &mut WorkingSet<<Self::Context as Spec>::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.

Implementors