Merge branch 'main' into jim/internal-telemetry-core

cosmos · Jul 8, 2024 · f3066ef · f3066ef
2 parents 1260f26 + 45342f2
commit f3066ef
Show file tree

Hide file tree

Showing 11 changed files with 132 additions and 125 deletions.
diff --git a/modules/apps/29-fee/keeper/escrow_test.go b/modules/apps/29-fee/keeper/escrow_test.go
@@ -400,13 +400,18 @@ func (suite *KeeperTestSuite) TestRefundFeesOnChannelClosure() {
 		expEscrowBal            sdk.Coins
 		expRefundBal            sdk.Coins
 		refundAcc               sdk.AccAddress
-		fee                     types.Fee
 	)
 
+	fee := types.Fee{
+		RecvFee:    defaultRecvFee,
+		AckFee:     defaultAckFee,
+		TimeoutFee: defaultTimeoutFee,
+	}
+
 	testCases := []struct {
-		name     string
-		malleate func()
-		locked   bool
+		name      string
+		malleate  func()
+		expResult func(originalRefundBal, originalEscrowBal, refundBal, escrowBal sdk.Coins)
 	}{
 		{
 			"success", func() {
@@ -420,7 +425,12 @@ func (suite *KeeperTestSuite) TestRefundFeesOnChannelClosure() {
 					err := suite.chainA.GetSimApp().BankKeeper.SendCoinsFromAccountToModule(suite.chainA.GetContext(), refundAcc, types.ModuleName, fee.Total())
 					suite.Require().NoError(err)
 				}
-			}, false,
+			}, func(_, _, refundBal, escrowBal sdk.Coins) {
+				suite.Require().False(suite.chainA.GetSimApp().IBCFeeKeeper.IsLocked(suite.chainA.GetContext()))
+				suite.Require().Empty(suite.chainA.GetSimApp().IBCFeeKeeper.GetIdentifiedPacketFeesForChannel(suite.chainA.GetContext(), suite.path.EndpointA.ChannelConfig.PortID, suite.path.EndpointA.ChannelID))
+				suite.Require().Empty(escrowBal)
+				suite.Require().Equal(expRefundBal, refundBal)
+			},
 		},
 		{
 			"success with undistributed packet fees on a different channel", func() {
@@ -445,7 +455,12 @@ func (suite *KeeperTestSuite) TestRefundFeesOnChannelClosure() {
 
 				expEscrowBal = fee.Total()
 				expRefundBal = expRefundBal.Sub(fee.Total()...)
-			}, false,
+			}, func(_, _, refundBal, escrowBal sdk.Coins) {
+				suite.Require().False(suite.chainA.GetSimApp().IBCFeeKeeper.IsLocked(suite.chainA.GetContext()))
+				suite.Require().Empty(suite.chainA.GetSimApp().IBCFeeKeeper.GetIdentifiedPacketFeesForChannel(suite.chainA.GetContext(), suite.path.EndpointA.ChannelConfig.PortID, suite.path.EndpointA.ChannelID))
+				suite.Require().Equal(expEscrowBal, escrowBal)
+				suite.Require().Equal(expRefundBal, refundBal)
+			},
 		},
 		{
 			"escrow account empty, module should become locked", func() {
@@ -457,7 +472,12 @@ func (suite *KeeperTestSuite) TestRefundFeesOnChannelClosure() {
 				suite.chainA.GetSimApp().IBCFeeKeeper.SetFeesInEscrow(suite.chainA.GetContext(), packetID, packetFees)
 
 				expIdentifiedPacketFees = []types.IdentifiedPacketFees{identifiedPacketFees}
-			}, true,
+			}, func(originalRefundBal, originalEscrowBal, refundBal, escrowBal sdk.Coins) {
+				suite.Require().True(suite.chainA.GetSimApp().IBCFeeKeeper.IsLocked(suite.chainA.GetContext()))
+				suite.Require().Equal(expIdentifiedPacketFees, suite.chainA.GetSimApp().IBCFeeKeeper.GetIdentifiedPacketFeesForChannel(suite.chainA.GetContext(), suite.path.EndpointA.ChannelConfig.PortID, suite.path.EndpointA.ChannelID))
+				suite.Require().Equal(originalRefundBal, refundBal)
+				suite.Require().Equal(originalEscrowBal, escrowBal)
+			},
 		},
 		{
 			"escrow account goes negative on second packet, module should become locked", func() {
@@ -476,7 +496,12 @@ func (suite *KeeperTestSuite) TestRefundFeesOnChannelClosure() {
 				suite.Require().NoError(err)
 
 				expIdentifiedPacketFees = []types.IdentifiedPacketFees{identifiedPacketFee1, identifiedPacketFee2}
-			}, true,
+			}, func(originalRefundBal, originalEscrowBal, refundBal, escrowBal sdk.Coins) {
+				suite.Require().True(suite.chainA.GetSimApp().IBCFeeKeeper.IsLocked(suite.chainA.GetContext()))
+				suite.Require().Equal(expIdentifiedPacketFees, suite.chainA.GetSimApp().IBCFeeKeeper.GetIdentifiedPacketFeesForChannel(suite.chainA.GetContext(), suite.path.EndpointA.ChannelConfig.PortID, suite.path.EndpointA.ChannelID))
+				suite.Require().Equal(originalRefundBal, refundBal)
+				suite.Require().Equal(originalEscrowBal, escrowBal)
+			},
 		},
 		{
 			"invalid refund acc address", func() {
@@ -497,7 +522,12 @@ func (suite *KeeperTestSuite) TestRefundFeesOnChannelClosure() {
 
 				expEscrowBal = fee.Total()
 				expRefundBal = expRefundBal.Sub(fee.Total()...)
-			}, false,
+			}, func(_, _, refundBal, escrowBal sdk.Coins) {
+				suite.Require().False(suite.chainA.GetSimApp().IBCFeeKeeper.IsLocked(suite.chainA.GetContext()))
+				suite.Require().Equal(expIdentifiedPacketFees, suite.chainA.GetSimApp().IBCFeeKeeper.GetIdentifiedPacketFeesForChannel(suite.chainA.GetContext(), suite.path.EndpointA.ChannelConfig.PortID, suite.path.EndpointA.ChannelID))
+				suite.Require().Equal(expEscrowBal, escrowBal)
+				suite.Require().Equal(expRefundBal, refundBal)
+			},
 		},
 		{
 			"distributing to blocked address is skipped", func() {
@@ -520,7 +550,12 @@ func (suite *KeeperTestSuite) TestRefundFeesOnChannelClosure() {
 
 				expEscrowBal = fee.Total()
 				expRefundBal = expRefundBal.Sub(fee.Total()...)
-			}, false,
+			}, func(_, _, refundBal, escrowBal sdk.Coins) {
+				suite.Require().False(suite.chainA.GetSimApp().IBCFeeKeeper.IsLocked(suite.chainA.GetContext()))
+				suite.Require().Equal(expIdentifiedPacketFees, suite.chainA.GetSimApp().IBCFeeKeeper.GetIdentifiedPacketFeesForChannel(suite.chainA.GetContext(), suite.path.EndpointA.ChannelConfig.PortID, suite.path.EndpointA.ChannelID))
+				suite.Require().Equal(expEscrowBal, escrowBal)
+				suite.Require().Equal(expRefundBal, refundBal)
+			},
 		},
 	}
 
