180 lines
5.4 KiB
Go
180 lines
5.4 KiB
Go
package gov
|
|
|
|
// DONTCOVER
|
|
|
|
import (
|
|
"encoding/json"
|
|
|
|
"github.com/gorilla/mux"
|
|
"github.com/spf13/cobra"
|
|
|
|
abci "github.com/tendermint/tendermint/abci/types"
|
|
|
|
"github.com/cosmos/cosmos-sdk/client/context"
|
|
"github.com/cosmos/cosmos-sdk/codec"
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
"github.com/cosmos/cosmos-sdk/types/module"
|
|
"github.com/cosmos/cosmos-sdk/x/gov/client"
|
|
"github.com/cosmos/cosmos-sdk/x/gov/client/cli"
|
|
"github.com/cosmos/cosmos-sdk/x/gov/client/rest"
|
|
"github.com/cosmos/cosmos-sdk/x/gov/simulation"
|
|
"github.com/cosmos/cosmos-sdk/x/gov/types"
|
|
)
|
|
|
|
var (
|
|
_ module.AppModule = AppModule{}
|
|
_ module.AppModuleBasic = AppModuleBasic{}
|
|
_ module.AppModuleSimulation = AppModuleSimulation{}
|
|
)
|
|
|
|
// AppModuleBasic defines the basic application module used by the gov module.
|
|
type AppModuleBasic struct {
|
|
proposalHandlers []client.ProposalHandler // proposal handlers which live in governance cli and rest
|
|
}
|
|
|
|
// NewAppModuleBasic creates a new AppModuleBasic object
|
|
func NewAppModuleBasic(proposalHandlers ...client.ProposalHandler) AppModuleBasic {
|
|
return AppModuleBasic{
|
|
proposalHandlers: proposalHandlers,
|
|
}
|
|
}
|
|
|
|
// Name returns the gov module's name.
|
|
func (AppModuleBasic) Name() string {
|
|
return types.ModuleName
|
|
}
|
|
|
|
// RegisterCodec registers the gov module's types for the given codec.
|
|
func (AppModuleBasic) RegisterCodec(cdc *codec.Codec) {
|
|
RegisterCodec(cdc)
|
|
}
|
|
|
|
// DefaultGenesis returns default genesis state as raw bytes for the gov
|
|
// module.
|
|
func (AppModuleBasic) DefaultGenesis() json.RawMessage {
|
|
return ModuleCdc.MustMarshalJSON(DefaultGenesisState())
|
|
}
|
|
|
|
// ValidateGenesis performs genesis state validation for the gov module.
|
|
func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error {
|
|
var data GenesisState
|
|
err := ModuleCdc.UnmarshalJSON(bz, &data)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return ValidateGenesis(data)
|
|
}
|
|
|
|
// RegisterRESTRoutes registers the REST routes for the gov module.
|
|
func (a AppModuleBasic) RegisterRESTRoutes(ctx context.CLIContext, rtr *mux.Router) {
|
|
var proposalRESTHandlers []rest.ProposalRESTHandler
|
|
for _, proposalHandler := range a.proposalHandlers {
|
|
proposalRESTHandlers = append(proposalRESTHandlers, proposalHandler.RESTHandler(ctx))
|
|
}
|
|
|
|
rest.RegisterRoutes(ctx, rtr, proposalRESTHandlers)
|
|
}
|
|
|
|
// GetTxCmd returns the root tx command for the gov module.
|
|
func (a AppModuleBasic) GetTxCmd(cdc *codec.Codec) *cobra.Command {
|
|
|
|
var proposalCLIHandlers []*cobra.Command
|
|
for _, proposalHandler := range a.proposalHandlers {
|
|
proposalCLIHandlers = append(proposalCLIHandlers, proposalHandler.CLIHandler(cdc))
|
|
}
|
|
|
|
return cli.GetTxCmd(StoreKey, cdc, proposalCLIHandlers)
|
|
}
|
|
|
|
// GetQueryCmd returns the root query command for the gov module.
|
|
func (AppModuleBasic) GetQueryCmd(cdc *codec.Codec) *cobra.Command {
|
|
return cli.GetQueryCmd(StoreKey, cdc)
|
|
}
|
|
|
|
//____________________________________________________________________________
|
|
|
|
// AppModuleSimulation defines the module simulation functions used by the gov module.
|
|
type AppModuleSimulation struct{}
|
|
|
|
// RegisterStoreDecoder performs a no-op.
|
|
func (AppModuleSimulation) RegisterStoreDecoder(sdr sdk.StoreDecoderRegistry) {
|
|
sdr[StoreKey] = simulation.DecodeStore
|
|
}
|
|
|
|
//____________________________________________________________________________
|
|
|
|
// AppModule implements an application module for the gov module.
|
|
type AppModule struct {
|
|
AppModuleBasic
|
|
AppModuleSimulation
|
|
|
|
keeper Keeper
|
|
supplyKeeper types.SupplyKeeper
|
|
}
|
|
|
|
// NewAppModule creates a new AppModule object
|
|
func NewAppModule(keeper Keeper, supplyKeeper types.SupplyKeeper) AppModule {
|
|
return AppModule{
|
|
AppModuleBasic: AppModuleBasic{},
|
|
AppModuleSimulation: AppModuleSimulation{},
|
|
keeper: keeper,
|
|
supplyKeeper: supplyKeeper,
|
|
}
|
|
}
|
|
|
|
// Name returns the gov module's name.
|
|
func (AppModule) Name() string {
|
|
return ModuleName
|
|
}
|
|
|
|
// RegisterInvariants registers module invariants
|
|
func (am AppModule) RegisterInvariants(ir sdk.InvariantRegistry) {
|
|
RegisterInvariants(ir, am.keeper)
|
|
}
|
|
|
|
// Route returns the message routing key for the gov module.
|
|
func (AppModule) Route() string {
|
|
return RouterKey
|
|
}
|
|
|
|
// NewHandler returns an sdk.Handler for the gov module.
|
|
func (am AppModule) NewHandler() sdk.Handler {
|
|
return NewHandler(am.keeper)
|
|
}
|
|
|
|
// QuerierRoute returns the gov module's querier route name.
|
|
func (AppModule) QuerierRoute() string {
|
|
return QuerierRoute
|
|
}
|
|
|
|
// NewQuerierHandler returns no sdk.Querier.
|
|
func (am AppModule) NewQuerierHandler() sdk.Querier {
|
|
return NewQuerier(am.keeper)
|
|
}
|
|
|
|
// InitGenesis performs genesis initialization for the gov module. It returns
|
|
// no validator updates.
|
|
func (am AppModule) InitGenesis(ctx sdk.Context, data json.RawMessage) []abci.ValidatorUpdate {
|
|
var genesisState GenesisState
|
|
ModuleCdc.MustUnmarshalJSON(data, &genesisState)
|
|
InitGenesis(ctx, am.keeper, am.supplyKeeper, genesisState)
|
|
return []abci.ValidatorUpdate{}
|
|
}
|
|
|
|
// ExportGenesis returns the exported genesis state as raw bytes for the gov
|
|
// module.
|
|
func (am AppModule) ExportGenesis(ctx sdk.Context) json.RawMessage {
|
|
gs := ExportGenesis(ctx, am.keeper)
|
|
return ModuleCdc.MustMarshalJSON(gs)
|
|
}
|
|
|
|
// BeginBlock performs a no-op.
|
|
func (AppModule) BeginBlock(_ sdk.Context, _ abci.RequestBeginBlock) {}
|
|
|
|
// EndBlock returns the end blocker for the gov module. It returns no validator
|
|
// updates.
|
|
func (am AppModule) EndBlock(ctx sdk.Context, _ abci.RequestEndBlock) []abci.ValidatorUpdate {
|
|
EndBlocker(ctx, am.keeper)
|
|
return []abci.ValidatorUpdate{}
|
|
}
|