fix: clawback before vesting start time (#483)

* fix: clawback before vesting start time * types test * changelog
evmos · Apr 15, 2022 · f9a1828 · f9a1828
1 parent b08fa08
commit f9a1828
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -41,6 +41,10 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 - (fees) [\#436](https://github.com/tharsis/evmos/pull/436) Add `x/fees` module.
 
+### Bug Fixes
+
+- (vesting) [\#483](https://github.com/tharsis/evmos/pull/483) Fix balance clawback when vesting start time is in the future
+
 ## [v3.0.0] - 2022-04-05
 
 ### State Machine Breaking

diff --git a/x/vesting/keeper/msg_server.go b/x/vesting/keeper/msg_server.go
@@ -171,7 +171,7 @@ func (k Keeper) Clawback(
 		)
 	}
 
-	// Chech if account exists
+	// Check if account exists
 	acc := ak.GetAccount(ctx, addr)
 	if acc == nil {
 		return nil, sdkerrors.Wrapf(sdkerrors.ErrNotFound, "account %s does not exist", msg.AccountAddress)
@@ -188,6 +188,11 @@ func (k Keeper) Clawback(
 		return nil, sdkerrors.Wrapf(sdkerrors.ErrInvalidRequest, "clawback can only be requested by original funder %s", va.FunderAddress)
 	}
 
+	// Return error if clawback is attempted before start time
+	if ctx.BlockTime().Before(va.StartTime) {
+		return nil, sdkerrors.Wrapf(sdkerrors.ErrInvalidRequest, "clawback can only be executed after vesting begins: %s", va.FunderAddress)
+	}
+
 	// Perform clawback transfer
 	if err := k.transferClawback(ctx, *va, dest); err != nil {
 		return nil, err

diff --git a/x/vesting/keeper/msg_server_test.go b/x/vesting/keeper/msg_server_test.go
@@ -224,6 +224,7 @@ func (suite *KeeperTestSuite) TestMsgClawback() {
 		funder       sdk.AccAddress
 		addr         sdk.AccAddress
 		dest         sdk.AccAddress
+		startTime    time.Time
 		expectedPass bool
 	}{
 		{
@@ -232,6 +233,7 @@ func (suite *KeeperTestSuite) TestMsgClawback() {
 			addr,
 			sdk.AccAddress(tests.GenerateAddress().Bytes()),
 			addr3,
+			suite.ctx.BlockTime(),
 			false,
 		},
 		{
@@ -244,6 +246,7 @@ func (suite *KeeperTestSuite) TestMsgClawback() {
 			addr,
 			addr4,
 			addr3,
+			suite.ctx.BlockTime(),
 			false,
 		},
 		{
@@ -252,6 +255,17 @@ func (suite *KeeperTestSuite) TestMsgClawback() {
 			addr3,
 			addr2,
 			addr3,
+			suite.ctx.BlockTime(),
+			false,
+		},
+		{
+			"before start time",
+			func() {
+			},
+			addr,
+			addr2,
+			addr3,
+			suite.ctx.BlockTime().Add(time.Hour),
 			false,
 		},
 		{
@@ -261,6 +275,7 @@ func (suite *KeeperTestSuite) TestMsgClawback() {
 			addr,
 			addr2,
 			addr3,
+			suite.ctx.BlockTime(),
 			true,
 		},
 		{
@@ -270,6 +285,7 @@ func (suite *KeeperTestSuite) TestMsgClawback() {
 			addr,
 			addr2,
 			sdk.AccAddress([]byte{}),
+			suite.ctx.BlockTime(),
 			true,
 		},
 	}
@@ -283,8 +299,8 @@ func (suite *KeeperTestSuite) TestMsgClawback() {
 			suite.app.AccountKeeper.SetAccount(suite.ctx, funder)
 			testutil.FundAccount(suite.app.BankKeeper, suite.ctx, addr, balances)
 
-			// Create Clawnback Vesting Account
-			createMsg := types.NewMsgCreateClawbackVestingAccount(addr, addr2, suite.ctx.BlockTime(), lockupPeriods, vestingPeriods, false)
+			// Create Clawback Vesting Account
+			createMsg := types.NewMsgCreateClawbackVestingAccount(addr, addr2, tc.startTime, lockupPeriods, vestingPeriods, false)
 			createRes, err := suite.app.VestingKeeper.CreateClawbackVestingAccount(ctx, createMsg)
 			suite.Require().NoError(err)
 			suite.Require().NotNil(createRes)

diff --git a/x/vesting/types/clawback_vesting_account.go b/x/vesting/types/clawback_vesting_account.go
@@ -164,10 +164,17 @@ func (va ClawbackVestingAccount) GetPassedPeriodCount(blockTime time.Time) int {
 func (va ClawbackVestingAccount) ComputeClawback(
 	clawbackTime int64,
 ) (ClawbackVestingAccount, sdk.Coins) {
+	// if the clawback time is before the vesting start time, perform a no-op
+	// as there is nothing to clawback
+	// NOTE: error must be checked during message execution
+	if clawbackTime < va.GetStartTime() {
+		return va, sdk.Coins{}
+	}
+
 	totalVested := va.GetVestedOnly(time.Unix(clawbackTime, 0))
 	totalUnvested := va.GetUnvestedOnly(time.Unix(clawbackTime, 0))
 
-	// Remove all unvested periods from the schdule
+	// Remove all unvested periods from the schedule
 	passedPeriodID := va.GetPassedPeriodCount(time.Unix(clawbackTime, 0))
 	newVestingPeriods := va.VestingPeriods[:passedPeriodID]
 

diff --git a/x/vesting/types/clawback_vesting_account_test.go b/x/vesting/types/clawback_vesting_account_test.go
@@ -490,6 +490,14 @@ func (suite *VestingAccountTestSuite) TestComputeClawback() {
 		expLockupPeriods   []sdkvesting.Period
 		expVestingPeriods  []sdkvesting.Period
 	}{
+		{
+			"clawback before start time, no-op",
+			now.Add(-time.Hour).Unix(),
+			sdk.Coins{},
+			origCoins,
+			lockupPeriods,
+			vestingPeriods,
+		},
 		{
 			"clawback everything before any period passes",
 			now.Unix(),