update x/gov to match module spec

.pending/improvements/modules/_4665-update-gov

@@ -0,0 +1 @@
+#4665 update `x/gov` to match module spec

simapp/app.go

@@ -157,7 +157,7 @@ func NewSimApp(
 	govRouter.AddRoute(gov.RouterKey, gov.ProposalHandler).
 		AddRoute(params.RouterKey, params.NewParamChangeProposalHandler(app.paramsKeeper)).
 		AddRoute(distr.RouterKey, distr.NewCommunityPoolSpendProposalHandler(app.distrKeeper))
-	app.govKeeper = gov.NewKeeper(app.cdc, keys[gov.StoreKey], app.paramsKeeper, govSubspace,
+	app.govKeeper = gov.NewKeeper(app.cdc, keys[gov.StoreKey], govSubspace,
 		app.supplyKeeper, &stakingKeeper, gov.DefaultCodespace, govRouter)
 
 	// register the staking hooks

x/distribution/keeper/test_common.go

@@ -121,10 +121,10 @@ func CreateTestInputAdvanced(t *testing.T, isCheckTx bool, initPower int64,
 	bondPool := supply.NewEmptyModuleAccount(staking.BondedPoolName, supply.Burner, supply.Staking)
 
 	blacklistedAddrs := make(map[string]bool)
-	blacklistedAddrs[feeCollectorAcc.String()] = true
-	blacklistedAddrs[notBondedPool.String()] = true
-	blacklistedAddrs[bondPool.String()] = true
-	blacklistedAddrs[distrAcc.String()] = true
+	blacklistedAddrs[feeCollectorAcc.GetAddress().String()] = true
+	blacklistedAddrs[notBondedPool.GetAddress().String()] = true
+	blacklistedAddrs[bondPool.GetAddress().String()] = true
+	blacklistedAddrs[distrAcc.GetAddress().String()] = true
 
 	cdc := MakeTestCodec()
 	pk := params.NewKeeper(cdc, keyParams, tkeyParams, params.DefaultCodespace)

x/gov/endblocker.go → x/gov/abci.go

@@ -39,7 +39,7 @@ func EndBlocker(ctx sdk.Context, keeper Keeper) {
 	keeper.IterateActiveProposalsQueue(ctx, ctx.BlockHeader().Time, func(proposal Proposal) bool {
 		var tagValue, logMsg string
 
-		passes, burnDeposits, tallyResults := tally(ctx, keeper, proposal)
+		passes, burnDeposits, tallyResults := keeper.Tally(ctx, proposal)
 
 		if burnDeposits {
 			keeper.DeleteDeposits(ctx, proposal.ProposalID)
@@ -48,7 +48,7 @@ func EndBlocker(ctx sdk.Context, keeper Keeper) {
 		}
 
 		if passes {
-			handler := keeper.router.GetRoute(proposal.ProposalRoute())
+			handler := keeper.Router().GetRoute(proposal.ProposalRoute())
 			cacheCtx, writeCache := ctx.CacheContext()
 
 			// The proposal handler may execute state mutating logic depending

x/gov/endblocker_test.go → x/gov/abci_test.go

@@ -1,6 +1,7 @@
 package gov
 
 import (
+	"encoding/binary"
 	"testing"
 	"time"
 
@@ -9,11 +10,12 @@ import (
 	abci "github.com/tendermint/tendermint/abci/types"
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	keep "github.com/cosmos/cosmos-sdk/x/gov/keeper"
 	"github.com/cosmos/cosmos-sdk/x/staking"
 )
 
 func TestTickExpiredDepositPeriod(t *testing.T) {
-	input := getMockApp(t, 10, GenesisState{}, nil)
+	input := getMockApp(t, 10, GenesisState{}, nil, ProposalHandler)
 
 	header := abci.Header{Height: input.mApp.LastBlockHeight() + 1}
 	input.mApp.BeginBlock(abci.RequestBeginBlock{Header: header})
@@ -62,7 +64,7 @@ func TestTickExpiredDepositPeriod(t *testing.T) {
 }
 
 func TestTickMultipleExpiredDepositPeriod(t *testing.T) {
-	input := getMockApp(t, 10, GenesisState{}, nil)
+	input := getMockApp(t, 10, GenesisState{}, nil, ProposalHandler)
 
 	header := abci.Header{Height: input.mApp.LastBlockHeight() + 1}
 	input.mApp.BeginBlock(abci.RequestBeginBlock{Header: header})
@@ -130,7 +132,7 @@ func TestTickMultipleExpiredDepositPeriod(t *testing.T) {
 }
 
 func TestTickPassedDepositPeriod(t *testing.T) {
-	input := getMockApp(t, 10, GenesisState{}, nil)
+	input := getMockApp(t, 10, GenesisState{}, nil, ProposalHandler)
 
 	header := abci.Header{Height: input.mApp.LastBlockHeight() + 1}
 	input.mApp.BeginBlock(abci.RequestBeginBlock{Header: header})
@@ -153,8 +155,7 @@ func TestTickPassedDepositPeriod(t *testing.T) {
 
 	res := govHandler(ctx, newProposalMsg)
 	require.True(t, res.IsOK())
-	var proposalID uint64
-	input.keeper.cdc.MustUnmarshalBinaryLengthPrefixed(res.Data, &proposalID)
+	proposalID := binary.LittleEndian.Uint64(res.Data)
 
 	inactiveQueue = input.keeper.InactiveProposalQueueIterator(ctx, ctx.BlockHeader().Time)
 	require.False(t, inactiveQueue.Valid())
@@ -178,7 +179,7 @@ func TestTickPassedDepositPeriod(t *testing.T) {
 }
 
 func TestTickPassedVotingPeriod(t *testing.T) {
-	input := getMockApp(t, 10, GenesisState{}, nil)
+	input := getMockApp(t, 10, GenesisState{}, nil, ProposalHandler)
 	SortAddresses(input.addrs)
 
 	header := abci.Header{Height: input.mApp.LastBlockHeight() + 1}
@@ -195,12 +196,11 @@ func TestTickPassedVotingPeriod(t *testing.T) {
 	activeQueue.Close()
 
 	proposalCoins := sdk.Coins{sdk.NewCoin(sdk.DefaultBondDenom, sdk.TokensFromConsensusPower(5))}
-	newProposalMsg := NewMsgSubmitProposal(testProposal(), proposalCoins, input.addrs[0])
+	newProposalMsg := NewMsgSubmitProposal(keep.TestProposal, proposalCoins, input.addrs[0])
 
 	res := govHandler(ctx, newProposalMsg)
 	require.True(t, res.IsOK())
-	var proposalID uint64
-	input.keeper.cdc.MustUnmarshalBinaryLengthPrefixed(res.Data, &proposalID)
+	proposalID := binary.LittleEndian.Uint64(res.Data)
 
 	newHeader := ctx.BlockHeader()
 	newHeader.Time = ctx.BlockHeader().Time.Add(time.Duration(1) * time.Second)
@@ -223,13 +223,11 @@ func TestTickPassedVotingPeriod(t *testing.T) {
 
 	var activeProposalID uint64
 
-	require.NoError(t, input.keeper.cdc.UnmarshalBinaryLengthPrefixed(activeQueue.Value(), &activeProposalID))
+	require.NoError(t, input.mApp.Cdc.UnmarshalBinaryLengthPrefixed(activeQueue.Value(), &activeProposalID))
 	proposal, ok := input.keeper.GetProposal(ctx, activeProposalID)
 	require.True(t, ok)
 	require.Equal(t, StatusVotingPeriod, proposal.Status)
-	depositsIterator := input.keeper.GetDepositsIterator(ctx, proposalID)
-	require.True(t, depositsIterator.Valid())
-	depositsIterator.Close()
+
 	activeQueue.Close()
 
 	EndBlocker(ctx, input.keeper)
@@ -240,7 +238,7 @@ func TestTickPassedVotingPeriod(t *testing.T) {
 }
 
 func TestProposalPassedEndblocker(t *testing.T) {
-	input := getMockApp(t, 1, GenesisState{}, nil)
+	input := getMockApp(t, 1, GenesisState{}, nil, ProposalHandler)
 	SortAddresses(input.addrs)
 
 	handler := NewHandler(input.keeper)
@@ -259,7 +257,7 @@ func TestProposalPassedEndblocker(t *testing.T) {
 	require.NotNil(t, macc)
 	initialModuleAccCoins := macc.GetCoins()
 
-	proposal, err := input.keeper.SubmitProposal(ctx, testProposal())
+	proposal, err := input.keeper.SubmitProposal(ctx, keep.TestProposal)
 	require.NoError(t, err)
 
 	proposalCoins := sdk.Coins{sdk.NewCoin(sdk.DefaultBondDenom, sdk.TokensFromConsensusPower(10))}
@@ -289,11 +287,9 @@ func TestProposalPassedEndblocker(t *testing.T) {
 }
 
 func TestEndBlockerProposalHandlerFailed(t *testing.T) {
-	input := getMockApp(t, 1, GenesisState{}, nil)
-	SortAddresses(input.addrs)
-
 	// hijack the router to one that will fail in a proposal's handler
-	input.keeper.router = NewRouter().AddRoute(RouterKey, badProposalHandler)
+	input := getMockApp(t, 1, GenesisState{}, nil, badProposalHandler)
+	SortAddresses(input.addrs)
 
 	handler := NewHandler(input.keeper)
 	stakingHandler := staking.NewHandler(input.sk)
@@ -310,7 +306,7 @@ func TestEndBlockerProposalHandlerFailed(t *testing.T) {
 	// Create a proposal where the handler will pass for the test proposal
 	// because the value of contextKeyBadProposal is true.
 	ctx = ctx.WithValue(contextKeyBadProposal, true)
-	proposal, err := input.keeper.SubmitProposal(ctx, testProposal())
+	proposal, err := input.keeper.SubmitProposal(ctx, keep.TestProposal)
 	require.NoError(t, err)
 
 	proposalCoins := sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, sdk.TokensFromConsensusPower(10)))

x/gov/alias.go

@@ -1,10 +1,12 @@
 // nolint
 // autogenerated code using github.com/rigelrozanski/multitool
 // aliases generated for the following subdirectories:
+// ALIASGEN: github.com/cosmos/cosmos-sdk/x/gov/keeper
 // ALIASGEN: github.com/cosmos/cosmos-sdk/x/gov/types
 package gov
 
 import (
+	"github.com/cosmos/cosmos-sdk/x/gov/keeper"
 	"github.com/cosmos/cosmos-sdk/x/gov/types"
 )
 
@@ -23,6 +25,7 @@ const (
 	CodeInvalidGenesis           = types.CodeInvalidGenesis
 	CodeInvalidProposalStatus    = types.CodeInvalidProposalStatus
 	CodeProposalHandlerNotExists = types.CodeProposalHandlerNotExists
+	DefaultPeriod                = types.DefaultPeriod
 	ModuleName                   = types.ModuleName
 	StoreKey                     = types.StoreKey
 	RouterKey                    = types.RouterKey
@@ -59,20 +62,26 @@ const (
 
 var (
 	// functions aliases
+	RegisterInvariants            = keeper.RegisterInvariants
+	AllInvariants                 = keeper.AllInvariants
+	ModuleAccountInvariant        = keeper.ModuleAccountInvariant
+	NewKeeper                     = keeper.NewKeeper
+	NewQuerier                    = keeper.NewQuerier
 	RegisterCodec                 = types.RegisterCodec
 	RegisterProposalTypeCodec     = types.RegisterProposalTypeCodec
 	ValidateAbstract              = types.ValidateAbstract
 	NewDeposit                    = types.NewDeposit
 	ErrUnknownProposal            = types.ErrUnknownProposal
 	ErrInactiveProposal           = types.ErrInactiveProposal
 	ErrAlreadyActiveProposal      = types.ErrAlreadyActiveProposal
-	ErrAlreadyFinishedProposal    = types.ErrAlreadyFinishedProposal
-	ErrAddressNotStaked           = types.ErrAddressNotStaked
 	ErrInvalidProposalContent     = types.ErrInvalidProposalContent
 	ErrInvalidProposalType        = types.ErrInvalidProposalType
 	ErrInvalidVote                = types.ErrInvalidVote
 	ErrInvalidGenesis             = types.ErrInvalidGenesis
 	ErrNoProposalHandlerExists    = types.ErrNoProposalHandlerExists
+	NewGenesisState               = types.NewGenesisState
+	DefaultGenesisState           = types.DefaultGenesisState
+	ValidateGenesis               = types.ValidateGenesis
 	ProposalKey                   = types.ProposalKey
 	ActiveProposalByTimeKey       = types.ActiveProposalByTimeKey
 	ActiveProposalQueueKey        = types.ActiveProposalQueueKey
@@ -96,11 +105,9 @@ var (
 	NewVotingParams               = types.NewVotingParams
 	NewParams                     = types.NewParams
 	NewProposal                   = types.NewProposal
+	NewRouter                     = types.NewRouter
 	ProposalStatusFromString      = types.ProposalStatusFromString
 	ValidProposalStatus           = types.ValidProposalStatus
-	NewTallyResult                = types.NewTallyResult
-	NewTallyResultFromMap         = types.NewTallyResultFromMap
-	EmptyTallyResult              = types.EmptyTallyResult
 	NewTextProposal               = types.NewTextProposal
 	NewSoftwareUpgradeProposal    = types.NewSoftwareUpgradeProposal
 	RegisterProposalType          = types.RegisterProposalType
@@ -111,6 +118,10 @@ var (
 	NewQueryDepositParams         = types.NewQueryDepositParams
 	NewQueryVoteParams            = types.NewQueryVoteParams
 	NewQueryProposalsParams       = types.NewQueryProposalsParams
+	NewValidatorGovInfo           = types.NewValidatorGovInfo
+	NewTallyResult                = types.NewTallyResult
+	NewTallyResultFromMap         = types.NewTallyResultFromMap
+	EmptyTallyResult              = types.EmptyTallyResult
 	NewVote                       = types.NewVote
 	VoteOptionFromString          = types.VoteOptionFromString
 	ValidVoteOption               = types.ValidVoteOption
@@ -129,10 +140,12 @@ var (
 )
 
 type (
+	Keeper                  = keeper.Keeper
 	Content                 = types.Content
 	Handler                 = types.Handler
 	Deposit                 = types.Deposit
 	Deposits                = types.Deposits
+	GenesisState            = types.GenesisState
 	MsgSubmitProposal       = types.MsgSubmitProposal
 	MsgDeposit              = types.MsgDeposit
 	MsgVote                 = types.MsgVote
@@ -144,13 +157,14 @@ type (
 	Proposals               = types.Proposals
 	ProposalQueue           = types.ProposalQueue
 	ProposalStatus          = types.ProposalStatus
-	TallyResult             = types.TallyResult
 	TextProposal            = types.TextProposal
 	SoftwareUpgradeProposal = types.SoftwareUpgradeProposal
 	QueryProposalParams     = types.QueryProposalParams
 	QueryDepositParams      = types.QueryDepositParams
 	QueryVoteParams         = types.QueryVoteParams
 	QueryProposalsParams    = types.QueryProposalsParams
+	ValidatorGovInfo        = types.ValidatorGovInfo
+	TallyResult             = types.TallyResult
 	Vote                    = types.Vote
 	Votes                   = types.Votes
 	VoteOption              = types.VoteOption