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 all commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

* [#4659](https://github.com/osmosis-labs/osmosis/pull/4659) implement AllPools query in x/poolmanager.
* [#4783](https://github.com/osmosis-labs/osmosis/pull/4783) Update wasmd to 0.31.0
* [#4830](https://github.com/osmosis-labs/osmosis/pull/4830) Add gas cost when we AddToGaugeRewards, linearly increase with coins to add
* [#4886](https://github.com/osmosis-labs/osmosis/pull/4886) Implement MsgSplitRouteSwapExactAmountIn and MsgSplitRouteSwapExactAmountOut that supports route splitting.
* [#4829] (https://github.com/osmosis-labs/osmosis/pull/4829) Add highest liquidity pool query in x/protorev

Expand Down
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)+len(gauge.Coins))), "scaling gas cost for adding to gauge rewards")

if err := k.bk.SendCoinsFromAccountToModule(ctx, owner, types.ModuleName, coins); err != nil {
return err
}
Expand Down
97 changes: 97 additions & 0 deletions x/incentives/keeper/gauge_test.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package keeper_test

import (
"fmt"
"time"

"github.com/stretchr/testify/suite"
Expand Down Expand Up @@ -332,3 +333,99 @@ 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: "valid case: valid gauge with >4 denoms",
owner: suite.TestAccs[0],
coinsToAdd: sdk.NewCoins(
sdk.NewCoin("uosmo", sdk.NewInt(100000)),
sdk.NewCoin("atom", sdk.NewInt(99999)),
sdk.NewCoin("mars", sdk.NewInt(88888)),
sdk.NewCoin("akash", sdk.NewInt(77777)),
sdk.NewCoin("eth", sdk.NewInt(6666)),
sdk.NewCoin("usdc", sdk.NewInt(555)),
sdk.NewCoin("dai", sdk.NewInt(4444)),
sdk.NewCoin("ust", sdk.NewInt(3333)),
),
gaugeId: 1,
minimumGasConsumed: uint64(8 * types.BaseGasFeeForAddRewardToGauge),

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
fmt.Println(gasConsumed, tc.minimumGasConsumed)
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
)