WIP: Refactor crisis using internal package

simapp/app.go

@@ -18,6 +18,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/auth/genaccounts"
 	"github.com/cosmos/cosmos-sdk/x/bank"
 	"github.com/cosmos/cosmos-sdk/x/crisis"
+	"github.com/cosmos/cosmos-sdk/x/crisis/internal/keeper"
 	distr "github.com/cosmos/cosmos-sdk/x/distribution"
 	distrclient "github.com/cosmos/cosmos-sdk/x/distribution/client"
 	"github.com/cosmos/cosmos-sdk/x/genutil"
@@ -95,7 +96,7 @@ type SimApp struct {
 	mintKeeper          mint.Keeper
 	distrKeeper         distr.Keeper
 	govKeeper           gov.Keeper
-	crisisKeeper        crisis.Keeper
+	crisisKeeper        keeper.Keeper
 	paramsKeeper        params.Keeper
 
 	// the module manager
@@ -152,7 +153,7 @@ func NewSimApp(logger log.Logger, db dbm.DB, traceStore io.Writer, loadLatest bo
 		app.feeCollectionKeeper, distr.DefaultCodespace)
 	app.slashingKeeper = slashing.NewKeeper(app.cdc, app.keySlashing, &stakingKeeper,
 		slashingSubspace, slashing.DefaultCodespace)
-	app.crisisKeeper = crisis.NewKeeper(crisisSubspace, invCheckPeriod, app.distrKeeper,
+	app.crisisKeeper = keeper.NewKeeper(crisisSubspace, invCheckPeriod, app.distrKeeper,
 		app.bankKeeper, app.feeCollectionKeeper)
 
 	// register the proposal types

x/crisis/abci_app.go → x/crisis/abci.go

@@ -4,11 +4,12 @@ import (
 	"github.com/tendermint/tendermint/libs/log"
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/x/crisis/internal/keeper"
 )
 
 // check all registered invariants
-func EndBlocker(ctx sdk.Context, k Keeper, logger log.Logger) {
-	if k.invCheckPeriod == 0 || ctx.BlockHeight()%int64(k.invCheckPeriod) != 0 {
+func EndBlocker(ctx sdk.Context, k keeper.Keeper, logger log.Logger) {
+	if k.InvCheckPeriod() == 0 || ctx.BlockHeight()%int64(k.InvCheckPeriod()) != 0 {
 		// skip running the invariant check
 		return
 	}

x/crisis/alias.go

@@ -5,7 +5,7 @@
 package crisis
 
 import (
-	"github.com/cosmos/cosmos-sdk/x/crisis/types"
+	"github.com/cosmos/cosmos-sdk/x/crisis/internal/types"
 )
 
 const (
@@ -24,7 +24,6 @@ var (
 	DefaultGenesisState   = types.DefaultGenesisState
 	NewMsgVerifyInvariant = types.NewMsgVerifyInvariant
 	ParamKeyTable         = types.ParamKeyTable
-	NewInvarRoute         = types.NewInvarRoute
 
 	// variable aliases
 	ModuleCdc                = types.ModuleCdc

x/crisis/client/cli/tx.go

@@ -10,7 +10,7 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/auth"
 	"github.com/cosmos/cosmos-sdk/x/auth/client/utils"
-	"github.com/cosmos/cosmos-sdk/x/crisis/types"
+	"github.com/cosmos/cosmos-sdk/x/crisis/internal/types"
 )
 
 // command to replace a delegator's withdrawal address

x/crisis/genesis.go

@@ -2,16 +2,17 @@ package crisis
 
 import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	"github.com/cosmos/cosmos-sdk/x/crisis/types"
+	"github.com/cosmos/cosmos-sdk/x/crisis/internal/keeper"
+	"github.com/cosmos/cosmos-sdk/x/crisis/internal/types"
 )
 
 // new crisis genesis
-func InitGenesis(ctx sdk.Context, keeper Keeper, data types.GenesisState) {
+func InitGenesis(ctx sdk.Context, keeper keeper.Keeper, data types.GenesisState) {
 	keeper.SetConstantFee(ctx, data.ConstantFee)
 }
 
 // ExportGenesis returns a GenesisState for a given context and keeper.
-func ExportGenesis(ctx sdk.Context, keeper Keeper) types.GenesisState {
+func ExportGenesis(ctx sdk.Context, keeper keeper.Keeper) types.GenesisState {
 	constantFee := keeper.GetConstantFee(ctx)
 	return types.NewGenesisState(constantFee)
 }

x/crisis/handler.go

@@ -4,14 +4,14 @@ import (
 	"fmt"
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	"github.com/cosmos/cosmos-sdk/x/crisis/tags"
-	"github.com/cosmos/cosmos-sdk/x/crisis/types"
+	"github.com/cosmos/cosmos-sdk/x/crisis/internal/keeper"
+	"github.com/cosmos/cosmos-sdk/x/crisis/internal/types"
 )
 
 // RouterKey
 const RouterKey = ModuleName
 
-func NewHandler(k Keeper) sdk.Handler {
+func NewHandler(k keeper.Keeper) sdk.Handler {
 	return func(ctx sdk.Context, msg sdk.Msg) sdk.Result {
 		switch msg := msg.(type) {
 		case types.MsgVerifyInvariant:
@@ -24,7 +24,7 @@ func NewHandler(k Keeper) sdk.Handler {
 	}
 }
 
-func handleMsgVerifyInvariant(ctx sdk.Context, msg types.MsgVerifyInvariant, k Keeper) sdk.Result {
+func handleMsgVerifyInvariant(ctx sdk.Context, msg types.MsgVerifyInvariant, k keeper.Keeper) sdk.Result {
 
 	// remove the constant fee
 	constantFee := sdk.NewCoins(k.GetConstantFee(ctx))
@@ -73,8 +73,8 @@ func handleMsgVerifyInvariant(ctx sdk.Context, msg types.MsgVerifyInvariant, k K
 	}
 
 	resTags := sdk.NewTags(
-		tags.Sender, msg.Sender.String(),
-		tags.Invariant, msg.InvariantRoute,
+		types.Sender, msg.Sender.String(),
+		types.Invariant, msg.InvariantRoute,
 	)
 	return sdk.Result{
 		Tags: resTags,

x/crisis/handler_test.go

@@ -1,4 +1,4 @@
-package crisis
+package crisis_test
 
 import (
 	"errors"
@@ -10,24 +10,27 @@ import (
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/x/auth"
+	"github.com/cosmos/cosmos-sdk/x/crisis"
+	"github.com/cosmos/cosmos-sdk/x/crisis/internal/keeper"
+	"github.com/cosmos/cosmos-sdk/x/crisis/internal/types"
 	distr "github.com/cosmos/cosmos-sdk/x/distribution"
 )
 
 var (
 	testModuleName        = "dummy"
-	dummyRouteWhichPasses = NewInvarRoute(testModuleName, "which-passes", func(_ sdk.Context) error { return nil })
-	dummyRouteWhichFails  = NewInvarRoute(testModuleName, "which-fails", func(_ sdk.Context) error { return errors.New("whoops") })
+	dummyRouteWhichPasses = types.NewInvarRoute(testModuleName, "which-passes", func(_ sdk.Context) error { return nil })
+	dummyRouteWhichFails  = types.NewInvarRoute(testModuleName, "which-fails", func(_ sdk.Context) error { return errors.New("whoops") })
 	addrs                 = distr.TestAddrs
 )
 
-func CreateTestInput(t *testing.T) (sdk.Context, Keeper, auth.AccountKeeper, distr.Keeper) {
+func CreateTestInput(t *testing.T) (sdk.Context, keeper.Keeper, auth.AccountKeeper, distr.Keeper) {
 
 	communityTax := sdk.NewDecWithPrec(2, 2)
 	ctx, accKeeper, bankKeeper, distrKeeper, _, feeCollectionKeeper, paramsKeeper :=
 		distr.CreateTestInputAdvanced(t, false, 10, communityTax)
 
-	paramSpace := paramsKeeper.Subspace(DefaultParamspace)
-	crisisKeeper := NewKeeper(paramSpace, 1, distrKeeper, bankKeeper, feeCollectionKeeper)
+	paramSpace := paramsKeeper.Subspace(crisis.DefaultParamspace)
+	crisisKeeper := keeper.NewKeeper(paramSpace, 1, distrKeeper, bankKeeper, feeCollectionKeeper)
 	constantFee := sdk.NewInt64Coin("stake", 10000000)
 	crisisKeeper.SetConstantFee(ctx, constantFee)
 
@@ -51,28 +54,31 @@ func TestHandleMsgVerifyInvariantWithNotEnoughSenderCoins(t *testing.T) {
 	excessCoins := sdk.NewCoin(coin.Denom, coin.Amount.AddRaw(1))
 	crisisKeeper.SetConstantFee(ctx, excessCoins)
 
-	msg := NewMsgVerifyInvariant(sender, testModuleName, dummyRouteWhichPasses.Route)
-	res := handleMsgVerifyInvariant(ctx, msg, crisisKeeper)
+	h := crisis.NewHandler(crisisKeeper)
+	msg := crisis.NewMsgVerifyInvariant(sender, testModuleName, dummyRouteWhichPasses.Route)
+	res := h(ctx, msg)
 	require.False(t, res.IsOK())
 }
 
 func TestHandleMsgVerifyInvariantWithBadInvariant(t *testing.T) {
 	ctx, crisisKeeper, _, _ := CreateTestInput(t)
 	sender := addrs[0]
 
-	msg := NewMsgVerifyInvariant(sender, testModuleName, "route-that-doesnt-exist")
-	res := handleMsgVerifyInvariant(ctx, msg, crisisKeeper)
+	msg := crisis.NewMsgVerifyInvariant(sender, testModuleName, "route-that-doesnt-exist")
+	h := crisis.NewHandler(crisisKeeper)
+	res := h(ctx, msg)
 	require.False(t, res.IsOK())
 }
 
 func TestHandleMsgVerifyInvariantWithInvariantBroken(t *testing.T) {
 	ctx, crisisKeeper, _, _ := CreateTestInput(t)
 	sender := addrs[0]
 
-	msg := NewMsgVerifyInvariant(sender, testModuleName, dummyRouteWhichFails.Route)
+	h := crisis.NewHandler(crisisKeeper)
+	msg := crisis.NewMsgVerifyInvariant(sender, testModuleName, dummyRouteWhichFails.Route)
 	var res sdk.Result
 	require.Panics(t, func() {
-		res = handleMsgVerifyInvariant(ctx, msg, crisisKeeper)
+		res = h(ctx, msg)
 	}, fmt.Sprintf("%v", res))
 }
 
@@ -85,25 +91,27 @@ func TestHandleMsgVerifyInvariantWithInvariantBrokenAndNotEnoughPoolCoins(t *tes
 	feePool.CommunityPool = sdk.DecCoins{}
 	distrKeeper.SetFeePool(ctx, feePool)
 
-	msg := NewMsgVerifyInvariant(sender, testModuleName, dummyRouteWhichFails.Route)
+	h := crisis.NewHandler(crisisKeeper)
+	msg := crisis.NewMsgVerifyInvariant(sender, testModuleName, dummyRouteWhichFails.Route)
 	var res sdk.Result
 	require.Panics(t, func() {
-		res = handleMsgVerifyInvariant(ctx, msg, crisisKeeper)
+		res = h(ctx, msg)
 	}, fmt.Sprintf("%v", res))
 }
 
 func TestHandleMsgVerifyInvariantWithInvariantNotBroken(t *testing.T) {
 	ctx, crisisKeeper, _, _ := CreateTestInput(t)
 	sender := addrs[0]
 
-	msg := NewMsgVerifyInvariant(sender, testModuleName, dummyRouteWhichPasses.Route)
-	res := handleMsgVerifyInvariant(ctx, msg, crisisKeeper)
+	h := crisis.NewHandler(crisisKeeper)
+	msg := crisis.NewMsgVerifyInvariant(sender, testModuleName, dummyRouteWhichPasses.Route)
+	res := h(ctx, msg)
 	require.True(t, res.IsOK())
 }
 
 func TestInvalidMsg(t *testing.T) {
-	k := Keeper{}
-	h := NewHandler(k)
+	k := keeper.Keeper{}
+	h := crisis.NewHandler(k)
 
 	res := h(sdk.Context{}, sdk.NewTestMsg())
 	require.False(t, res.IsOK())

x/crisis/keeper.go → x/crisis/internal/keeper/keeper.go

@@ -1,4 +1,4 @@
-package crisis
+package keeper
 
 import (
 	"fmt"
@@ -7,7 +7,7 @@ import (
 	"github.com/tendermint/tendermint/libs/log"
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	"github.com/cosmos/cosmos-sdk/x/crisis/types"
+	"github.com/cosmos/cosmos-sdk/x/crisis/internal/types"
 	"github.com/cosmos/cosmos-sdk/x/params"
 )
 
@@ -17,15 +17,15 @@ type Keeper struct {
 	paramSpace     params.Subspace
 	invCheckPeriod uint
 
-	distrKeeper         DistrKeeper
-	bankKeeper          BankKeeper
-	feeCollectionKeeper FeeCollectionKeeper
+	distrKeeper         types.DistrKeeper
+	bankKeeper          types.BankKeeper
+	feeCollectionKeeper types.FeeCollectionKeeper
 }
 
 // NewKeeper creates a new Keeper object
 func NewKeeper(paramSpace params.Subspace, invCheckPeriod uint,
-	distrKeeper DistrKeeper, bankKeeper BankKeeper,
-	feeCollectionKeeper FeeCollectionKeeper) Keeper {
+	distrKeeper types.DistrKeeper, bankKeeper types.BankKeeper,
+	feeCollectionKeeper types.FeeCollectionKeeper) Keeper {
 
 	return Keeper{
 		routes:              []types.InvarRoute{},
@@ -79,4 +79,6 @@ func (k Keeper) AssertInvariants(ctx sdk.Context, logger log.Logger) {
 	logger.With("module", "x/crisis").Info("asserted all invariants", "duration", diff, "height", ctx.BlockHeight())
 }
 
+func (k Keeper) InvCheckPeriod() uint { return k.invCheckPeriod }
+
 // DONTCOVER

x/crisis/params.go → x/crisis/internal/keeper/params.go

@@ -1,8 +1,8 @@
-package crisis
+package keeper
 
 import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	"github.com/cosmos/cosmos-sdk/x/crisis/types"
+	"github.com/cosmos/cosmos-sdk/x/crisis/internal/types"
 )
 
 // GetConstantFee get's the constant fee from the paramSpace

x/crisis/expected_keepers.go → x/crisis/internal/types/expected_keepers.go

@@ -1,4 +1,4 @@
-package crisis
+package types
 
 import (
 	sdk "github.com/cosmos/cosmos-sdk/types"

x/crisis/types/genesis.go → x/crisis/internal/types/genesis.go

@@ -1,6 +1,8 @@
 package types
 
 import (
+	"fmt"
+
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
@@ -22,3 +24,11 @@ func DefaultGenesisState() GenesisState {
 		ConstantFee: sdk.NewCoin(sdk.DefaultBondDenom, sdk.NewInt(1000)),
 	}
 }
+
+// ValidateGenesis validates crisis genesis data
+func ValidateGenesis(data GenesisState) error {
+	if !data.ConstantFee.IsPositive() {
+		return fmt.Errorf("constant fee must be positive: %s", data.ConstantFee)
+	}
+	return nil
+}

x/crisis/tags/tags.go → x/crisis/internal/types/tags.go

@@ -1,4 +1,4 @@
-package tags
+package types
 
 import (
 	sdk "github.com/cosmos/cosmos-sdk/types"

x/crisis/module.go

@@ -14,6 +14,7 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
 	"github.com/cosmos/cosmos-sdk/x/crisis/client/cli"
+	"github.com/cosmos/cosmos-sdk/x/crisis/internal/keeper"
 )
 
 var (
@@ -62,12 +63,12 @@ func (AppModuleBasic) GetQueryCmd(_ *codec.Codec) *cobra.Command { return nil }
 // app module for bank
 type AppModule struct {
 	AppModuleBasic
-	keeper Keeper
+	keeper keeper.Keeper
 	logger log.Logger
 }
 
 // NewAppModule creates a new AppModule object
-func NewAppModule(keeper Keeper, logger log.Logger) AppModule {
+func NewAppModule(keeper keeper.Keeper, logger log.Logger) AppModule {
 	return AppModule{
 		AppModuleBasic: AppModuleBasic{},
 		keeper:         keeper,