!feat: Add invartiants #101
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| package keeper | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/realio-tech/multi-staking-module/x/multi-staking/types" | ||
|
|
||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| authtypes "github.com/cosmos/cosmos-sdk/x/auth/types" | ||
| ) | ||
|
|
||
| // RegisterInvariants registers all staking invariants | ||
| func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper) { | ||
| ir.RegisterRoute(types.ModuleName, "module-accounts", | ||
| ModuleAccountInvariants(k)) | ||
| ir.RegisterRoute(types.ModuleName, "validator-lock-denom", | ||
| ValidatorLockDenomInvariants(k)) | ||
| } | ||
|
|
||
| func ModuleAccountInvariants(k Keeper) sdk.Invariant { | ||
| return func(ctx sdk.Context) (string, bool) { | ||
| totalLockCoinAmount := sdk.NewCoins() | ||
|
|
||
| // calculate lock amount | ||
| lockCoinAmount := sdk.NewCoins() | ||
| k.MultiStakingLockIterator(ctx, func(stakingLock types.MultiStakingLock) bool { | ||
| lockCoinAmount = lockCoinAmount.Add(stakingLock.LockedCoin.ToCoin()) | ||
| return false | ||
| }) | ||
| totalLockCoinAmount = totalLockCoinAmount.Add(lockCoinAmount...) | ||
|
|
||
| // calculate unlocking amount | ||
| unlockingCoinAmount := sdk.NewCoins() | ||
| k.MultiStakingUnlockIterator(ctx, func(unlock types.MultiStakingUnlock) bool { | ||
| for _, entry := range unlock.Entries { | ||
| unlockingCoinAmount = unlockingCoinAmount.Add(entry.UnlockingCoin.ToCoin()) | ||
| } | ||
| return false | ||
| }) | ||
| totalLockCoinAmount = totalLockCoinAmount.Add(unlockingCoinAmount...) | ||
|
|
||
| moduleAccount := authtypes.NewModuleAddress(types.ModuleName) | ||
| escrowBalances := k.bankKeeper.GetAllBalances(ctx, moduleAccount) | ||
|
|
||
| broken := !escrowBalances.IsAllGTE(totalLockCoinAmount) | ||
|
|
||
| return sdk.FormatInvariant( | ||
| types.ModuleName, | ||
| "ModuleAccountInvariants", | ||
| fmt.Sprintf( | ||
| "\tescrow coins balances: %v\n"+ | ||
| "\ttotal lock coin amount: %v\n", | ||
| escrowBalances, totalLockCoinAmount), | ||
| ), broken | ||
| } | ||
| } | ||
|
|
||
| func ValidatorLockDenomInvariants(k Keeper) sdk.Invariant { | ||
| return func(ctx sdk.Context) (string, bool) { | ||
| var ( | ||
| msg string | ||
| broken bool | ||
| ) | ||
|
|
||
| var multiStakingLocks []types.MultiStakingLock | ||
| k.MultiStakingLockIterator(ctx, func(stakingLock types.MultiStakingLock) bool { | ||
| multiStakingLocks = append(multiStakingLocks, stakingLock) | ||
| return false | ||
| }) | ||
|
|
||
| for _, lock := range multiStakingLocks { | ||
| valBench32Addr := lock.LockID.ValAddr | ||
| valAddr, _ := sdk.ValAddressFromBech32(valBench32Addr) | ||
| if valMsDenom := k.GetValidatorMultiStakingCoin(ctx, valAddr); valMsDenom != lock.LockedCoin.Denom { | ||
| broken = true | ||
| msg += fmt.Sprintf("validator lock denom invariants:\n\t"+ | ||
| "\tlock denom: %v allow denom: %v\n"+ | ||
| "\tlock: %v\n", | ||
| lock.LockedCoin.Denom, valMsDenom, lock) | ||
| } | ||
| } | ||
|
|
||
| var multiStakingUnlocks []types.MultiStakingUnlock | ||
| k.MultiStakingUnlockIterator(ctx, func(stakingUnlock types.MultiStakingUnlock) bool { | ||
| multiStakingUnlocks = append(multiStakingUnlocks, stakingUnlock) | ||
| return false | ||
| }) | ||
|
|
||
| for _, unlock := range multiStakingUnlocks { | ||
| valBench32Addr := unlock.UnlockID.ValAddr | ||
| valAddr, _ := sdk.ValAddressFromBech32(valBench32Addr) | ||
| valMsDenom := k.GetValidatorMultiStakingCoin(ctx, valAddr) | ||
|
|
||
| for _, entry := range unlock.Entries { | ||
| if entry.UnlockingCoin.Denom != valMsDenom { | ||
| broken = true | ||
| msg += fmt.Sprintf("validator unlock denom invariants:\n\t"+ | ||
| "\n\tunlock denom: %v allow denom: %v\n"+ | ||
| "\n\t entry height %v"+ | ||
| "\n\t validator address %s deladdress %s", | ||
| entry.UnlockingCoin.Denom, valMsDenom, entry.CreationHeight, unlock.UnlockID.ValAddr, unlock.UnlockID.MultiStakerAddr) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return sdk.FormatInvariant(types.ModuleName, "validator lock denom", fmt.Sprintf("found invalid validator lock denom\n%s", msg)), broken | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| package keeper_test | ||
|
|
||
| import ( | ||
| "time" | ||
|
|
||
| "github.com/realio-tech/multi-staking-module/testutil" | ||
| "github.com/realio-tech/multi-staking-module/x/multi-staking/keeper" | ||
| tmproto "github.com/tendermint/tendermint/proto/tendermint/types" | ||
|
|
||
| codectypes "github.com/cosmos/cosmos-sdk/codec/types" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types" | ||
| ) | ||
|
|
||
| func (suite *KeeperTestSuite) TestModuleAccountInvariants() { | ||
| delAddr := testutil.GenAddress() | ||
| priv, valAddr := testutil.GenValAddressWithPrivKey() | ||
| valPubKey := priv.PubKey() | ||
|
|
||
| testCases := []struct { | ||
| name string | ||
| malleate func() | ||
| expPass bool | ||
| }{ | ||
| { | ||
| name: "Success", | ||
| malleate: func() {}, | ||
| expPass: true, | ||
| }, | ||
| { | ||
| name: "Success Edit Validator", | ||
| malleate: func() { | ||
| suite.ctx = suite.ctx.WithBlockHeader(tmproto.Header{Time: time.Now()}) | ||
| newRate := sdk.MustNewDecFromStr("0.03") | ||
| newMinSelfDelegation := sdk.NewInt(300) | ||
| editMsg := stakingtypes.NewMsgEditValidator(valAddr, stakingtypes.Description{ | ||
| Moniker: "test 1", | ||
| Identity: "test 1", | ||
| Website: "test 1", | ||
| SecurityContact: "test 1", | ||
| Details: "test 1", | ||
| }, | ||
| &newRate, | ||
| &newMinSelfDelegation, | ||
| ) | ||
| _, err := suite.msgServer.EditValidator(suite.ctx, editMsg) | ||
| suite.Require().NoError(err) | ||
| }, | ||
| expPass: true, | ||
| }, | ||
| { | ||
| name: "Success Delegate", | ||
| malleate: func() { | ||
| bondAmount := sdk.NewCoin(MultiStakingDenomA, sdk.NewInt(1000)) | ||
| delMsg := stakingtypes.NewMsgDelegate(delAddr, valAddr, bondAmount) | ||
| _, err := suite.msgServer.Delegate(suite.ctx, delMsg) | ||
| suite.Require().NoError(err) | ||
| }, | ||
| expPass: true, | ||
| }, | ||
| { | ||
| name: "Success Delegate", | ||
| malleate: func() { | ||
| bondAmount := sdk.NewCoin(MultiStakingDenomA, sdk.NewInt(1000)) | ||
| delMsg := stakingtypes.NewMsgDelegate(delAddr, valAddr, bondAmount) | ||
| _, err := suite.msgServer.Delegate(suite.ctx, delMsg) | ||
| suite.Require().NoError(err) | ||
| }, | ||
| expPass: true, | ||
| }, | ||
| { | ||
| name: "Success BeginRedelegate", | ||
| malleate: func() { | ||
| priv, valAddr2 := testutil.GenValAddressWithPrivKey() | ||
| valPubKey2 := priv.PubKey() | ||
| bondAmount := sdk.NewCoin(MultiStakingDenomA, sdk.NewInt(500)) | ||
| createMsg2 := stakingtypes.MsgCreateValidator{ | ||
| Description: stakingtypes.Description{ | ||
| Moniker: "test", | ||
| Identity: "test", | ||
| Website: "test", | ||
| SecurityContact: "test", | ||
| Details: "test", | ||
| }, | ||
| Commission: stakingtypes.CommissionRates{ | ||
| Rate: sdk.MustNewDecFromStr("0.05"), | ||
| MaxRate: sdk.MustNewDecFromStr("0.1"), | ||
| MaxChangeRate: sdk.MustNewDecFromStr("0.1"), | ||
| }, | ||
| MinSelfDelegation: sdk.NewInt(200), | ||
| DelegatorAddress: delAddr.String(), | ||
| ValidatorAddress: valAddr2.String(), | ||
| Pubkey: codectypes.UnsafePackAny(valPubKey2), | ||
| Value: bondAmount, | ||
| } | ||
|
|
||
| _, err := suite.msgServer.CreateValidator(suite.ctx, &createMsg2) | ||
| suite.Require().NoError(err) | ||
|
|
||
| multiStakingMsg := stakingtypes.NewMsgBeginRedelegate(delAddr, valAddr, valAddr2, bondAmount) | ||
| _, err = suite.msgServer.BeginRedelegate(suite.ctx, multiStakingMsg) | ||
| suite.Require().NoError(err) | ||
| }, | ||
| expPass: true, | ||
| }, | ||
| { | ||
| name: "Success Undelegate", | ||
| malleate: func() { | ||
| bondAmount := sdk.NewCoin(MultiStakingDenomA, sdk.NewInt(250)) | ||
| multiStakingMsg := stakingtypes.NewMsgUndelegate(delAddr, valAddr, bondAmount) | ||
| _, err := suite.msgServer.Undelegate(suite.ctx, multiStakingMsg) | ||
| suite.Require().NoError(err) | ||
|
|
||
| bondAmount1 := sdk.NewCoin(MultiStakingDenomA, sdk.NewInt(500)) | ||
| multiStakingMsg1 := stakingtypes.NewMsgUndelegate(delAddr, valAddr, bondAmount1) | ||
| _, err = suite.msgServer.Undelegate(suite.ctx, multiStakingMsg1) | ||
| suite.Require().NoError(err) | ||
| }, | ||
| expPass: true, | ||
| }, | ||
| } | ||
| for _, tc := range testCases { | ||
| suite.SetupTest() // reset | ||
|
|
||
| valCoins := sdk.NewCoins(sdk.NewCoin(MultiStakingDenomA, sdk.NewInt(10000)), sdk.NewCoin(MultiStakingDenomB, sdk.NewInt(10000))) | ||
| err := suite.FundAccount(delAddr, valCoins) | ||
| suite.Require().NoError(err) | ||
|
|
||
| suite.msKeeper.SetBondWeight(suite.ctx, MultiStakingDenomA, sdk.MustNewDecFromStr("0.3")) | ||
| bondAmount := sdk.NewCoin(MultiStakingDenomA, sdk.NewInt(3001)) | ||
| msg := stakingtypes.MsgCreateValidator{ | ||
| Description: stakingtypes.Description{ | ||
| Moniker: "test", | ||
| Identity: "test", | ||
| Website: "test", | ||
| SecurityContact: "test", | ||
| Details: "test", | ||
| }, | ||
| Commission: stakingtypes.CommissionRates{ | ||
| Rate: sdk.MustNewDecFromStr("0.05"), | ||
| MaxRate: sdk.MustNewDecFromStr("0.1"), | ||
| MaxChangeRate: sdk.MustNewDecFromStr("0.05"), | ||
| }, | ||
| MinSelfDelegation: sdk.NewInt(1), | ||
| DelegatorAddress: delAddr.String(), | ||
| ValidatorAddress: valAddr.String(), | ||
| Pubkey: codectypes.UnsafePackAny(valPubKey), | ||
| Value: bondAmount, | ||
| } | ||
|
|
||
| _, err = suite.msgServer.CreateValidator(suite.ctx, &msg) | ||
| suite.Require().NoError(err) | ||
|
|
||
| tc.malleate() | ||
| _, broken := keeper.ModuleAccountInvariants(*suite.msKeeper)(suite.ctx) | ||
|
|
||
| if tc.expPass { | ||
| suite.Require().False(broken) | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why there's no fail case in this test
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
invariants should be success in any case
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there should be fail case in test, just set data in the store that causes it to fail