@@ -531,46 +566,29 @@ func (suite *KeeperTestSuite) TestRefundFeesOnChannelClosure() {
 			suite.SetupTest()  // reset
 			suite.path.Setup() // setup channel
 			expIdentifiedPacketFees = []types.IdentifiedPacketFees(nil)
-			expEscrowBal = sdk.Coins{}
 
-			// setup
 			refundAcc = suite.chainA.SenderAccount.GetAddress()
 			moduleAcc := suite.chainA.GetSimApp().IBCFeeKeeper.GetFeeModuleAddress()
 
 			// expected refund balance if the refunds are successful
 			// NOTE: tc.malleate() should transfer from refund balance to correctly set the escrow balance
 			expRefundBal = suite.chainA.GetSimApp().BankKeeper.GetAllBalances(suite.chainA.GetContext(), refundAcc)
 
-			fee = types.Fee{
-				RecvFee:    defaultRecvFee,
-				AckFee:     defaultAckFee,
-				TimeoutFee: defaultTimeoutFee,
-			}
-
 			tc.malleate()
 
-			// refundAcc balance before distribution
+			// original balance before RefundFeesOnChannelClosure
 			originalRefundBal := suite.chainA.GetSimApp().BankKeeper.GetAllBalances(suite.chainA.GetContext(), refundAcc)
 			originalEscrowBal := suite.chainA.GetSimApp().BankKeeper.GetAllBalances(suite.chainA.GetContext(), moduleAcc)
 
+			// perform refund fees on channel closure
 			err := suite.chainA.GetSimApp().IBCFeeKeeper.RefundFeesOnChannelClosure(suite.chainA.GetContext(), suite.path.EndpointA.ChannelConfig.PortID, suite.path.EndpointA.ChannelID)
-			suite.Require().NoError(err)
+			suite.NoError(err)
 
 			// refundAcc balance after RefundFeesOnChannelClosure
 			refundBal := suite.chainA.GetSimApp().BankKeeper.GetAllBalances(suite.chainA.GetContext(), refundAcc)
 			escrowBal := suite.chainA.GetSimApp().BankKeeper.GetAllBalances(suite.chainA.GetContext(), moduleAcc)
 
-			suite.Require().Equal(tc.locked, suite.chainA.GetSimApp().IBCFeeKeeper.IsLocked(suite.chainA.GetContext()))
-			suite.Require().Equal(expIdentifiedPacketFees, suite.chainA.GetSimApp().IBCFeeKeeper.GetIdentifiedPacketFeesForChannel(suite.chainA.GetContext(), suite.path.EndpointA.ChannelConfig.PortID, suite.path.EndpointA.ChannelID))
-
-			if tc.locked {
-				// refund account and escrow account balances should remain unchanged
-				suite.Require().Equal(originalRefundBal, refundBal)
-				suite.Require().Equal(originalEscrowBal, escrowBal)
-			} else {
-				suite.Require().Equal(expEscrowBal, escrowBal) // escrow balance should be empty
-				suite.Require().Equal(expRefundBal, refundBal) // all packets should have been refunded
-			}
+			tc.expResult(originalRefundBal, originalEscrowBal, refundBal, escrowBal)
 		})
 	}
 }
