feat(ecocredit): custom bridging support for cancelling credits

proto/regen/ecocredit/v1/events.proto

@@ -106,6 +106,9 @@ message EventCancel {
 
   // amount is the decimal number of credits that have been cancelled.
   string amount = 3;
+
+  // reason is the reason the credits were cancelled.
+  string reason = 4;
 }
 
 // EventUpdateClassAdmin is emitted when the admin address of a credit class is
@@ -159,3 +162,15 @@ message EventAddCreditType {
   // abbreviation is the abbreviation of the credit type.
   string abbreviation = 1;
 }
+
+// EventBridge is emitted emitted when credits are bridged to another chain.
+message EventBridge {
+  // target is the target chain.
+  string target = 1;
+
+  // recipient is the recipient address.
+  string recipient = 2;
+
+  // contract is the contract address.
+  string contract = 3;
+}

proto/regen/ecocredit/v1/tx.proto

@@ -71,6 +71,9 @@ service Msg {
   // UpdateProjectMetadata updates the project metadata
   rpc UpdateProjectMetadata(MsgUpdateProjectMetadata)
       returns (MsgUpdateProjectMetadataResponse);
+
+  // Bridge cancels credits and emits a bridge event.
+  rpc Bridge(MsgBridge) returns (MsgBridgeResponse);
 }
 
 // MsgCreateClass is the Msg/CreateClass request type.
@@ -321,6 +324,9 @@ message MsgCancel {
   // credits are the credits being cancelled.
   repeated CancelCredits credits = 2;
 
+  // reason is any arbitrary string that specifies the reason for cancelling credits.
+  string reason = 3;
+
   // CancelCredits specifies a batch and the number of credits being cancelled.
   message CancelCredits {
 
@@ -421,3 +427,21 @@ message MsgUpdateProjectMetadata {
 // MsgUpdateProjectMetadataResponse is the Msg/UpdateProjectMetadataResponse
 // response type.
 message MsgUpdateProjectMetadataResponse {}
+
+// MsgBridge is the Msg/Bridge request type.
+message MsgBridge {
+  // MsgCancel is the MsgCancel message type.
+  MsgCancel msg_cancel = 1;
+
+  // target is the target chain.
+  string target = 2;
+
+  // recipient is the recipient address.
+  string recipient = 3;
+
+  // contract is the contract address.
+  string contract = 4;
+}
+
+// MsgBridgeResponse is the Msg/MsgBridge response type.
+message MsgBridgeResponse {}

x/ecocredit/client/testsuite/tx.go

@@ -714,19 +714,20 @@ func (s *IntegrationTestSuite) TestTxCancel() {
 			name:           "missing args",
 			args:           []string{},
 			expectErr:      true,
-			expectedErrMsg: "Error: accepts 1 arg(s), received 0",
+			expectedErrMsg: "Error: accepts 2 arg(s), received 0",
 		},
 		{
 			name:           "too many args",
-			args:           []string{"foo", "bar"},
+			args:           []string{"foo", "bar", "bar1"},
 			expectErr:      true,
-			expectedErrMsg: "Error: accepts 1 arg(s), received 2",
+			expectedErrMsg: "Error: accepts 2 arg(s), received 3",
 		},
 		{
 			name: "missing from flag",
 			args: append(
 				[]string{
 					validCredits,
+					"reason",
 				},
 				s.commonTxFlags()...,
 			),
@@ -738,6 +739,7 @@ func (s *IntegrationTestSuite) TestTxCancel() {
 			args: append(
 				[]string{
 					validCredits,
+					"reason",
 					makeFlagFrom(val0.Address.String()),
 				},
 				s.commonTxFlags()...,
@@ -749,6 +751,7 @@ func (s *IntegrationTestSuite) TestTxCancel() {
 			args: append(
 				[]string{
 					validCredits,
+					"reason",
 					makeFlagFrom(val0.Address.String()),
 					fmt.Sprintf("--%s=%s", flags.FlagSignMode, flags.SignModeLegacyAminoJSON),
 				},

x/ecocredit/client/tx.go

@@ -370,14 +370,16 @@ Parameters:
 // TxCancelCmd returns a transaction command that cancels credits.
 func TxCancelCmd() *cobra.Command {
 	return txFlags(&cobra.Command{
-		Use:   "cancel [credits]",
+		Use:   "cancel [credits] [reason]",
 		Short: "Cancels a specified amount of credits from the account of the transaction author (--from)",
 		Long: `Cancels a specified amount of credits from the account of the transaction author (--from)
 
 Parameters:
   credits:  comma-separated list of credits in the form [<amount> <batch-denom>]
-            eg: '10 C01-20200101-20210101-001, 0.1 C01-20200101-20210101-001'`,
-		Args: cobra.ExactArgs(1),
+            eg: '10 C01-001-20200101-20210101-001, 0.1 C01-001-20200101-20210101-001'
+  reason:   reason is any arbitrary string that specifies the reason for cancelling credits.
+			`,
+		Args: cobra.ExactArgs(2),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			credits, err := parseCancelCreditsList(args[0])
 			if err != nil {
@@ -390,6 +392,7 @@ Parameters:
 			msg := core.MsgCancel{
 				Holder:  clientCtx.GetFromAddress().String(),
 				Credits: credits,
+				Reason:  args[1],
 			}
 			return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), &msg)
 		},