R4R: Parameter Change Proposal

cmd/gaia/app/app.go

@@ -95,7 +95,7 @@ func NewGaiaApp(logger log.Logger, db dbm.DB, traceStore io.Writer, loadLatest,
 		tkeyParams:       sdk.NewTransientStoreKey(params.TStoreKey),
 	}
 
-	app.paramsKeeper = params.NewKeeper(app.cdc, app.keyParams, app.tkeyParams)
+	app.paramsKeeper = params.NewKeeper(app.cdc, app.keyParams, app.tkeyParams, params.DefaultCodespace)
 
 	// define the accountKeeper
 	app.accountKeeper = auth.NewAccountKeeper(
@@ -138,7 +138,8 @@ func NewGaiaApp(logger log.Logger, db dbm.DB, traceStore io.Writer, loadLatest,
 		&stakingKeeper, app.paramsKeeper.Subspace(slashing.DefaultParamspace),
 		slashing.DefaultCodespace,
 	)
-	app.govKeeper = gov.NewKeeper(
+	var grouter gov.Router
+	app.govKeeper, grouter = gov.NewKeeper(
 		app.cdc,
 		app.keyGov,
 		app.paramsKeeper, app.paramsKeeper.Subspace(gov.DefaultParamspace), app.bankKeeper, &stakingKeeper,
@@ -180,6 +181,10 @@ func NewGaiaApp(logger log.Logger, db dbm.DB, traceStore io.Writer, loadLatest,
 		AddRoute(staking.QuerierRoute, staking.NewQuerier(app.stakingKeeper, app.cdc)).
 		AddRoute(mint.QuerierRoute, mint.NewQuerier(app.mintKeeper))
 
+	grouter.
+		AddRoute(gov.RouterKey, gov.ProposalHandler).
+		AddRoute(params.RouterKey, params.NewProposalHandler(app.paramsKeeper))
+
 	// initialize BaseApp
 	app.MountStores(app.keyMain, app.keyAccount, app.keyStaking, app.keyMint, app.keyDistr,
 		app.keySlashing, app.keyGov, app.keyFeeCollection, app.keyParams,

cmd/gaia/cmd/gaiadebug/hack.go

@@ -167,7 +167,7 @@ func NewGaiaApp(logger log.Logger, db dbm.DB, baseAppOptions ...func(*bam.BaseAp
 		tkeyParams:  sdk.NewTransientStoreKey(params.TStoreKey),
 	}
 
-	app.paramsKeeper = params.NewKeeper(app.cdc, app.keyParams, app.tkeyParams)
+	app.paramsKeeper = params.NewKeeper(app.cdc, app.keyParams, app.tkeyParams, params.DefaultCodespace)
 
 	// define the accountKeeper
 	app.accountKeeper = auth.NewAccountKeeper(

types/tags.go

@@ -69,7 +69,7 @@ func MakeTag(k string, v string) Tag {
 //__________________________________________________
 
 // common tags
-var (
+const (
 	TagAction       = "action"
 	TagCategory     = "category"
 	TagSender       = "sender"

x/auth/keeper.go

@@ -7,7 +7,7 @@ import (
 
 	codec "github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	"github.com/cosmos/cosmos-sdk/x/params"
+	"github.com/cosmos/cosmos-sdk/x/params/subspace"
 )
 
 const (
@@ -40,14 +40,14 @@ type AccountKeeper struct {
 	// The codec codec for binary encoding/decoding of accounts.
 	cdc *codec.Codec
 
-	paramSubspace params.Subspace
+	paramSubspace subspace.Subspace
 }
 
 // NewAccountKeeper returns a new sdk.AccountKeeper that uses go-amino to
 // (binary) encode and decode concrete sdk.Accounts.
 // nolint
 func NewAccountKeeper(
-	cdc *codec.Codec, key sdk.StoreKey, paramstore params.Subspace, proto func() Account,
+	cdc *codec.Codec, key sdk.StoreKey, paramstore subspace.Subspace, proto func() Account,
 ) AccountKeeper {
 
 	return AccountKeeper{

x/auth/params.go

@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/cosmos/cosmos-sdk/x/params"
+	"github.com/cosmos/cosmos-sdk/x/params/subspace"
 )
 
 // DefaultParamspace defines the default auth module parameter subspace
@@ -29,7 +29,7 @@ var (
 	KeySigVerifyCostSecp256k1 = []byte("SigVerifyCostSecp256k1")
 )
 
-var _ params.ParamSet = &Params{}
+var _ subspace.ParamSet = &Params{}
 
 // Params defines the parameters for the auth module.
 type Params struct {
@@ -41,15 +41,15 @@ type Params struct {
 }
 
 // ParamKeyTable for auth module
-func ParamKeyTable() params.KeyTable {
-	return params.NewKeyTable().RegisterParamSet(&Params{})
+func ParamKeyTable() subspace.KeyTable {
+	return subspace.NewKeyTable().RegisterParamSet(&Params{})
 }
 
 // ParamSetPairs implements the ParamSet interface and returns all the key/value pairs
 // pairs of auth module's parameters.
 // nolint
-func (p *Params) ParamSetPairs() params.ParamSetPairs {
-	return params.ParamSetPairs{
+func (p *Params) ParamSetPairs() subspace.ParamSetPairs {
+	return subspace.ParamSetPairs{
 		{KeyMaxMemoCharacters, &p.MaxMemoCharacters},
 		{KeyTxSigLimit, &p.TxSigLimit},
 		{KeyTxSizeCostPerByte, &p.TxSizeCostPerByte},

x/auth/test_utils.go

@@ -11,7 +11,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/codec"
 	"github.com/cosmos/cosmos-sdk/store"
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	"github.com/cosmos/cosmos-sdk/x/params"
+	subspace "github.com/cosmos/cosmos-sdk/x/params/subspace"
 )
 
 type testInput struct {
@@ -29,8 +29,8 @@ func setupTestInput() testInput {
 
 	authCapKey := sdk.NewKVStoreKey("authCapKey")
 	fckCapKey := sdk.NewKVStoreKey("fckCapKey")
-	keyParams := sdk.NewKVStoreKey("params")
-	tkeyParams := sdk.NewTransientStoreKey("transient_params")
+	keyParams := sdk.NewKVStoreKey("subspace")
+	tkeyParams := sdk.NewTransientStoreKey("transient_subspace")
 
 	ms := store.NewCommitMultiStore(db)
 	ms.MountStoreWithDB(authCapKey, sdk.StoreTypeIAVL, db)
@@ -39,8 +39,8 @@ func setupTestInput() testInput {
 	ms.MountStoreWithDB(tkeyParams, sdk.StoreTypeTransient, db)
 	ms.LoadLatestVersion()
 
-	pk := params.NewKeeper(cdc, keyParams, tkeyParams)
-	ak := NewAccountKeeper(cdc, authCapKey, pk.Subspace(DefaultParamspace), ProtoBaseAccount)
+	ps := subspace.NewSubspace(cdc, keyParams, tkeyParams, DefaultParamspace)
+	ak := NewAccountKeeper(cdc, authCapKey, ps, ProtoBaseAccount)
 	fck := NewFeeCollectionKeeper(cdc, fckCapKey)
 	ctx := sdk.NewContext(ms, abci.Header{ChainID: "test-chain-id"}, false, log.NewNopLogger())
 

x/bank/keeper_test.go

@@ -42,7 +42,7 @@ func setupTestInput() testInput {
 	ms.MountStoreWithDB(tkeyParams, sdk.StoreTypeTransient, db)
 	ms.LoadLatestVersion()
 
-	pk := params.NewKeeper(cdc, keyParams, tkeyParams)
+	pk := params.NewKeeper(cdc, keyParams, tkeyParams, params.DefaultCodespace)
 	ak := auth.NewAccountKeeper(
 		cdc, authCapKey, pk.Subspace(auth.DefaultParamspace), auth.ProtoBaseAccount,
 	)

x/distribution/keeper/test_common.go

@@ -111,7 +111,7 @@ func CreateTestInputAdvanced(t *testing.T, isCheckTx bool, initPower int64,
 	require.Nil(t, err)
 
 	cdc := MakeTestCodec()
-	pk := params.NewKeeper(cdc, keyParams, tkeyParams)
+	pk := params.NewKeeper(cdc, keyParams, tkeyParams, params.DefaultCodespace)
 
 	ctx := sdk.NewContext(ms, abci.Header{ChainID: "foochainid"}, isCheckTx, log.NewNopLogger())
 	accountKeeper := auth.NewAccountKeeper(cdc, keyAcc, pk.Subspace(auth.DefaultParamspace), auth.ProtoBaseAccount)

x/gov/client/cli/parse.go

@@ -19,6 +19,10 @@ func parseSubmitProposalFlags() (*proposal, error) {
 		proposal.Description = viper.GetString(flagDescription)
 		proposal.Type = govClientUtils.NormalizeProposalType(viper.GetString(flagProposalType))
 		proposal.Deposit = viper.GetString(flagDeposit)
+
+		if proposal.Type == "" {
+			return nil, fmt.Errorf("Invalid ProposalType %s was given", flagProposalType)
+		}
 		return proposal, nil
 	}
 

x/gov/client/cli/tx.go

@@ -88,12 +88,13 @@ $ gaiacli gov submit-proposal --title="Test Proposal" --description="My awesome
 				return err
 			}
 
-			proposalType, err := gov.ProposalTypeFromString(proposal.Type)
-			if err != nil {
-				return err
+			content := gov.ContentFromProposalType(proposal.Title, proposal.Description, proposal.Type)
+			if content == nil {
+				return fmt.Errorf("Invalid proposal type %s", proposal.Type)
 			}
 
-			msg := gov.NewMsgSubmitProposal(proposal.Title, proposal.Description, proposalType, from, amount)
+			msg := gov.NewMsgSubmitProposal(content, from, amount)
+
 			err = msg.ValidateBasic()
 			if err != nil {
 				return err

x/gov/client/rest/rest.go

@@ -88,14 +88,20 @@ func postProposalHandlerFn(cdc *codec.Codec, cliCtx context.CLIContext) http.Han
 			return
 		}
 
-		proposalType, err := gov.ProposalTypeFromString(govClientUtils.NormalizeProposalType(req.ProposalType))
-		if err != nil {
-			rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error())
+		proposalType := govClientUtils.NormalizeProposalType(req.ProposalType)
+		if proposalType == "" {
+			rest.WriteErrorResponse(w, http.StatusBadRequest, fmt.Sprintf("Invalid ProposalType %s", req.ProposalType))
 			return
 		}
 
 		// create the message
-		msg := gov.NewMsgSubmitProposal(req.Title, req.Description, proposalType, req.Proposer, req.InitialDeposit)
+
+		content := gov.ContentFromProposalType(req.Title, req.Description, proposalType)
+		if content == nil {
+			rest.WriteErrorResponse(w, http.StatusBadRequest, fmt.Sprintf("Invalid proposalType %s", proposalType))
+			return
+		}
+		msg := gov.NewMsgSubmitProposal(content, req.Proposer, req.InitialDeposit)
 		if err := msg.ValidateBasic(); err != nil {
 			rest.WriteErrorResponse(w, http.StatusBadRequest, err.Error())
 			return

x/gov/client/utils/utils.go

@@ -1,5 +1,7 @@
 package utils
 
+import "github.com/cosmos/cosmos-sdk/x/gov"
+
 // NormalizeVoteOption - normalize user specified vote option
 func NormalizeVoteOption(option string) string {
 	switch option {
@@ -19,11 +21,9 @@ func NormalizeVoteOption(option string) string {
 func NormalizeProposalType(proposalType string) string {
 	switch proposalType {
 	case "Text", "text":
-		return "Text"
-	case "ParameterChange", "parameter_change":
-		return "ParameterChange"
+		return gov.ProposalTypeText
 	case "SoftwareUpgrade", "software_upgrade":
-		return "SoftwareUpgrade"
+		return gov.ProposalTypeSoftwareUpgrade
 	}
 	return ""
 }

x/gov/codec.go

@@ -2,6 +2,7 @@ package gov
 
 import (
 	"github.com/cosmos/cosmos-sdk/codec"
+	"github.com/cosmos/cosmos-sdk/x/gov/proposal"
 )
 
 var msgCdc = codec.New()
@@ -12,7 +13,7 @@ func RegisterCodec(cdc *codec.Codec) {
 	cdc.RegisterConcrete(MsgDeposit{}, "cosmos-sdk/MsgDeposit", nil)
 	cdc.RegisterConcrete(MsgVote{}, "cosmos-sdk/MsgVote", nil)
 
-	cdc.RegisterInterface((*ProposalContent)(nil), nil)
+	proposal.RegisterCodec(cdc)
 	cdc.RegisterConcrete(TextProposal{}, "gov/TextProposal", nil)
 	cdc.RegisterConcrete(SoftwareUpgradeProposal{}, "gov/SoftwareUpgradeProposal", nil)
 }

x/gov/contents.go

@@ -0,0 +1,76 @@
+package gov
+
+import (
+	"fmt"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/x/gov/proposal"
+)
+
+//nolint
+const (
+	ProposalTypeText            string = "Text"
+	ProposalTypeSoftwareUpgrade string = "SoftwareUpgrade"
+)
+
+// Text Proposals
+type TextProposal struct {
+	Title       string `json:"title"`
+	Description string `json:"description"`
+}
+
+func NewTextProposal(title, description string) proposal.Content {
+	return TextProposal{title, description}
+}
+
+// Implements Proposal Interface
+var _ proposal.Content = TextProposal{}
+
+// nolint
+func (tp TextProposal) GetTitle() string       { return tp.Title }
+func (tp TextProposal) GetDescription() string { return tp.Description }
+func (tp TextProposal) ProposalRoute() string  { return RouterKey }
+func (tp TextProposal) ProposalType() string   { return ProposalTypeText }
+func (tp TextProposal) ValidateBasic() sdk.Error {
+	return proposal.ValidateAbstract(DefaultCodespace, tp)
+}
+func (tp TextProposal) String() string {
+	return fmt.Sprintf("TextProposal{%s, %s}", tp.Title, tp.Description)
+}
+
+// Software Upgrade Proposals
+// TODO: we have to add fields for SUP specific arguments e.g. commit hash, upgrade date, etc.
+type SoftwareUpgradeProposal struct {
+	Title       string `json:"title"`
+	Description string `json:"description"`
+}
+
+func NewSoftwareUpgradeProposal(title, description string) proposal.Content {
+	return SoftwareUpgradeProposal{title, description}
+}
+
+// Implements Proposal Interface
+var _ proposal.Content = SoftwareUpgradeProposal{}
+
+// nolint
+func (sup SoftwareUpgradeProposal) GetTitle() string       { return sup.Title }
+func (sup SoftwareUpgradeProposal) GetDescription() string { return sup.Description }
+func (sup SoftwareUpgradeProposal) ProposalRoute() string  { return RouterKey }
+func (sup SoftwareUpgradeProposal) ProposalType() string   { return ProposalTypeSoftwareUpgrade }
+func (sup SoftwareUpgradeProposal) ValidateBasic() sdk.Error {
+	return proposal.ValidateAbstract(DefaultCodespace, sup)
+}
+func (sup SoftwareUpgradeProposal) String() string {
+	return fmt.Sprintf("SoftwareUpgradeProposal{%s, %s}", sup.Title, sup.Description)
+}
+
+func ContentFromProposalType(title, desc, ty string) proposal.Content {
+	switch ty {
+	case ProposalTypeText:
+		return NewTextProposal(title, desc)
+	case ProposalTypeSoftwareUpgrade:
+		return NewSoftwareUpgradeProposal(title, desc)
+	default:
+		return nil
+	}
+}

x/gov/endblocker.go

@@ -53,13 +53,33 @@ func EndBlocker(ctx sdk.Context, keeper Keeper) sdk.Tags {
 		passes, tallyResults := tally(ctx, keeper, activeProposal)
 
 		var tagValue string
+		var logMsg string
 		if passes {
 			keeper.RefundDeposits(ctx, activeProposal.ProposalID)
 			activeProposal.Status = StatusPassed
-			tagValue = tags.ActionProposalPassed
+
+			handler := keeper.router.GetRoute(activeProposal.ProposalRoute())
+
+			cctx, writeCache := ctx.CacheContext()
+
+			// The handler is state mutating logic depending on the proposal content.
+			// The handler may mutate the state or not
+			// if handler fails no state mutation happened and the err msg is logged.
+			contentErr := handler(cctx, activeProposal.Content)
+			if contentErr == nil {
+				tagValue = tags.ActionProposalPassed
+				logMsg = "passed"
+
+				// writes state mutation to the underlying multistore
+				writeCache()
+			} else {
+				logMsg = fmt.Sprintf("passed, but failed on execution: %s", contentErr.ABCILog())
+				tagValue = tags.ActionProposalFailed
+			}
 		} else {
 			keeper.DeleteDeposits(ctx, activeProposal.ProposalID)
 			activeProposal.Status = StatusRejected
+			logMsg = "rejected"
 			tagValue = tags.ActionProposalRejected
 		}
 
@@ -69,8 +89,8 @@ func EndBlocker(ctx sdk.Context, keeper Keeper) sdk.Tags {
 
 		logger.Info(
 			fmt.Sprintf(
-				"proposal %d (%s) tallied; passed: %v",
-				activeProposal.ProposalID, activeProposal.GetTitle(), passes,
+				"proposal %d (%s) %s",
+				activeProposal.ProposalID, activeProposal.GetTitle(), logMsg,
 			),
 		)