diff --git a/modules/apps/callbacks/ibc_middleware_test.go b/modules/apps/callbacks/ibc_middleware_test.go
@@ -25,8 +25,6 @@ import (
 	ibcmock "github.com/cosmos/ibc-go/v8/testing/mock"
 )
 
-var emptyForwardingPacketData = transfertypes.ForwardingPacketData{}
-
 func (s *CallbacksTestSuite) TestNewIBCMiddleware() {
 	testCases := []struct {
 		name          string
@@ -189,7 +187,7 @@ func (s *CallbacksTestSuite) TestSendPacket() {
 				ibctesting.TestAccAddress,
 				ibctesting.TestAccAddress,
 				fmt.Sprintf(`{"src_callback": {"address": "%s"}}`, simapp.SuccessContract),
-				emptyForwardingPacketData,
+				ibctesting.EmptyForwardingPacketData,
 			)
 
 			chanCap := s.path.EndpointA.Chain.GetChannelCapability(s.path.EndpointA.ChannelConfig.PortID, s.path.EndpointA.ChannelID)
@@ -331,7 +329,7 @@ func (s *CallbacksTestSuite) TestOnAcknowledgementPacket() {
 				ibctesting.TestAccAddress,
 				ibctesting.TestAccAddress,
 				fmt.Sprintf(`{"src_callback": {"address":"%s", "gas_limit":"%d"}}`, simapp.SuccessContract, userGasLimit),
-				emptyForwardingPacketData,
+				ibctesting.EmptyForwardingPacketData,
 			)
 
 			packet = channeltypes.Packet{
@@ -665,7 +663,7 @@ func (s *CallbacksTestSuite) TestOnRecvPacket() {
 				ibctesting.TestAccAddress,
 				s.chainB.SenderAccount.GetAddress().String(),
 				fmt.Sprintf(`{"dest_callback": {"address":"%s", "gas_limit":"%d"}}`, ibctesting.TestAccAddress, userGasLimit),
-				emptyForwardingPacketData,
+				ibctesting.EmptyForwardingPacketData,
 			)
 
 			packet = channeltypes.Packet{
@@ -797,7 +795,7 @@ func (s *CallbacksTestSuite) TestWriteAcknowledgement() {
 				ibctesting.TestAccAddress,
 				s.chainB.SenderAccount.GetAddress().String(),
 				fmt.Sprintf(`{"dest_callback": {"address":"%s", "gas_limit":"600000"}}`, ibctesting.TestAccAddress),
-				emptyForwardingPacketData,
+				ibctesting.EmptyForwardingPacketData,
 			)
 
 			packet = channeltypes.Packet{
@@ -1021,7 +1019,7 @@ func (s *CallbacksTestSuite) TestUnmarshalPacketDataV1() {
 		Sender:     ibctesting.TestAccAddress,
 		Receiver:   ibctesting.TestAccAddress,
 		Memo:       fmt.Sprintf(`{"src_callback": {"address": "%s"}, "dest_callback": {"address":"%s"}}`, ibctesting.TestAccAddress, ibctesting.TestAccAddress),
-		Forwarding: emptyForwardingPacketData,
+		Forwarding: ibctesting.EmptyForwardingPacketData,
 	}
 
 	portID := s.path.EndpointA.ChannelConfig.PortID

diff --git a/modules/apps/transfer/ibc_module_test.go b/modules/apps/transfer/ibc_module_test.go
@@ -367,7 +367,7 @@ func (suite *TransferTestSuite) TestOnRecvPacket() {
 				suite.chainA.SenderAccount.GetAddress().String(),
 				suite.chainB.SenderAccount.GetAddress().String(),
 				"",
-				types.ForwardingPacketData{},
+				ibctesting.EmptyForwardingPacketData,
 			)
 
 			tokensBz, err := json.Marshal(packetData.Tokens)

diff --git a/modules/apps/transfer/internal/packet_test.go b/modules/apps/transfer/internal/packet_test.go
@@ -16,8 +16,6 @@ const (
 	receiver = "receiver"
 )
 
-var emptyForwardingPacketData = types.ForwardingPacketData{}
-
 func TestUnmarshalPacketData(t *testing.T) {
 	var (
 		packetDataBz []byte
@@ -43,7 +41,7 @@ func TestUnmarshalPacketData(t *testing.T) {
 							Denom:  types.NewDenom("atom", types.NewHop("transfer", "channel-0")),
 							Amount: "1000",
 						},
-					}, sender, receiver, "", emptyForwardingPacketData)
+					}, sender, receiver, "", types.ForwardingPacketData{})
 
 				packetDataBz = packetData.GetBytes()
 				version = types.V2
@@ -115,7 +113,7 @@ func TestV2ForwardsCompatibilityFails(t *testing.T) {
 					Denom:  types.NewDenom("atom", types.NewHop("transfer", "channel-0")),
 					Amount: "1000",
 				},
-			}, "sender", "receiver", "", emptyForwardingPacketData,
+			}, "sender", "receiver", "", types.ForwardingPacketData{},
 		)
 
 		packetDataBz = packet.GetBytes()
