Skip to content
GitLab
Switch branch/tag
Find file BlameHistoryPermalink
keeper_test.go 30.38 KiB
1 
package keeper_test
2
3 
import (
4 
	"fmt"
5 
	"testing"
6 
	"time"
7
8 
	"github.com/cosmos/btcutil/bech32"
9 
	sdk "github.com/cosmos/cosmos-sdk/types"
10 
	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
11 
	"github.com/cosmos/cosmos-sdk/x/distribution"
12 
	distributiontypes "github.com/cosmos/cosmos-sdk/x/distribution/types"
13
14 
	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
15 
	"github.com/stretchr/testify/suite"
16 
	abci "github.com/tendermint/tendermint/abci/types"
17 
	tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
18
19 
	"github.com/osmosis-labs/osmosis/v10/app/apptesting"
20 
	"github.com/osmosis-labs/osmosis/v10/osmoutils"
21 
	lockuptypes "github.com/osmosis-labs/osmosis/v10/x/lockup/types"
22 
	"github.com/osmosis-labs/osmosis/v10/x/mint/keeper"
23 
	"github.com/osmosis-labs/osmosis/v10/x/mint/types"
24 
	poolincentivestypes "github.com/osmosis-labs/osmosis/v10/x/pool-incentives/types"
25 
)
26
27 
type KeeperTestSuite struct {
28 
	apptesting.KeeperTestHelper
29 
	queryClient types.QueryClient
30 
}
31
32 
var (
33 
	testAddressOne   = sdk.AccAddress([]byte("addr1---------------"))
34 
	testAddressTwo   = sdk.AccAddress([]byte("addr2---------------"))
35 
	testAddressThree = sdk.AccAddress([]byte("addr3---------------"))
36 
	testAddressFour  = sdk.AccAddress([]byte("addr4---------------"))
37 
)
38
39 
func TestKeeperTestSuite(t *testing.T) {
40 
	suite.Run(t, new(KeeperTestSuite))
41 
}
42
43 
func (suite *KeeperTestSuite) SetupTest() {
44 
	suite.Setup()
45
46 
	suite.queryClient = types.NewQueryClient(suite.QueryHelper)
47 
	params := suite.App.MintKeeper.GetParams(suite.Ctx)
48 
	params.ReductionPeriodInEpochs = 10
49 
	suite.App.MintKeeper.SetParams(suite.Ctx, params)
50 
}
51
52 
// setupDeveloperVestingModuleAccountTest sets up test cases that utilize developer vesting
53 
// module account logic. It reverts some default logic added by suite.Setup()
54 
// Specifically, it removes the developer vesting module account
55 
// from account keeper if isDeveloperModuleAccountCreated is true.
56 
// Additionally, it initializes suite's Ctx with blockHeight
57 
func (suite *KeeperTestSuite) setupDeveloperVestingModuleAccountTest(blockHeight int64, isDeveloperModuleAccountCreated bool) {
58 
	suite.Setup()
59 
	// Reset height to the desired value since test suite setup initialized
60 
	// it to 1.
61 
	bankKeeper := suite.App.BankKeeper
62 
	accountKeeper := suite.App.AccountKeeper
63
64 
	suite.Ctx = suite.Ctx.WithBlockHeader(tmproto.Header{Height: blockHeight})
65
66 
	if !isDeveloperModuleAccountCreated {
67 
		// Remove the developer vesting account since suite setup creates and initializes it.
68 
		// This environment w/o the developer vesting account configured is necessary for
69 
		// testing edge cases of multiple tests.
70 
		developerVestingAccount := accountKeeper.GetAccount(suite.Ctx, accountKeeper.GetModuleAddress(types.DeveloperVestingModuleAcctName))
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
accountKeeper.RemoveAccount(suite.Ctx, developerVestingAccount) bankKeeper.BurnCoins(suite.Ctx, types.ModuleName, sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, sdk.NewInt(keeper.DeveloperVestingAmount)))) // If developer module account is created, the suite.Setup() also sets the offset, // therefore, we should reset it to 0 to set up the environment truly w/o the module account. supplyOffset := bankKeeper.GetSupplyOffset(suite.Ctx, sdk.DefaultBondDenom) bankKeeper.AddSupplyOffset(suite.Ctx, sdk.DefaultBondDenom, supplyOffset.Mul(sdk.NewInt(-1))) suite.Require().Equal(sdk.ZeroInt(), bankKeeper.GetSupplyOffset(suite.Ctx, sdk.DefaultBondDenom)) } } // TestGetProportions tests that mint allocations are computed as expected. func (suite *KeeperTestSuite) TestGetProportions() { complexRatioDec := sdk.NewDecWithPrec(131, 3).Quo(sdk.NewDecWithPrec(273, 3)) tests := []struct { name string ratio sdk.Dec expectedCoin sdk.Coin expectedError error mintedCoin sdk.Coin }{ { name: "0 * 0.2 = 0", mintedCoin: sdk.NewCoin(sdk.DefaultBondDenom, sdk.NewInt(0)), ratio: sdk.NewDecWithPrec(2, 1), expectedCoin: sdk.NewCoin(sdk.DefaultBondDenom, sdk.NewInt(0)), }, { name: "100000 * 0.2 = 20000", mintedCoin: sdk.NewCoin(sdk.DefaultBondDenom, sdk.NewInt(100000)), ratio: sdk.NewDecWithPrec(2, 1), expectedCoin: sdk.NewCoin(sdk.DefaultBondDenom, sdk.NewInt(100000).Quo(sdk.NewInt(5))), }, { name: "123456 * 2/3 = 82304", mintedCoin: sdk.NewCoin(sdk.DefaultBondDenom, sdk.NewInt(123456)), ratio: sdk.NewDecWithPrec(2, 1).Quo(sdk.NewDecWithPrec(3, 1)), expectedCoin: sdk.NewCoin(sdk.DefaultBondDenom, sdk.NewInt(82304)), }, { name: "54617981 * .131/.273 approx = 2.62", mintedCoin: sdk.NewCoin("uosmo", sdk.NewInt(54617981)), ratio: complexRatioDec, // .131/.273 // TODO: Should not be truncated. Remove truncation after rounding errors are addressed and resolved. // Ref: https://github.com/osmosis-labs/osmosis/issues/1917 expectedCoin: sdk.NewCoin("uosmo", sdk.NewInt(54617981).ToDec().Mul(complexRatioDec).TruncateInt()), }, { name: "1 * 1 = 1", mintedCoin: sdk.NewCoin(sdk.DefaultBondDenom, sdk.NewInt(1)), ratio: sdk.NewDec(1), expectedCoin: sdk.NewCoin(sdk.DefaultBondDenom, sdk.NewInt(1)), }, { name: "1 * 1.01 - error, ratio must be <= 1", mintedCoin: sdk.NewCoin(sdk.DefaultBondDenom, sdk.NewInt(0)), ratio: sdk.NewDecWithPrec(101, 2), expectedError: keeper.ErrInvalidRatio{ActualRatio: sdk.NewDecWithPrec(101, 2)}, }, } for _, tc := range tests { suite.Run(tc.name, func() { coin, err := keeper.GetProportions(tc.mintedCoin, tc.ratio) if tc.expectedError != nil { suite.Require().Equal(tc.expectedError, err) suite.Require().Equal(sdk.Coin{}, coin)