Struct cw_multi_test::StakeKeeper

pub struct StakeKeeper { /* private fields */ }

A structure representing a default stake keeper.

Implementations

impl StakeKeeper

pub fn new() -> Self

Creates a new stake keeper with default module address.

pub fn setup( &self, storage: &mut dyn Storage, staking_info: StakingInfo ) -> AnyResult<()>

Provides some general parameters to the stake keeper

pub fn add_validator( &self, api: &dyn Api, storage: &mut dyn Storage, block: &BlockInfo, validator: Validator ) -> AnyResult<()>

Add a new validator available for staking

pub fn get_rewards( &self, storage: &dyn Storage, block: &BlockInfo, delegator: &Addr, validator: &Addr ) -> AnyResult<Option<Coin>>

Returns the rewards of the given delegator at the given validator

Trait Implementations

impl Default for StakeKeeper

fn default() -> Self

Creates a new stake keeper with default settings.

impl Module for StakeKeeper

type ExecT = StakingMsg

Type of messages processed by the module instance.

type QueryT = StakingQuery

Type of queries processed by the module instance.

type SudoT = StakingSudo

Type of privileged messages used by the module instance.

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

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: StakingQuery ) -> AnyResult<Binary>

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

fn sudo<ExecC: CustomMsg, QueryC: CustomQuery>( &self, api: &dyn Api, storage: &mut dyn Storage, _router: &dyn CosmosRouter<ExecC = ExecC, QueryC = QueryC>, block: &BlockInfo, msg: StakingSudo ) -> AnyResult<AppResponse>

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.

impl Staking for StakeKeeper

fn process_queue<ExecC: CustomMsg, QueryC: CustomQuery>( &self, api: &dyn Api, storage: &mut dyn Storage, router: &dyn CosmosRouter<ExecC = ExecC, QueryC = QueryC>, block: &BlockInfo ) -> AnyResult<AppResponse>

This is called from the end blocker (update_block / set_block) to process the staking queue. Needed because unbonding has a waiting time. If you’re implementing a dummy staking module, this can be a no-op.