Skip to content

Commit 1b68635

Browse files
committed
chore: lint and remove some todos.
1 parent fcfe4b5 commit 1b68635

File tree

8 files changed

+25
-30
lines changed

8 files changed

+25
-30
lines changed

modules/apps/27-interchain-accounts/controller/ibc_middleware_test.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1276,15 +1276,15 @@ func (suite *InterchainAccountsTestSuite) TestPacketDataUnmarshalerInterface() {
12761276
Memo: "",
12771277
}
12781278

1279-
ctx := suite.chainA.GetContext()
1280-
1281-
packetData, err := controller.IBCMiddleware{}.UnmarshalPacketData(ctx, "", "", expPacketData.GetBytes())
1279+
// Context, port identifier and channel identifier are unused for controller.
1280+
packetData, err := controller.IBCMiddleware{}.UnmarshalPacketData(suite.chainA.GetContext(), "", "", expPacketData.GetBytes())
12821281
suite.Require().NoError(err)
12831282
suite.Require().Equal(expPacketData, packetData)
12841283

12851284
// test invalid packet data
12861285
invalidPacketData := []byte("invalid packet data")
1287-
packetData, err = controller.IBCMiddleware{}.UnmarshalPacketData(ctx, "", "", invalidPacketData)
1286+
// Context, port identifier and channel identifier are not used for controller.
1287+
packetData, err = controller.IBCMiddleware{}.UnmarshalPacketData(suite.chainA.GetContext(), "", "", invalidPacketData)
12881288
suite.Require().Error(err)
12891289
suite.Require().Nil(packetData)
12901290
}

modules/apps/27-interchain-accounts/host/ibc_module_test.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -883,15 +883,15 @@ func (suite *InterchainAccountsTestSuite) TestPacketDataUnmarshalerInterface() {
883883
Memo: "",
884884
}
885885

886-
ctx := suite.chainA.GetContext()
887-
888-
packetData, err := icahost.IBCModule{}.UnmarshalPacketData(ctx, "", "", expPacketData.GetBytes())
886+
// Context, port identifier and channel identifier are unused for host.
887+
packetData, err := icahost.IBCModule{}.UnmarshalPacketData(suite.chainA.GetContext(), "", "", expPacketData.GetBytes())
889888
suite.Require().NoError(err)
890889
suite.Require().Equal(expPacketData, packetData)
891890

892891
// test invalid packet data
893892
invalidPacketData := []byte("invalid packet data")
894-
packetData, err = icahost.IBCModule{}.UnmarshalPacketData(ctx, "", "", invalidPacketData)
893+
// Context, port identifier and channel identifier are unused for host.
894+
packetData, err = icahost.IBCModule{}.UnmarshalPacketData(suite.chainA.GetContext(), "", "", invalidPacketData)
895895
suite.Require().Error(err)
896896
suite.Require().Nil(packetData)
897897
}

