package upgrade import ( "encoding/json" "github.com/gogo/protobuf/grpc" "github.com/gorilla/mux" "github.com/spf13/cobra" abci "github.com/tendermint/tendermint/abci/types" "github.com/cosmos/cosmos-sdk/client" "github.com/cosmos/cosmos-sdk/client/flags" "github.com/cosmos/cosmos-sdk/codec" codectypes "github.com/cosmos/cosmos-sdk/codec/types" sdk "github.com/cosmos/cosmos-sdk/types" "github.com/cosmos/cosmos-sdk/types/module" "github.com/cosmos/cosmos-sdk/x/upgrade/client/cli" "github.com/cosmos/cosmos-sdk/x/upgrade/client/rest" "github.com/cosmos/cosmos-sdk/x/upgrade/keeper" "github.com/cosmos/cosmos-sdk/x/upgrade/types" ) // module codec var moduleCdc = codec.New() func init() { types.RegisterCodec(moduleCdc) } var ( _ module.AppModule = AppModule{} _ module.AppModuleBasic = AppModuleBasic{} _ module.InterfaceModule = AppModuleBasic{} ) // AppModuleBasic implements the sdk.AppModuleBasic interface type AppModuleBasic struct{} // Name returns the ModuleName func (AppModuleBasic) Name() string { return types.ModuleName } // RegisterCodec registers the upgrade types on the amino codec func (AppModuleBasic) RegisterCodec(cdc *codec.Codec) { types.RegisterCodec(cdc) } // RegisterRESTRoutes registers all REST query handlers func (AppModuleBasic) RegisterRESTRoutes(clientCtx client.Context, r *mux.Router) { rest.RegisterRoutes(clientCtx, r) } // GetQueryCmd returns the cli query commands for this module func (AppModuleBasic) GetQueryCmd(clientCtx client.Context) *cobra.Command { queryCmd := &cobra.Command{ Use: "upgrade", Short: "Querying commands for the upgrade module", } queryCmd.AddCommand(flags.GetCommands( cli.GetPlanCmd(types.StoreKey, clientCtx.Codec), cli.GetAppliedHeightCmd(types.StoreKey, clientCtx.Codec), )...) return queryCmd } // GetTxCmd returns the transaction commands for this module func (AppModuleBasic) GetTxCmd(_ client.Context) *cobra.Command { txCmd := &cobra.Command{ Use: "upgrade", Short: "Upgrade transaction subcommands", } txCmd.AddCommand(flags.PostCommands()...) return txCmd } func (b AppModuleBasic) RegisterInterfaceTypes(registry codectypes.InterfaceRegistry) { types.RegisterInterfaces(registry) } // AppModule implements the sdk.AppModule interface type AppModule struct { AppModuleBasic keeper keeper.Keeper } // NewAppModule creates a new AppModule object func NewAppModule(keeper keeper.Keeper) AppModule { return AppModule{ AppModuleBasic: AppModuleBasic{}, keeper: keeper, } } // RegisterInvariants does nothing, there are no invariants to enforce func (AppModule) RegisterInvariants(_ sdk.InvariantRegistry) {} // Route is empty, as we do not handle Messages (just proposals) func (AppModule) Route() sdk.Route { return sdk.Route{} } // QuerierRoute returns the route we respond to for abci queries func (AppModule) QuerierRoute() string { return types.QuerierKey } // NewQuerierHandler registers a query handler to respond to the module-specific queries func (am AppModule) NewQuerierHandler() sdk.Querier { return keeper.NewQuerier(am.keeper) } func (am AppModule) RegisterQueryService(grpc.Server) {} // InitGenesis is ignored, no sense in serializing future upgrades func (am AppModule) InitGenesis(_ sdk.Context, _ codec.JSONMarshaler, _ json.RawMessage) []abci.ValidatorUpdate { return []abci.ValidatorUpdate{} } // DefaultGenesis is an empty object func (AppModuleBasic) DefaultGenesis(_ codec.JSONMarshaler) json.RawMessage { return []byte("{}") } // ValidateGenesis is always successful, as we ignore the value func (AppModuleBasic) ValidateGenesis(_ codec.JSONMarshaler, _ json.RawMessage) error { return nil } // ExportGenesis is always empty, as InitGenesis does nothing either func (am AppModule) ExportGenesis(_ sdk.Context, cdc codec.JSONMarshaler) json.RawMessage { return am.DefaultGenesis(cdc) } // BeginBlock calls the upgrade module hooks // // CONTRACT: this is registered in BeginBlocker *before* all other modules' BeginBlock functions func (am AppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock) { BeginBlocker(am.keeper, ctx, req) } // EndBlock does nothing func (am AppModule) EndBlock(ctx sdk.Context, _ abci.RequestEndBlock) []abci.ValidatorUpdate { return []abci.ValidatorUpdate{} }