feat!: (x/gov) store an index of proposals that are in voting period

proto/cosmos/gov/v1/gov.proto

@@ -58,6 +58,10 @@ message Proposal {
   string metadata = 10;
 }
 
+message ProposalMessages {
+  repeated google.protobuf.Any messages = 1;
+}
+
 // ProposalStatus enumerates the valid statuses of a proposal.
 enum ProposalStatus {
   // PROPOSAL_STATUS_UNSPECIFIED defines the default proposal status.

x/gov/abci.go

@@ -67,14 +67,14 @@ func EndBlocker(ctx sdk.Context, keeper *keeper.Keeper) {
 			// the handlers fails, no state mutation is written and the error
 			// message is logged.
 			cacheCtx, writeCache := ctx.CacheContext()
-			messages, err := proposal.GetMsgs()
-			if err == nil {
-				for idx, msg = range messages {
-					handler := keeper.Router().Handler(msg)
-					_, err = handler(cacheCtx, msg)
-					if err != nil {
-						break
-					}
+			messages := keeper.GetProposalMessages(ctx, proposal.GetId())
+
+			var err error
+			for idx, msg = range messages {
+				handler := keeper.Router().Handler(msg)
+				_, err = handler(cacheCtx, msg)
+				if err != nil {
+					break
 				}
 			}
 

x/gov/keeper/proposal.go

@@ -7,6 +7,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/client"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+	sdktx "github.com/cosmos/cosmos-sdk/types/tx"
 	"github.com/cosmos/cosmos-sdk/x/gov/types"
 	v1 "github.com/cosmos/cosmos-sdk/x/gov/types/v1"
 )
@@ -72,12 +73,13 @@ func (keeper Keeper) SubmitProposal(ctx sdk.Context, messages []sdk.Msg, metadat
 	submitTime := ctx.BlockHeader().Time
 	depositPeriod := keeper.GetParams(ctx).MaxDepositPeriod
 
-	proposal, err := v1.NewProposal(messages, proposalID, metadata, submitTime, submitTime.Add(*depositPeriod))
+	proposal, err := v1.NewProposal(proposalID, metadata, submitTime, submitTime.Add(*depositPeriod))
 	if err != nil {
 		return v1.Proposal{}, err
 	}
 
 	keeper.SetProposal(ctx, proposal)
+	keeper.SetProposalMessages(ctx, proposalID, messages)
 	keeper.InsertInactiveProposalQueue(ctx, proposalID, *proposal.DepositEndTime)
 	keeper.SetProposalID(ctx, proposalID+1)
 
@@ -125,6 +127,43 @@ func (keeper Keeper) SetProposal(ctx sdk.Context, proposal v1.Proposal) {
 	store.Set(types.ProposalKey(proposal.Id), bz)
 }
 
+func (keeper Keeper) SetProposalMessages(ctx sdk.Context, proposalID uint64, messages []sdk.Msg) {
+	msgs, err := sdktx.SetMsgs(messages)
+	if err != nil {
+		panic(err)
+	}
+
+	bz, err := keeper.cdc.Marshal(&v1.ProposalMessages{Messages: msgs})
+	if err != nil {
+		panic(err)
+	}
+
+	store := ctx.KVStore(keeper.storeKey)
+	store.Set(types.ProposalMessagesKey(proposalID), bz)
+}
+
+func (keeper Keeper) GetProposalMessages(ctx sdk.Context, proposalID uint64) []sdk.Msg {
+	store := ctx.KVStore(keeper.storeKey)
+
+	bz := store.Get(types.ProposalMessagesKey(proposalID))
+	if bz == nil {
+		return nil
+	}
+
+	var propMsgs v1.ProposalMessages
+	err := keeper.cdc.Unmarshal(bz, &propMsgs)
+	if err != nil {
+		panic(err)
+	}
+
+	msgs, err := sdktx.GetMsgs(propMsgs.Messages, "sdk.Msg")
+	if err != nil {
+		panic(err)
+	}
+
+	return msgs
+}
+
 // DeleteProposal deletes a proposal from store.
 // Panics if the proposal doesn't exist.
 func (keeper Keeper) DeleteProposal(ctx sdk.Context, proposalID uint64) {

x/gov/keeper/proposal_test.go

@@ -94,7 +94,7 @@ func (suite *KeeperTestSuite) TestGetProposalsFiltered() {
 
 	for _, s := range status {
 		for i := 0; i < 50; i++ {
-			p, err := v1.NewProposal(TestProposal, proposalID, "", time.Now(), time.Now())
+			p, err := v1.NewProposal(proposalID, "", time.Now(), time.Now())
 			suite.Require().NoError(err)
 
 			p.Status = s
@@ -107,6 +107,7 @@ func (suite *KeeperTestSuite) TestGetProposalsFiltered() {
 			}
 
 			suite.govKeeper.SetProposal(suite.ctx, p)
+			suite.govKeeper.SetProposalMessages(suite.ctx, proposalID, TestProposal)
 			proposalID++
 		}
 	}

x/gov/types/keys.go

@@ -41,6 +41,7 @@ var (
 	ActiveProposalQueuePrefix   = []byte{0x01}
 	InactiveProposalQueuePrefix = []byte{0x02}
 	ProposalIDKey               = []byte{0x03}
+	ProposalMessagesKeyPrefix   = []byte{0x04}
 
 	DepositsKeyPrefix = []byte{0x10}
 
@@ -69,6 +70,10 @@ func ProposalKey(proposalID uint64) []byte {
 	return append(ProposalsKeyPrefix, GetProposalIDBytes(proposalID)...)
 }
 
+func ProposalMessagesKey(proposalID uint64) []byte {
+	return append(ProposalMessagesKeyPrefix, GetProposalIDBytes(proposalID)...)
+}
+
 // ActiveProposalByTimeKey gets the active proposal queue key by endTime
 func ActiveProposalByTimeKey(endTime time.Time) []byte {
 	return append(ActiveProposalQueuePrefix, sdk.FormatTimeBytes(endTime)...)

x/gov/types/v1/proposal.go

@@ -23,17 +23,12 @@ const (
 )
 
 // NewProposal creates a new Proposal instance
-func NewProposal(messages []sdk.Msg, id uint64, metadata string, submitTime, depositEndTime time.Time) (Proposal, error) {
-	msgs, err := sdktx.SetMsgs(messages)
-	if err != nil {
-		return Proposal{}, err
-	}
-
+func NewProposal(id uint64, metadata string, submitTime, depositEndTime time.Time) (Proposal, error) {
 	tally := EmptyTallyResult()
 
 	p := Proposal{
-		Id:               id,
-		Messages:         msgs,
+		Id: id,
+		// Messages:         msgs, // TODO: Remove
 		Metadata:         metadata,
 		Status:           StatusDepositPeriod,
 		FinalTallyResult: &tally,
@@ -44,7 +39,8 @@ func NewProposal(messages []sdk.Msg, id uint64, metadata string, submitTime, dep
 	return p, nil
 }
 
-// GetMessages returns the proposal messages
+// Deprecated: GetMessages returns the proposal messages
+// Use keeper.GetProposalMessages to get a stored proposal's messages.
 func (p Proposal) GetMsgs() ([]sdk.Msg, error) {
 	return sdktx.GetMsgs(p.Messages, "sdk.MsgProposal")
 }