refactor: simplify logic for asserting invariant

modules/apps/transfer/keeper/invariants.go

@@ -25,40 +25,27 @@ func AllInvariants(k *Keeper) sdk.Invariant {
 // each denom is not smaller than the amount stored in the state entry.
 func TotalEscrowPerDenomInvariants(k *Keeper) sdk.Invariant {
 	return func(ctx sdk.Context) (string, bool) {
-		var (
-			msg                     string
-			broken                  bool
-			totalEscrowedInAccounts sdk.Coins
-		)
+		var actualTotalEscrowed sdk.Coins
 
-		totalEscrowedInState := k.GetAllTotalEscrowed(ctx)
+		expectedTotalEscrowed := k.GetAllTotalEscrowed(ctx)
 
 		portID := k.GetPort(ctx)
 		transferChannels := k.channelKeeper.GetAllChannelsWithPortPrefix(ctx, portID)
 		for _, channel := range transferChannels {
 			escrowAddress := types.GetEscrowAddress(portID, channel.ChannelId)
 			escrowBalances := k.bankKeeper.GetAllBalances(ctx, escrowAddress)
 
-			totalEscrowedInAccounts = totalEscrowedInAccounts.Add(escrowBalances...)
+			actualTotalEscrowed = actualTotalEscrowed.Add(escrowBalances...)
 		}
 
-		for _, expectedEscrow := range totalEscrowedInState {
-			if found, actualEscrow := totalEscrowedInAccounts.Find(expectedEscrow.GetDenom()); found {
-				if expectedEscrow.Amount.GT(actualEscrow.Amount) {
-					broken = true
-					msg += fmt.Sprintf("\tdenom: %s, actual escrow (%s) is < expected escrow (%s)\n", expectedEscrow.GetDenom(), actualEscrow.Amount, expectedEscrow.Amount)
-				}
-			}
-		}
-
-		if broken {
-			// the total amount for each denom in escrow should be >= the amount stored in state for each denom
+		// the actual escrowed amount must be greater than or equal to the expected amount for all denominations
+		if !actualTotalEscrowed.IsAllGTE(expectedTotalEscrowed) {
 			return sdk.FormatInvariant(
 				types.ModuleName,
 				"total escrow per denom invariance",
-				fmt.Sprintf("found denom(s) with total escrow amount lower than expected:\n%s", msg)), broken
+				fmt.Sprintf("found denom(s) with total escrow amount lower than expected:\nactual total escrowed: %s\nexpected total escrowed: %s", actualTotalEscrowed, expectedTotalEscrowed)), true
 		}
 
-		return "", broken
+		return "", false
 	}
 }

modules/apps/transfer/keeper/invariants_test.go

@@ -1,8 +1,6 @@
 package keeper_test
 
 import (
-	"fmt"
-
 	"cosmossdk.io/math"
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
@@ -39,7 +37,6 @@ func (suite *KeeperTestSuite) TestTotalEscrowPerDenomInvariant() {
 			suite.SetupTest() // reset
 			path := NewTransferPath(suite.chainA, suite.chainB)
 			suite.coordinator.Setup(path)
-			ctx := suite.chainA.GetContext()
 
 			amount := math.NewInt(100)
 
@@ -54,23 +51,20 @@ func (suite *KeeperTestSuite) TestTotalEscrowPerDenomInvariant() {
 				suite.chainA.GetTimeoutHeight(), 0, "",
 			)
 
-			res, err := suite.chainA.GetSimApp().TransferKeeper.Transfer(sdk.WrapSDKContext(ctx), msg)
+			res, err := suite.chainA.SendMsgs(msg)
 			suite.Require().NoError(err)
 			suite.Require().NotNil(res)
 
 			tc.malleate()
 
-			out, broken := keeper.TotalEscrowPerDenomInvariants(&suite.chainA.GetSimApp().TransferKeeper)(ctx)
+			out, broken := keeper.TotalEscrowPerDenomInvariants(&suite.chainA.GetSimApp().TransferKeeper)(suite.chainA.GetContext())
 
 			if tc.expPass {
 				suite.Require().False(broken)
 				suite.Require().Empty(out)
 			} else {
 				suite.Require().True(broken)
-
-				escrow := suite.chainA.GetSimApp().TransferKeeper.GetTotalEscrowForDenom(ctx, sdk.DefaultBondDenom)
-				expOut := fmt.Sprintf("denom: %s, actual escrow (%s) is < expected escrow (%s)\n", sdk.DefaultBondDenom, amount, escrow)
-				suite.Require().Contains(out, expOut)
+				suite.Require().NotEmpty(out)
 			}
 		})
 	}