feat(gov,group): improve metadata checks and add docs

proto/cosmos/gov/v1/gov.proto

@@ -80,6 +80,7 @@ message Proposal {
   google.protobuf.Timestamp voting_end_time = 9 [(gogoproto.stdtime) = true];
 
   // metadata is any arbitrary metadata attached to the proposal.
+  // the recommended format of the metadata is to be found here: https://docs.cosmos.network/v0.47/modules/gov#proposal-3
   string metadata = 10;
 
   // title is the title of the proposal
@@ -150,7 +151,8 @@ message Vote {
   // options is the weighted vote options.
   repeated WeightedVoteOption options = 4;
 
-  // metadata is any  arbitrary metadata to attached to the vote.
+  // metadata is any arbitrary metadata to attached to the vote.
+  // the recommended format of the metadata is to be found here: https://docs.cosmos.network/v0.47/modules/gov#vote-5
   string metadata = 5;
 }
 

proto/cosmos/group/v1/types.proto

@@ -131,6 +131,7 @@ message GroupInfo {
   string admin = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"];
 
   // metadata is any arbitrary metadata to attached to the group.
+  // the recommended format of the metadata is to be found here: https://docs.cosmos.network/v0.47/modules/group#group-1
   string metadata = 3;
 
   // version is used to track changes to a group's membership structure that
@@ -171,6 +172,7 @@ message GroupPolicyInfo {
   string admin = 3 [(cosmos_proto.scalar) = "cosmos.AddressString"];
 
   // metadata is any arbitrary metadata attached to the group policy.
+  // the recommended format of the metadata is to be found here: https://docs.cosmos.network/v0.47/modules/group#decision-policy-1
   string metadata = 4;
 
   // version is used to track changes to a group's GroupPolicyInfo structure that
@@ -199,6 +201,7 @@ message Proposal {
   string group_policy_address = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"];
 
   // metadata is any arbitrary metadata attached to the proposal.
+  // the recommended format of the metadata is to be found here: https://docs.cosmos.network/v0.47/modules/group#proposal-4
   string metadata = 3;
 
   // proposers are the account addresses of the proposers.
@@ -313,7 +316,7 @@ message TallyResult {
   string no_with_veto_count = 4;
 }
 
-// Vote represents a vote for a proposal.
+// Vote represents a vote for a proposal.string metadata
 message Vote {
   // proposal is the unique ID of the proposal.
   uint64 proposal_id = 1;
@@ -325,6 +328,7 @@ message Vote {
   VoteOption option = 3;
 
   // metadata is any arbitrary metadata attached to the vote.
+  // the recommended format of the metadata is to be found here: https://docs.cosmos.network/v0.47/modules/group#vote-2
   string metadata = 4;
 
   // submit_time is the timestamp when the vote was submitted.

x/gov/keeper/msg_server.go

@@ -2,6 +2,7 @@ package keeper
 
 import (
 	"context"
+	"encoding/json"
 	"fmt"
 	"strconv"
 
@@ -47,11 +48,28 @@ func (k msgServer) SubmitProposal(goCtx context.Context, msg *v1.MsgSubmitPropos
 		return nil, err
 	}
 
-	// Check that either metadata or Msgs length is non nil.
+	// check that either metadata or Msgs length is non nil.
 	if len(msg.Messages) == 0 && len(msg.Metadata) == 0 {
 		return nil, errors.Wrap(govtypes.ErrNoProposalMsgs, "either metadata or Msgs length must be non-nil")
 	}
 
+	// verify that if present, the metadata title and summary equals the proposal title and summary
+	if len(msg.Metadata) != 0 {
+		proposalMetadata := govtypes.ProposalMetadata{}
+		if err := json.Unmarshal([]byte(msg.Metadata), &proposalMetadata); err == nil {
+			if proposalMetadata.Title != msg.Title {
+				return nil, errors.Wrapf(govtypes.ErrInvalidProposalContent, "metadata title '%s' must equal proposal title '%s'", proposalMetadata.Title, msg.Title)
+			}
+
+			if proposalMetadata.Summary != msg.Summary {
+				return nil, errors.Wrapf(govtypes.ErrInvalidProposalContent, "metadata summary '%s' must equal proposal summary '%s'", proposalMetadata.Summary, msg.Summary)
+			}
+		}
+
+		// if we can't unmarshal the metadata, this means the client didn't use the recommended metadata format
+		// nothing can be done here, and this is still a valid case, so we ignore the error
+	}
+
 	proposalMsgs, err := msg.GetMsgs()
 	if err != nil {
 		return nil, err

x/gov/keeper/msg_server_test.go

@@ -109,6 +109,36 @@ func (suite *KeeperTestSuite) TestSubmitProposalReq() {
 			expErr:    true,
 			expErrMsg: "proposal summary cannot be empty",
 		},
+		"title != metadata.title": {
+			preRun: func() (*v1.MsgSubmitProposal, error) {
+				return v1.NewMsgSubmitProposal(
+					[]sdk.Msg{bankMsg},
+					initialDeposit,
+					proposer.String(),
+					"{\"title\":\"Proposal\", \"description\":\"description of proposal\"}",
+					"Proposal2",
+					"description of proposal",
+					false,
+				)
+			},
+			expErr:    true,
+			expErrMsg: "metadata title 'Proposal' must equal proposal title 'Proposal2",
+		},
+		"summary != metadata.summary": {
+			preRun: func() (*v1.MsgSubmitProposal, error) {
+				return v1.NewMsgSubmitProposal(
+					[]sdk.Msg{bankMsg},
+					initialDeposit,
+					proposer.String(),
+					"{\"title\":\"Proposal\", \"description\":\"description of proposal\"}",
+					"Proposal",
+					"description",
+					false,
+				)
+			},
+			expErr:    true,
+			expErrMsg: "metadata summary '' must equal proposal summary 'description'",
+		},
 		"metadata too long": {
 			preRun: func() (*v1.MsgSubmitProposal, error) {
 				return v1.NewMsgSubmitProposal(

x/group/keeper/msg_server.go

@@ -4,6 +4,7 @@ import (
 	"bytes"
 	"context"
 	"encoding/binary"
+	"encoding/json"
 	"fmt"
 	"strings"
 
@@ -16,6 +17,8 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/group/errors"
 	"github.com/cosmos/cosmos-sdk/x/group/internal/math"
 	"github.com/cosmos/cosmos-sdk/x/group/internal/orm"
+
+	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
 )
 
 var _ group.MsgServer = Keeper{}
@@ -527,6 +530,23 @@ func (k Keeper) SubmitProposal(goCtx context.Context, msg *group.MsgSubmitPropos
 		return nil, err
 	}
 
+	// verify that if present, the metadata title and summary equals the proposal title and summary
+	if len(msg.Metadata) != 0 {
+		proposalMetadata := govtypes.ProposalMetadata{}
+		if err := json.Unmarshal([]byte(msg.Metadata), &proposalMetadata); err == nil {
+			if proposalMetadata.Title != msg.Title {
+				return nil, fmt.Errorf("metadata title '%s' must equal proposal title '%s'", proposalMetadata.Title, msg.Title)
+			}
+
+			if proposalMetadata.Summary != msg.Summary {
+				return nil, fmt.Errorf("metadata summary '%s' must equal proposal summary '%s'", proposalMetadata.Summary, msg.Summary)
+			}
+		}
+
+		// if we can't unmarshal the metadata, this means the client didn't use the recommended metadata format
+		// nothing can be done here, and this is still a valid case, so we ignore the error
+	}
+
 	msgs, err := msg.GetMsgs()
 	if err != nil {
 		return nil, errorsmod.Wrap(err, "request msgs")

x/group/keeper/msg_server_test.go

@@ -1697,6 +1697,30 @@ func (s *TestSuite) TestSubmitProposal() {
 			expProposal: defaultProposal,
 			postRun:     func(sdkCtx sdk.Context) {},
 		},
+		"title != metadata.title": {
+			req: &group.MsgSubmitProposal{
+				GroupPolicyAddress: accountAddr.String(),
+				Proposers:          []string{addr2.String()},
+				Metadata:           "{\"title\":\"title\",\"summary\":\"description\"}",
+				Title:              "title2",
+				Summary:            "description",
+			},
+			expErr:    true,
+			expErrMsg: "metadata title 'title' must equal proposal title 'title2'",
+			postRun:   func(sdkCtx sdk.Context) {},
+		},
+		"summary != metadata.summary": {
+			req: &group.MsgSubmitProposal{
+				GroupPolicyAddress: accountAddr.String(),
+				Proposers:          []string{addr2.String()},
+				Metadata:           "{\"title\":\"title\",\"summary\":\"description of proposal\"}",
+				Title:              "title",
+				Summary:            "description",
+			},
+			expErr:    true,
+			expErrMsg: "metadata summary 'description of proposal' must equal proposal summary 'description'",
+			postRun:   func(sdkCtx sdk.Context) {},
+		},
 		"metadata too long": {
 			req: &group.MsgSubmitProposal{
 				GroupPolicyAddress: accountAddr.String(),