feat(x/ecocredit): add simpler version of send command (#1213)

* feat(x/ecocredit): add simpler version of `send` command for exchanging a single credit type

fixes #1023

* simplify approach by implementing the send CLI command using the existing MsgSend

* - add support for --retire-to flag
- add integration tests for new command

* fix formatting drift

* fix cli flag usage, add command example

* update command descriptions

* rename retirement jurisdiction flag, fix integration tests

x/ecocredit/client/testsuite/tx.go

@@ -331,6 +331,82 @@ func (s *IntegrationTestSuite) TestTxCreateBatchCmd() {
 func (s *IntegrationTestSuite) TestTxSendCmd() {
 	require := s.Require()
 
+	sender := s.addr1.String()
+	amount := "10"
+	retirementJurisdiction := "US-WA"
+
+	recipient := s.addr2.String()
+
+	testCases := []struct {
+		name      string
+		args      []string
+		expErr    bool
+		expErrMsg string
+	}{
+		{
+			name:      "missing args",
+			args:      []string{"foo", "bar"},
+			expErr:    true,
+			expErrMsg: "Error: accepts 3 arg(s), received 2",
+		},
+		{
+			name:      "too many args",
+			args:      []string{"foo", "bar", "baz", "foobarbaz"},
+			expErr:    true,
+			expErrMsg: "Error: accepts 3 arg(s), received 4",
+		},
+		{
+			name: "missing from flag",
+			args: []string{
+				amount,
+				s.batchDenom,
+				recipient,
+			},
+			expErr:    true,
+			expErrMsg: "Error: required flag(s) \"from\" not set",
+		},
+		{
+			name: "valid tradeable",
+			args: []string{
+				amount,
+				s.batchDenom,
+				recipient,
+				fmt.Sprintf("--%s=%s", flags.FlagFrom, sender),
+			},
+		},
+		{
+			name: "valid retire",
+			args: []string{
+				amount,
+				s.batchDenom,
+				recipient,
+				fmt.Sprintf("--%s=%s", flags.FlagFrom, sender),
+				fmt.Sprintf("--%s=%s", coreclient.FlagRetirementJurisdiction, retirementJurisdiction),
+			},
+		},
+	}
+	for _, tc := range testCases {
+		s.Run(tc.name, func() {
+			cmd := coreclient.TxSendCmd()
+			args := append(tc.args, s.commonTxFlags()...)
+			out, err := cli.ExecTestCLICmd(s.val.ClientCtx, cmd, args)
+			if tc.expErr {
+				require.Error(err)
+				require.Contains(out.String(), tc.expErrMsg)
+			} else {
+				require.NoError(err)
+
+				var res sdk.TxResponse
+				require.NoError(s.val.ClientCtx.Codec.UnmarshalJSON(out.Bytes(), &res))
+				require.Zero(res.Code, res.RawLog)
+			}
+		})
+	}
+}
+
+func (s *IntegrationTestSuite) TestTxSendBulkCmd() {
+	require := s.Require()
+
 	sender := s.addr1.String()
 	recipient := s.addr2.String()
 
@@ -441,7 +517,7 @@ func (s *IntegrationTestSuite) TestTxSendCmd() {
 
 	for _, tc := range testCases {
 		s.Run(tc.name, func() {
-			cmd := coreclient.TxSendCmd()
+			cmd := coreclient.TxSendBulkCmd()
 			args := append(tc.args, s.commonTxFlags()...)
 			out, err := cli.ExecTestCLICmd(s.val.ClientCtx, cmd, args)
 			if tc.expErr {

x/ecocredit/client/tx.go

@@ -20,15 +20,16 @@ import (
 )
 
 const (
-	FlagProjectId     string = "project-id"
-	FlagIssuances     string = "issuances"
-	FlagStartDate     string = "start-date"
-	FlagEndDate       string = "end-date"
-	FlagMetadata      string = "metadata"
-	FlagAddIssuers    string = "add-issuers"
-	FlagRemoveIssuers string = "remove-issuers"
-	FlagReferenceId   string = "reference-id"
-	FlagIssuer        string = "issuer"
+	FlagProjectId              string = "project-id"
+	FlagIssuances              string = "issuances"
+	FlagStartDate              string = "start-date"
+	FlagEndDate                string = "end-date"
+	FlagMetadata               string = "metadata"
+	FlagAddIssuers             string = "add-issuers"
+	FlagRemoveIssuers          string = "remove-issuers"
+	FlagReferenceId            string = "reference-id"
+	FlagIssuer                 string = "issuer"
+	FlagRetirementJurisdiction string = "retirement-jurisdiction"
 )
 
 // TxCmd returns a root CLI command handler for all x/ecocredit transaction commands.
@@ -46,6 +47,7 @@ func TxCmd(name string) *cobra.Command {
 		TxGenBatchJSONCmd(),
 		TxCreateBatchCmd(),
 		TxSendCmd(),
+		TxSendBulkCmd(),
 		TxRetireCmd(),
 		TxCancelCmd(),
 		TxUpdateClassMetadataCmd(),
@@ -294,13 +296,62 @@ Example JSON:
 	return txFlags(cmd)
 }
 
-// TxSendCmd returns a transaction command that sends credits from one account
+// TxSendCmd returns a transaction command that sends credits from a single batch from one account
 // to another.
 func TxSendCmd() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "send [recipient] [credits]",
-		Short: "Sends credits from the transaction author (--from) to the recipient",
-		Long: `Sends credits from the transaction author (--from) to the recipient.
+		Use:   "send [amount] [batch_denom] [recipient]",
+		Short: "Sends credits from a single batch from the transaction author (--from) to the recipient",
+		Long: `Sends credits from a single batch from the transaction author (--from) to the recipient.
+
+By default, the credits will be sent as tradeable. Use the --retirement-jurisdiction flag to retire the credits to the recipient address.
+
+Parameters:
+  amount: amount to send
+  batch_denom: batch denomination
+  recipient: recipient address`,
+		Example: "regen tx ecocredit send 20 regen18xvpj53vaupyfejpws5sktv5lnas5xj2phm3cf C01-001-20200403-20210405-001 --from myKey",
+		Args:    cobra.ExactArgs(3),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx, err := sdkclient.GetClientTxContext(cmd)
+			if err != nil {
+				return err
+			}
+			retireTo, err := cmd.Flags().GetString(FlagRetirementJurisdiction)
+			if err != nil {
+				return err
+			}
+			tradableAmount := args[0]
+			retiredAmount := "0"
+			if len(retireTo) > 0 {
+				tradableAmount = "0"
+				retiredAmount = args[0]
+			}
+			credit := core.MsgSend_SendCredits{
+				TradableAmount:         tradableAmount,
+				BatchDenom:             args[1],
+				RetiredAmount:          retiredAmount,
+				RetirementJurisdiction: retireTo,
+			}
+			msg := core.MsgSend{
+				Sender:    clientCtx.GetFromAddress().String(),
+				Recipient: args[2],
+				Credits:   []*core.MsgSend_SendCredits{&credit},
+			}
+			return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), &msg)
+		},
+	}
+	cmd.Flags().String(FlagRetirementJurisdiction, "", "Jurisdiction to retire the credits to. If empty, credits are not retired. (default empty)")
+	return txFlags(cmd)
+}
+
+// TxSendBulkCmd returns a transaction command that can send credits from multiple batches from one account
+// to another
+func TxSendBulkCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "send-bulk [recipient] [credits]",
+		Short: "Sends credits from multiple batches from the transaction author (--from) to the recipient",
+		Long: `Sends credits from multiple batches from the transaction author (--from) to the recipient.
 
 Parameters:
   recipient: recipient address