feat: add MsgWithdrawProposal to group module

proto/cosmos/group/v1beta1/events.proto

@@ -41,6 +41,13 @@ message EventCreateProposal {
   uint64 proposal_id = 1;
 }
 
+// EventWithdrawProposal is an event emitted when a proposal is withdrawn.
+message EventWithdrawProposal {
+
+  // proposal_id is the unique ID of the proposal.
+  uint64 proposal_id = 1;
+}
+
 // EventVote is an event emitted when a voter votes on a proposal.
 message EventVote {
 

proto/cosmos/group/v1beta1/tx.proto

@@ -42,6 +42,9 @@ service Msg {
   // CreateProposal submits a new proposal.
   rpc CreateProposal(MsgCreateProposal) returns (MsgCreateProposalResponse);
 
+  // WithdrawProposal aborts a proposal.
+  rpc WithdrawProposal(MsgWithdrawProposal) returns (MsgWithdrawProposalResponse);
+
   // Vote allows a voter to vote on a proposal.
   rpc Vote(MsgVote) returns (MsgVoteResponse);
 
@@ -258,6 +261,18 @@ message MsgCreateProposalResponse {
   uint64 proposal_id = 1;
 }
 
+// MsgWithdrawProposal is the Msg/WithdrawProposal request type.
+message MsgWithdrawProposal {
+  // proposal is the unique ID of the proposal.
+  uint64 proposal_id = 1;
+
+  // address is the admin of the group policy or one of the proposer of the proposal.
+  string address = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+}
+
+// MsgWithdrawProposalResponse is the Msg/WithdrawProposal response type.
+message MsgWithdrawProposalResponse {}
+
 // MsgVote is the Msg/Vote request type.
 message MsgVote {
   option (cosmos.msg.v1.signer) = "voter";

proto/cosmos/group/v1beta1/types.proto

@@ -178,10 +178,9 @@ message Proposal {
     // Final status of a proposal when the group was modified before the final tally.
     STATUS_ABORTED = 3 [(gogoproto.enumvalue_customname) = "ProposalStatusAborted"];
 
-    // TODO: do we want to support a withdrawn operation?
     // A proposal can be deleted before the voting start time by the owner. When this happens the final status
     // is Withdrawn.
-    //        STATUS_WITHDRAWN = 4 [(gogoproto.enumvalue_customname) = "Withdrawn"];
+    STATUS_WITHDRAWN = 4 [(gogoproto.enumvalue_customname) = "ProposalStatusWithdrawn"];
   }
 
   // Status represents the high level position in the life cycle of the proposal. Initial value is Submitted.

x/group/client/cli/tx.go

@@ -539,6 +539,57 @@ Parameters:
 	return cmd
 }
 
+// MsgWithdrawProposalCmd creates a CLI command for Msg/WithdrawProposal.
+func MsgWithdrawProposalCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "withdraw-proposal [proposal-id] [group-policy-admin-or-proposer]",
+		Short: "Withdraw a submitted proposal",
+		Long: `Withdraw a submitted proposal.
+
+Parameters:
+			proposal-id: unique ID of the proposal.
+			group-policy-admin-or-proposer: either admin of the group policy or one the proposer of the proposal.
+			(note: --from flag will be ignored here)
+`,
+		Args: cobra.ExactArgs(2),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			err := cmd.Flags().Set(flags.FlagFrom, args[1])
+			if err != nil {
+				return err
+			}
+
+			clientCtx, err := client.GetClientTxContext(cmd)
+			if err != nil {
+				return err
+			}
+
+			proposalID, err := strconv.ParseUint(args[0], 10, 64)
+			if err != nil {
+				return err
+			}
+
+			msg := &group.MsgWithdrawProposal{
+				ProposalId: proposalID,
+				Address:    clientCtx.GetFromAddress().String(),
+			}
+
+			if err != nil {
+				return err
+			}
+
+			if err = msg.ValidateBasic(); err != nil {
+				return fmt.Errorf("message validation failed: %w", err)
+			}
+
+			return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg)
+		},
+	}
+
+	flags.AddTxFlagsToCmd(cmd)
+
+	return cmd
+}
+
 // MsgVoteCmd creates a CLI command for Msg/Vote.
 func MsgVoteCmd() *cobra.Command {
 	cmd := &cobra.Command{

x/group/client/testutil/tx.go

@@ -76,11 +76,16 @@ func (s *IntegrationTestSuite) SetupSuite() {
 	}
 
 	// create a group
-	validMembers := fmt.Sprintf(`{"members": [{
-	  "address": "%s",
-		"weight": "3",
-		"metadata": "%s"
-	}]}`, val.Address.String(), validMetadata)
+	validMembers := fmt.Sprintf(`
+	{
+		"members": [
+			{
+				"address": "%s",
+				"weight": "3",
+				"metadata": "%s"
+			}
+		]
+	}`, val.Address.String(), validMetadata)
 	validMembersFile := testutil.WriteToNewTempFile(s.T(), validMembers)
 	out, err := cli.ExecTestCLICmd(val.ClientCtx, client.MsgCreateGroupCmd(),
 		append(
@@ -1505,6 +1510,155 @@ func (s *IntegrationTestSuite) TestTxVote() {
 	}
 }
 
+func (s *IntegrationTestSuite) TestTxWithdrawProposal() {
+	val := s.network.Validators[0]
+	clientCtx := val.ClientCtx
+
+	var commonFlags = []string{
+		fmt.Sprintf("--%s=true", flags.FlagSkipConfirmation),
+		fmt.Sprintf("--%s=%s", flags.FlagBroadcastMode, flags.BroadcastBlock),
+		fmt.Sprintf("--%s=%s", flags.FlagFees, sdk.NewCoins(sdk.NewCoin(s.cfg.BondDenom, sdk.NewInt(10))).String()),
+	}
+
+	ids := make([]string, 2)
+
+	validTxFileName := getTxSendFileName(s, s.groupPolicies[1].Address, val.Address.String())
+	for i := 0; i < 2; i++ {
+		out, err := cli.ExecTestCLICmd(val.ClientCtx, client.MsgCreateProposalCmd(),
+			append(
+				[]string{
+					s.groupPolicies[1].Address,
+					val.Address.String(),
+					validTxFileName,
+					"",
+					fmt.Sprintf("--%s=%s", flags.FlagFrom, val.Address.String()),
+				},
+				commonFlags...,
+			),
+		)
+		s.Require().NoError(err, out.String())
+
+		var txResp sdk.TxResponse
+		s.Require().NoError(val.ClientCtx.Codec.UnmarshalJSON(out.Bytes(), &txResp), out.String())
+		s.Require().Equal(uint32(0), txResp.Code, out.String())
+		ids[i] = s.getProposalIdFromTxResponse(txResp)
+	}
+
+	testCases := []struct {
+		name         string
+		args         []string
+		expectErr    bool
+		expectErrMsg string
+		respType     proto.Message
+		expectedCode uint32
+	}{
+		{
+			"correct data",
+			append(
+				[]string{
+					ids[0],
+					val.Address.String(),
+				},
+				commonFlags...,
+			),
+			false,
+			"",
+			&sdk.TxResponse{},
+			0,
+		},
+		{
+			"already withdrawn proposal",
+			append(
+				[]string{
+					ids[0],
+					val.Address.String(),
+				},
+				commonFlags...,
+			),
+			true,
+			"cannot withdraw a proposal with the status of STATUS_WITHDRAWN",
+			&sdk.TxResponse{},
+			0,
+		},
+		{
+			"proposal not found",
+			append(
+				[]string{
+					"222",
+					"wrongAdmin",
+				},
+				commonFlags...,
+			),
+			true,
+			"not found",
+			&sdk.TxResponse{},
+			0,
+		},
+		{
+			"invalid proposal",
+			append(
+				[]string{
+					"abc",
+					val.Address.String(),
+				},
+				commonFlags...,
+			),
+			true,
+			"invalid syntax",
+			&sdk.TxResponse{},
+			0,
+		},
+		{
+			"wrong admin",
+			append(
+				[]string{
+					ids[1],
+					"wrongAdmin",
+				},
+				commonFlags...,
+			),
+			true,
+			"key not found",
+			&sdk.TxResponse{},
+			0,
+		},
+	}
+
+	for _, tc := range testCases {
+		tc := tc
+
+		s.Run(tc.name, func() {
+			cmd := client.MsgWithdrawProposalCmd()
+
+			out, err := cli.ExecTestCLICmd(clientCtx, cmd, tc.args)
+			if tc.expectErr {
+				s.Require().Contains(out.String(), tc.expectErrMsg)
+			} else {
+				s.Require().NoError(err, out.String())
+				s.Require().NoError(clientCtx.Codec.UnmarshalJSON(out.Bytes(), tc.respType), out.String())
+
+				txResp := tc.respType.(*sdk.TxResponse)
+				s.Require().Equal(tc.expectedCode, txResp.Code, out.String())
+			}
+		})
+	}
+}
+
+func (s *IntegrationTestSuite) getProposalIdFromTxResponse(txResp sdk.TxResponse) string {
+	s.Require().Greater(len(txResp.Logs), 0)
+	s.Require().NotNil(txResp.Logs[0].Events)
+	events := txResp.Logs[0].Events
+	createProposalEvent, _ := sdk.TypedEventToEvent(&group.EventCreateProposal{})
+
+	for _, e := range events {
+		if e.Type == createProposalEvent.Type {
+			return strings.ReplaceAll(e.Attributes[0].Value, "\"", "")
+		}
+	}
+
+	return ""
+}
+
 func (s *IntegrationTestSuite) TestTxExec() {
 	val := s.network.Validators[0]
 	clientCtx := val.ClientCtx

x/group/codec.go

@@ -22,6 +22,7 @@ func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino) {
 	cdc.RegisterConcrete(&MsgUpdateGroupPolicyDecisionPolicy{}, "cosmos-sdk/MsgUpdateGroupPolicyDecisionPolicy", nil)
 	cdc.RegisterConcrete(&MsgUpdateGroupPolicyMetadata{}, "cosmos-sdk/MsgUpdateGroupPolicyMetadata", nil)
 	cdc.RegisterConcrete(&MsgCreateProposal{}, "cosmos-sdk/group/MsgCreateProposal", nil)
+	cdc.RegisterConcrete(&MsgWithdrawProposal{}, "cosmos-sdk/group/MsgWithdrawProposal", nil)
 	cdc.RegisterConcrete(&MsgVote{}, "cosmos-sdk/group/MsgVote", nil)
 	cdc.RegisterConcrete(&MsgExec{}, "cosmos-sdk/group/MsgExec", nil)
 }
@@ -37,6 +38,7 @@ func RegisterInterfaces(registry cdctypes.InterfaceRegistry) {
 		&MsgUpdateGroupPolicyDecisionPolicy{},
 		&MsgUpdateGroupPolicyMetadata{},
 		&MsgCreateProposal{},
+		&MsgWithdrawProposal{},
 		&MsgVote{},
 		&MsgExec{},
 	)