feat: add draft-proposal for x/group (backport #13353) (#13359)

* feat: add `draft-proposal` for x/group (#13353) * feat: add `draft-proposal` for x/group * add changelog * extract useful function * add `GetMsgFromTypeURL` tests (cherry picked from commit 7eb259f) # Conflicts: # CHANGELOG.md # types/tx_msg.go # x/gov/client/cli/prompt.go * fix conflicts * fix whitespace * backport #13350 * renaming as main * updates Co-authored-by: Julien Robert <julien@rbrt.fr>
cosmos · Sep 23, 2022 · 72f8923 · 72f8923
1 parent 9454b97
commit 72f8923
Show file tree

Hide file tree

Showing 10 changed files with 433 additions and 69 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -43,7 +43,8 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Features
 
-* (cli) [#13304](https://github.com/cosmos/cosmos-sdk/pull/13304) Add `tx gov draft-proposal` command for generating proposal JSONs.
+* (cli) [#13353](https://github.com/cosmos/cosmos-sdk/pull/13353) Add `tx group draft-proposal` command for generating group proposal JSONs (skeleton).
+* (cli) [#13304](https://github.com/cosmos/cosmos-sdk/pull/13304) Add `tx gov draft-proposal` command for generating proposal JSONs (skeleton).
 * (x/authz) [#13047](https://github.com/cosmos/cosmos-sdk/pull/13047) Add a GetAuthorization function to the keeper.
 * (cli) [#12742](https://github.com/cosmos/cosmos-sdk/pull/12742) Add the `prune` CLI cmd to manually prune app store history versions based on the pruning options.
 
@@ -389,8 +390,96 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Deprecated
 
-* (x/upgrade) [\#9906](https://github.com/cosmos/cosmos-sdk/pull/9906) Deprecate `UpgradeConsensusState` gRPC query since this functionality is only used for IBC, which now has its own [IBC replacement](https://github.com/cosmos/ibc-go/blob/2c880a22e9f9cc75f62b527ca94aa75ce1106001/proto/ibc/core/client/v1/query.proto#L54)
-* (types) [\#10948](https://github.com/cosmos/cosmos-sdk/issues/10948) Deprecate the types.DBBackend variable and types.NewLevelDB function. They are replaced by a new entry in `app.toml`: `app-db-backend` and `tendermint/tm-db`s `NewDB` function. If `app-db-backend` is defined, then it is used. Otherwise, if `types.DBBackend` is defined, it is used (until removed: [\#11241](https://github.com/cosmos/cosmos-sdk/issues/11241)). Otherwise, Tendermint config's `db-backend` is used.
+* (x/upgrade) [#9906](https://github.com/cosmos/cosmos-sdk/pull/9906) Deprecate `UpgradeConsensusState` gRPC query since this functionality is only used for IBC, which now has its own [IBC replacement](https://github.com/cosmos/ibc-go/blob/2c880a22e9f9cc75f62b527ca94aa75ce1106001/proto/ibc/core/client/v1/query.proto#L54)
+* (types) [#10948](https://github.com/cosmos/cosmos-sdk/issues/10948) Deprecate the types.DBBackend variable and types.NewLevelDB function. They are replaced by a new entry in `app.toml`: `app-db-backend` and `tendermint/tm-db`s `NewDB` function. If `app-db-backend` is defined, then it is used. Otherwise, if `types.DBBackend` is defined, it is used (until removed: [#11241](https://github.com/cosmos/cosmos-sdk/issues/11241)). Otherwise, Tendermint config's `db-backend` is used.
+
+## v0.45.8 - 2022-08-25
+
+### Improvements
+
+* [#12981](https://github.com/cosmos/cosmos-sdk/pull/12981) Return proper error when parsing telemetry configuration.
+* [#12885](https://github.com/cosmos/cosmos-sdk/pull/12885) Amortize cost of processing cache KV store.
+* [#12970](https://github.com/cosmos/cosmos-sdk/pull/12970) Bump Tendermint to `v0.34.21` and IAVL to `v0.19.1`.
+* [#12693](https://github.com/cosmos/cosmos-sdk/pull/12693) Make sure the order of each node is consistent when emitting proto events.
+
+### Bug Fixes
+
+* [#13046](https://github.com/cosmos/cosmos-sdk/pull/13046) Fix missing return statement in BaseApp.Query.
+
+## v0.45.7 - 2022-08-04
+
+### Features
+
+* (upgrade) [#12603](https://github.com/cosmos/cosmos-sdk/pull/12603) feat: Move AppModule.BeginBlock and AppModule.EndBlock to extension interfaces
+
+### Improvements
+
+* (events) [#12850](https://github.com/cosmos/cosmos-sdk/pull/12850) Add a new `fee_payer` attribute to the `tx` event that is emitted from the `DeductFeeDecorator` AnteHandler decorator.
+* (x/params) [#12724](https://github.com/cosmos/cosmos-sdk/pull/12724) Add `GetParamSetIfExists` function to params `Subspace` to prevent panics on breaking changes.
+* [#12668](https://github.com/cosmos/cosmos-sdk/pull/12668) Add `authz_msg_index` event attribute to message events emitted when executing via `MsgExec` through `x/authz`.
+* [#12697](https://github.com/cosmos/cosmos-sdk/pull/12697) Upgrade IAVL to v0.19.0 with fast index and error propagation. NOTE: first start will take a while to propagate into new model.
+    * Note: after upgrading to this version it may take up to 15 minutes to migrate from 0.17 to 0.19. This time is used to create the fast cache introduced into IAVL for performance
+* [#12784](https://github.com/cosmos/cosmos-sdk/pull/12784) Upgrade Tendermint to 0.34.20.
+* (x/bank) [#12674](https://github.com/cosmos/cosmos-sdk/pull/12674) Add convenience function `CreatePrefixedAccountStoreKey()` to construct key to access account's balance for a given denom.
+
+### Bug Fixes
+
+* (x/mint) [#12384](https://github.com/cosmos/cosmos-sdk/pull/12384) Ensure `GoalBonded` must be positive when performing `x/mint` parameter validation.
+* (simapp) [#12437](https://github.com/cosmos/cosmos-sdk/pull/12437) fix the non-determinstic behavior in simulations caused by `GenTx` and check
+empty coins slice before it is used to create `banktype.MsgSend`.
+* (x/capability) [12818](https://github.com/cosmos/cosmos-sdk/pull/12818) Use fixed length hex for pointer at FwdCapabilityKey.
+
+## [v0.45.6](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.6) - 2022-06-28
+
+### Improvements
+
+* (simapp) [#12314](https://github.com/cosmos/cosmos-sdk/pull/12314) Increase `DefaultGenTxGas` from `1000000` to `10000000`
+* [#12371](https://github.com/cosmos/cosmos-sdk/pull/12371) Update min required Golang version to 1.18.
+
+### Bug Fixes
+
+* [#12317](https://github.com/cosmos/cosmos-sdk/pull/12317) Rename `edit-validator` command's `--moniker` flag to `--new-moniker`
+* (x/upgrade) [#12264](https://github.com/cosmos/cosmos-sdk/pull/12264) Fix `GetLastCompleteUpgrade` to properly return the latest upgrade.
+* (x/crisis) [#12208](https://github.com/cosmos/cosmos-sdk/pull/12208) Fix progress index of crisis invariant assertion logs.
+
+### Features
+
+* (query) [#12253](https://github.com/cosmos/cosmos-sdk/pull/12253) Add `GenericFilteredPaginate` to the `query` package to improve UX.
+
+## [v0.45.5](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.5) - 2022-06-09
+
+### Improvements
+
+* (x/feegrant) [#11813](https://github.com/cosmos/cosmos-sdk/pull/11813) Fix pagination total count in `AllowancesByGranter` query.
+* (errors) [#12002](https://github.com/cosmos/cosmos-sdk/pull/12002) Removed 'redacted' error message from defaultErrEncoder.
+* (ante) [#12017](https://github.com/cosmos/cosmos-sdk/pull/12017) Index ante events for failed tx (backport #12013).
+* [#12153](https://github.com/cosmos/cosmos-sdk/pull/12153) Add a new `NewSimulationManagerFromAppModules` constructor, to simplify simulation wiring.
+
+### Bug Fixes
+
+* [#11796](https://github.com/cosmos/cosmos-sdk/pull/11796) Handle EOF error case in `readLineFromBuf`, which allows successful reading of passphrases from STDIN.
+* [#11772](https://github.com/cosmos/cosmos-sdk/pull/11772) Limit types.Dec length to avoid overflow.
+* [#10947](https://github.com/cosmos/cosmos-sdk/pull/10947) Add `AllowancesByGranter` query to the feegrant module
+* [#9639](https://github.com/cosmos/cosmos-sdk/pull/9639) Check store keys length before accessing them by making sure that `key` is of length `m+1` (for `key[n:m]`)
+* [#11983](https://github.com/cosmos/cosmos-sdk/pull/11983) (x/feegrant, x/authz) rename grants query commands to `grants-by-grantee`, `grants-by-granter` cmds.
+
+## Improvements
+
+* [#11886](https://github.com/cosmos/cosmos-sdk/pull/11886) Improve error messages
+
+## [v0.45.4](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.4) - 2022-04-25
+
+### Bug Fixes
+
+* [#11624](https://github.com/cosmos/cosmos-sdk/pull/11624) Handle the error returned from `NewNode` in the `server` package.
+* [#11724](https://github.com/cosmos/cosmos-sdk/pull/11724) Fix data race issues with `api.Server`.
+
+### Improvements
+
+* (types) [#12201](https://github.com/cosmos/cosmos-sdk/pull/12201) Add `MustAccAddressFromBech32` util function
+* [#11693](https://github.com/cosmos/cosmos-sdk/pull/11693) Add validation for gentx cmd.
+* [#11686](https://github.com/cosmos/cosmos-sdk/pull/11686) Update the min required Golang version to `1.17`.
+* (x/auth/vesting) [#11652](https://github.com/cosmos/cosmos-sdk/pull/11652) Add util functions for `Period(s)`
 
 ## [v0.45.3](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.45.3) - 2022-04-12
 

diff --git a/types/tx_msg.go b/types/tx_msg.go
@@ -1,8 +1,12 @@
 package types
 
 import (
+	"encoding/json"
+	fmt "fmt"
+
 	"github.com/gogo/protobuf/proto"
 
+	"github.com/cosmos/cosmos-sdk/codec"
 	cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
 )
 
@@ -79,3 +83,22 @@ type TxEncoder func(tx Tx) ([]byte, error)
 func MsgTypeURL(msg Msg) string {
 	return "/" + proto.MessageName(msg)
 }
+
+// GetMsgFromTypeURL returns a `sdk.Msg` message type from a type URL
+func GetMsgFromTypeURL(cdc codec.Codec, input string) (Msg, error) {
+	var msg Msg
+	bz, err := json.Marshal(struct {
+		Type string `json:"@type"`
+	}{
+		Type: input,
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	if err := cdc.UnmarshalInterfaceJSON(bz, &msg); err != nil {
+		return nil, fmt.Errorf("failed to determine sdk.Msg for %s URL : %w", input, err)
+	}
+
+	return msg, nil
+}
diff --git a/types/tx_msg_test.go b/types/tx_msg_test.go
@@ -5,6 +5,7 @@ import (
 
 	"github.com/stretchr/testify/suite"
 
+	"github.com/cosmos/cosmos-sdk/codec"
 	"github.com/cosmos/cosmos-sdk/testutil/testdata"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
@@ -33,3 +34,12 @@ func (s *testMsgSuite) TestMsg() {
 func (s *testMsgSuite) TestMsgTypeURL() {
 	s.Require().Equal("/testdata.TestMsg", sdk.MsgTypeURL(new(testdata.TestMsg)))
 }
+
+func (s *testMsgSuite) TestGetMsgFromTypeURL() {
+	msg := new(testdata.TestMsg)
+	cdc := codec.NewProtoCodec(testdata.NewTestInterfaceRegistry())
+
+	result, err := sdk.GetMsgFromTypeURL(cdc, "/testdata.TestMsg")
+	s.Require().NoError(err)
+	s.Require().Equal(msg, result)
+}
diff --git a/x/gov/client/cli/prompt.go b/x/gov/client/cli/prompt.go
@@ -27,17 +27,6 @@ const (
 	draftMetadataFileName = "draft_metadata.json"
 )
 
-// ProposalMetadata is the metadata of a proposal
-// This metadata is supposed to live off-chain when submitted in a proposal
-type ProposalMetadata struct {
-	Title             string `json:"title"`
-	Authors           string `json:"authors"`
-	Summary           string `json:"summary"`
-	Details           string `json:"details"`
-	ProposalForumUrl  string `json:"proposal_forum_url"` // named 'Url' instead of 'URL' for avoiding the camel case split
-	VoteOptionContext string `json:"vote_option_context"`
-}
-
 // Prompt prompts the user for all values of the given type.
 // data is the struct to be filled
 // namePrefix is the name to be display as "Enter <namePrefix> <field>"
@@ -94,8 +83,17 @@ func Prompt[T any](data T, namePrefix string) (T, error) {
 		case reflect.String:
 			v.Field(i).SetString(result)
 		case reflect.Int:
-			resultInt, _ := strconv.Atoi(result)
-			v.Field(i).SetInt(int64(resultInt))
+			resultInt, err := strconv.ParseInt(result, 10, 0)
+			if err != nil {
+				return data, fmt.Errorf("invalid value for int: %w", err)
+			}
+			// If a value was successfully parsed the ranges of:
+			//      [minInt,     maxInt]
+			// are within the ranges of:
+			//      [minInt64, maxInt64]
+			// of which on 64-bit machines, which are most common,
+			// int==int64
+			v.Field(i).SetInt(resultInt)
 		default:
 			// skip other types
 			// possibly in the future we can add more types (like slices)
@@ -106,21 +104,22 @@ func Prompt[T any](data T, namePrefix string) (T, error) {
 	return data, nil
 }
 
-type proposalTypes struct {
-	Type    string
+type proposalType struct {
+	Name    string
 	MsgType string
 	Msg     sdk.Msg
 }
 
 // Prompt the proposal type values and return the proposal and its metadata
-func (p *proposalTypes) Prompt(cdc codec.Codec) (*proposal, ProposalMetadata, error) {
+func (p *proposalType) Prompt(cdc codec.Codec) (*proposal, types.ProposalMetadata, error) {
 	proposal := &proposal{}
 
 	// set metadata
-	metadata, err := Prompt(ProposalMetadata{}, "proposal")
+	metadata, err := Prompt(types.ProposalMetadata{}, "proposal")
 	if err != nil {
 		return nil, metadata, fmt.Errorf("failed to set proposal metadata: %w", err)
 	}
+	// the metadata must be saved on IPFS, set placeholder
 	proposal.Metadata = "ipfs://CID"
 
 	// set deposit
@@ -151,56 +150,38 @@ func (p *proposalTypes) Prompt(cdc codec.Codec) (*proposal, ProposalMetadata, er
 	return proposal, metadata, nil
 }
 
-var supportedProposalTypes = []proposalTypes{
+var suggestedProposalTypes = []proposalType{
 	{
-		Type:    proposalText,
+		Name:    proposalText,
 		MsgType: "", // no message for text proposal
 	},
 	{
-		Type:    "software-upgrade",
+		Name:    "software-upgrade",
 		MsgType: "/cosmos.upgrade.v1beta1.MsgSoftwareUpgrade",
 	},
 	{
-		Type:    "cancel-software-upgrade",
+		Name:    "cancel-software-upgrade",
 		MsgType: "/cosmos.upgrade.v1beta1.MsgCancelUpgrade",
 	},
 	{
-		Type:    proposalOther,
+		Name:    proposalOther,
 		MsgType: "", // user will input the message type
 	},
 }
 
-func getProposalTypes() []string {
-	types := make([]string, len(supportedProposalTypes))
-	for i, p := range supportedProposalTypes {
-		types[i] = p.Type
+func getProposalSuggestions() []string {
+	types := make([]string, len(suggestedProposalTypes))
+	for i, p := range suggestedProposalTypes {
+		types[i] = p.Name
 	}
 	return types
 }
 
-func getProposalMsg(cdc codec.Codec, input string) (sdk.Msg, error) {
-	var msg sdk.Msg
-	bz, err := json.Marshal(struct {
-		Type string `json:"@type"`
-	}{
-		Type: input,
-	})
-	if err != nil {
-		return nil, err
-	}
-
-	if err := cdc.UnmarshalInterfaceJSON(bz, &msg); err != nil {
-		return nil, fmt.Errorf("failed to determined sdk.Msg from %s proposal type : %w", input, err)
-	}
-
-	return msg, nil
-}
-
 // NewCmdDraftProposal let a user generate a draft proposal.
 func NewCmdDraftProposal() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:          "draft-proposal",
-		Short:        "Generate a draft proposal json file. The generated proposal json contains only one message.",
+		Short:        "Generate a draft proposal json file. The generated proposal json contains only one message (skeleton).",
 		SilenceUsage: true,
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			clientCtx, err := client.GetClientTxContext(cmd)
@@ -211,24 +192,24 @@ func NewCmdDraftProposal() *cobra.Command {
 			// prompt proposal type
 			proposalTypesPrompt := promptui.Select{
 				Label: "Select proposal type",
-				Items: getProposalTypes(),
+				Items: getProposalSuggestions(),
 			}
 
-			_, proposalType, err := proposalTypesPrompt.Run()
+			_, selectedProposalType, err := proposalTypesPrompt.Run()
 			if err != nil {
 				return fmt.Errorf("failed to prompt proposal types: %w", err)
 			}
 
-			var proposal proposalTypes
-			for _, p := range supportedProposalTypes {
-				if strings.EqualFold(p.Type, proposalType) {
+			var proposal proposalType
+			for _, p := range suggestedProposalTypes {
+				if strings.EqualFold(p.Name, selectedProposalType) {
 					proposal = p
 					break
 				}
 			}
 
 			// create any proposal type
-			if proposal.Type == proposalOther {
+			if proposal.Name == proposalOther {
 				// prompt proposal type
 				msgPrompt := promptui.Select{
 					Label: "Select proposal message type:",
@@ -248,23 +229,23 @@ func NewCmdDraftProposal() *cobra.Command {
 			}
 
 			if proposal.MsgType != "" {
-				proposal.Msg, err = getProposalMsg(clientCtx.Codec, proposal.MsgType)
+				proposal.Msg, err = sdk.GetMsgFromTypeURL(clientCtx.Codec, proposal.MsgType)
 				if err != nil {
 					// should never happen
 					panic(err)
 				}
 			}
 
-			prop, metadata, err := proposal.Prompt(clientCtx.Codec)
+			result, metadata, err := proposal.Prompt(clientCtx.Codec)
 			if err != nil {
 				return err
 			}
 
-			if err := writeFile(draftMetadataFileName, metadata); err != nil {
+			if err := writeFile(draftProposalFileName, result); err != nil {
 				return err
 			}
 
-			if err := writeFile(draftProposalFileName, prop); err != nil {
+			if err := writeFile(draftMetadataFileName, metadata); err != nil {
 				return err
 			}