refactor: ibc port router for app callbacks #6314

damiannolan · 2024-05-15T10:40:41Z

Description

closes: #6941
closes: #3371
closes: #4427
closes: #4444
closes: #5774
closes: #5814
closes: #71
closes: #3312
closes: #3817
closes: #3727
closes: #41

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.

coderabbitai · 2024-05-15T10:40:48Z

Important

Review Skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

proto/ibc/core/channel/v1/tx.proto

modules/apps/transfer/keeper/relay.go

…/port-router

colin-axner · 2024-05-16T09:33:14Z

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

+		timeoutHeight clienttypes.Height,
+		timeoutTimestamp uint64,


we should remove timeout info from the interface. Left for now since it breaks callbacks interface, but I don't see a reason to leave it for callbacks

colin-axner · 2024-05-16T09:33:38Z

modules/apps/callbacks/ibc_middleware.go

 	}

+	// TODO: the packet sender is now passed in, it is possible to remove `GetPacketSender` in favour of this arg


we can remove the GetPacketSender interface now! Wahoo!

…ect to it

damiannolan · 2024-07-11T12:53:17Z

The ics20 code needs to be taken care of and some tests refactored. Just did what was needed to resolve the merge conflicts and get most tests passing.

colin-axner · 2024-08-01T14:31:02Z

modules/core/05-port/keeper/keeper.go

+	for _, prefix := range k.Keys() {
+		if strings.Contains(module, prefix) {
+			return k.AppRouter.GetRoute(prefix)
+		}
+	}


lets make this well documented since the implications are subtle cc @damiannolan

* not working yet * More tests fixed. * added message error * commented out tests * Wire approuter to e2e testing simapp * Delete obsolete tests * remove possibly unneeded call * Removed tests no longer needed * test: fix commented/removed tests --------- Co-authored-by: Colin Axnér <25233464+colin-axner@users.noreply.github.com>

#7010) * chore: adding updates to composite router and scaffolding for IBCLegacyModule * chore: support construction of LegacyIBCModules over consecutive calls to AddRoute * chore: removed ack handhsake impl * chore: fix linter * chore: lint * Linter * chore: addressing PR feedback * chore: routeToLegacyModule returns a single item * Update modules/core/05-port/types/router_v2.go * Update modules/core/05-port/types/router_v2.go * Update modules/core/05-port/types/router_v2.go * chore: fix errors from merge conflict --------- Co-authored-by: bznein <nikolas.degiorgis@interchain.io> Co-authored-by: Colin Axnér <25233464+colin-axner@users.noreply.github.com>

* chore: adding updates to composite router and scaffolding for IBCLegacyModule * chore: support construction of LegacyIBCModules over consecutive calls to AddRoute * chore: removed ack handhsake impl * chore: fix linter * chore: lint * Linter * chore: addressing PR feedback * chore: rename IBCModule to ClassicIBCModule and add new IBCModule interface * fix: e2e for fee wrapped channels --------- Co-authored-by: bznein <nikolas.degiorgis@interchain.io> Co-authored-by: Colin Axnér <25233464+colin-axner@users.noreply.github.com>

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

+	for prefix := range rtr.routes {
+		if strings.Contains(module, prefix) {
+			return rtr.routes[prefix], true
+		}
+	}


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

+	for prefix := range rtr.legacyRoutes {
+		if strings.Contains(module, prefix) {
+			return rtr.legacyRoutes[prefix], true
+		}
+	}


* chore: adding wrapping functions to ics29 * chore: added docstring to VersionWrapper interface * chore: fix linter * refactor: use unsafe unwrap func in OnChanOpenInit * chore: fixing wiring in app.go and fee tests * fix: fee middleware tests * fix: ics27 controller tests * wip: debugging callbacks * chore: fix linter * chore: fix miswiring in callbacks module * chore: modifications to binary simapp * chore: do not unwrap a version if it is an empty string * Update modules/apps/27-interchain-accounts/controller/ibc_middleware.go * Apply suggestions from code review * chore: add more code docs --------- Co-authored-by: Colin Axnér <25233464+colin-axner@users.noreply.github.com>

* chore: add fee implementation for OnChanOpenTry * chore: fix wiring in app.gos * chore: updated callbacks tests to handle new OnChanOpenTry * chore: lint, correct error string * chore: remove commented code * chore: addressing PR feedback

* refactor: use new port router for OnChanOpenAck * fix: transfer test * fix: controller tests * fix: legacy ibc module handler on disabling

* chore: add fee implementation for OnChanOpenTry * chore: fix wiring in app.gos * chore: updated callbacks tests to handle new OnChanOpenTry * chore: lint, correct error string * chore: remove commented code * chore: implementing OnChanUpgradeInit * chore: linter * chore: removed redundant test * chore: addressing PR feedback

