gov

package
v1.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 6, 2021 License: Apache-2.0 Imports: 29 Imported by: 0

Documentation

Overview

Package gov defines the gov module.

Index

Constants

View Source 
const (
	ModuleName        = types.ModuleName
	StoreKey          = types.StoreKey
	RouterKey         = types.RouterKey
	QuerierRoute      = types.QuerierRoute
	DefaultParamspace = types.DefaultParamspace
)
View Source 
const (
	AttributeTxHash = types.AttributeTxHash
)

Variables

View Source 
var (
	// function aliases
	NewKeeper           = keeper.NewKeeper
	ProposalHandler     = types.ProposalHandler
	DefaultGenesisState = types.DefaultGenesisState
	ParamKeyTable       = types.ParamKeyTable
)

Functions

func EndBlocker 

func EndBlocker(ctx sdk.Context, k keeper.Keeper)

EndBlocker is called every block, removes inactive proposals, tallies active proposals and deletes/refunds deposits. TODO refactor into smaller functions

func ExportGenesis 

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

ExportGenesis writes the current store values to a genesis file, which can be imported again with InitGenesis.

func InitGenesis 

func InitGenesis(ctx sdk.Context, k keeper.Keeper, supplyKeeper govTypes.SupplyKeeper, data types.GenesisState)

InitGenesis stores genesis parameters.

func NewHandler 

func NewHandler(k keeper.Keeper) sdk.Handler

NewHandler handles all "gov" type messages.

Types

type AppModule 

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

AppModule is the main ctk module app type.

func NewAppModule 

func NewAppModule(
	govKeeper keeper.Keeper,
	authKeeper govTypes.AccountKeeper,
	supplyKeeper govTypes.SupplyKeeper,
) AppModule

NewAppModule creates a new AppModule object.

func (AppModule) BeginBlock 

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

BeginBlock implements the Cosmos SDK BeginBlock module function.

func (AppModule) EndBlock 

func (am AppModule) EndBlock(ctx sdk.Context, rbb abci.RequestEndBlock) []abci.ValidatorUpdate

EndBlock implements the Cosmos SDK EndBlock module function.

func (AppModule) ExportGenesis 

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

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

func (AppModule) InitGenesis 

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

InitGenesis performs genesis initialization for the governance module.

func (AppModule) Name 

func (am AppModule) Name() string

Name returns the governance module's name.

func (AppModule) NewHandler 

func (am AppModule) NewHandler() sdk.Handler

NewHandler returns an sdk.Handler for the governance module.

func (AppModule) NewQuerierHandler 

func (am AppModule) NewQuerierHandler() sdk.Querier

NewQuerierHandler returns the governance module sdk.Querier.

func (AppModule) ProposalContents 

func (AppModule) ProposalContents(_ module.SimulationState) []sim.WeightedProposalContent

ProposalContents returns all the gov content functions used to simulate governance proposals.

func (AppModule) QuerierRoute 

func (am AppModule) QuerierRoute() string

QuerierRoute returns the governance module's querier route name.

func (AppModule) RandomizedParams 

func (AppModule) RandomizedParams(r *rand.Rand) []sim.ParamChange

RandomizedParams creates randomized gov param changes for the simulator.

func (AppModule) RegisterInvariants 

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

RegisterInvariants registers the governance module invariants.

func (AppModule) Route 

func (am AppModule) Route() string

Route returns the message routing key for the governance module.

func (AppModule) WeightedOperations 

func (am AppModule) WeightedOperations(simState module.SimulationState) []sim.WeightedOperation

WeightedOperations returns the all the gov module operations with their respective weights.

type AppModuleBasic 

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

AppModuleBasic is the app module basics object.

func NewAppModuleBasic 

func NewAppModuleBasic(proposalHandlers ...client.ProposalHandler) AppModuleBasic

NewAppModuleBasic creates a new AppModuleBasic object.

func (AppModuleBasic) DefaultGenesis 

func (AppModuleBasic) DefaultGenesis() json.RawMessage

DefaultGenesis returns the default genesis state.

func (AppModuleBasic) GenerateGenesisState 

func (AppModuleBasic) GenerateGenesisState(simState *module.SimulationState)

GenerateGenesisState creates a randomized GenState of this module.

func (AppModuleBasic) GetQueryCmd 

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

GetQueryCmd gets the root query command of this module.

func (AppModuleBasic) GetTxCmd 

func (a AppModuleBasic) GetTxCmd(cdc *codec.Codec) *cobra.Command

GetTxCmd gets the root tx command of this module.

func (AppModuleBasic) Name 

func (AppModuleBasic) Name() string

Name returns the gov module's name.

func (AppModuleBasic) RegisterCodec 

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

RegisterCodec registers gov's necessary types and interfaces

func (AppModuleBasic) RegisterRESTRoutes 

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

RegisterRESTRoutes registers REST routes for the module.

func (AppModuleBasic) RegisterStoreDecoder 

func (AppModuleBasic) RegisterStoreDecoder(sdr sdk.StoreDecoderRegistry)

RegisterStoreDecoder registers a decoder for gov module.

func (AppModuleBasic) ValidateGenesis 

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

ValidateGenesis validates the module genesis.

type Keeper 

type Keeper = keeper.Keeper

Source Files

View all Source files

Directories

Path Synopsis
client
cli
rest
Package rest defines the RESTful service for the gov module.
 Package rest defines the RESTful service for the gov module.
utils
Package utils defines the utils for client services for the gov module.
 Package utils defines the utils for client services for the gov module.
Package keeper specifies the keeper for the gov module.
 Package keeper specifies the keeper for the gov module.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.