feat: add cli for canceling a software upgrade (#5)

.changelog/v1.0.1/improvements/4-add-helper-commands.md

@@ -1,2 +1 @@
-- Add helper commands for broadcasting software upgrade and recover client
-  messages. ([\#4](https://github.com/noble-assets/authority/pull/4))
+- Add helper commands for broadcasting software upgrade and recover client messages. ([#4](https://github.com/noble-assets/authority/pull/4))

.changelog/v1.0.2/improvements/5-add-helper-command.md

@@ -0,0 +1 @@
+- Add helper command for broadcasting a cancel software upgrade message. ([#5](https://github.com/noble-assets/authority/pull/5))

.changelog/v1.0.2/summary.md

@@ -0,0 +1,3 @@
+*Feb 10, 2025*
+
+This is a non-consensus breaking patch release to the v1 line.

CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## v1.0.2
+
+*Feb 10, 2025*
+
+This is a non-consensus breaking patch release to the v1 line.
+
+### IMPROVEMENTS
+
+- Add helper command for broadcasting a cancel software upgrade message. ([#5](https://github.com/noble-assets/authority/pull/5))
+
 ## v1.0.1
 
 *Dec 6, 2024*
@@ -8,8 +18,7 @@ This is a non-consensus breaking patch release to the v1 line.
 
 ### IMPROVEMENTS
 
-- Add helper commands for broadcasting software upgrade and recover client
-  messages. ([\#4](https://github.com/noble-assets/authority/pull/4))
+- Add helper commands for broadcasting software upgrade and recover client messages. ([#4](https://github.com/noble-assets/authority/pull/4))
 
 ## v1.0.0
 

client/cli/tx.go

@@ -51,6 +51,7 @@ func GetTxCmd() *cobra.Command {
 
 	cmd.AddCommand(NewCmdExecute())
 	cmd.AddCommand(NewCmdSoftwareUpgrade())
+	cmd.AddCommand(NewCmdCancelSoftwareUpgrade())
 	cmd.AddCommand(NewCmdRecoverClient())
 
 	return cmd
@@ -157,6 +158,38 @@ func NewCmdSoftwareUpgrade() *cobra.Command {
 	return cmd
 }
 
+// NewCmdCancelSoftwareUpgrade is a helper for cancelling the currently scheduled software upgrade.
+//
+// This command has been adapted from the Cosmos SDK implementation.
+// https://github.com/cosmos/cosmos-sdk/blob/x/upgrade/v0.1.4/x/upgrade/client/cli/tx.go#L135-L182
+func NewCmdCancelSoftwareUpgrade() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "cancel-software-upgrade [flags]",
+		Args:  cobra.NoArgs,
+		Short: "Helper for cancelling the currently scheduled software upgrade",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx, err := client.GetClientTxContext(cmd)
+			if err != nil {
+				return err
+			}
+
+			msgExecute := types.NewMsgExecute(
+				clientCtx.FromAddress.String(),
+				[]sdk.Msg{
+					&upgradetypes.MsgCancelUpgrade{
+						Authority: types.ModuleAddress.String(),
+					},
+				})
+
+			return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msgExecute)
+		},
+	}
+
+	flags.AddTxFlagsToCmd(cmd)
+
+	return cmd
+}
+
 // NewCmdRecoverClient is a helper for recovering an expired client.
 //
 // This command has been adapted from the IBC-Go implementation.

e2e/upgrade_test.go

@@ -29,8 +29,8 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-// TestScheduleUpgrade tests the module's ability to schedule an upgrade on-chain.
-func TestScheduleUpgrade(t *testing.T) {
+// TestScheduleAndCancelUpgrade tests the module's ability to schedule and cancel an upgrade on-chain.
+func TestScheduleAndCancelUpgrade(t *testing.T) {
 	t.Parallel()
 
 	var wrapper Wrapper
@@ -41,8 +41,7 @@ func TestScheduleUpgrade(t *testing.T) {
 
 	EnsureUpgrade(t, wrapper, ctx, "", 0)
 
-	cmd := []string{"authority", "software-upgrade", "v2", "--upgrade-height", "50",
-		"--chain-id", wrapper.chain.Config().ChainID, "--no-validate"}
+	cmd := []string{"authority", "software-upgrade", "v2", "--upgrade-height", "50", "--no-validate"}
 
 	// broadcast from un-authorized account
 	_, err := validator.ExecTx(
@@ -61,4 +60,24 @@ func TestScheduleUpgrade(t *testing.T) {
 	require.NoError(t, err)
 
 	EnsureUpgrade(t, wrapper, ctx, "v2", 50)
+
+	cmd = []string{"authority", "cancel-software-upgrade"}
+
+	// broadcast from un-authorized account
+	_, err = validator.ExecTx(
+		ctx,
+		notAuthorized.KeyName(),
+		cmd...,
+	)
+	require.ErrorContains(t, err, "signer is not authority")
+
+	// broadcast from authorized authority account
+	_, err = validator.ExecTx(
+		ctx,
+		wrapper.owner.KeyName(),
+		cmd...,
+	)
+	require.NoError(t, err)
+
+	EnsureUpgrade(t, wrapper, ctx, "", 0)
 }