types

Documentation

Index

• Variables
• func RegisterCodec(cdc *codec.Codec)
• type AccountKeeper
• type StakingKeeper

Variables

var ModuleCdc *codec.Codec

ModuleCdc defines module codec.

Functions

func RegisterCodec

func RegisterCodec(cdc *codec.Codec)

RegisterCodec registers concrete types on codec.

Types

type AccountKeeper

type AccountKeeper interface {
	GetAccount(ctx sdk.Context, addr sdk.AccAddress) authexported.Account
	IterateAccounts(ctx sdk.Context, process func(authexported.Account) (stop bool))
}

AccountKeeper expected account keeper

type StakingKeeper

type StakingKeeper interface {
	// iterate through validators by operator address, execute func for each validator
	IterateValidators(sdk.Context, func(index int64, validator stakingexported.ValidatorI) (stop bool))

	// get a particular validator by operator address
	Validator(sdk.Context, sdk.ValAddress) stakingexported.ValidatorI

	// get a particular validator by consensus address
	ValidatorByConsAddr(sdk.Context, sdk.ConsAddress) stakingexported.ValidatorI

	// slash the validator and delegators of the validator, specifying offense height, offense power, and slash fraction
	Slash(sdk.Context, sdk.ConsAddress, int64, int64, sdk.Dec)

	// jail a validator
	Jail(sdk.Context, sdk.ConsAddress)

	// unjail a validator
	Unjail(sdk.Context, sdk.ConsAddress)

	// get a particular delegation for a given validator and delegator outside the scope of the staking module.
	Delegation(sdk.Context, sdk.AccAddress, sdk.ValAddress) stakingexported.DelegationI

	// get the maximum amount of bonded validators
	MaxValidators(sdk.Context) uint16
}

StakingKeeper expected staking keeper