* deps: bump cosmos-sdk to v0.50.9 (#6828) * deps: bump cosmos-sdk to v0.50.8 * chore: update changelog * deps: bump cosmossdk.io/client to v2.0.0-beta.3. bump x/upgrade to v0.1.4 * chore: make tidy-all * test: bump to 3f6796fba413cca for testing purposes. * deps: bump cosmos sdk to 0.50.9 * Update CHANGELOG.md * chore: update CHANGELOG for submodules. --------- Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com> * chore(api!): move checks from Transfer to OnSendPacket * Fix merge error * fix to test * Add Require() back * Update modules/apps/transfer/ibc_module.go Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> * Linter * Removed wrong merge results * reintroduce test * Move check for isSendEnabledCoins to keeper * new tests * fixed test * linter * Removed checks and added comment * removed extra parentheses * Revert "Merge remote-tracking branch 'origin' into bznein/6949/msgTransferWrapperToSendPacket" This reverts commit be9f558, reversing changes made to 36e4b05. * Delete commented out code --------- Co-authored-by: Damian Nolan <damiannolan@gmail.com> Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com> Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>

* chore: implement OnChanUpgradeTry * wip: partial implementation for OnChanUpgradeAck * chore: updated tests to work with new OnChanUpgradeAck implementation

* chore: implement OnChanUpgradeTry * wip: partial implementation for OnChanUpgradeAck * chore: updated tests to work with new OnChanUpgradeAck implementation * chore: implemented OnChanUpgradeOpen * chore: addressing PR feedback

) * refactor: update OnRecvPacket to use result type in favour of ack interface * refactor: update recv packet handling in interchain accounts, update event func arg to use concrete type * api! remove Acknowledgement interface from exported pkg * refactor: modifications to test code for api removal * lint: fix duplicate imports * refactor: use concrete acknowledgement in callbacks test * doc: update inline godocs for OnRecvPacket in ibccallbacks * fix: remove wrapping of result ack in callbacks recv packet * test: refactor writeAck tests to use expected error format * chore: add godocs and stringer impl for new recv result types * chore: add issue link for async acknowledgements in 29-fee * doc: update godocs for RecvPacketResult and status enums * chore: address pr comments, test updates and inline docs

* test not working * refactored test and removed unneeded caese

* refactor: use new port router for OnAcknowledgementPacket * fix: msg server update * fix: ics27 host tests * fix: ics27 controller tests * lint * chore: docs * add type assertions * add 29 type assertion

* initial commit * revert change * loop callbacks * fix loop * wip * chore: fixing remainder of timeout test failures * chore: check type assertion * PR feedbacK --------- Co-authored-by: chatton <cian@interchain.io>

…7142) * chore: updated handlers to use reverseCallbacks function * chore: add reconstructVersion to im * chore: remove duplicate import * chore: pr feedback

colin-axner · 2024-10-02T09:09:28Z

Closing this pr. It was used to do investigative work on redesigning the port router such that we could support ibc applications to be written with a cleaner interface and without the use of the confusing middleware design and ICS4Wrapper. It was determined making these changes in a backwards compatible way was not reasonable and thus these changes are being actively investigated in the ibc eureka / v2 work. Capabilities have been removed! And any other work in this pr will be upstreamed as necessary. v1 ibc applications will remain as is and a new design approach will be enabled for v2

great work by all involved in diving into these investigations!

damiannolan added 4 commits May 15, 2024 11:59

feat: add intial SendPacket msgs and rpc definition to ibc core

845e45f

feat: add OnSendPacket callback to IBCModule interface

db5cddf

chore: invoke OnSendPacket callback from msg server rpc

385674a

chore: add comment

5c861f4

damiannolan commented May 15, 2024

View reviewed changes

proto/ibc/core/channel/v1/tx.proto Outdated Show resolved Hide resolved

damiannolan and others added 5 commits May 15, 2024 14:11

chore: rename proto fields

9d4d2ea

chore: add OnSendPacket to ibccallbacks

90fe8ae

feat: add router_v2 while leaving current router impl in place

fc309f6

chore: add getter and setters for AppRouter to core ibc

d0f85db

imp: implement callbacks OnSendPacket

588ff66

colin-axner mentioned this pull request May 15, 2024

DRAFT: Allow multiple applications to bind themselves onto a single channel #5819

Closed

9 tasks

colin-axner and others added 3 commits May 16, 2024 09:58

imp: implement OnSendPacket for ics27

8bc82f6

imp: implement OnSendPacket in transfer

f883d68

Merge branch 'main' into feat/port-router

c5eef93

damiannolan commented May 16, 2024

View reviewed changes

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

damiannolan and others added 3 commits May 16, 2024 10:29

chore: start wiring up router_v2 in app.go

