278 lines
9.6 KiB
Go
278 lines
9.6 KiB
Go
package distribution
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
|
|
gwruntime "github.com/grpc-ecosystem/grpc-gateway/runtime"
|
|
"github.com/spf13/cobra"
|
|
|
|
modulev1 "cosmossdk.io/api/cosmos/distribution/module/v1"
|
|
"cosmossdk.io/core/address"
|
|
"cosmossdk.io/core/appmodule"
|
|
"cosmossdk.io/core/store"
|
|
"cosmossdk.io/depinject"
|
|
|
|
sdkclient "github.com/cosmos/cosmos-sdk/client"
|
|
"github.com/cosmos/cosmos-sdk/codec"
|
|
cdctypes "github.com/cosmos/cosmos-sdk/codec/types"
|
|
"github.com/cosmos/cosmos-sdk/testutil/simsx"
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
"github.com/cosmos/cosmos-sdk/types/module"
|
|
simtypes "github.com/cosmos/cosmos-sdk/types/simulation"
|
|
authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
|
|
"github.com/cosmos/cosmos-sdk/x/distribution/client/cli"
|
|
"github.com/cosmos/cosmos-sdk/x/distribution/exported"
|
|
"github.com/cosmos/cosmos-sdk/x/distribution/keeper"
|
|
"github.com/cosmos/cosmos-sdk/x/distribution/simulation"
|
|
"github.com/cosmos/cosmos-sdk/x/distribution/types"
|
|
govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
|
|
staking "github.com/cosmos/cosmos-sdk/x/staking/types"
|
|
)
|
|
|
|
// ConsensusVersion defines the current x/distribution module consensus version.
|
|
const ConsensusVersion = 3
|
|
|
|
var (
|
|
_ module.AppModuleBasic = AppModule{}
|
|
_ module.AppModuleSimulation = AppModule{}
|
|
_ module.HasGenesis = AppModule{}
|
|
_ module.HasServices = AppModule{}
|
|
|
|
_ appmodule.AppModule = AppModule{}
|
|
_ appmodule.HasBeginBlocker = AppModule{}
|
|
)
|
|
|
|
// AppModuleBasic defines the basic application module used by the distribution module.
|
|
type AppModuleBasic struct {
|
|
cdc codec.Codec
|
|
ac address.Codec
|
|
}
|
|
|
|
// Name returns the distribution module's name.
|
|
func (AppModuleBasic) Name() string {
|
|
return types.ModuleName
|
|
}
|
|
|
|
// RegisterLegacyAminoCodec registers the distribution module's types for the given codec.
|
|
func (AppModuleBasic) RegisterLegacyAminoCodec(cdc *codec.LegacyAmino) {
|
|
types.RegisterLegacyAminoCodec(cdc)
|
|
}
|
|
|
|
// DefaultGenesis returns default genesis state as raw bytes for the distribution
|
|
// module.
|
|
func (AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage {
|
|
return cdc.MustMarshalJSON(types.DefaultGenesisState())
|
|
}
|
|
|
|
// ValidateGenesis performs genesis state validation for the distribution module.
|
|
func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, _ sdkclient.TxEncodingConfig, bz json.RawMessage) error {
|
|
var data types.GenesisState
|
|
if err := cdc.UnmarshalJSON(bz, &data); err != nil {
|
|
return fmt.Errorf("failed to unmarshal %s genesis state: %w", types.ModuleName, err)
|
|
}
|
|
|
|
return types.ValidateGenesis(&data)
|
|
}
|
|
|
|
// RegisterGRPCGatewayRoutes registers the gRPC Gateway routes for the distribution module.
|
|
func (AppModuleBasic) RegisterGRPCGatewayRoutes(clientCtx sdkclient.Context, mux *gwruntime.ServeMux) {
|
|
if err := types.RegisterQueryHandlerClient(context.Background(), mux, types.NewQueryClient(clientCtx)); err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
|
|
// GetTxCmd returns the root tx command for the distribution module.
|
|
func (ab AppModuleBasic) GetTxCmd() *cobra.Command {
|
|
return cli.NewTxCmd(ab.cdc.InterfaceRegistry().SigningContext().ValidatorAddressCodec(), ab.cdc.InterfaceRegistry().SigningContext().AddressCodec())
|
|
}
|
|
|
|
// RegisterInterfaces implements InterfaceModule
|
|
func (AppModuleBasic) RegisterInterfaces(registry cdctypes.InterfaceRegistry) {
|
|
types.RegisterInterfaces(registry)
|
|
}
|
|
|
|
// AppModule implements an application module for the distribution module.
|
|
type AppModule struct {
|
|
AppModuleBasic
|
|
|
|
keeper keeper.Keeper
|
|
accountKeeper types.AccountKeeper
|
|
bankKeeper types.BankKeeper
|
|
stakingKeeper types.StakingKeeper
|
|
|
|
// legacySubspace is used solely for migration of x/params managed parameters
|
|
legacySubspace exported.Subspace
|
|
}
|
|
|
|
// NewAppModule creates a new AppModule object
|
|
func NewAppModule(
|
|
cdc codec.Codec, keeper keeper.Keeper, accountKeeper types.AccountKeeper,
|
|
bankKeeper types.BankKeeper, stakingKeeper types.StakingKeeper, ss exported.Subspace,
|
|
) AppModule {
|
|
return AppModule{
|
|
AppModuleBasic: AppModuleBasic{cdc: cdc, ac: accountKeeper.AddressCodec()},
|
|
keeper: keeper,
|
|
accountKeeper: accountKeeper,
|
|
bankKeeper: bankKeeper,
|
|
stakingKeeper: stakingKeeper,
|
|
legacySubspace: ss,
|
|
}
|
|
}
|
|
|
|
// IsOnePerModuleType implements the depinject.OnePerModuleType interface.
|
|
func (am AppModule) IsOnePerModuleType() {}
|
|
|
|
// IsAppModule implements the appmodule.AppModule interface.
|
|
func (am AppModule) IsAppModule() {}
|
|
|
|
// RegisterServices registers module services.
|
|
func (am AppModule) RegisterServices(cfg module.Configurator) {
|
|
types.RegisterMsgServer(cfg.MsgServer(), keeper.NewMsgServerImpl(am.keeper))
|
|
types.RegisterQueryServer(cfg.QueryServer(), keeper.NewQuerier(am.keeper))
|
|
|
|
m := keeper.NewMigrator(am.keeper, am.legacySubspace)
|
|
if err := cfg.RegisterMigration(types.ModuleName, 1, m.Migrate1to2); err != nil {
|
|
panic(fmt.Sprintf("failed to migrate x/%s from version 1 to 2: %v", types.ModuleName, err))
|
|
}
|
|
|
|
if err := cfg.RegisterMigration(types.ModuleName, 2, m.Migrate2to3); err != nil {
|
|
panic(fmt.Sprintf("failed to migrate x/%s from version 2 to 3: %v", types.ModuleName, err))
|
|
}
|
|
}
|
|
|
|
// InitGenesis performs genesis initialization for the distribution module. It returns
|
|
// no validator updates.
|
|
func (am AppModule) InitGenesis(ctx sdk.Context, cdc codec.JSONCodec, data json.RawMessage) {
|
|
var genesisState types.GenesisState
|
|
cdc.MustUnmarshalJSON(data, &genesisState)
|
|
am.keeper.InitGenesis(ctx, genesisState)
|
|
}
|
|
|
|
// ExportGenesis returns the exported genesis state as raw bytes for the distribution
|
|
// module.
|
|
func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONCodec) json.RawMessage {
|
|
gs := am.keeper.ExportGenesis(ctx)
|
|
return cdc.MustMarshalJSON(gs)
|
|
}
|
|
|
|
// ConsensusVersion implements AppModule/ConsensusVersion.
|
|
func (AppModule) ConsensusVersion() uint64 { return ConsensusVersion }
|
|
|
|
// BeginBlock returns the begin blocker for the distribution module.
|
|
func (am AppModule) BeginBlock(ctx context.Context) error {
|
|
c := sdk.UnwrapSDKContext(ctx)
|
|
return BeginBlocker(c, am.keeper)
|
|
}
|
|
|
|
// AppModuleSimulation functions
|
|
|
|
// GenerateGenesisState creates a randomized GenState of the distribution module.
|
|
func (AppModule) GenerateGenesisState(simState *module.SimulationState) {
|
|
simulation.RandomizedGenState(simState)
|
|
}
|
|
|
|
// ProposalMsgs returns msgs used for governance proposals for simulations.
|
|
// migrate to ProposalMsgsX. This method is ignored when ProposalMsgsX exists and will be removed in the future.
|
|
func (AppModule) ProposalMsgs(_ module.SimulationState) []simtypes.WeightedProposalMsg {
|
|
return simulation.ProposalMsgs()
|
|
}
|
|
|
|
// RegisterStoreDecoder registers a decoder for distribution module's types
|
|
func (am AppModule) RegisterStoreDecoder(sdr simtypes.StoreDecoderRegistry) {
|
|
sdr[types.StoreKey] = simulation.NewDecodeStore(am.cdc)
|
|
}
|
|
|
|
// WeightedOperations returns the all the gov module operations with their respective weights.
|
|
// migrate to WeightedOperationsX. This method is ignored when WeightedOperationsX exists and will be removed in the future
|
|
func (am AppModule) WeightedOperations(simState module.SimulationState) []simtypes.WeightedOperation {
|
|
return simulation.WeightedOperations(
|
|
simState.AppParams, simState.Cdc, simState.TxConfig,
|
|
am.accountKeeper, am.bankKeeper, am.keeper, am.stakingKeeper,
|
|
)
|
|
}
|
|
|
|
// ProposalMsgsX registers governance proposal messages in the simulation registry.
|
|
func (AppModule) ProposalMsgsX(weights simsx.WeightSource, reg simsx.Registry) {
|
|
reg.Add(weights.Get("msg_update_params", 100), simulation.MsgUpdateParamsFactory())
|
|
}
|
|
|
|
// WeightedOperationsX registers weighted distribution module operations for simulation.
|
|
func (am AppModule) WeightedOperationsX(weights simsx.WeightSource, reg simsx.Registry) {
|
|
reg.Add(weights.Get("msg_set_withdraw_address", 50), simulation.MsgSetWithdrawAddressFactory(am.keeper))
|
|
reg.Add(weights.Get("msg_withdraw_delegation_reward", 50), simulation.MsgWithdrawDelegatorRewardFactory(am.keeper, am.stakingKeeper))
|
|
reg.Add(weights.Get("msg_withdraw_validator_commission", 50), simulation.MsgWithdrawValidatorCommissionFactory(am.keeper, am.stakingKeeper))
|
|
}
|
|
|
|
//
|
|
// App Wiring Setup
|
|
//
|
|
|
|
func init() {
|
|
appmodule.Register(&modulev1.Module{},
|
|
appmodule.Provide(ProvideModule),
|
|
)
|
|
}
|
|
|
|
type ModuleInputs struct {
|
|
depinject.In
|
|
|
|
Config *modulev1.Module
|
|
StoreService store.KVStoreService
|
|
Cdc codec.Codec
|
|
|
|
AccountKeeper types.AccountKeeper
|
|
BankKeeper types.BankKeeper
|
|
StakingKeeper types.StakingKeeper
|
|
ExternalPoolKeeper types.ExternalCommunityPoolKeeper `optional:"true"`
|
|
|
|
// LegacySubspace is used solely for migration of x/params managed parameters
|
|
LegacySubspace exported.Subspace `optional:"true"`
|
|
}
|
|
|
|
type ModuleOutputs struct {
|
|
depinject.Out
|
|
|
|
DistrKeeper keeper.Keeper
|
|
Module appmodule.AppModule
|
|
Hooks staking.StakingHooksWrapper
|
|
}
|
|
|
|
func ProvideModule(in ModuleInputs) ModuleOutputs {
|
|
feeCollectorName := in.Config.FeeCollectorName
|
|
if feeCollectorName == "" {
|
|
feeCollectorName = authtypes.FeeCollectorName
|
|
}
|
|
|
|
// default to governance authority if not provided
|
|
authority := authtypes.NewModuleAddress(govtypes.ModuleName)
|
|
if in.Config.Authority != "" {
|
|
authority = authtypes.NewModuleAddressOrBech32Address(in.Config.Authority)
|
|
}
|
|
|
|
var opts []keeper.InitOption
|
|
if in.ExternalPoolKeeper != nil {
|
|
opts = append(opts, keeper.WithExternalCommunityPool(in.ExternalPoolKeeper))
|
|
}
|
|
|
|
k := keeper.NewKeeper(
|
|
in.Cdc,
|
|
in.StoreService,
|
|
in.AccountKeeper,
|
|
in.BankKeeper,
|
|
in.StakingKeeper,
|
|
feeCollectorName,
|
|
authority.String(),
|
|
opts...,
|
|
)
|
|
|
|
m := NewAppModule(in.Cdc, k, in.AccountKeeper, in.BankKeeper, in.StakingKeeper, in.LegacySubspace)
|
|
|
|
return ModuleOutputs{
|
|
DistrKeeper: k,
|
|
Module: m,
|
|
Hooks: staking.StakingHooksWrapper{StakingHooks: k.Hooks()},
|
|
}
|
|
}
|