modules/apps/29-fee/ibc_middleware_test.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1582,6 +1582,7 @@ func (suite *FeeTestSuite) TestPacketDataUnmarshalerInterfaceError() {
15821582
// test the case when the underlying application cannot be casted to a PacketDataUnmarshaler
15831583
mockFeeMiddleware := ibcfee.NewIBCMiddleware(nil, feekeeper.Keeper{})
15841584

1585+
// Context, port identifier, channel identifier are not used in mockFeeMiddleware.
15851586
_, err := mockFeeMiddleware.UnmarshalPacketData(suite.chainA.GetContext(), "", "", ibcmock.MockPacketData)
15861587
expError := errorsmod.Wrapf(types.ErrUnsupportedAction, "underlying app does not implement %T", (*porttypes.PacketDataUnmarshaler)(nil))
15871588
suite.Require().ErrorIs(err, expError)

modules/apps/callbacks/callbacks_test.go

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ import (
66
"fmt"
77
"testing"
88

9-
storetypes "cosmossdk.io/store/types"
10-
11-
129
dbm "github.com/cosmos/cosmos-db"
1310
"github.com/stretchr/testify/suite"
1411

@@ -304,10 +301,12 @@ func GetExpectedEvent(
304301
err error
305302
)
306303

307-
packet := channeltypes.NewPacket(data, 0, srcPortID, "", "", "", clienttypes.ZeroHeight(), 0)
304+
// Set up gas meter with remainingGas.
308305
gasMeter := storetypes.NewGasMeter(remainingGas)
309306
ctx = ctx.WithGasMeter(gasMeter)
310307

308+
// Mock packet.
309+
packet := channeltypes.NewPacket(data, 0, srcPortID, "", "", "", clienttypes.ZeroHeight(), 0)
311310
if callbackType == types.CallbackTypeReceivePacket {
312311
callbackData, err = types.GetDestCallbackData(ctx, packetDataUnmarshaler, packet, maxCallbackGas)
313312
} else {

modules/apps/callbacks/ibc_middleware.go

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,7 @@ func (im IBCMiddleware) SendPacket(
9999
return 0, err
100100
}
101101

102-
// TODO(jim): Look up dest info?
103102
packet := channeltypes.NewPacket(data, seq, sourcePort, sourceChannel, "", "", timeoutHeight, timeoutTimestamp)
104-
105103
callbackData, err := types.GetSourceCallbackData(ctx, im.app, packet, im.maxCallbackGas)
106104
// SendPacket is not blocked if the packet does not opt-in to callbacks
107105
if err != nil {
@@ -248,9 +246,13 @@ func (im IBCMiddleware) WriteAcknowledgement(
248246
return err
249247
}
250248

251-
// TODO(jim): Proper cast (though has same effect either way)
249+
chanPacket, ok := packet.(channeltypes.Packet)
250+
if !ok {
251+
panic(fmt.Errorf("expected type %T, got %T", &channeltypes.Packet{}, packet))
252+
}
253+
252254
callbackData, err := types.GetDestCallbackData(
253-
ctx, im.app, packet.(channeltypes.Packet), im.maxCallbackGas,
255+
ctx, im.app, chanPacket, im.maxCallbackGas,
254256
)
255257
// WriteAcknowledgement is not blocked if the packet does not opt-in to callbacks
256258
if err != nil {

modules/apps/callbacks/ibc_middleware_test.go

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -200,8 +200,7 @@ func (s *CallbacksTestSuite) TestSendPacket() {
200200
s.Require().Equal(uint64(1), seq)
201201

202202
expEvent, exists := GetExpectedEvent(
203-
ctx,
204-
transferICS4Wrapper.(porttypes.PacketDataUnmarshaler), gasLimit, packetData.GetBytes(), s.path.EndpointA.ChannelConfig.PortID,
203+
ctx, transferICS4Wrapper.(porttypes.PacketDataUnmarshaler), gasLimit, packetData.GetBytes(), s.path.EndpointA.ChannelConfig.PortID,
205204
s.path.EndpointA.ChannelConfig.PortID, s.path.EndpointA.ChannelID, seq, types.CallbackTypeSendPacket, nil,
206205
)
207206
if exists {
@@ -382,8 +381,7 @@ func (s *CallbacksTestSuite) TestOnAcknowledgementPacket() {
382381
s.Require().Equal(uint8(1), sourceStatefulCounter)
383382

384383
expEvent, exists := GetExpectedEvent(
385-
ctx,
386-
transferStack.(porttypes.PacketDataUnmarshaler), gasLimit, packet.Data, packet.SourcePort,
384+
ctx, transferStack.(porttypes.PacketDataUnmarshaler), gasLimit, packet.Data, packet.SourcePort,
387385
packet.SourcePort, packet.SourceChannel, packet.Sequence, types.CallbackTypeAcknowledgementPacket, nil,
388386
)
389387
s.Require().True(exists)
@@ -545,8 +543,7 @@ func (s *CallbacksTestSuite) TestOnTimeoutPacket() {
545543
s.Require().Equal(uint8(2), sourceStatefulCounter)
546544

547545
expEvent, exists := GetExpectedEvent(
548-
ctx,
549-
transferStack.(porttypes.PacketDataUnmarshaler), gasLimit, packet.Data, packet.SourcePort,
546+
ctx, transferStack.(porttypes.PacketDataUnmarshaler), gasLimit, packet.Data, packet.SourcePort,
550547
packet.SourcePort, packet.SourceChannel, packet.Sequence, types.CallbackTypeTimeoutPacket, nil,
551548
)
552549
s.Require().True(exists)
@@ -715,8 +712,7 @@ func (s *CallbacksTestSuite) TestOnRecvPacket() {
715712
s.Require().Equal(uint8(1), destStatefulCounter)
716713

717714
expEvent, exists := GetExpectedEvent(
718-
ctx,
719-
transferStack.(porttypes.PacketDataUnmarshaler), gasLimit, packet.Data, packet.SourcePort,
715+
ctx, transferStack.(porttypes.PacketDataUnmarshaler), gasLimit, packet.Data, packet.SourcePort,
720716
packet.DestinationPort, packet.DestinationChannel, packet.Sequence, types.CallbackTypeReceivePacket, nil,
721717
)
722718
s.Require().True(exists)
@@ -818,8 +814,7 @@ func (s *CallbacksTestSuite) TestWriteAcknowledgement() {
818814
s.Require().NoError(err)
819815

820816
expEvent, exists := GetExpectedEvent(
821-
ctx,
822-
transferICS4Wrapper.(porttypes.PacketDataUnmarshaler), gasLimit, packet.Data, packet.SourcePort,
817+
ctx, transferICS4Wrapper.(porttypes.PacketDataUnmarshaler), gasLimit, packet.Data, packet.SourcePort,
823818
packet.DestinationPort, packet.DestinationChannel, packet.Sequence, types.CallbackTypeReceivePacket, nil,
824819
)
825820
if exists {

modules/apps/callbacks/types/callbacks.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ import (
44
"strconv"
55
"strings"
66

7-
87
errorsmod "cosmossdk.io/errors"
98

109
sdk "github.com/cosmos/cosmos-sdk/types"

modules/apps/callbacks/types/callbacks_test.go

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ package types_test
33
import (
44
"fmt"
55

6-
7-
86
storetypes "cosmossdk.io/store/types"
97

108
sdk "github.com/cosmos/cosmos-sdk/types"
@@ -283,7 +281,7 @@ func (s *CallbacksTypesTestSuite) TestGetCallbackData() {
283281

284282
tc.malleate()
285283

286-
// TODO(jim): better way?
284+
// Set up gas meter for context.
287285
gasMeter := storetypes.NewGasMeter(remainingGas)
288286
ctx := s.chain.GetContext().WithGasMeter(gasMeter)
289287

@@ -326,6 +324,7 @@ func (s *CallbacksTypesTestSuite) TestGetSourceCallbackDataTransfer() {
326324

327325
packetUnmarshaler := transfer.IBCModule{}
328326

327+
// Set up gas meter for context.
329328
gasMeter := storetypes.NewGasMeter(2_000_000)
330329
ctx := s.chain.GetContext().WithGasMeter(gasMeter)
331330

0 commit comments

Comments
 (0)