test: add more test cases for cancel unbond delegation

proto/cosmos/staking/v1beta1/tx.proto

@@ -32,7 +32,7 @@ service Msg {
   rpc Undelegate(MsgUndelegate) returns (MsgUndelegateResponse);
 
   // CancelUnbondingDelegation defines a method for performing canceling the unbonding delegation
-  // and delegate back to previous validator
+  // and delegate back to previous validator.
   rpc CancelUnbondingDelegation(MsgCancelUnbondingDelegation) returns (MsgCancelUnbondingDelegationResponse);
 }
 
@@ -125,7 +125,7 @@ message MsgUndelegateResponse {
   google.protobuf.Timestamp completion_time = 1 [(gogoproto.nullable) = false, (gogoproto.stdtime) = true];
 }
 
-// MsgCancelUnbondingDelegation defines the SDK message for performing an cancel unbonding delegation for delegator
+// MsgCancelUnbondingDelegation defines the SDK message for performing a cancel unbonding delegation for delegator
 message MsgCancelUnbondingDelegation{
   option (gogoproto.equal)           = false;
   option (gogoproto.goproto_getters) = false;

x/staking/client/cli/tx.go

@@ -44,7 +44,7 @@ func NewTxCmd() *cobra.Command {
 		NewDelegateCmd(),
 		NewRedelegateCmd(),
 		NewUnbondCmd(),
-		NewCancelUnBondDelegation(),
+		NewCancelUnbondingDelegation(),
 	)
 
 	return stakingTxCmd
@@ -278,7 +278,7 @@ $ %s tx staking unbond %s1gghjut3ccd8ay0zduzj64hwre2fxs9ldmqhffj 100stake --from
 	return cmd
 }
 
