/
module.go
196 lines (161 loc) · 6.47 KB
/
module.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
// Package gov defines the gov module.
package gov
import (
"encoding/json"
"fmt"
"math/rand"
"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"
"github.com/cosmos/cosmos-sdk/x/gov/client"
govrest "github.com/cosmos/cosmos-sdk/x/gov/client/rest"
govSim "github.com/cosmos/cosmos-sdk/x/gov/simulation"
govTypes "github.com/cosmos/cosmos-sdk/x/gov/types"
sim "github.com/cosmos/cosmos-sdk/x/simulation"
"github.com/certikfoundation/shentu/x/gov/client/cli"
"github.com/certikfoundation/shentu/x/gov/client/rest"
"github.com/certikfoundation/shentu/x/gov/keeper"
"github.com/certikfoundation/shentu/x/gov/simulation"
"github.com/certikfoundation/shentu/x/gov/types"
)
var (
_ module.AppModule = AppModule{}
_ module.AppModuleBasic = AppModuleBasic{}
)
// AppModuleBasic is the app module basics object.
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 gov.AppModuleBasic{}.Name()
}
// RegisterCodec registers gov's necessary types and interfaces
func (AppModuleBasic) RegisterCodec(cdc *codec.Codec) {
gov.RegisterCodec(cdc)
}
// DefaultGenesis returns the default genesis state.
func (AppModuleBasic) DefaultGenesis() json.RawMessage {
return gov.ModuleCdc.MustMarshalJSON(types.DefaultGenesisState())
}
// ValidateGenesis validates the module genesis.
func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error {
var data types.GenesisState
if err := gov.ModuleCdc.UnmarshalJSON(bz, &data); err != nil {
return fmt.Errorf("failed to unmarshal %s genesis state: %w", ModuleName, err)
}
return types.ValidateGenesis(data)
}
// RegisterRESTRoutes registers REST routes for the module.
func (a AppModuleBasic) RegisterRESTRoutes(ctx context.CLIContext, rtr *mux.Router) {
proposalRESTHandlers := make([]govrest.ProposalRESTHandler, 0, len(a.proposalHandlers))
for _, proposalHandler := range a.proposalHandlers {
proposalRESTHandlers = append(proposalRESTHandlers, proposalHandler.RESTHandler(ctx))
}
rest.RegisterRoutes(ctx, rtr, proposalRESTHandlers)
}
// GetTxCmd gets the root tx command of this module.
func (a AppModuleBasic) GetTxCmd(cdc *codec.Codec) *cobra.Command {
proposalCLIHandlers := make([]*cobra.Command, 0, len(a.proposalHandlers))
for _, proposalHandler := range a.proposalHandlers {
proposalCLIHandlers = append(proposalCLIHandlers, proposalHandler.CLIHandler(cdc))
}
return cli.GetTxCmd(StoreKey, cdc, proposalCLIHandlers)
}
// GetQueryCmd gets the root query command of this module.
func (AppModuleBasic) GetQueryCmd(cdc *codec.Codec) *cobra.Command {
return cli.GetQueryCmd(StoreKey, cdc)
}
// AppModule is the main ctk module app type.
type AppModule struct {
AppModuleBasic
authKeeper govTypes.AccountKeeper
supplyKeeper govTypes.SupplyKeeper
keeper keeper.Keeper
}
// NewAppModule creates a new AppModule object.
func NewAppModule(
govKeeper keeper.Keeper,
authKeeper govTypes.AccountKeeper,
supplyKeeper govTypes.SupplyKeeper,
) AppModule {
return AppModule{
AppModuleBasic: AppModuleBasic{},
authKeeper: authKeeper,
supplyKeeper: supplyKeeper,
keeper: govKeeper,
}
}
// Name returns the governance module's name.
func (am AppModule) Name() string {
return ModuleName
}
// RegisterInvariants registers the governance module invariants.
func (am AppModule) RegisterInvariants(ir sdk.InvariantRegistry) {}
// Route returns the message routing key for the governance module.
func (am AppModule) Route() string {
return RouterKey
}
// NewHandler returns an sdk.Handler for the governance module.
func (am AppModule) NewHandler() sdk.Handler {
return NewHandler(am.keeper)
}
// QuerierRoute returns the governance module's querier route name.
func (am AppModule) QuerierRoute() string {
return QuerierRoute
}
// NewQuerierHandler returns the governance module sdk.Querier.
func (am AppModule) NewQuerierHandler() sdk.Querier {
return keeper.NewQuerier(am.keeper)
}
// InitGenesis performs genesis initialization for the governance module.
func (am AppModule) InitGenesis(ctx sdk.Context, data json.RawMessage) []abci.ValidatorUpdate {
var genesisState types.GenesisState
gov.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 governance module.
func (am AppModule) ExportGenesis(ctx sdk.Context) json.RawMessage {
gs := ExportGenesis(ctx, am.keeper)
return gov.ModuleCdc.MustMarshalJSON(gs)
}
// BeginBlock implements the Cosmos SDK BeginBlock module function.
func (am AppModule) BeginBlock(ctx sdk.Context, rbb abci.RequestBeginBlock) {}
// EndBlock implements the Cosmos SDK EndBlock module function.
func (am AppModule) EndBlock(ctx sdk.Context, rbb abci.RequestEndBlock) []abci.ValidatorUpdate {
EndBlocker(ctx, am.keeper)
return []abci.ValidatorUpdate{}
}
// GenerateGenesisState creates a randomized GenState of this module.
func (AppModuleBasic) GenerateGenesisState(simState *module.SimulationState) {
simulation.RandomizedGenState(simState)
}
// RegisterStoreDecoder registers a decoder for gov module.
func (AppModuleBasic) RegisterStoreDecoder(sdr sdk.StoreDecoderRegistry) {
sdr[StoreKey] = simulation.DecodeStore
}
// WeightedOperations returns the all the gov module operations with their respective weights.
func (am AppModule) WeightedOperations(simState module.SimulationState) []sim.WeightedOperation {
return simulation.WeightedOperations(simState.AppParams, simState.Cdc, am.authKeeper, am.keeper.CertKeeper, am.keeper, simState.Contents)
}
// RandomizedParams creates randomized gov param changes for the simulator.
func (AppModule) RandomizedParams(r *rand.Rand) []sim.ParamChange {
return simulation.ParamChanges(r)
}
// ProposalContents returns all the gov content functions used to
// simulate governance proposals.
func (AppModule) ProposalContents(_ module.SimulationState) []sim.WeightedProposalContent {
return govSim.ProposalContents()
}