chore: remove unused ics29 keeper funcs (#1044)

* removing keys, adding additional test, moving event attribute keys

* removing unused code and updating tests

* removing unused IdentifiedPacketFee type

docs/ibc/proto-docs.md

@@ -30,7 +30,6 @@
 
 - [ibc/applications/fee/v1/fee.proto](#ibc/applications/fee/v1/fee.proto)
     - [Fee](#ibc.applications.fee.v1.Fee)
-    - [IdentifiedPacketFee](#ibc.applications.fee.v1.IdentifiedPacketFee)
     - [IdentifiedPacketFees](#ibc.applications.fee.v1.IdentifiedPacketFees)
     - [PacketFee](#ibc.applications.fee.v1.PacketFee)
     - [PacketFees](#ibc.applications.fee.v1.PacketFees)
@@ -726,27 +725,6 @@ https://github.com/cosmos/ibc/tree/master/spec/app/ics-029-fee-payment#fee-middl
 
 
 
-<a name="ibc.applications.fee.v1.IdentifiedPacketFee"></a>
-
-### IdentifiedPacketFee
-IdentifiedPacketFee contains the relayer fee along with the associated metadata needed to process it.
-This includes the PacketId identifying the packet the fee is paying for,
-the refund address to which any unused funds are refunded,
-and an optional list of relayers that are permitted to receive the fee.
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| `packet_id` | [ibc.core.channel.v1.PacketId](#ibc.core.channel.v1.PacketId) |  |  |
-| `fee` | [Fee](#ibc.applications.fee.v1.Fee) |  |  |
-| `refund_address` | [string](#string) |  |  |
-| `relayers` | [string](#string) | repeated |  |
-
-
-
-
-
-
 <a name="ibc.applications.fee.v1.IdentifiedPacketFees"></a>
 
 ### IdentifiedPacketFees

modules/apps/29-fee/keeper/escrow_test.go

@@ -179,10 +179,6 @@ func (suite *KeeperTestSuite) TestDistributeFee() {
 			suite.chainA.GetSimApp().IBCFeeKeeper.DistributePacketFees(suite.chainA.GetContext(), forwardRelayer, reverseRelayer, []types.PacketFee{packetFee, packetFee})
 
 			if tc.expPass {
-				// there should no longer be a fee in escrow for this packet
-				found := suite.chainA.GetSimApp().IBCFeeKeeper.HasFeeInEscrow(suite.chainA.GetContext(), packetID)
-				suite.Require().False(found)
-
 				// check if the reverse relayer is paid
 				hasBalance := suite.chainA.GetSimApp().BankKeeper.HasBalance(suite.chainA.GetContext(), reverseRelayer, fee.AckFee[0].Add(fee.AckFee[0]))
 				suite.Require().True(hasBalance)

modules/apps/29-fee/keeper/keeper.go

@@ -225,26 +225,6 @@ func (k Keeper) DeleteForwardRelayerAddress(ctx sdk.Context, packetID channeltyp
 	store.Delete(key)
 }
 
-// Stores a Fee for a given packet in state
-func (k Keeper) SetFeeInEscrow(ctx sdk.Context, fee types.IdentifiedPacketFee) {
-	store := ctx.KVStore(k.storeKey)
-	bz := k.MustMarshalFee(&fee)
-	store.Set(types.KeyFeeInEscrow(fee.PacketId), bz)
-}
-
-// Gets a Fee for a given packet
-func (k Keeper) GetFeeInEscrow(ctx sdk.Context, packetID channeltypes.PacketId) (types.IdentifiedPacketFee, bool) {
-	store := ctx.KVStore(k.storeKey)
-	key := types.KeyFeeInEscrow(packetID)
-	bz := store.Get(key)
-	if bz == nil {
-		return types.IdentifiedPacketFee{}, false
-	}
-	fee := k.MustUnmarshalFee(bz)
-
-	return fee, true
-}
-
 // GetFeesInEscrow returns all escrowed packet fees for a given packetID
 func (k Keeper) GetFeesInEscrow(ctx sdk.Context, packetID channeltypes.PacketId) (types.PacketFees, bool) {
 	store := ctx.KVStore(k.storeKey)
@@ -265,7 +245,7 @@ func (k Keeper) HasFeesInEscrow(ctx sdk.Context, packetID channeltypes.PacketId)
 	return store.Has(key)
 }
 
-// SetFeesInEscrow sets the given packet fees in escrow keyed by the packetID 
+// SetFeesInEscrow sets the given packet fees in escrow keyed by the packetID
 func (k Keeper) SetFeesInEscrow(ctx sdk.Context, packetID channeltypes.PacketId, fees types.PacketFees) {
 	store := ctx.KVStore(k.storeKey)
 	bz := k.MustMarshalFees(fees)
@@ -294,36 +274,6 @@ func (k Keeper) IteratePacketFeesInEscrow(ctx sdk.Context, portID, channelID str
 	}
 }
 
-// IterateChannelFeesInEscrow iterates over all the fees on the given channel currently escrowed and calls the provided callback
-// if the callback returns true, then iteration is stopped.
-func (k Keeper) IterateChannelFeesInEscrow(ctx sdk.Context, portID, channelID string, cb func(identifiedFee types.IdentifiedPacketFee) (stop bool)) {
-	store := ctx.KVStore(k.storeKey)
-	iterator := sdk.KVStorePrefixIterator(store, types.KeyFeeInEscrowChannelPrefix(portID, channelID))
-
-	defer iterator.Close()
-	for ; iterator.Valid(); iterator.Next() {
-		identifiedFee := k.MustUnmarshalFee(iterator.Value())
-		if cb(identifiedFee) {
-			break
-		}
-	}
-}
-
-// Deletes the fee associated with the given packetID
-func (k Keeper) DeleteFeeInEscrow(ctx sdk.Context, packetID channeltypes.PacketId) {
-	store := ctx.KVStore(k.storeKey)
-	key := types.KeyFeeInEscrow(packetID)
-	store.Delete(key)
-}
-
-// HasFeeInEscrow returns true if there is a Fee still to be escrowed for a given packet
-func (k Keeper) HasFeeInEscrow(ctx sdk.Context, packetID channeltypes.PacketId) bool {
-	store := ctx.KVStore(k.storeKey)
-	key := types.KeyFeeInEscrow(packetID)
-
-	return store.Has(key)
-}
-
 // GetAllIdentifiedPacketFees returns a list of all IdentifiedPacketFees that are stored in state
 func (k Keeper) GetAllIdentifiedPacketFees(ctx sdk.Context) []types.IdentifiedPacketFees {
 	store := ctx.KVStore(k.storeKey)
@@ -350,20 +300,6 @@ func (k Keeper) GetAllIdentifiedPacketFees(ctx sdk.Context) []types.IdentifiedPa
 	return identifiedFees
 }
 
-// MustMarshalFee attempts to encode a Fee object and returns the
-// raw encoded bytes. It panics on error.
-func (k Keeper) MustMarshalFee(fee *types.IdentifiedPacketFee) []byte {
-	return k.cdc.MustMarshal(fee)
-}
-
-// MustUnmarshalFee attempts to decode and return a Fee object from
-// raw encoded bytes. It panics on error.
-func (k Keeper) MustUnmarshalFee(bz []byte) types.IdentifiedPacketFee {
-	var fee types.IdentifiedPacketFee
-	k.cdc.MustUnmarshal(bz, &fee)
-	return fee
-}
-
 // MustMarshalFees attempts to encode a Fee object and returns the
 // raw encoded bytes. It panics on error.
 func (k Keeper) MustMarshalFees(fees types.PacketFees) []byte {

modules/apps/29-fee/keeper/keeper_test.go

@@ -1,6 +1,7 @@
 package keeper_test
 
 import (
+	"fmt"
 	"testing"
 
 	"github.com/cosmos/cosmos-sdk/baseapp"
@@ -66,30 +67,27 @@ func TestKeeperTestSuite(t *testing.T) {
 	suite.Run(t, new(KeeperTestSuite))
 }
 
-func (suite *KeeperTestSuite) TestFeeInEscrow() {
+func (suite *KeeperTestSuite) TestFeesInEscrow() {
 	suite.coordinator.Setup(suite.path)
 
-	fee := types.Fee{RecvFee: defaultReceiveFee, AckFee: defaultAckFee, TimeoutFee: defaultTimeoutFee}
+	// escrow five fees for packet sequence 1
+	packetID := channeltypes.NewPacketId(suite.path.EndpointA.ChannelID, suite.path.EndpointA.ChannelConfig.PortID, 1)
+	fee := types.NewFee(defaultReceiveFee, defaultAckFee, defaultTimeoutFee)
 
-	// set some fees
 	for i := 1; i < 6; i++ {
-		packetId := channeltypes.NewPacketId(suite.path.EndpointA.ChannelID, suite.path.EndpointA.ChannelConfig.PortID, uint64(i))
-		fee := types.NewIdentifiedPacketFee(packetId, fee, suite.chainA.SenderAccount.GetAddress().String(), []string{})
-		suite.chainA.GetSimApp().IBCFeeKeeper.SetFeeInEscrow(suite.chainA.GetContext(), fee)
+		packetFee := types.NewPacketFee(fee, suite.chainA.SenderAccount.GetAddress().String(), nil)
+		suite.chainA.GetSimApp().IBCFeeKeeper.EscrowPacketFee(suite.chainA.GetContext(), packetID, packetFee)
 	}
 
-	// delete 1 fee
-	packetId := channeltypes.NewPacketId(suite.path.EndpointA.ChannelID, suite.path.EndpointA.ChannelConfig.PortID, 3)
-	suite.chainA.GetSimApp().IBCFeeKeeper.DeleteFeeInEscrow(suite.chainA.GetContext(), packetId)
-
-	// iterate over remaining fees
-	arr := []int64{}
-	expectedArr := []int64{1, 2, 4, 5}
-	suite.chainA.GetSimApp().IBCFeeKeeper.IterateChannelFeesInEscrow(suite.chainA.GetContext(), suite.path.EndpointA.ChannelConfig.PortID, suite.path.EndpointA.ChannelID, func(identifiedFee types.IdentifiedPacketFee) (stop bool) {
-		arr = append(arr, int64(identifiedFee.PacketId.Sequence))
-		return false
-	})
-	suite.Require().Equal(expectedArr, arr, "did not retrieve expected fees during iteration")
+	// retrieve the fees in escrow and assert the length of PacketFees
+	feesInEscrow, found := suite.chainA.GetSimApp().IBCFeeKeeper.GetFeesInEscrow(suite.chainA.GetContext(), packetID)
+	suite.Require().True(found)
+	suite.Require().Len(feesInEscrow.PacketFees, 5, fmt.Sprintf("expected length 5, but got %d", len(feesInEscrow.PacketFees)))
+
+	// delete fees for packet sequence 1
+	suite.chainA.GetSimApp().IBCFeeKeeper.DeleteFeesInEscrow(suite.chainA.GetContext(), packetID)
+	hasFeesInEscrow := suite.chainA.GetSimApp().IBCFeeKeeper.HasFeesInEscrow(suite.chainA.GetContext(), packetID)
+	suite.Require().False(hasFeesInEscrow)
 }
 
 func (suite *KeeperTestSuite) TestDisableAllChannels() {

modules/apps/29-fee/types/events.go

@@ -3,4 +3,8 @@ package types
 // 29-fee events
 const (
 	EventTypeIncentivizedPacket = "incentivized_ibc_packet"
+
+	AttributeKeyRecvFee    = "recv_fee"
+	AttributeKeyAckFee     = "ack_fee"
+	AttributeKeyTimeoutFee = "timeout_fee"
 )