chore: update grpc queries to handle multiple fees #967
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,6 @@ | ||
| package keeper_test | ||
|
|
||
| import ( | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| "github.com/cosmos/cosmos-sdk/types/query" | ||
|
|
||
|
|
@@ -11,25 +9,10 @@ import ( | |
| ibctesting "github.com/cosmos/ibc-go/v3/testing" | ||
| ) | ||
|
|
||
| func (suite *KeeperTestSuite) TestQueryIncentivizedPackets() { | ||
| var ( | ||
| req *types.QueryIncentivizedPacketsRequest | ||
| expectedPackets []types.IdentifiedPacketFees | ||
| ) | ||
|
|
||
| testCases := []struct { | ||
|
|
@@ -40,117 +23,116 @@ func (suite *KeeperTestSuite) TestQueryIncentivizedPacketI() { | |
| { | ||
| "success", | ||
| func() { | ||
| suite.chainA.GetSimApp().IBCFeeKeeper.SetFeeEnabled(suite.chainA.GetContext(), ibctesting.MockFeePort, ibctesting.FirstChannelID) | ||
|
|
||
| fee := types.NewFee(defaultReceiveFee, defaultAckFee, defaultTimeoutFee) | ||
| packetFee := types.NewPacketFee(fee, suite.chainA.SenderAccount.GetAddress().String(), []string(nil)) | ||
|
|
||
| for i := 0; i < 3; i++ { | ||
| // escrow packet fees for three different packets | ||
| packetID := channeltypes.NewPacketId(ibctesting.FirstChannelID, ibctesting.MockFeePort, uint64(i+1)) | ||
| suite.chainA.GetSimApp().IBCFeeKeeper.EscrowPacketFee(suite.chainA.GetContext(), packetID, packetFee) | ||
|
|
||
| expectedPackets = append(expectedPackets, types.NewIdentifiedPacketFees(packetID, []types.PacketFee{packetFee})) | ||
| } | ||
|
|
||
| req = &types.QueryIncentivizedPacketsRequest{ | ||
| Pagination: &query.PageRequest{ | ||
| Limit: 5, | ||
| CountTotal: false, | ||
| }, | ||
| QueryHeight: 0, | ||
| } | ||
| }, | ||
| true, | ||
| }, | ||
| { | ||
| "empty pagination", | ||
| func() { | ||
| expectedPackets = nil | ||
| req = &types.QueryIncentivizedPacketsRequest{} | ||
| }, | ||
| true, | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| suite.Run(tc.name, func() { | ||
| suite.SetupTest() // reset | ||
|
|
||
| tc.malleate() // malleate mutates test data | ||
|
|
||
| ctx := sdk.WrapSDKContext(suite.chainA.GetContext()) | ||
| res, err := suite.queryClient.IncentivizedPackets(ctx, req) | ||
|
|
||
| if tc.expPass { | ||
| suite.Require().NoError(err) | ||
| suite.Require().NotNil(res) | ||
| suite.Require().Equal(expectedPackets, res.IncentivizedPackets) | ||
| } else { | ||
| suite.Require().Error(err) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func (suite *KeeperTestSuite) TestQueryIncentivizedPacket() { | ||
| var ( | ||
| req *types.QueryIncentivizedPacketRequest | ||
| ) | ||
|
|
||
| testCases := []struct { | ||
| name string | ||
| malleate func() | ||
| expPass bool | ||
| }{ | ||
| { | ||
| "success", | ||
| func() {}, | ||
| true, | ||
| }, | ||
| { | ||
| "fees not found for packet id", | ||
| func() { | ||
| req = &types.QueryIncentivizedPacketRequest{ | ||
| PacketId: channeltypes.NewPacketId(ibctesting.FirstChannelID, ibctesting.MockFeePort, 100), | ||
| QueryHeight: 0, | ||
| } | ||
| }, | ||
| false, | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| suite.Run(tc.name, func() { | ||
| suite.SetupTest() // reset | ||
|
|
||
| suite.chainA.GetSimApp().IBCFeeKeeper.SetFeeEnabled(suite.chainA.GetContext(), ibctesting.MockFeePort, ibctesting.FirstChannelID) | ||
|
|
||
| packetID := channeltypes.NewPacketId(ibctesting.FirstChannelID, ibctesting.MockFeePort, 1) | ||
| fee := types.NewFee(defaultReceiveFee, defaultAckFee, defaultTimeoutFee) | ||
| packetFee := types.NewPacketFee(fee, suite.chainA.SenderAccount.GetAddress().String(), []string(nil)) | ||
|
|
||
| for i := 0; i < 3; i++ { | ||
| // escrow three packet fees for the same packet | ||
| err := suite.chainA.GetSimApp().IBCFeeKeeper.EscrowPacketFee(suite.chainA.GetContext(), packetID, packetFee) | ||
| suite.Require().NoError(err) | ||
| } | ||
|
|
||
| req = &types.QueryIncentivizedPacketRequest{ | ||
| PacketId: packetID, | ||
| QueryHeight: 0, | ||
|
Comment on lines
+110
to
+124
There was a problem hiding this comment. haha I just thought to do the same on #983 |
||
| } | ||
|
|
||
| tc.malleate() // malleate mutates test data | ||
|
|
||
| ctx := sdk.WrapSDKContext(suite.chainA.GetContext()) | ||
| res, err := suite.queryClient.IncentivizedPacket(ctx, req) | ||
|
|
||
| if tc.expPass { | ||
| suite.Require().NoError(err) | ||
| suite.Require().NotNil(res) | ||
| suite.Require().Equal(types.NewIdentifiedPacketFees(packetID, []types.PacketFee{packetFee, packetFee, packetFee}), res.IncentivizedPacket) | ||
| } else { | ||
| suite.Require().Error(err) | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this correct? From my investigation, pagination doesn't include the prefix iterated on in the return value. I guess there's a trailing "/" leading the key, which is subtle
So I think the key is something like "/transfer/channel-0/5"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm kinda wondering if we should just reconstruct the full key and then use the parse functions in keys.go
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, correct, so a paginated query doesn't include the prefix, but because of the leading
"/"when we split using the slash separator the first element is an empty string. So with your example,keySplitends up as a 4 element slice:[]string{"", "transfer", "channel-0", "5"}.I do think since you've added the parse function we should try to leverage it here. It should be something like below, right?
edit: Done ✅