supply

Documentation

Index

• Constants
• Variables
• func InitGenesis(ctx sdk.Context, keeper Keeper, ak types.AccountKeeper, data GenesisState)
• func ValidateGenesis(data GenesisState) error
• type AppModule
  • func NewAppModule(keeper Keeper, ak types.AccountKeeper) AppModule
  • func (am AppModule) BeginBlock(_ sdk.Context, _ abci.RequestBeginBlock)
  • func (AppModule) EndBlock(_ sdk.Context, _ abci.RequestEndBlock) []abci.ValidatorUpdate
  • func (am AppModule) ExportGenesis(ctx sdk.Context) json.RawMessage
  • func (am AppModule) InitGenesis(ctx sdk.Context, data json.RawMessage) []abci.ValidatorUpdate
  • func (AppModule) Name() string
  • func (am AppModule) NewHandler() sdk.Handler
  • func (am AppModule) NewQuerierHandler() sdk.Querier
  • func (AppModule) QuerierRoute() string
  • func (am AppModule) RegisterInvariants(ir sdk.InvariantRegistry)
  • func (AppModule) Route() string
• type AppModuleBasic
  • func (AppModuleBasic) DefaultGenesis() json.RawMessage
  • func (AppModuleBasic) GetQueryCmd(cdc *codec.Codec) *cobra.Command
  • func (AppModuleBasic) GetTxCmd(_ *codec.Codec) *cobra.Command
  • func (AppModuleBasic) Name() string
  • func (AppModuleBasic) RegisterCodec(cdc *codec.Codec)
  • func (AppModuleBasic) RegisterRESTRoutes(ctx context.CLIContext, rtr *mux.Router)
  • func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error
• type GenesisState
  • func ExportGenesis(ctx sdk.Context, keeper Keeper) GenesisState
• type Keeper
• type ModuleAccount
• type Supply
• type Vesting

Constants

const (
	ModuleName   = types.ModuleName
	StoreKey     = types.StoreKey
	RouterKey    = types.RouterKey
	QuerierRoute = types.QuerierRoute
	Minter       = types.Minter
	Burner       = types.Burner
	Staking      = types.Staking
)

Variables

var (
	// functions aliases
	RegisterInvariants    = keeper.RegisterInvariants
	AllInvariants         = keeper.AllInvariants
	TotalSupply           = keeper.TotalSupply
	NewKeeper             = keeper.NewKeeper
	NewQuerier            = keeper.NewQuerier
	SupplyKey             = keeper.SupplyKey
	NewModuleAddress      = types.NewModuleAddress
	NewEmptyModuleAccount = types.NewEmptyModuleAccount
	NewModuleAccount      = types.NewModuleAccount
	RegisterCodec         = types.RegisterCodec
	NewGenesisState       = types.NewGenesisState
	DefaultGenesisState   = types.DefaultGenesisState
	NewSupply             = types.NewSupply
	DefaultSupply         = types.DefaultSupply

	// variable aliases
	DefaultCodespace = keeper.DefaultCodespace
	ModuleCdc        = types.ModuleCdc
)

var (
	CalculateVestingAmount = types.CalculateVestingAmount
)

Functions

func InitGenesis

func InitGenesis(ctx sdk.Context, keeper Keeper, ak types.AccountKeeper, data GenesisState)

InitGenesis sets supply information for genesis.

CONTRACT: all types of accounts must have been already initialized/created

func ValidateGenesis

func ValidateGenesis(data GenesisState) error

ValidateGenesis performs basic validation of supply genesis data returning an error for any failed validation criteria.

Types

type AppModule

type AppModule struct {
	AppModuleBasic
	// contains filtered or unexported fields
}

AppModule implements an application module for the supply module.

func NewAppModule

func NewAppModule(keeper Keeper, ak types.AccountKeeper) AppModule

NewAppModule creates a new AppModule object

func (AppModule) BeginBlock

func (am AppModule) BeginBlock(_ sdk.Context, _ abci.RequestBeginBlock)

BeginBlock returns the begin blocker for the supply module.

func (AppModule) EndBlock

func (AppModule) EndBlock(_ sdk.Context, _ abci.RequestEndBlock) []abci.ValidatorUpdate

EndBlock returns the end blocker for the supply module. It returns no validator updates.

func (AppModule) ExportGenesis

func (am AppModule) ExportGenesis(ctx sdk.Context) json.RawMessage

ExportGenesis returns the exported genesis state as raw bytes for the supply module.

func (AppModule) InitGenesis

func (am AppModule) InitGenesis(ctx sdk.Context, data json.RawMessage) []abci.ValidatorUpdate

InitGenesis performs genesis initialization for the supply module. It returns no validator updates.

func (AppModule) Name

func (AppModule) Name() string

Name returns the supply module's name.

func (AppModule) NewHandler

func (am AppModule) NewHandler() sdk.Handler

NewHandler returns an sdk.Handler for the supply module.

func (AppModule) NewQuerierHandler

func (am AppModule) NewQuerierHandler() sdk.Querier

NewQuerierHandler returns the supply module sdk.Querier.

func (AppModule) QuerierRoute

func (AppModule) QuerierRoute() string

QuerierRoute returns the supply module's querier route name.

func (AppModule) RegisterInvariants

func (am AppModule) RegisterInvariants(ir sdk.InvariantRegistry)

RegisterInvariants registers the supply module invariants.

func (AppModule) Route

func (AppModule) Route() string

Route returns the message routing key for the supply module.

type AppModuleBasic

type AppModuleBasic struct{}

AppModuleBasic defines the basic application module used by the supply module.

func (AppModuleBasic) DefaultGenesis

func (AppModuleBasic) DefaultGenesis() json.RawMessage

DefaultGenesis returns default genesis state as raw bytes for the supply module.

func (AppModuleBasic) GetQueryCmd

func (AppModuleBasic) GetQueryCmd(cdc *codec.Codec) *cobra.Command

GetQueryCmd returns no root query command for the supply module.

func (AppModuleBasic) GetTxCmd

func (AppModuleBasic) GetTxCmd(_ *codec.Codec) *cobra.Command

GetTxCmd returns the root tx command for the supply module.

func (AppModuleBasic) Name

func (AppModuleBasic) Name() string

Name returns the supply module's name.

func (AppModuleBasic) RegisterCodec

func (AppModuleBasic) RegisterCodec(cdc *codec.Codec)

RegisterCodec registers the supply module's types for the given codec.

func (AppModuleBasic) RegisterRESTRoutes

func (AppModuleBasic) RegisterRESTRoutes(ctx context.CLIContext, rtr *mux.Router)

RegisterRESTRoutes registers the REST routes for the supply module.

func (AppModuleBasic) ValidateGenesis

func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error

ValidateGenesis performs genesis state validation for the supply module.

type GenesisState

type GenesisState = types.GenesisState

func ExportGenesis

func ExportGenesis(ctx sdk.Context, keeper Keeper) GenesisState

ExportGenesis returns a GenesisState for a given context and keeper.

type Keeper

type Keeper = keeper.Keeper

type ModuleAccount

type ModuleAccount = types.ModuleAccount

type Supply

type Supply = types.Supply

type Vesting

type Vesting = types.Vesting