Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: ibc port router for app callbacks #6314

Closed
wants to merge 51 commits into from
Closed

Conversation

damiannolan
Copy link
Member

@damiannolan damiannolan commented May 15, 2024

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.

  • Targeted PR against the 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 and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/).
  • Added relevant godoc comments.
  • Provide a conventional commit message to follow the repository standards.
  • Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Review SonarCloud Report in the comment section below once CI passes.

Copy link
Contributor

coderabbitai bot commented May 15, 2024

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.

Comment on lines +90 to +91
timeoutHeight clienttypes.Height,
timeoutTimestamp uint64,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

}

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can remove the GetPacketSender interface now! Wahoo!

@damiannolan
Copy link
Member Author

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.

Comment on lines 101 to 105
for _, prefix := range k.Keys() {
if strings.Contains(module, prefix) {
return k.AppRouter.GetRoute(prefix)
}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

bznein and others added 5 commits August 5, 2024 17:02
* 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>
Comment on lines +70 to +74
for prefix := range rtr.routes {
if strings.Contains(module, prefix) {
return rtr.routes[prefix], true
}
}

Check warning

Code scanning / CodeQL

Iteration over map Warning

Iteration over map may be a possible source of non-determinism
Comment on lines +109 to +113
for prefix := range rtr.legacyRoutes {
if strings.Contains(module, prefix) {
return rtr.legacyRoutes[prefix], true
}
}

Check warning

Code scanning / CodeQL

Iteration over map Warning

Iteration over map may be a possible source of non-determinism
chatton and others added 18 commits August 7, 2024 13:08
* 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
Copy link
Contributor

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!

@colin-axner colin-axner closed this Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants