package gov import ( "context" "encoding/json" "fmt" gwruntime "github.com/grpc-ecosystem/grpc-gateway/runtime" "github.com/spf13/cobra" "google.golang.org/grpc" "cosmossdk.io/core/appmodule" "cosmossdk.io/core/codec" "cosmossdk.io/core/registry" govclient "cosmossdk.io/x/gov/client" "cosmossdk.io/x/gov/client/cli" "cosmossdk.io/x/gov/keeper" "cosmossdk.io/x/gov/simulation" govtypes "cosmossdk.io/x/gov/types" v1 "cosmossdk.io/x/gov/types/v1" "cosmossdk.io/x/gov/types/v1beta1" "github.com/cosmos/cosmos-sdk/client" "github.com/cosmos/cosmos-sdk/simsx" "github.com/cosmos/cosmos-sdk/types/module" simtypes "github.com/cosmos/cosmos-sdk/types/simulation" ) const ConsensusVersion = 6 var ( _ module.HasAminoCodec = AppModule{} _ module.HasGRPCGateway = AppModule{} _ module.AppModuleSimulation = AppModule{} _ appmodule.AppModule = AppModule{} _ appmodule.HasEndBlocker = AppModule{} _ appmodule.HasMigrations = AppModule{} _ appmodule.HasRegisterInterfaces = AppModule{} _ appmodule.HasGenesis = AppModule{} ) // AppModule implements an application module for the gov module. type AppModule struct { cdc codec.Codec legacyProposalHandlers []govclient.ProposalHandler keeper *keeper.Keeper accountKeeper govtypes.AccountKeeper bankKeeper govtypes.BankKeeper poolKeeper govtypes.PoolKeeper } // NewAppModule creates a new AppModule object func NewAppModule( cdc codec.Codec, keeper *keeper.Keeper, ak govtypes.AccountKeeper, bk govtypes.BankKeeper, pk govtypes.PoolKeeper, legacyProposalHandlers ...govclient.ProposalHandler, ) AppModule { return AppModule{ cdc: cdc, legacyProposalHandlers: legacyProposalHandlers, keeper: keeper, accountKeeper: ak, bankKeeper: bk, poolKeeper: pk, } } // IsAppModule implements the appmodule.AppModule interface. func (am AppModule) IsAppModule() {} // Name returns the gov module's name. // Deprecated: kept for legacy reasons. func (AppModule) Name() string { return govtypes.ModuleName } // RegisterLegacyAminoCodec registers the gov module's types for the given codec. func (AppModule) RegisterLegacyAminoCodec(registrar registry.AminoRegistrar) { v1beta1.RegisterLegacyAminoCodec(registrar) v1.RegisterLegacyAminoCodec(registrar) } // RegisterGRPCGatewayRoutes registers the gRPC Gateway routes for the gov module. func (AppModule) RegisterGRPCGatewayRoutes(clientCtx client.Context, mux *gwruntime.ServeMux) { if err := v1.RegisterQueryHandlerClient(context.Background(), mux, v1.NewQueryClient(clientCtx)); err != nil { panic(err) } if err := v1beta1.RegisterQueryHandlerClient(context.Background(), mux, v1beta1.NewQueryClient(clientCtx)); err != nil { panic(err) } } // GetTxCmd returns the root tx command for the gov module. func (am AppModule) GetTxCmd() *cobra.Command { legacyProposalCLIHandlers := getProposalCLIHandlers(am.legacyProposalHandlers) return cli.NewTxCmd(legacyProposalCLIHandlers) } func getProposalCLIHandlers(handlers []govclient.ProposalHandler) []*cobra.Command { proposalCLIHandlers := make([]*cobra.Command, 0, len(handlers)) for _, proposalHandler := range handlers { proposalCLIHandlers = append(proposalCLIHandlers, proposalHandler.CLIHandler()) } return proposalCLIHandlers } // RegisterInterfaces implements InterfaceModule.RegisterInterfaces func (AppModule) RegisterInterfaces(registrar registry.InterfaceRegistrar) { v1.RegisterInterfaces(registrar) v1beta1.RegisterInterfaces(registrar) } // RegisterServices registers module services. func (am AppModule) RegisterServices(registrar grpc.ServiceRegistrar) error { msgServer := keeper.NewMsgServerImpl(am.keeper) addr, err := am.accountKeeper.AddressCodec().BytesToString(am.accountKeeper.GetModuleAddress(govtypes.ModuleName)) if err != nil { return err } v1beta1.RegisterMsgServer(registrar, keeper.NewLegacyMsgServerImpl(addr, msgServer)) v1.RegisterMsgServer(registrar, msgServer) v1beta1.RegisterQueryServer(registrar, keeper.NewLegacyQueryServer(am.keeper)) v1.RegisterQueryServer(registrar, keeper.NewQueryServer(am.keeper)) return nil } // RegisterMigrations registers module migrations func (am AppModule) RegisterMigrations(mr appmodule.MigrationRegistrar) error { m := keeper.NewMigrator(am.keeper) if err := mr.Register(govtypes.ModuleName, 1, m.Migrate1to2); err != nil { return fmt.Errorf("failed to migrate x/gov from version 1 to 2: %w", err) } if err := mr.Register(govtypes.ModuleName, 2, m.Migrate2to3); err != nil { return fmt.Errorf("failed to migrate x/gov from version 2 to 3: %w", err) } if err := mr.Register(govtypes.ModuleName, 3, m.Migrate3to4); err != nil { return fmt.Errorf("failed to migrate x/gov from version 3 to 4: %w", err) } if err := mr.Register(govtypes.ModuleName, 4, m.Migrate4to5); err != nil { return fmt.Errorf("failed to migrate x/gov from version 4 to 5: %w", err) } if err := mr.Register(govtypes.ModuleName, 5, m.Migrate5to6); err != nil { return fmt.Errorf("failed to migrate x/gov from version 5 to 6: %w", err) } return nil } // DefaultGenesis returns default genesis state as raw bytes for the gov module. func (am AppModule) DefaultGenesis() json.RawMessage { data, err := am.cdc.MarshalJSON(v1.DefaultGenesisState()) if err != nil { panic(err) } return data } // ValidateGenesis performs genesis state validation for the gov module. func (am AppModule) ValidateGenesis(bz json.RawMessage) error { var data v1.GenesisState if err := am.cdc.UnmarshalJSON(bz, &data); err != nil { return fmt.Errorf("failed to unmarshal %s genesis state: %w", govtypes.ModuleName, err) } return v1.ValidateGenesis(am.accountKeeper.AddressCodec(), &data) } // InitGenesis performs genesis initialization for the gov module. func (am AppModule) InitGenesis(ctx context.Context, data json.RawMessage) error { var genesisState v1.GenesisState if err := am.cdc.UnmarshalJSON(data, &genesisState); err != nil { return err } return InitGenesis(ctx, am.accountKeeper, am.bankKeeper, am.keeper, &genesisState) } // ExportGenesis returns the exported genesis state as raw bytes for the gov module. func (am AppModule) ExportGenesis(ctx context.Context) (json.RawMessage, error) { gs, err := ExportGenesis(ctx, am.keeper) if err != nil { return nil, err } return am.cdc.MarshalJSON(gs) } // ConsensusVersion implements HasConsensusVersion func (AppModule) ConsensusVersion() uint64 { return ConsensusVersion } // EndBlock returns the end blocker for the gov module. func (am AppModule) EndBlock(ctx context.Context) error { return am.keeper.EndBlocker(ctx) } // AppModuleSimulation functions // GenerateGenesisState creates a randomized GenState of the gov module. func (AppModule) GenerateGenesisState(simState *module.SimulationState) { simulation.RandomizedGenState(simState) } // RegisterStoreDecoder registers a decoder for gov module's types func (am AppModule) RegisterStoreDecoder(sdr simtypes.StoreDecoderRegistry) { sdr[govtypes.StoreKey] = simtypes.NewStoreDecoderFuncFromCollectionsSchema(am.keeper.Schema) } // ProposalMsgsX returns msgs used for governance proposals for simulations. func (AppModule) ProposalMsgsX(weights simsx.WeightSource, reg simsx.Registry) { reg.Add(weights.Get("submit_text_proposal", 5), simulation.TextProposalFactory()) } func (am AppModule) WeightedOperationsX(weights simsx.WeightSource, reg simsx.Registry, proposalMsgIter simsx.WeightedProposalMsgIter, legacyProposals []simtypes.WeightedProposalContent, //nolint:staticcheck // used for legacy proposal types ) { // submit proposal for each payload message for weight, factory := range proposalMsgIter { // use a ratio so that we don't flood with gov ops reg.Add(weight/25, simulation.MsgSubmitProposalFactory(am.keeper, factory)) } for _, wContent := range legacyProposals { reg.Add(weights.Get(wContent.AppParamsKey(), uint32(wContent.DefaultWeight())), simulation.MsgSubmitLegacyProposalFactory(am.keeper, wContent.ContentSimulatorFn())) } state := simulation.NewSharedState() reg.Add(weights.Get("msg_deposit", 100), simulation.MsgDepositFactory(am.keeper, state)) reg.Add(weights.Get("msg_vote", 67), simulation.MsgVoteFactory(am.keeper, state)) reg.Add(weights.Get("msg_weighted_vote", 33), simulation.MsgWeightedVoteFactory(am.keeper, state)) reg.Add(weights.Get("cancel_proposal", 5), simulation.MsgCancelProposalFactory(am.keeper, state)) reg.Add(weights.Get("legacy_text_proposal", 5), simulation.MsgSubmitLegacyProposalFactory(am.keeper, simulation.SimulateLegacyTextProposalContent)) }