@@ -155,7 +153,7 @@ func TestPacketV1ToPacketV2(t *testing.T) {
 						Denom:  types.NewDenom("atom", types.NewHop("transfer", "channel-0")),
 						Amount: "1000",
 					},
-				}, sender, receiver, "", emptyForwardingPacketData),
+				}, sender, receiver, "", types.ForwardingPacketData{}),
 			nil,
 		},
 		{
@@ -167,7 +165,7 @@ func TestPacketV1ToPacketV2(t *testing.T) {
 						Denom:  types.NewDenom("atom"),
 						Amount: "1000",
 					},
-				}, sender, receiver, "", emptyForwardingPacketData),
+				}, sender, receiver, "", types.ForwardingPacketData{}),
 			nil,
 		},
 		{
@@ -179,7 +177,7 @@ func TestPacketV1ToPacketV2(t *testing.T) {
 						Denom:  types.NewDenom("atom/withslash", types.NewHop("transfer", "channel-0")),
 						Amount: "1000",
 					},
-				}, sender, receiver, "", emptyForwardingPacketData),
+				}, sender, receiver, "", types.ForwardingPacketData{}),
 			nil,
 		},
 		{
@@ -191,7 +189,7 @@ func TestPacketV1ToPacketV2(t *testing.T) {
 						Denom:  types.NewDenom("atom/", types.NewHop("transfer", "channel-0")),
 						Amount: "1000",
 					},
-				}, sender, receiver, "", emptyForwardingPacketData),
+				}, sender, receiver, "", types.ForwardingPacketData{}),
 			nil,
 		},
 		{
@@ -203,7 +201,7 @@ func TestPacketV1ToPacketV2(t *testing.T) {
 						Denom:  types.NewDenom("atom/pool", types.NewHop("transfer", "channel-0"), types.NewHop("transfer", "channel-1")),
 						Amount: "1000",
 					},
-				}, sender, receiver, "", emptyForwardingPacketData),
+				}, sender, receiver, "", types.ForwardingPacketData{}),
 			nil,
 		},
 		{
@@ -215,7 +213,7 @@ func TestPacketV1ToPacketV2(t *testing.T) {
 						Denom:  types.NewDenom("atom", types.NewHop("transfer", "channel-0"), types.NewHop("transfer", "channel-1"), types.NewHop("transfer-custom", "channel-2")),
 						Amount: "1000",
 					},
-				}, sender, receiver, "", emptyForwardingPacketData),
+				}, sender, receiver, "", types.ForwardingPacketData{}),
 			nil,
 		},
 		{
@@ -227,7 +225,7 @@ func TestPacketV1ToPacketV2(t *testing.T) {
 						Denom:  types.NewDenom("atom/pool", types.NewHop("transfer", "channel-0"), types.NewHop("transfer", "channel-1"), types.NewHop("transfer-custom", "channel-2")),
 						Amount: "1000",
 					},
-				}, sender, receiver, "", emptyForwardingPacketData),
+				}, sender, receiver, "", types.ForwardingPacketData{}),
 			nil,
 		},
 		{

diff --git a/modules/apps/transfer/keeper/mbt_relay_test.go b/modules/apps/transfer/keeper/mbt_relay_test.go
@@ -159,7 +159,7 @@ func FungibleTokenPacketFromTla(packet TlaFungibleTokenPacket) FungibleTokenPack
 			AddressFromString(packet.Data.Sender),
 			AddressFromString(packet.Data.Receiver),
 			"",
-			types.ForwardingPacketData{},
+			ibctesting.EmptyForwardingPacketData,
 		),
 	}
 }

diff --git a/modules/apps/transfer/keeper/relay_forwarding_test.go b/modules/apps/transfer/keeper/relay_forwarding_test.go
@@ -947,7 +947,7 @@ func (suite *KeeperTestSuite) TestOnTimeoutPacketForwarding() {
 		},
 		address,
 		receiver.GetAddress().String(),
-		"", types.ForwardingPacketData{},
+		"", ibctesting.EmptyForwardingPacketData,
 	)
 
 	packet = channeltypes.NewPacket(