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

Draft
wants to merge 27 commits into
base: main
Choose a base branch
from
Draft

Conversation

damiannolan
Copy link
Member

@damiannolan damiannolan commented May 15, 2024

Description

WIP: based on designs from ibc lite and port router refactor investigations.

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

Working items/task list based on discussions with @colin-axner:

Step 1.

  • Add api for SendPacket rpc and proto msg definitions
  • Add OnSendPacket callback to to IBCModule
  • Add router_v2 with ordered list of IBCModule
  • Implement OnSendPacket in each application.
    • transfer
    • callbacks
    • ICA
    • ICS29
  • Wire up router_v2 in app.go with of modules
    • Initial wire up of router_v2 with app stacks
    • Remove application wrapping. Unwrap/Detangle e.g. transfer wrapped with ics29 etc
  • Invoke MsgSendPacket from applications.
    • transfer
    • callbacks
    • ICA
    • ICS29
  • Remove capabilities
    • recv, ack, timeout, timeoutOnClose handlers
    • handshake handlers
    • apps
  • Remove SendPacket from ICS4Wrapper
  • Use router_v2 for all other ibc app callbacks (leave recv/ack til last)
    • OnChanOpenInit
    • OnChanOpenTry
    • OnChanOpenAck
    • OnChanOpenConfirm
    • OnChanCloseInit
    • OnChanCloseConfirm
    • OnRecvPacket
    • OnTimeoutPacket
    • OnAcknowledgementPacket
    • Convert GetAppVersion to unparsing version func
    • Convert WriteAcknowledgement into ack glue together func
    • OnChanUpgradeInit
    • OnChanUpgradeTry
    • OnChanUpgradeAck
    • OnChanUpgradeConfirm
    • Wait for all acks to be returned before writing async acks (add state key storage)
  • Remove IBCMiddleware interface
  • Remove ics4Wrapper
  • Remove router_v1 when functionality is incrementally switched over && app wiring

Step 2.

  • Add multi packet data structure + api
  • Determine upgrade path to using multi packet data with backwards compatibility

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants