Simplify SendPacket API #1703

AdityaSripal · 2022-07-14T15:58:11Z

Description

closes: #1395

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the module structure standards.
Wrote unit and integration tests
Updated relevant documentation (docs/) or specification (x/<module>/spec/)
Added relevant godoc comments.
Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
Re-reviewed Files changed in the Github PR explorer
Review Codecov Report in the comment section below once CI passes

AdityaSripal · 2022-07-14T16:57:59Z

testing/endpoint.go

@@ -375,7 +375,9 @@ func (endpoint *Endpoint) SendPacket(packet exported.PacketI) error {
 	channelCap := endpoint.Chain.GetChannelCapability(packet.GetSourcePort(), packet.GetSourceChannel())

 	// no need to send message, acting as a module
-	err := endpoint.Chain.App.GetIBCKeeper().ChannelKeeper.SendPacket(endpoint.Chain.GetContext(), channelCap, packet)
+	// TODO: Change Endpoint SendPacket to take in arguments directly


I will address this in a subsequent PR to reduce diffs

Can you open an issue to track this work?

damiannolan

Nice!! Looks super clean, love how much simpler the SendTx code in ICA is.
Left one question about telemetry, not sure how critical it really is tho.

🚀

damiannolan · 2022-07-15T11:17:12Z

modules/apps/transfer/keeper/relay.go

-		telemetry.NewLabel(coretypes.LabelDestinationPort, destinationPort),
-		telemetry.NewLabel(coretypes.LabelDestinationChannel, destinationChannel),
-	}
+	labels := []metrics.Label{}


Are we losing this telemetry info now for destination port and channel?

Yes. cc: @colin-axner

I think it is okay, so long as there is telemetry within core IBC showing where packets are being sent from/to, then the telemetry could filter on port ID to get the same info. This might break external UX though, so might make more sense to do in a followup

I don't think telemetry is used on external UX? Also I just think it makes sense to keep it clean here, rather than grabbing channel just so that we can emit the same telemetry.

Afaiu, breaking telemetry does not count as an api breaking or state machine breaking change. So i don't want to be so restrictive and conservative in this case.

I'm in favor of just removing it. We can add it in the changelog so that people who need this information are informed of it beforehand

Changing any of the labels will break the telemetry counter. Thus any IBC apps reporting statistics via Prometheus would likely break. I think it makes sense to check with external apps to ensure we don't make a disruptive change out of the blue

We could remove this telemetry entirely and replace it with one in core IBC that emits per packet sent, rather than duplicating for every application

chatton

Looks great! Nice cleanup. I just had a few small questions

modules/apps/transfer/keeper/relay.go

modules/core/04-channel/keeper/packet.go

crodriguezvega

Thanks, @AdityaSripal! I think we need to add also some documentation in the migration docs for app developers, right? And we should decide in what version this should be released...

modules/core/04-channel/keeper/packet.go

colin-axner

Concept ACK, see suggested feedback. Seems like a straightforward change. Nice improvement! 🦾

modules/apps/27-interchain-accounts/controller/keeper/relay.go

modules/apps/27-interchain-accounts/types/expected_keepers.go

modules/apps/transfer/keeper/relay.go

colin-axner · 2022-09-28T11:23:14Z

modules/apps/transfer/keeper/relay.go

-		telemetry.NewLabel(coretypes.LabelDestinationPort, destinationPort),
-		telemetry.NewLabel(coretypes.LabelDestinationChannel, destinationChannel),
-	}
+	labels := []metrics.Label{}


I think it is okay, so long as there is telemetry within core IBC showing where packets are being sent from/to, then the telemetry could filter on port ID to get the same info. This might break external UX though, so might make more sense to do in a followup

modules/core/04-channel/keeper/packet.go

modules/core/05-port/types/module.go

colin-axner · 2022-09-28T11:29:09Z

testing/endpoint.go

@@ -375,7 +375,9 @@ func (endpoint *Endpoint) SendPacket(packet exported.PacketI) error {
 	channelCap := endpoint.Chain.GetChannelCapability(packet.GetSourcePort(), packet.GetSourceChannel())

 	// no need to send message, acting as a module
-	err := endpoint.Chain.App.GetIBCKeeper().ChannelKeeper.SendPacket(endpoint.Chain.GetContext(), channelCap, packet)
+	// TODO: Change Endpoint SendPacket to take in arguments directly


Can you open an issue to track this work?

modules/core/04-channel/keeper/packet.go

colin-axner · 2022-09-28T11:31:45Z

Marking as draft just so it is easier to know when suggestions and merge conflicts have been addressed and the pr is ready for a full review again

codecov-commenter · 2022-09-30T21:22:28Z

Codecov Report

Merging #1703 (2faf51e) into main (8c7c655) will increase coverage by 0.02%.
The diff coverage is 77.50%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1703      +/-   ##
==========================================
+ Coverage   78.65%   78.67%   +0.02%     
==========================================
  Files         178      178              
  Lines       12367    12311      -56     
==========================================
- Hits         9727     9686      -41     
+ Misses       2208     2197      -11     
+ Partials      432      428       -4

Impacted Files	Coverage Δ
...7-interchain-accounts/controller/ibc_middleware.go	`70.96% <0.00%> (ø)`
...27-interchain-accounts/controller/keeper/keeper.go	`92.53% <ø> (ø)`
.../apps/27-interchain-accounts/host/keeper/keeper.go	`83.80% <ø> (ø)`
modules/apps/29-fee/ibc_middleware.go	`91.83% <0.00%> (ø)`
modules/apps/29-fee/keeper/keeper.go	`92.48% <ø> (ø)`
modules/apps/29-fee/keeper/relay.go	`88.23% <0.00%> (ø)`
modules/apps/transfer/keeper/keeper.go	`91.17% <ø> (ø)`
.../27-interchain-accounts/controller/keeper/relay.go	`75.00% <66.66%> (+0.53%)`	⬆️
modules/apps/transfer/keeper/relay.go	`88.07% <80.00%> (-0.64%)`	⬇️
modules/core/04-channel/keeper/packet.go	`98.20% <92.59%> (+1.61%)`	⬆️
... and 2 more

AdityaSripal · 2022-09-30T21:20:39Z

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

@@ -25,7 +26,7 @@ type Keeper struct {
 	cdc        codec.BinaryCodec
 	paramSpace paramtypes.Subspace

-	ics4Wrapper   icatypes.ICS4Wrapper
+	ics4Wrapper   porttypes.ICS4Wrapper


No reason for us to duplicate ICS4Wrapper in the expected keepers. the interface already exists in port types. This also prevents accidentally missing a function. Done for all apps

modules/apps/27-interchain-accounts/types/expected_keepers.go

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

modules/apps/transfer/types/expected_keepers.go

AdityaSripal · 2022-09-30T21:33:59Z

modules/core/04-channel/keeper/packet_test.go

@@ -20,7 +20,7 @@ import (
 var (
 	disabledTimeoutTimestamp = uint64(0)
 	disabledTimeoutHeight    = clienttypes.ZeroHeight()
-	timeoutHeight            = clienttypes.NewHeight(1, 100)
+	defaultTimeoutHeight     = clienttypes.NewHeight(1, 100)


I had to change this back since it was conflicting with the local var in TestSendPacket. I also just find it makes more sense, since there are some non default values I put in the test cases.

There's a function on the destination chain now. suite.chainB.GetTimeoutHeight()

colin-axner

I added back telemetry. Would prefer to intentionally remove it in a followup pr

damiannolan

LGTM! Nice work 🚀

docs/migrations/v5-to-v6.md

modules/core/04-channel/keeper/packet.go

damiannolan · 2022-10-05T12:18:09Z

modules/core/05-port/types/module.go

+		timeoutHeight clienttypes.Height,
+		timeoutTimestamp uint64,
+		data []byte,
+	) (sequence uint64, err error)


Should we leave these as unnamed return args as they are in other methods such as GetAppVersion?

It is good as is in my opinion. OnChanOpenInit has named returns. GetAppVersion probably should have had a named return

Maybe we can make them all consistent in housekeeping followup.

Co-authored-by: Damian Nolan <[email protected]>

…et-api

…o aditya/send-packet-api

colin-axner · 2022-10-05T13:10:22Z

@crodriguezvega Are there any changes left you think we should make? With regards to your current suggestions, I think it probably makes sense to continue using the packet variables so as to ensure we are referencing the correct values

Otherwise I think this pr is ready to be merged

crodriguezvega · 2022-10-05T20:20:03Z

docs/ibc/apps.md

@@ -238,10 +238,21 @@ DecodePacketData(encoded []byte) (CustomPacketData) {
 Then a module must encode its packet data before sending it through IBC.


I realized that this file is actually not used in the docs website, so could probably be removed...

I see, looks like we took this info and split it up into separate files? Lets open an issue whose task is to see if any info in here should be moved before deleting the file

crodriguezvega · 2022-10-05T20:21:51Z

@crodriguezvega Are there any changes left you think we should make?

Yes, I just updated the documentation. I would appreciate a review to check it all looks ok. After that, I agree we can merge it.

…o aditya/send-packet-api

colin-axner

Thanks @crodriguezvega for updating docs! I re-reviewed all changes

## Description closes: #1395 --- Before we can merge this PR, please make sure that all the following items have been checked off. If any of the checklist items are not applicable, please leave them but write a little note why. - [x] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] Linked to Github issue with discussion and accepted design OR link to spec that describes this work. - [ ] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/structure.md). - [ ] Wrote unit and integration [tests](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#testing) - [ ] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`) - [ ] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code). - [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md` - [ ] Re-reviewed `Files changed` in the Github PR explorer - [ ] Review `Codecov Report` in the comment section below once CI passes (cherry picked from commit 88525d2) # Conflicts: # modules/apps/29-fee/keeper/keeper.go # modules/core/04-channel/keeper/packet.go # modules/core/04-channel/keeper/packet_test.go

* Simplify SendPacket API (#1703) ## Description closes: #1395 --- Before we can merge this PR, please make sure that all the following items have been checked off. If any of the checklist items are not applicable, please leave them but write a little note why. - [x] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] Linked to Github issue with discussion and accepted design OR link to spec that describes this work. - [ ] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules/structure.md). - [ ] Wrote unit and integration [tests](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#testing) - [ ] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`) - [ ] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code). - [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md` - [ ] Re-reviewed `Files changed` in the Github PR explorer - [ ] Review `Codecov Report` in the comment section below once CI passes (cherry picked from commit 88525d2) # Conflicts: # modules/apps/29-fee/keeper/keeper.go # modules/core/04-channel/keeper/packet.go # modules/core/04-channel/keeper/packet_test.go * fix conflicts * Update develop.md * remove test that was added for 02-client refactor (and therefore before v6.0.x was branched off) Co-authored-by: Aditya <[email protected]> Co-authored-by: crodriguezvega <[email protected]> Co-authored-by: Carlos Rodriguez <[email protected]> Co-authored-by: colin axnér <[email protected]>

fix compile issues and channel keeper tests

05e1d86

AdityaSripal requested review from seantking, charleenfei, colin-axner, damiannolan, fedekunze, crodriguezvega and chatton as code owners July 14, 2022 15:58

AdityaSripal added 2 commits July 14, 2022 18:38

add back deleted code

99db505

fix merge

a146b33

AdityaSripal commented Jul 14, 2022

View reviewed changes

CHANGELOG

3d4a0eb

damiannolan approved these changes Jul 15, 2022

View reviewed changes

chatton reviewed Jul 15, 2022

View reviewed changes

modules/apps/transfer/keeper/relay.go Outdated Show resolved Hide resolved

modules/core/04-channel/keeper/packet.go Outdated Show resolved Hide resolved

crodriguezvega reviewed Jul 18, 2022

View reviewed changes

colin-axner reviewed Aug 10, 2022

View reviewed changes

modules/core/04-channel/keeper/packet.go Outdated Show resolved Hide resolved

colin-axner reviewed Aug 10, 2022

View reviewed changes

modules/core/04-channel/keeper/packet.go Outdated Show resolved Hide resolved

colin-axner mentioned this pull request Aug 24, 2022

MsgTransferResponse should include the packet sequence #1969

Closed

3 tasks

colin-axner reviewed Sep 28, 2022

View reviewed changes

colin-axner marked this pull request as draft September 28, 2022 11:31

AdityaSripal added 4 commits September 30, 2022 12:22

fix var naming and remove unnecessary test cases

3cbbef6

add sequence to return argument of SendPacket

847fd98

fix merge

3527aed

Merge branch 'main' into aditya/send-packet-api

7a94343

AdityaSripal mentioned this pull request Sep 30, 2022

IBC testing endpoint should use new SendPacket API #2452

Closed

remove print

8386d5d

AdityaSripal commented Sep 30, 2022

View reviewed changes

Remove unnecessary diffs

302d32a

colin-axner added 3 commits October 3, 2022 17:07

chore: add migration docs

c348aa4

revert breaking telemetry

c30f011

fix: migration docs was in wrong location

079c3a1

colin-axner approved these changes Oct 3, 2022

View reviewed changes

colin-axner requested review from crodriguezvega and damiannolan October 3, 2022 15:16

damiannolan approved these changes Oct 5, 2022

View reviewed changes

colin-axner and others added 5 commits October 5, 2022 14:55

Update docs/migrations/v5-to-v6.md

90e5e08

Co-authored-by: Damian Nolan <[email protected]>

update 'SendPacket' godoc

827529a

Merge branch 'main' of github.com:cosmos/ibc-go into aditya/send-pack…

e48d77e

…et-api

Merge branch 'aditya/send-packet-api' of github.com:cosmos/ibc-go int…

acaf109

…o aditya/send-packet-api

chore: update changelog entry to include packet seq return

9a7737e

update documentation

6ad76d1

crodriguezvega reviewed Oct 5, 2022

View reviewed changes

Merge branch 'main' into aditya/send-packet-api

2faf51e

colin-axner mentioned this pull request Oct 6, 2022

Remove redundant documenation in docs/ibc/apps.md #2480

Open

3 tasks

colin-axner added 2 commits October 6, 2022 13:06

chore: fix test case to increase code coverage

17882e6

Merge branch 'aditya/send-packet-api' of github.com:cosmos/ibc-go int…

d9eb17f

…o aditya/send-packet-api

colin-axner approved these changes Oct 6, 2022

View reviewed changes

colin-axner removed their assignment Oct 6, 2022

colin-axner added backport-to-v6.0.x automerge labels Oct 6, 2022

mergify bot merged commit 88525d2 into main Oct 6, 2022

mergify bot deleted the aditya/send-packet-api branch October 6, 2022 11:11

mergify bot mentioned this pull request Oct 6, 2022

Simplify SendPacket API (backport #1703) #2482

Merged

damiannolan mentioned this pull request Oct 14, 2022

docs: adding migration doc for ibc-go v6 #2417

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Simplify SendPacket API #1703

Simplify SendPacket API #1703

AdityaSripal commented Jul 14, 2022 •

edited by colin-axner

Loading

AdityaSripal Jul 14, 2022

colin-axner Sep 28, 2022

AdityaSripal Sep 30, 2022

damiannolan left a comment •

edited

Loading

damiannolan Jul 15, 2022

AdityaSripal Jul 18, 2022

colin-axner Sep 28, 2022

AdityaSripal Sep 30, 2022

colin-axner Oct 3, 2022 •

edited

Loading

colin-axner Oct 3, 2022

chatton left a comment

crodriguezvega left a comment

colin-axner left a comment

colin-axner Sep 28, 2022

colin-axner Sep 28, 2022

colin-axner commented Sep 28, 2022

codecov-commenter commented Sep 30, 2022 •

edited

Loading

AdityaSripal Sep 30, 2022

AdityaSripal Sep 30, 2022

colin-axner Oct 3, 2022

colin-axner left a comment

damiannolan left a comment

damiannolan Oct 5, 2022

colin-axner Oct 5, 2022

damiannolan Oct 5, 2022

colin-axner commented Oct 5, 2022

crodriguezvega Oct 5, 2022

colin-axner Oct 6, 2022

colin-axner Oct 6, 2022

crodriguezvega commented Oct 5, 2022

colin-axner left a comment

		@@ -238,10 +238,21 @@ DecodePacketData(encoded []byte) (CustomPacketData) {
		Then a module must encode its packet data before sending it through IBC.

Simplify SendPacket API #1703

Simplify SendPacket API #1703

Conversation

AdityaSripal commented Jul 14, 2022 • edited by colin-axner Loading

Description

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

damiannolan left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

colin-axner Oct 3, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chatton left a comment

Choose a reason for hiding this comment

crodriguezvega left a comment

Choose a reason for hiding this comment

colin-axner left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

colin-axner commented Sep 28, 2022

codecov-commenter commented Sep 30, 2022 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

colin-axner left a comment

Choose a reason for hiding this comment

damiannolan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

colin-axner commented Oct 5, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crodriguezvega commented Oct 5, 2022

colin-axner left a comment

Choose a reason for hiding this comment

AdityaSripal commented Jul 14, 2022 •

edited by colin-axner

Loading

damiannolan left a comment •

edited

Loading

colin-axner Oct 3, 2022 •

edited

Loading

codecov-commenter commented Sep 30, 2022 •

edited

Loading