Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Incentives Module][bugfix] Scale gas costs by denoms in gauge #4830

Merged
merged 7 commits into from
Apr 21, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions x/incentives/keeper/gauge.go
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,10 @@ func (k Keeper) AddToGaugeRewards(ctx sdk.Context, owner sdk.AccAddress, coins s
if gauge.IsFinishedGauge(ctx.BlockTime()) {
return errors.New("gauge is already completed")
}

// Fixed gas consumption adding reward to gauges based on the number of coins to add
ctx.GasMeter().ConsumeGas(uint64(types.BaseGasFeeForAddRewardToGauge*len(coins)), "add to gauge reward cost")
stackman27 marked this conversation as resolved.
Show resolved Hide resolved

if err := k.bk.SendCoinsFromAccountToModule(ctx, owner, types.ModuleName, coins); err != nil {
return err
}
Expand Down
77 changes: 77 additions & 0 deletions x/incentives/keeper/gauge_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -332,3 +332,80 @@ func (suite *KeeperTestSuite) TestChargeFeeIfSufficientFeeDenomBalance() {
})
}
}

func (suite *KeeperTestSuite) TestAddToGaugeRewards() {
testCases := []struct {
name string
owner sdk.AccAddress
coinsToAdd sdk.Coins
gaugeId uint64
minimumGasConsumed uint64

expectErr bool
}{
{
name: "valid case: valid gauge",
owner: suite.TestAccs[0],
coinsToAdd: sdk.NewCoins(
sdk.NewCoin("uosmo", sdk.NewInt(100000)),
sdk.NewCoin("atom", sdk.NewInt(99999)),
),
gaugeId: 1,
minimumGasConsumed: uint64(2 * types.BaseGasFeeForAddRewardToGauge),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the base gas cost for txns like these are usually in the 10k-20k gas range, we should add a test case with many denoms (>4) to ensure that the minimumGasConsumed check isn't passing trivially

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sounds good added! for 8 tokens it looks like this;

gasConsumed: 161441  tc. minimumGasConsumed: 80000


expectErr: false,
},
{
name: "invalid case: gauge Id is not valid",
owner: suite.TestAccs[0],
coinsToAdd: sdk.NewCoins(
sdk.NewCoin("uosmo", sdk.NewInt(100000)),
sdk.NewCoin("atom", sdk.NewInt(99999)),
),
gaugeId: 0,
minimumGasConsumed: uint64(0),

expectErr: true,
},
}

for _, tc := range testCases {
suite.Run(tc.name, func() {
suite.SetupTest()
_, _, existingGaugeCoins, _ := suite.SetupNewGauge(true, sdk.Coins{sdk.NewInt64Coin("stake", 12)})

suite.FundAcc(tc.owner, tc.coinsToAdd)

existingGasConsumed := suite.Ctx.GasMeter().GasConsumed()

err := suite.App.IncentivesKeeper.AddToGaugeRewards(suite.Ctx, tc.owner, tc.coinsToAdd, tc.gaugeId)
if tc.expectErr {
suite.Require().Error(err)

// balance shouldn't change in the module
balance := suite.App.BankKeeper.GetAllBalances(suite.Ctx, suite.App.AccountKeeper.GetModuleAddress(types.ModuleName))
suite.Require().Equal(existingGaugeCoins, balance)

} else {
suite.Require().NoError(err)

// Ensure that at least the minimum amount of gas was charged (based on number of additional gauge coins)
gasConsumed := suite.Ctx.GasMeter().GasConsumed() - existingGasConsumed
suite.Require().True(gasConsumed >= tc.minimumGasConsumed)

// existing coins gets added to the module when we create gauge and add to gauge
expectedCoins := existingGaugeCoins.Add(tc.coinsToAdd...)

// check module account balance, should go up
balance := suite.App.BankKeeper.GetAllBalances(suite.Ctx, suite.App.AccountKeeper.GetModuleAddress(types.ModuleName))
suite.Require().Equal(expectedCoins, balance)

// check gauge coins should go up
gauge, err := suite.App.IncentivesKeeper.GetGaugeByID(suite.Ctx, tc.gaugeId)
suite.Require().NoError(err)

suite.Require().Equal(expectedCoins, gauge.Coins)
}
})
}
}
5 changes: 5 additions & 0 deletions x/incentives/types/constants.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package types

var (
BaseGasFeeForAddRewardToGauge = 10_000
)