9094794478
<!-- The default pull request template is for types feat, fix, or refactor. For other templates, add one of the following parameters to the url: - template=docs.md - template=other.md --> ## Description Closes: #8961 SDK allows InitGenesis to return with an empty validator set. In practice, the error for an empty validator set gets thrown in tendermint. To fix this, * Add non-empty validator set check to the `mm.InitGenesis` function. This will break `simapp.Setup` because it relies on an empty validator set [#comment](https://github.com/cosmos/cosmos-sdk/pull/8909#issuecomment-804850834). * Update `simapp.Setup` to use a single validator. * Fix failing tests (Most of them are keeper tests). <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [x] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [x] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
285 lines
12 KiB
Go
285 lines
12 KiB
Go
package simulation_test
|
|
|
|
import (
|
|
"math/rand"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/suite"
|
|
abci "github.com/tendermint/tendermint/abci/types"
|
|
tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
|
|
|
|
"github.com/cosmos/cosmos-sdk/simapp"
|
|
simappparams "github.com/cosmos/cosmos-sdk/simapp/params"
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
simtypes "github.com/cosmos/cosmos-sdk/types/simulation"
|
|
"github.com/cosmos/cosmos-sdk/x/bank/testutil"
|
|
"github.com/cosmos/cosmos-sdk/x/distribution/simulation"
|
|
"github.com/cosmos/cosmos-sdk/x/distribution/types"
|
|
distrtypes "github.com/cosmos/cosmos-sdk/x/distribution/types"
|
|
stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
|
|
)
|
|
|
|
// TestWeightedOperations tests the weights of the operations.
|
|
func (suite *SimTestSuite) TestWeightedOperations() {
|
|
cdc := suite.app.AppCodec()
|
|
appParams := make(simtypes.AppParams)
|
|
|
|
weightesOps := simulation.WeightedOperations(appParams, cdc, suite.app.AccountKeeper,
|
|
suite.app.BankKeeper, suite.app.DistrKeeper, suite.app.StakingKeeper,
|
|
)
|
|
|
|
// setup 3 accounts
|
|
s := rand.NewSource(1)
|
|
r := rand.New(s)
|
|
accs := suite.getTestingAccounts(r, 3)
|
|
|
|
expected := []struct {
|
|
weight int
|
|
opMsgRoute string
|
|
opMsgName string
|
|
}{
|
|
{simappparams.DefaultWeightMsgSetWithdrawAddress, types.ModuleName, types.TypeMsgSetWithdrawAddress},
|
|
{simappparams.DefaultWeightMsgWithdrawDelegationReward, types.ModuleName, types.TypeMsgWithdrawDelegatorReward},
|
|
{simappparams.DefaultWeightMsgWithdrawValidatorCommission, types.ModuleName, types.TypeMsgWithdrawValidatorCommission},
|
|
{simappparams.DefaultWeightMsgFundCommunityPool, types.ModuleName, types.TypeMsgFundCommunityPool},
|
|
}
|
|
|
|
for i, w := range weightesOps {
|
|
operationMsg, _, _ := w.Op()(r, suite.app.BaseApp, suite.ctx, accs, "")
|
|
// the following checks are very much dependent from the ordering of the output given
|
|
// by WeightedOperations. if the ordering in WeightedOperations changes some tests
|
|
// will fail
|
|
suite.Require().Equal(expected[i].weight, w.Weight(), "weight should be the same")
|
|
suite.Require().Equal(expected[i].opMsgRoute, operationMsg.Route, "route should be the same")
|
|
suite.Require().Equal(expected[i].opMsgName, operationMsg.Name, "operation Msg name should be the same")
|
|
}
|
|
}
|
|
|
|
// TestSimulateMsgSetWithdrawAddress tests the normal scenario of a valid message of type TypeMsgSetWithdrawAddress.
|
|
// Abonormal scenarios, where the message is created by an errors, are not tested here.
|
|
func (suite *SimTestSuite) TestSimulateMsgSetWithdrawAddress() {
|
|
|
|
// setup 3 accounts
|
|
s := rand.NewSource(1)
|
|
r := rand.New(s)
|
|
accounts := suite.getTestingAccounts(r, 3)
|
|
|
|
// begin a new block
|
|
suite.app.BeginBlock(abci.RequestBeginBlock{Header: tmproto.Header{Height: suite.app.LastBlockHeight() + 1, AppHash: suite.app.LastCommitID().Hash}})
|
|
|
|
// execute operation
|
|
op := simulation.SimulateMsgSetWithdrawAddress(suite.app.AccountKeeper, suite.app.BankKeeper, suite.app.DistrKeeper)
|
|
operationMsg, futureOperations, err := op(r, suite.app.BaseApp, suite.ctx, accounts, "")
|
|
suite.Require().NoError(err)
|
|
|
|
var msg types.MsgSetWithdrawAddress
|
|
types.ModuleCdc.UnmarshalJSON(operationMsg.Msg, &msg)
|
|
|
|
suite.Require().True(operationMsg.OK)
|
|
suite.Require().Equal("cosmos1ghekyjucln7y67ntx7cf27m9dpuxxemn4c8g4r", msg.DelegatorAddress)
|
|
suite.Require().Equal("cosmos1p8wcgrjr4pjju90xg6u9cgq55dxwq8j7u4x9a0", msg.WithdrawAddress)
|
|
suite.Require().Equal(types.TypeMsgSetWithdrawAddress, msg.Type())
|
|
suite.Require().Equal(types.ModuleName, msg.Route())
|
|
suite.Require().Len(futureOperations, 0)
|
|
}
|
|
|
|
// TestSimulateMsgWithdrawDelegatorReward tests the normal scenario of a valid message
|
|
// of type TypeMsgWithdrawDelegatorReward.
|
|
// Abonormal scenarios, where the message is created by an errors, are not tested here.
|
|
func (suite *SimTestSuite) TestSimulateMsgWithdrawDelegatorReward() {
|
|
// setup 3 accounts
|
|
s := rand.NewSource(4)
|
|
r := rand.New(s)
|
|
accounts := suite.getTestingAccounts(r, 3)
|
|
|
|
// setup accounts[0] as validator
|
|
validator0 := suite.getTestingValidator0(accounts)
|
|
|
|
// setup delegation
|
|
delTokens := suite.app.StakingKeeper.TokensFromConsensusPower(suite.ctx, 2)
|
|
validator0, issuedShares := validator0.AddTokensFromDel(delTokens)
|
|
delegator := accounts[1]
|
|
delegation := stakingtypes.NewDelegation(delegator.Address, validator0.GetOperator(), issuedShares)
|
|
suite.app.StakingKeeper.SetDelegation(suite.ctx, delegation)
|
|
suite.app.DistrKeeper.SetDelegatorStartingInfo(suite.ctx, validator0.GetOperator(), delegator.Address, distrtypes.NewDelegatorStartingInfo(2, sdk.OneDec(), 200))
|
|
|
|
suite.setupValidatorRewards(validator0.GetOperator())
|
|
|
|
// begin a new block
|
|
suite.app.BeginBlock(abci.RequestBeginBlock{Header: tmproto.Header{Height: suite.app.LastBlockHeight() + 1, AppHash: suite.app.LastCommitID().Hash}})
|
|
|
|
// execute operation
|
|
op := simulation.SimulateMsgWithdrawDelegatorReward(suite.app.AccountKeeper, suite.app.BankKeeper, suite.app.DistrKeeper, suite.app.StakingKeeper)
|
|
operationMsg, futureOperations, err := op(r, suite.app.BaseApp, suite.ctx, accounts, "")
|
|
suite.Require().NoError(err)
|
|
|
|
var msg types.MsgWithdrawDelegatorReward
|
|
types.ModuleCdc.UnmarshalJSON(operationMsg.Msg, &msg)
|
|
|
|
suite.Require().True(operationMsg.OK)
|
|
suite.Require().Equal("cosmosvaloper1l4s054098kk9hmr5753c6k3m2kw65h686d3mhr", msg.ValidatorAddress)
|
|
suite.Require().Equal("cosmos1d6u7zhjwmsucs678d7qn95uqajd4ucl9jcjt26", msg.DelegatorAddress)
|
|
suite.Require().Equal(types.TypeMsgWithdrawDelegatorReward, msg.Type())
|
|
suite.Require().Equal(types.ModuleName, msg.Route())
|
|
suite.Require().Len(futureOperations, 0)
|
|
}
|
|
|
|
// TestSimulateMsgWithdrawValidatorCommission tests the normal scenario of a valid message
|
|
// of type TypeMsgWithdrawValidatorCommission.
|
|
// Abonormal scenarios, where the message is created by an errors, are not tested here.
|
|
func (suite *SimTestSuite) TestSimulateMsgWithdrawValidatorCommission() {
|
|
suite.testSimulateMsgWithdrawValidatorCommission("atoken")
|
|
suite.testSimulateMsgWithdrawValidatorCommission("tokenxxx")
|
|
}
|
|
|
|
// all the checks in this function should not fail if we change the tokenName
|
|
func (suite *SimTestSuite) testSimulateMsgWithdrawValidatorCommission(tokenName string) {
|
|
// setup 3 accounts
|
|
s := rand.NewSource(1)
|
|
r := rand.New(s)
|
|
accounts := suite.getTestingAccounts(r, 3)
|
|
|
|
// setup accounts[0] as validator
|
|
validator0 := suite.getTestingValidator0(accounts)
|
|
|
|
// set module account coins
|
|
distrAcc := suite.app.DistrKeeper.GetDistributionAccount(suite.ctx)
|
|
suite.Require().NoError(testutil.FundModuleAccount(suite.app.BankKeeper, suite.ctx, distrAcc.GetName(), sdk.NewCoins(
|
|
sdk.NewCoin(tokenName, sdk.NewInt(10)),
|
|
sdk.NewCoin("stake", sdk.NewInt(5)),
|
|
)))
|
|
suite.app.AccountKeeper.SetModuleAccount(suite.ctx, distrAcc)
|
|
|
|
// set outstanding rewards
|
|
valCommission := sdk.NewDecCoins(
|
|
sdk.NewDecCoinFromDec(tokenName, sdk.NewDec(5).Quo(sdk.NewDec(2))),
|
|
sdk.NewDecCoinFromDec("stake", sdk.NewDec(1).Quo(sdk.NewDec(1))),
|
|
)
|
|
|
|
suite.app.DistrKeeper.SetValidatorOutstandingRewards(suite.ctx, validator0.GetOperator(), types.ValidatorOutstandingRewards{Rewards: valCommission})
|
|
suite.app.DistrKeeper.SetValidatorOutstandingRewards(suite.ctx, suite.genesisVals[0].GetOperator(), types.ValidatorOutstandingRewards{Rewards: valCommission})
|
|
|
|
// setup validator accumulated commission
|
|
suite.app.DistrKeeper.SetValidatorAccumulatedCommission(suite.ctx, validator0.GetOperator(), types.ValidatorAccumulatedCommission{Commission: valCommission})
|
|
suite.app.DistrKeeper.SetValidatorAccumulatedCommission(suite.ctx, suite.genesisVals[0].GetOperator(), types.ValidatorAccumulatedCommission{Commission: valCommission})
|
|
|
|
// begin a new block
|
|
suite.app.BeginBlock(abci.RequestBeginBlock{Header: tmproto.Header{Height: suite.app.LastBlockHeight() + 1, AppHash: suite.app.LastCommitID().Hash}})
|
|
|
|
// execute operation
|
|
op := simulation.SimulateMsgWithdrawValidatorCommission(suite.app.AccountKeeper, suite.app.BankKeeper, suite.app.DistrKeeper, suite.app.StakingKeeper)
|
|
operationMsg, futureOperations, err := op(r, suite.app.BaseApp, suite.ctx, accounts, "")
|
|
if !operationMsg.OK {
|
|
suite.Require().Equal("could not find account", operationMsg.Comment)
|
|
} else {
|
|
suite.Require().NoError(err)
|
|
|
|
var msg types.MsgWithdrawValidatorCommission
|
|
types.ModuleCdc.UnmarshalJSON(operationMsg.Msg, &msg)
|
|
|
|
suite.Require().True(operationMsg.OK)
|
|
suite.Require().Equal("cosmosvaloper1tnh2q55v8wyygtt9srz5safamzdengsn9dsd7z", msg.ValidatorAddress)
|
|
suite.Require().Equal(types.TypeMsgWithdrawValidatorCommission, msg.Type())
|
|
suite.Require().Equal(types.ModuleName, msg.Route())
|
|
suite.Require().Len(futureOperations, 0)
|
|
}
|
|
}
|
|
|
|
// TestSimulateMsgFundCommunityPool tests the normal scenario of a valid message of type TypeMsgFundCommunityPool.
|
|
// Abonormal scenarios, where the message is created by an errors, are not tested here.
|
|
func (suite *SimTestSuite) TestSimulateMsgFundCommunityPool() {
|
|
// setup 3 accounts
|
|
s := rand.NewSource(1)
|
|
r := rand.New(s)
|
|
accounts := suite.getTestingAccounts(r, 3)
|
|
|
|
// begin a new block
|
|
suite.app.BeginBlock(abci.RequestBeginBlock{Header: tmproto.Header{Height: suite.app.LastBlockHeight() + 1, AppHash: suite.app.LastCommitID().Hash}})
|
|
|
|
// execute operation
|
|
op := simulation.SimulateMsgFundCommunityPool(suite.app.AccountKeeper, suite.app.BankKeeper, suite.app.DistrKeeper, suite.app.StakingKeeper)
|
|
operationMsg, futureOperations, err := op(r, suite.app.BaseApp, suite.ctx, accounts, "")
|
|
suite.Require().NoError(err)
|
|
|
|
var msg types.MsgFundCommunityPool
|
|
types.ModuleCdc.UnmarshalJSON(operationMsg.Msg, &msg)
|
|
|
|
suite.Require().True(operationMsg.OK)
|
|
suite.Require().Equal("4896096stake", msg.Amount.String())
|
|
suite.Require().Equal("cosmos1ghekyjucln7y67ntx7cf27m9dpuxxemn4c8g4r", msg.Depositor)
|
|
suite.Require().Equal(types.TypeMsgFundCommunityPool, msg.Type())
|
|
suite.Require().Equal(types.ModuleName, msg.Route())
|
|
suite.Require().Len(futureOperations, 0)
|
|
}
|
|
|
|
type SimTestSuite struct {
|
|
suite.Suite
|
|
|
|
ctx sdk.Context
|
|
app *simapp.SimApp
|
|
genesisVals []stakingtypes.Validator
|
|
}
|
|
|
|
func (suite *SimTestSuite) SetupTest() {
|
|
checkTx := false
|
|
app := simapp.Setup(suite.T(), checkTx)
|
|
suite.app = app
|
|
suite.ctx = app.BaseApp.NewContext(checkTx, tmproto.Header{})
|
|
genesisVals := app.StakingKeeper.GetAllValidators(suite.ctx)
|
|
suite.Require().Len(genesisVals, 1)
|
|
suite.genesisVals = genesisVals
|
|
}
|
|
|
|
func (suite *SimTestSuite) getTestingAccounts(r *rand.Rand, n int) []simtypes.Account {
|
|
accounts := simtypes.RandomAccounts(r, n)
|
|
|
|
initAmt := suite.app.StakingKeeper.TokensFromConsensusPower(suite.ctx, 200)
|
|
initCoins := sdk.NewCoins(sdk.NewCoin(sdk.DefaultBondDenom, initAmt))
|
|
|
|
// add coins to the accounts
|
|
for _, account := range accounts {
|
|
acc := suite.app.AccountKeeper.NewAccountWithAddress(suite.ctx, account.Address)
|
|
suite.app.AccountKeeper.SetAccount(suite.ctx, acc)
|
|
suite.Require().NoError(testutil.FundAccount(suite.app.BankKeeper, suite.ctx, account.Address, initCoins))
|
|
}
|
|
|
|
return accounts
|
|
}
|
|
|
|
func (suite *SimTestSuite) getTestingValidator0(accounts []simtypes.Account) stakingtypes.Validator {
|
|
commission0 := stakingtypes.NewCommission(sdk.ZeroDec(), sdk.OneDec(), sdk.OneDec())
|
|
return suite.getTestingValidator(accounts, commission0, 0)
|
|
}
|
|
|
|
func (suite *SimTestSuite) getTestingValidator(accounts []simtypes.Account, commission stakingtypes.Commission, n int) stakingtypes.Validator {
|
|
require := suite.Require()
|
|
account := accounts[n]
|
|
valPubKey := account.PubKey
|
|
valAddr := sdk.ValAddress(account.PubKey.Address().Bytes())
|
|
validator, err := stakingtypes.NewValidator(valAddr, valPubKey, stakingtypes.
|
|
Description{})
|
|
require.NoError(err)
|
|
validator, err = validator.SetInitialCommission(commission)
|
|
require.NoError(err)
|
|
validator.DelegatorShares = sdk.NewDec(100)
|
|
validator.Tokens = sdk.NewInt(1000000)
|
|
|
|
suite.app.StakingKeeper.SetValidator(suite.ctx, validator)
|
|
|
|
return validator
|
|
}
|
|
|
|
func (suite *SimTestSuite) setupValidatorRewards(valAddress sdk.ValAddress) {
|
|
decCoins := sdk.DecCoins{sdk.NewDecCoinFromDec(sdk.DefaultBondDenom, sdk.OneDec())}
|
|
historicalRewards := distrtypes.NewValidatorHistoricalRewards(decCoins, 2)
|
|
suite.app.DistrKeeper.SetValidatorHistoricalRewards(suite.ctx, valAddress, 2, historicalRewards)
|
|
// setup current revards
|
|
currentRewards := distrtypes.NewValidatorCurrentRewards(decCoins, 3)
|
|
suite.app.DistrKeeper.SetValidatorCurrentRewards(suite.ctx, valAddress, currentRewards)
|
|
|
|
}
|
|
|
|
func TestSimTestSuite(t *testing.T) {
|
|
suite.Run(t, new(SimTestSuite))
|
|
}
|