Trait Module

pub trait Module {
    type ExecT;
    type QueryT;
    type SudoT;

    // Required methods
    fn execute<ExecC, QueryC>(
        &self,
        api: &dyn Api,
        storage: &mut dyn Storage,
        router: &dyn CosmosRouter<ExecC = ExecC, QueryC = QueryC>,
        block: &BlockInfo,
        sender: Addr,
        msg: Self::ExecT,
    ) -> AnyResult<AppResponse>
       where ExecC: CustomMsg + DeserializeOwned + 'static,
             QueryC: CustomQuery + DeserializeOwned + 'static;
    fn query(
        &self,
        api: &dyn Api,
        storage: &dyn Storage,
        querier: &dyn Querier,
        block: &BlockInfo,
        request: Self::QueryT,
    ) -> AnyResult<Binary>;
    fn sudo<ExecC, QueryC>(
        &self,
        api: &dyn Api,
        storage: &mut dyn Storage,
        router: &dyn CosmosRouter<ExecC = ExecC, QueryC = QueryC>,
        block: &BlockInfo,
        msg: Self::SudoT,
    ) -> AnyResult<AppResponse>
       where ExecC: CustomMsg + DeserializeOwned + 'static,
             QueryC: CustomQuery + DeserializeOwned + 'static;
}

General module

Provides a generic interface for modules within the test environment. It is essential for creating modular and extensible testing setups, allowing developers to integrate custom functionalities or test specific scenarios.

Required Associated Types

type ExecT

Type of messages processed by the module instance.

type QueryT

Type of queries processed by the module instance.

type SudoT

Type of privileged messages used by the module instance.

Required Methods

fn execute<ExecC, QueryC>( &self, api: &dyn Api, storage: &mut dyn Storage, router: &dyn CosmosRouter<ExecC = ExecC, QueryC = QueryC>, block: &BlockInfo, sender: Addr, msg: Self::ExecT, ) -> AnyResult<AppResponse>

where ExecC: CustomMsg + DeserializeOwned + 'static, QueryC: CustomQuery + DeserializeOwned + 'static,

Runs any ExecT message, which can be called by any external actor or smart contract.

fn query( &self, api: &dyn Api, storage: &dyn Storage, querier: &dyn Querier, block: &BlockInfo, request: Self::QueryT, ) -> AnyResult<Binary>

Runs any QueryT message, which can be called by any external actor or smart contract.

fn sudo<ExecC, QueryC>( &self, api: &dyn Api, storage: &mut dyn Storage, router: &dyn CosmosRouter<ExecC = ExecC, QueryC = QueryC>, block: &BlockInfo, msg: Self::SudoT, ) -> AnyResult<AppResponse>

where ExecC: CustomMsg + DeserializeOwned + 'static, QueryC: CustomQuery + DeserializeOwned + 'static,

Runs privileged actions, like minting tokens, or governance proposals. This allows modules to have full access to these privileged actions, that cannot be triggered by smart contracts.

There is no sender, as this must be previously authorized before calling.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl Module for BankKeeper

type ExecT = BankMsg

type QueryT = BankQuery

type SudoT = BankSudo

impl Module for DistributionKeeper

type ExecT = DistributionMsg

type QueryT = DistributionQuery

type SudoT = Empty

impl Module for StakeKeeper

type ExecT = StakingMsg

type QueryT = StakingQuery

type SudoT = StakingSudo

impl<Exec, Query> Module for CachingCustomHandler<Exec, Query>

where Exec: Default + Clone, Query: Default + Clone,

type ExecT = Exec

type QueryT = Query

type SudoT = Empty

impl<ExecT, QueryT, SudoT> Module for AcceptingModule<ExecT, QueryT, SudoT>

where ExecT: Debug, QueryT: Debug, SudoT: Debug,

type ExecT = ExecT

type QueryT = QueryT

type SudoT = SudoT

impl<ExecT, QueryT, SudoT> Module for FailingModule<ExecT, QueryT, SudoT>

where ExecT: Debug, QueryT: Debug, SudoT: Debug,

type ExecT = ExecT

type QueryT = QueryT

type SudoT = SudoT