package keeper import ( "fmt" sdk "github.com/cosmos/cosmos-sdk/types" "github.com/cosmos/cosmos-sdk/x/bank/types" ) // RegisterInvariants registers the bank module invariants func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper) { ir.RegisterRoute(types.ModuleName, "nonnegative-outstanding", NonnegativeBalanceInvariant(k)) ir.RegisterRoute(types.ModuleName, "total-supply", TotalSupply(k)) } // AllInvariants runs all invariants of the X/bank module. func AllInvariants(k Keeper) sdk.Invariant { return func(ctx sdk.Context) (string, bool) { return TotalSupply(k)(ctx) } } // NonnegativeBalanceInvariant checks that all accounts in the application have non-negative balances func NonnegativeBalanceInvariant(k ViewKeeper) sdk.Invariant { return func(ctx sdk.Context) (string, bool) { var ( msg string count int ) k.IterateAllBalances(ctx, func(addr sdk.AccAddress, balance sdk.Coin) bool { if balance.IsNegative() { count++ msg += fmt.Sprintf("\t%s has a negative balance of %s\n", addr, balance) } return false }) broken := count != 0 return sdk.FormatInvariant( types.ModuleName, "nonnegative-outstanding", fmt.Sprintf("amount of negative balances found %d\n%s", count, msg), ), broken } } // TotalSupply checks that the total supply reflects all the coins held in accounts func TotalSupply(k Keeper) sdk.Invariant { return func(ctx sdk.Context) (string, bool) { expectedTotal := sdk.Coins{} supply := k.GetSupply(ctx) k.IterateAllBalances(ctx, func(_ sdk.AccAddress, balance sdk.Coin) bool { expectedTotal = expectedTotal.Add(balance) return false }) broken := !expectedTotal.IsEqual(supply.GetTotal()) return sdk.FormatInvariant(types.ModuleName, "total supply", fmt.Sprintf( "\tsum of accounts coins: %v\n"+ "\tsupply.Total: %v\n", expectedTotal, supply.GetTotal())), broken } }