266 lines
8.4 KiB
Go
266 lines
8.4 KiB
Go
package mint
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
|
|
gwruntime "github.com/grpc-ecosystem/grpc-gateway/runtime"
|
|
"github.com/spf13/cobra"
|
|
abci "github.com/tendermint/tendermint/abci/types"
|
|
|
|
modulev1 "cosmossdk.io/api/cosmos/mint/module/v1"
|
|
"cosmossdk.io/core/appmodule"
|
|
|
|
"cosmossdk.io/depinject"
|
|
"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/runtime"
|
|
store "github.com/cosmos/cosmos-sdk/store/types"
|
|
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"
|
|
govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
|
|
"github.com/cosmos/cosmos-sdk/x/mint/client/cli"
|
|
"github.com/cosmos/cosmos-sdk/x/mint/exported"
|
|
"github.com/cosmos/cosmos-sdk/x/mint/keeper"
|
|
"github.com/cosmos/cosmos-sdk/x/mint/simulation"
|
|
"github.com/cosmos/cosmos-sdk/x/mint/types"
|
|
)
|
|
|
|
// ConsensusVersion defines the current x/mint module consensus version.
|
|
const ConsensusVersion = 2
|
|
|
|
var (
|
|
_ module.BeginBlockAppModule = AppModule{}
|
|
_ module.AppModuleBasic = AppModuleBasic{}
|
|
_ module.AppModuleSimulation = AppModule{}
|
|
)
|
|
|
|
// AppModuleBasic defines the basic application module used by the mint module.
|
|
type AppModuleBasic struct {
|
|
cdc codec.Codec
|
|
}
|
|
|
|
var _ module.AppModuleBasic = AppModuleBasic{}
|
|
|
|
// Name returns the mint module's name.
|
|
func (AppModuleBasic) Name() string {
|
|
return types.ModuleName
|
|
}
|
|
|
|
// RegisterLegacyAminoCodec registers the mint module's types on the given LegacyAmino codec.
|
|
func (AppModuleBasic) RegisterLegacyAminoCodec(cdc *codec.LegacyAmino) {
|
|
types.RegisterLegacyAminoCodec(cdc)
|
|
}
|
|
|
|
// RegisterInterfaces registers the module's interface types
|
|
func (b AppModuleBasic) RegisterInterfaces(r cdctypes.InterfaceRegistry) {
|
|
types.RegisterInterfaces(r)
|
|
}
|
|
|
|
// DefaultGenesis returns default genesis state as raw bytes for the mint
|
|
// module.
|
|
func (AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage {
|
|
return cdc.MustMarshalJSON(types.DefaultGenesisState())
|
|
}
|
|
|
|
// ValidateGenesis performs genesis state validation for the mint module.
|
|
func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, config client.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 mint module.
|
|
func (AppModuleBasic) RegisterGRPCGatewayRoutes(clientCtx client.Context, mux *gwruntime.ServeMux) {
|
|
if err := types.RegisterQueryHandlerClient(context.Background(), mux, types.NewQueryClient(clientCtx)); err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
|
|
// GetTxCmd returns no root tx command for the mint module.
|
|
func (AppModuleBasic) GetTxCmd() *cobra.Command { return nil }
|
|
|
|
// GetQueryCmd returns the root query command for the mint module.
|
|
func (AppModuleBasic) GetQueryCmd() *cobra.Command {
|
|
return cli.GetQueryCmd()
|
|
}
|
|
|
|
// AppModule implements an application module for the mint module.
|
|
type AppModule struct {
|
|
AppModuleBasic
|
|
|
|
keeper keeper.Keeper
|
|
authKeeper types.AccountKeeper
|
|
|
|
// legacySubspace is used solely for migration of x/params managed parameters
|
|
legacySubspace exported.Subspace
|
|
|
|
// inflationCalculator is used to calculate the inflation rate during BeginBlock.
|
|
// If inflationCalculator is nil, the default inflation calculation logic is used.
|
|
inflationCalculator types.InflationCalculationFn
|
|
}
|
|
|
|
// NewAppModule creates a new AppModule object. If the InflationCalculationFn
|
|
// argument is nil, then the SDK's default inflation function will be used.
|
|
func NewAppModule(
|
|
cdc codec.Codec,
|
|
keeper keeper.Keeper,
|
|
ak types.AccountKeeper,
|
|
ic types.InflationCalculationFn,
|
|
ss exported.Subspace,
|
|
) AppModule {
|
|
if ic == nil {
|
|
ic = types.DefaultInflationCalculationFn
|
|
}
|
|
|
|
return AppModule{
|
|
AppModuleBasic: AppModuleBasic{cdc: cdc},
|
|
keeper: keeper,
|
|
authKeeper: ak,
|
|
inflationCalculator: ic,
|
|
legacySubspace: ss,
|
|
}
|
|
}
|
|
|
|
// Name returns the mint module's name.
|
|
func (AppModule) Name() string {
|
|
return types.ModuleName
|
|
}
|
|
|
|
// RegisterInvariants registers the mint module invariants.
|
|
func (am AppModule) RegisterInvariants(_ sdk.InvariantRegistry) {}
|
|
|
|
// RegisterServices registers a gRPC query service to respond to the
|
|
// module-specific gRPC queries.
|
|
func (am AppModule) RegisterServices(cfg module.Configurator) {
|
|
types.RegisterMsgServer(cfg.MsgServer(), keeper.NewMsgServerImpl(am.keeper))
|
|
types.RegisterQueryServer(cfg.QueryServer(), 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))
|
|
}
|
|
}
|
|
|
|
// InitGenesis performs genesis initialization for the mint module. It returns
|
|
// no validator updates.
|
|
func (am AppModule) InitGenesis(ctx sdk.Context, cdc codec.JSONCodec, data json.RawMessage) []abci.ValidatorUpdate {
|
|
var genesisState types.GenesisState
|
|
cdc.MustUnmarshalJSON(data, &genesisState)
|
|
|
|
am.keeper.InitGenesis(ctx, am.authKeeper, &genesisState)
|
|
return []abci.ValidatorUpdate{}
|
|
}
|
|
|
|
// ExportGenesis returns the exported genesis state as raw bytes for the mint
|
|
// 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 mint module.
|
|
func (am AppModule) BeginBlock(ctx sdk.Context, _ abci.RequestBeginBlock) {
|
|
BeginBlocker(ctx, am.keeper, am.inflationCalculator)
|
|
}
|
|
|
|
// AppModuleSimulation functions
|
|
|
|
// GenerateGenesisState creates a randomized GenState of the mint module.
|
|
func (AppModule) GenerateGenesisState(simState *module.SimulationState) {
|
|
simulation.RandomizedGenState(simState)
|
|
}
|
|
|
|
// ProposalContents doesn't return any content functions for governance proposals.
|
|
func (AppModule) ProposalContents(simState module.SimulationState) []simtypes.WeightedProposalContent {
|
|
return nil
|
|
}
|
|
|
|
// RegisterStoreDecoder registers a decoder for mint module's types.
|
|
func (am AppModule) RegisterStoreDecoder(sdr sdk.StoreDecoderRegistry) {
|
|
sdr[types.StoreKey] = simulation.NewDecodeStore(am.cdc)
|
|
}
|
|
|
|
// WeightedOperations doesn't return any mint module operation.
|
|
func (AppModule) WeightedOperations(_ module.SimulationState) []simtypes.WeightedOperation {
|
|
return nil
|
|
}
|
|
|
|
// ============================================================================
|
|
// New App Wiring Setup
|
|
// ============================================================================
|
|
|
|
func init() {
|
|
appmodule.Register(&modulev1.Module{},
|
|
appmodule.Provide(ProvideModuleBasic, ProvideModule),
|
|
)
|
|
}
|
|
|
|
func ProvideModuleBasic() runtime.AppModuleBasicWrapper {
|
|
return runtime.WrapAppModuleBasic(AppModuleBasic{})
|
|
}
|
|
|
|
type MintInputs struct {
|
|
depinject.In
|
|
|
|
ModuleKey depinject.OwnModuleKey
|
|
Config *modulev1.Module
|
|
Key *store.KVStoreKey
|
|
Cdc codec.Codec
|
|
Authority map[string]sdk.AccAddress `optional:"true"`
|
|
InflationCalculationFn types.InflationCalculationFn `optional:"true"`
|
|
|
|
// LegacySubspace is used solely for migration of x/params managed parameters
|
|
LegacySubspace exported.Subspace
|
|
|
|
AccountKeeper types.AccountKeeper
|
|
BankKeeper types.BankKeeper
|
|
StakingKeeper types.StakingKeeper
|
|
}
|
|
|
|
type MintOutputs struct {
|
|
depinject.Out
|
|
|
|
MintKeeper keeper.Keeper
|
|
Module runtime.AppModuleWrapper
|
|
}
|
|
|
|
func ProvideModule(in MintInputs) MintOutputs {
|
|
feeCollectorName := in.Config.FeeCollectorName
|
|
if feeCollectorName == "" {
|
|
feeCollectorName = authtypes.FeeCollectorName
|
|
}
|
|
|
|
authority, ok := in.Authority[depinject.ModuleKey(in.ModuleKey).Name()]
|
|
if !ok {
|
|
// default to governance authority if not provided
|
|
authority = authtypes.NewModuleAddress(govtypes.ModuleName)
|
|
}
|
|
|
|
k := keeper.NewKeeper(
|
|
in.Cdc,
|
|
in.Key,
|
|
in.StakingKeeper,
|
|
in.AccountKeeper,
|
|
in.BankKeeper,
|
|
feeCollectorName,
|
|
authority.String(),
|
|
)
|
|
|
|
// when no inflation calculation function is provided it will use the default types.DefaultInflationCalculationFn
|
|
m := NewAppModule(in.Cdc, k, in.AccountKeeper, in.InflationCalculationFn, in.LegacySubspace)
|
|
|
|
return MintOutputs{MintKeeper: k, Module: runtime.WrapAppModule(m)}
|
|
}
|