zero out coins on payout (#892)

x/incentive/genesis_test.go

@@ -0,0 +1,134 @@
+package incentive_test
+
+import (
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/suite"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	abci "github.com/tendermint/tendermint/abci/types"
+
+	"github.com/kava-labs/kava/app"
+	"github.com/kava-labs/kava/x/hard"
+	"github.com/kava-labs/kava/x/incentive"
+	"github.com/kava-labs/kava/x/kavadist"
+)
+
+const (
+	oneYear time.Duration = 365 * 24 * time.Hour
+)
+
+type GenesisTestSuite struct {
+	suite.Suite
+
+	ctx    sdk.Context
+	app    app.TestApp
+	keeper incentive.Keeper
+	addrs  []sdk.AccAddress
+
+	genesisTime time.Time
+}
+
+func (suite *GenesisTestSuite) SetupTest() {
+	tApp := app.NewTestApp()
+	keeper := tApp.GetIncentiveKeeper()
+	suite.genesisTime = time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC)
+
+	_, addrs := app.GeneratePrivKeyAddressPairs(3)
+	coins := []sdk.Coins{}
+	for j := 0; j < 3; j++ {
+		coins = append(coins, cs(c("bnb", 10_000_000_000), c("ukava", 10_000_000_000)))
+	}
+	authGS := app.NewAuthGenState(addrs, coins)
+
+	loanToValue, _ := sdk.NewDecFromStr("0.6")
+	borrowLimit := sdk.NewDec(1000000000000000)
+	hardGS := hard.NewGenesisState(
+		hard.NewParams(
+			hard.MoneyMarkets{
+				hard.NewMoneyMarket("ukava", hard.NewBorrowLimit(false, borrowLimit, loanToValue), "kava:usd", sdk.NewInt(1000000), hard.NewInterestRateModel(sdk.MustNewDecFromStr("0.05"), sdk.MustNewDecFromStr("2"), sdk.MustNewDecFromStr("0.8"), sdk.MustNewDecFromStr("10")), sdk.MustNewDecFromStr("0.05"), sdk.ZeroDec()),
+				hard.NewMoneyMarket("bnb", hard.NewBorrowLimit(false, borrowLimit, loanToValue), "bnb:usd", sdk.NewInt(1000000), hard.NewInterestRateModel(sdk.MustNewDecFromStr("0.05"), sdk.MustNewDecFromStr("2"), sdk.MustNewDecFromStr("0.8"), sdk.MustNewDecFromStr("10")), sdk.MustNewDecFromStr("0.05"), sdk.ZeroDec()),
+			},
+			sdk.NewDec(10),
+		),
+		hard.DefaultAccumulationTimes,
+		hard.DefaultDeposits,
+		hard.DefaultBorrows,
+		hard.DefaultTotalSupplied,
+		hard.DefaultTotalBorrowed,
+		hard.DefaultTotalReserves,
+	)
+	incentiveGS := incentive.NewGenesisState(
+		incentive.NewParams(
+			incentive.RewardPeriods{incentive.NewRewardPeriod(true, "bnb-a", suite.genesisTime.Add(-1*oneYear), suite.genesisTime.Add(oneYear), c("ukava", 122354))},
+			incentive.MultiRewardPeriods{incentive.NewMultiRewardPeriod(true, "bnb", suite.genesisTime.Add(-1*oneYear), suite.genesisTime.Add(oneYear), cs(c("hard", 122354)))},
+			incentive.MultiRewardPeriods{incentive.NewMultiRewardPeriod(true, "bnb", suite.genesisTime.Add(-1*oneYear), suite.genesisTime.Add(oneYear), cs(c("hard", 122354)))},
+			incentive.RewardPeriods{incentive.NewRewardPeriod(true, "ukava", suite.genesisTime.Add(-1*oneYear), suite.genesisTime.Add(oneYear), c("hard", 122354))},
+			incentive.Multipliers{incentive.NewMultiplier(incentive.Small, 1, d("0.25")), incentive.NewMultiplier(incentive.Large, 12, d("1.0"))},
+			suite.genesisTime.Add(5*oneYear),
+		),
+		incentive.DefaultGenesisAccumulationTimes,
+		incentive.DefaultGenesisAccumulationTimes,
+		incentive.DefaultGenesisAccumulationTimes,
+		incentive.DefaultGenesisAccumulationTimes,
+		incentive.DefaultUSDXClaims,
+		incentive.DefaultHardClaims,
+	)
+	tApp.InitializeFromGenesisStatesWithTime(
+		suite.genesisTime,
+		authGS,
+		app.GenesisState{incentive.ModuleName: incentive.ModuleCdc.MustMarshalJSON(incentiveGS)},
+		app.GenesisState{hard.ModuleName: hard.ModuleCdc.MustMarshalJSON(hardGS)},
+		NewCDPGenStateMulti(),
+		NewPricefeedGenStateMulti(),
+	)
+
+	ctx := tApp.NewContext(true, abci.Header{Height: 1, Time: suite.genesisTime})
+
+	// TODO add to auth gen state to tidy up test
+	err := tApp.GetSupplyKeeper().MintCoins(
+		ctx,
+		kavadist.KavaDistMacc,
+		cs(c("hard", 1_000_000_000_000_000), c("ukava", 1_000_000_000_000_000)),
+	)
+	suite.Require().NoError(err)
+
+	suite.addrs = addrs
+	suite.keeper = keeper
+	suite.app = tApp
+	suite.ctx = ctx
+}
+
+// Test to cover an bug where paid out claims would zero out rewards incorrectly, creating an invalid coins object.
+// The invalid reward coins would fail the genesis state validation
+func (suite *GenesisTestSuite) TestPaidOutClaimsPassValidateGenesis() {
+	hardHandler := hard.NewHandler(suite.app.GetHardKeeper())
+	_, err := hardHandler(suite.ctx, hard.NewMsgDeposit(suite.addrs[0], cs(c("bnb", 100_000_000))))
+	suite.Require().NoError(err)
+
+	suite.app.EndBlocker(suite.ctx, abci.RequestEndBlock{})
+	suite.ctx = suite.ctx.WithBlockTime(suite.genesisTime.Add(1 * 10 * time.Second))
+	suite.app.BeginBlocker(suite.ctx, abci.RequestBeginBlock{})
+
+	suite.app.EndBlocker(suite.ctx, abci.RequestEndBlock{})
+	suite.ctx = suite.ctx.WithBlockTime(suite.genesisTime.Add(2 * 10 * time.Second))
+	suite.app.BeginBlocker(suite.ctx, abci.RequestBeginBlock{})
+
+	_, err = hardHandler(suite.ctx, hard.NewMsgWithdraw(suite.addrs[0], cs(c("bnb", 100_000_000))))
+	suite.Require().NoError(err)
+
+	incentiveHandler := incentive.NewHandler(suite.keeper)
+	_, err = incentiveHandler(suite.ctx, incentive.NewMsgClaimHardReward(suite.addrs[0], string(incentive.Large)))
+	suite.Require().NoError(err)
+
+	genState := incentive.ExportGenesis(suite.ctx, suite.keeper)
+	suite.Require().NoError(
+		genState.Validate(),
+	)
+}
+
+func TestGenesisTestSuite(t *testing.T) {
+	suite.Run(t, new(GenesisTestSuite))
+}

x/incentive/keeper/rewards.go

@@ -657,11 +657,7 @@ func (k Keeper) SynchronizeHardLiquidityProviderClaim(ctx sdk.Context, owner sdk
 
 // ZeroHardLiquidityProviderClaim zeroes out the claim object's rewards and returns the updated claim object
 func (k Keeper) ZeroHardLiquidityProviderClaim(ctx sdk.Context, claim types.HardLiquidityProviderClaim) types.HardLiquidityProviderClaim {
-	var zeroRewards sdk.Coins
-	for _, coin := range claim.Reward {
-		zeroRewards = append(zeroRewards, sdk.NewCoin(coin.Denom, sdk.ZeroInt()))
-	}
-	claim.Reward = zeroRewards
+	claim.Reward = sdk.NewCoins()
 	k.SetHardLiquidityProviderClaim(ctx, claim)
 	return claim
 }