e626c7b

imp: add msg server handler to transfer

45896aa

Merge branch 'feat/port-router' of github.com:cosmos/ibc-go into feat…

20326d4

…/port-router

colin-axner reviewed May 16, 2024

View reviewed changes

colin-axner and others added 9 commits May 16, 2024 11:35

refactor: enable core IBC SendPacket API and switch transfer to redir…

3714960

…ect to it

refactor: rewire controller to use SendPacket API

b2df2f3

refactor: rewire 29-fee to use SendPacket API

b295949

refactor: use SendPacket API for callbacks

2f5116e

imp: remove capability from SendPacket and add prefix routing

16a88b4

refactor: adapt signer to sdk.AccAddress

67e4b5f

chore: rm capabilities from recv, ack, timeout packet handler

3db1613

lint: make lint-fix and address

07e8b1c

refactor: rm SendPacket from ics4wrapper

4214201

Merge branch 'main' into feat/port-router

4f8d319

colin-axner mentioned this pull request Jul 24, 2024

Port router refactor #6941

Open

colin-axner reviewed Aug 1, 2024

View reviewed changes

bznein and others added 5 commits August 5, 2024 17:02

Merge branch 'main' of github.com:cosmos/ibc-go into feat/port-router

9565e36

fix: tests

3eaf2ce

github-advanced-security bot found potential problems Aug 6, 2024

View reviewed changes

chatton and others added 18 commits August 7, 2024 13:08

Use new port router for OnChanOpenAck (#7084)

6ec1efa

* refactor: use new port router for OnChanOpenAck * fix: transfer test * fix: controller tests * fix: legacy ibc module handler on disabling

refactor: implement OnChanOpenConfirm using new port router (#7088)

ae43f7a

chore: implement OnChanUpgradeTry (#7092)

63dd289

refactor: implement OnChanCloseInit using new port router. (#7095)

467819d

Use new port router for OnChanUpgradeAck (#7094)

d779697

* chore: implement OnChanUpgradeTry * wip: partial implementation for OnChanUpgradeAck * chore: updated tests to work with new OnChanUpgradeAck implementation

refactor: implement onchancloseconfirm using new port router (#7096)

179025d

Use new port router for OnChanUpgradeOpen (#7102)

62db721

* chore: implement OnChanUpgradeTry * wip: partial implementation for OnChanUpgradeAck * chore: updated tests to work with new OnChanUpgradeAck implementation * chore: implemented OnChanUpgradeOpen * chore: addressing PR feedback

imp (api)!: convert coins to token only once in MsgTransfer (#7110)

d9c4e96

* test not working * refactored test and removed unneeded caese

use new port router with OnAcknowledgementPacket (#7108)

0ea612a

* refactor: use new port router for OnAcknowledgementPacket * fix: msg server update * fix: ics27 host tests * fix: ics27 controller tests * lint * chore: docs * add type assertions * add 29 type assertion

chore: docs (#7111)

a9d34ba

Bznein/7023/on timeout packet (#7144)

ec593cb

* initial commit * revert change * loop callbacks * fix loop * wip * chore: fixing remainder of timeout test failures * chore: check type assertion * PR feedbacK --------- Co-authored-by: chatton <cian@interchain.io>

Add convenience func to reverse callbacks and refactor other methods (#…

f5ab15b

…7142) * chore: updated handlers to use reverseCallbacks function * chore: add reconstructVersion to im * chore: remove duplicate import * chore: pr feedback

chore: use app router in OnTimeoutPacket handler (#7164)

6327b58

colin-axner closed this Oct 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: ibc port router for app callbacks #6314

refactor: ibc port router for app callbacks #6314

damiannolan commented May 15, 2024 •

edited by colin-axner

Loading

coderabbitai bot commented May 15, 2024 •

edited

Loading

Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

colin-axner May 16, 2024

colin-axner May 16, 2024

damiannolan commented Jul 11, 2024

colin-axner Aug 1, 2024

colin-axner commented Oct 2, 2024

		}

		// TODO: the packet sender is now passed in, it is possible to remove `GetPacketSender` in favour of this arg

refactor: ibc port router for app callbacks #6314

refactor: ibc port router for app callbacks #6314

Conversation

damiannolan commented May 15, 2024 • edited by colin-axner Loading

Description

coderabbitai bot commented May 15, 2024 • edited Loading

Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

colin-axner May 16, 2024

Choose a reason for hiding this comment

colin-axner May 16, 2024

Choose a reason for hiding this comment

damiannolan commented Jul 11, 2024

colin-axner Aug 1, 2024

Choose a reason for hiding this comment

colin-axner commented Oct 2, 2024

damiannolan commented May 15, 2024 •

edited by colin-axner

Loading

coderabbitai bot commented May 15, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)