-func NewCancelUnBondDelegation() *cobra.Command {
+func NewCancelUnbondingDelegation() *cobra.Command {
 	bech32PrefixValAddr := sdk.GetConfig().GetBech32ValidatorAddrPrefix()
 
 	cmd := &cobra.Command{

x/staking/client/testutil/suite.go

@@ -3,6 +3,7 @@ package testutil
 import (
 	"context"
 	"fmt"
+	sdkerr "github.com/cosmos/cosmos-sdk/types/errors"
 	"strings"
 	"testing"
 
@@ -534,7 +535,6 @@ func (s *IntegrationTestSuite) TestGetCmdQueryUnbondingDelegations() {
 
 				s.Require().NoError(err)
 				s.Require().Len(ubds.UnbondingResponses, 1)
-				fmt.Println(ubds.UnbondingResponses)
 				s.Require().Equal(ubds.UnbondingResponses[0].DelegatorAddress, val.Address.String())
 			}
 		})
@@ -1344,6 +1344,32 @@ func (s *IntegrationTestSuite) TestNewCancelUnbondingDelegationCmd() {
 			},
 			true, 0, nil,
 		},
+		{
+			"Wrong unbonding creation height",
+			[]string{
+				val.ValAddress.String(),
+				sdk.NewCoin(s.cfg.BondDenom, sdk.NewInt(10)).String(),
+				sdk.NewInt(10000).String(),
+				fmt.Sprintf("--%s=%s", flags.FlagFrom, val.Address.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()),
+			},
+			false, sdkerr.ErrNotFound.ABCICode(), &sdk.TxResponse{},
+		},
+		{
+			"Invalid unbonding amount (higher than the unbonding amount)",
+			[]string{
+				val.ValAddress.String(),
+				sdk.NewCoin(s.cfg.BondDenom, sdk.NewInt(10000)).String(),
+				sdk.NewInt(3).String(),
+				fmt.Sprintf("--%s=%s", flags.FlagFrom, val.Address.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()),
+			},
+			false, sdkerr.ErrInvalidRequest.ABCICode(), &sdk.TxResponse{},
+		},
 		{
 			"valid transaction of canceling unbonding delegation",
 			[]string{
@@ -1363,7 +1389,7 @@ func (s *IntegrationTestSuite) TestNewCancelUnbondingDelegationCmd() {
 		tc := tc
 
 		s.Run(tc.name, func() {
-			cmd := cli.NewCancelUnBondDelegation()
+			cmd := cli.NewCancelUnbondingDelegation()
 			clientCtx := val.ClientCtx
 
 			out, err := clitestutil.ExecTestCLICmd(clientCtx, cmd, tc.args)

x/staking/keeper/msg_server.go

@@ -411,14 +411,14 @@ func (k msgServer) CancelUnbondingDelegation(goCtx context.Context, msg *types.M
 		return nil, types.ErrNoValidatorFound
 	}
 
-	//// In some situations, the exchange rate becomes invalid, e.g. if
-	//// Validator loses all tokens due to slashing. In this case,
-	//// make all future delegations invalid.
+	// In some situations, the exchange rate becomes invalid, e.g. if
+	// Validator loses all tokens due to slashing. In this case,
+	// make all future delegations invalid.
 	if validator.InvalidExRate() {
 		return nil, types.ErrDelegatorShareExRateInvalid
 	}
 
-	if validator.IsJailed(){
+	if validator.IsJailed() {
 		return nil, types.ErrValidatorJailed
 	}
 
@@ -431,29 +431,31 @@ func (k msgServer) CancelUnbondingDelegation(goCtx context.Context, msg *types.M
 	}
 
 	var (
-		foundUnBondingAtHeight = false
-		unbondEntry            types.UnbondingDelegationEntry
-		unbondEntryIndex       int64
+		unbondEntry      types.UnbondingDelegationEntry
+		unbondEntryIndex int64 = -1
 	)
 
 	for i, entry := range ubd.Entries {
 		if entry.CreationHeight == int64(msg.CreationHeight) {
-			foundUnBondingAtHeight = true
 			unbondEntry = entry
 			unbondEntryIndex = int64(i)
 			break
 		}
 	}
-	if !foundUnBondingAtHeight {
-		return nil, sdkerrors.Wrapf(sdkerrors.ErrNotFound, "unbonding delegation is not found at block height %d", msg.CreationHeight)
+	if unbondEntryIndex == -1 {
+		return nil, sdkerrors.Wrapf(sdkerrors.ErrNotFound, "unbonding delegation entry is not found at block height %d", msg.CreationHeight)
+	}
+
+	if !msg.Amount.IsPositive() {
+		return nil, sdkerrors.Wrapf(sdkerrors.ErrInvalidRequest, "invalid amount")
 	}
 
 	if unbondEntry.Balance.LT(msg.Amount.Amount) {
-		return nil, sdkerrors.Wrap(types.ErrNotEnoughDelegationShares, msg.Amount.String())
+		return nil, sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "amount is greater than the unbonding delegation entry balance")
 	}
 
-	if !ubd.Entries[unbondEntryIndex].CompletionTime.After(ctx.BlockTime()){
-		return nil, sdkerrors.Wrap(types.ErrNotEnoughDelegationShares, msg.Amount.String())
+	if ubd.Entries[unbondEntryIndex].CompletionTime.Before(ctx.BlockTime()) {
+		return nil, sdkerrors.Wrapf(sdkerrors.ErrInvalidRequest, "unbonding delegation is already processed.")
 	}
 
 	// delegate the unbonding delegation amount to validator back
@@ -463,7 +465,7 @@ func (k msgServer) CancelUnbondingDelegation(goCtx context.Context, msg *types.M
 	}
 
 	amount := unbondEntry.Balance.Sub(msg.Amount.Amount)
-	if amount.Equal(sdk.NewInt(0)) {
+	if amount.IsZero() {
 		// remove from ubd
 		ubd.RemoveEntry(unbondEntryIndex)
 	} else {
@@ -481,7 +483,7 @@ func (k msgServer) CancelUnbondingDelegation(goCtx context.Context, msg *types.M
 
 	ctx.EventManager().EmitEvent(
 		sdk.NewEvent(
-			types.EventTypeCancelUnbondDelegation,
+			types.EventTypeCancelUnbondingDelegation,
 			sdk.NewAttribute(sdk.AttributeKeyAmount, msg.Amount.String()),
 			sdk.NewAttribute(types.AttributeKeyValidator, msg.ValidatorAddress),
 			sdk.NewAttribute(types.AttributeKeyDelegator, msg.DelegatorAddress),

x/staking/simulation/operations.go

@@ -405,7 +405,6 @@ func SimulateMsgCancelUnbondingDelegate(ak types.AccountKeeper, bk types.BankKee
 		valAddr := validator.GetOperator()
 		unbondingDelegation, found := k.GetUnbondingDelegation(ctx, simAccount.Address, valAddr)
 		if !found {
-			//return simtypes.NoOpMsg(types.ModuleName, types.TypeMsgCancelUnbondingDelegation, "account does have any unbonding delegation"), nil, fmt.Errorf("delegation addr: %s does not exist in simulation accounts", simAccount.Address)
 			return simtypes.NoOpMsg(types.ModuleName, types.TypeMsgCancelUnbondingDelegation, "account does have any unbonding delegation"), nil, nil
 		}
 
@@ -435,7 +434,6 @@ func SimulateMsgCancelUnbondingDelegate(ak types.AccountKeeper, bk types.BankKee
 
 		// if simaccount.PrivKey == nil, delegation address does not exist in accs. Return error
 		if simAccount.PrivKey == nil {
-			//return simtypes.NoOpMsg(types.ModuleName, msg.Type(), "account private key is nil"), nil, fmt.Errorf("delegation addr: %s does not exist in simulation accounts", delAddr)
 			return simtypes.NoOpMsg(types.ModuleName, msg.Type(), "account private key is nil"), nil, fmt.Errorf("delegation addr: %s does not exist in simulation accounts", simAccount.Address)
 		}
 

x/staking/types/events.go

@@ -2,14 +2,14 @@ package types
 
 // staking module event types
 const (
-	EventTypeCompleteUnbonding      = "complete_unbonding"
-	EventTypeCompleteRedelegation   = "complete_redelegation"
-	EventTypeCreateValidator        = "create_validator"
-	EventTypeEditValidator          = "edit_validator"
-	EventTypeDelegate               = "delegate"
-	EventTypeUnbond                 = "unbond"
-	EventTypeCancelUnbondDelegation = "cancel_unbond_delegation"
-	EventTypeRedelegate             = "redelegate"
+	EventTypeCompleteUnbonding         = "complete_unbonding"
+	EventTypeCompleteRedelegation      = "complete_redelegation"
+	EventTypeCreateValidator           = "create_validator"
+	EventTypeEditValidator             = "edit_validator"
+	EventTypeDelegate                  = "delegate"
+	EventTypeUnbond                    = "unbond"
+	EventTypeCancelUnbondingDelegation = "cancel_unbonding_delegation"
+	EventTypeRedelegate                = "redelegate"
 
 	AttributeKeyValidator         = "validator"
 	AttributeKeyCommissionRate    = "commission_rate"