types

Documentation

Overview

Package types only consists of a copy from the cosmos' mint module's expected keepers

Index

• func DefaultGenesisState() *types.GenesisState
• type AccountKeeper
• type BankKeeper
• type DistributionKeeper
• type ShieldKeeper
• type StakingKeeper

Functions

func DefaultGenesisState

func DefaultGenesisState() *types.GenesisState

DefaultGenesisState creates a default GenesisState object.

Types

type AccountKeeper

type AccountKeeper interface {
	GetModuleAddress(name string) sdk.AccAddress

	// TODO remove with genesis 2-phases refactor https://github.com/cosmos/cosmos-sdk/issues/2862
	SetModuleAccount(sdk.Context, types.ModuleAccountI)
	GetModuleAccount(ctx sdk.Context, moduleName string) types.ModuleAccountI
}

AccountKeeper defines the contract required for account APIs.

type BankKeeper

type BankKeeper interface {
	SendCoinsFromModuleToAccount(ctx sdk.Context, senderModule string, recipientAddr sdk.AccAddress, amt sdk.Coins) error
	SendCoinsFromModuleToModule(ctx sdk.Context, senderModule, recipientModule string, amt sdk.Coins) error
	MintCoins(ctx sdk.Context, name string, amt sdk.Coins) error
}

BankKeeper defines the contract needed to be fulfilled for banking and supply dependencies.

type DistributionKeeper

type DistributionKeeper interface {
	FundCommunityPool(ctx sdk.Context, amount sdk.Coins, sender sdk.AccAddress) error
	GetFeePool(ctx sdk.Context) distrtypes.FeePool
}

DistributionKeeper defines the expected distribution keeper.

type ShieldKeeper

type ShieldKeeper interface {
	GetGlobalShieldStakingPool(ctx sdk.Context) math.Int
	FundShieldBlockRewards(ctx sdk.Context, amount sdk.Coins, sender sdk.AccAddress) error
	GetShieldBlockRewardRatio(ctx sdk.Context) sdk.Dec
}

type StakingKeeper

type StakingKeeper interface {
	StakingTokenSupply(ctx sdk.Context) math.Int
	TotalBondedTokens(ctx sdk.Context) math.Int
	BondedRatio(ctx sdk.Context) sdk.Dec
	BondDenom(ctx sdk.Context) string
}

StakingKeeper defines the expected staking keeper.