search

open-ibc / vibc-core-smart-contracts

Apache License 2.0
30 stars 24 forks source link

Adding skip ack option, wip #204

Closed mvpoyatt closed 2 months ago

mvpoyatt commented 2 months ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 2 months ago

Walkthrough

The pull request introduces modifications across multiple contracts to enhance the handling of acknowledgment packets. The primary change involves updating function signatures to return both an AckPacket and a boolean value skipAck, allowing for more nuanced control over acknowledgment processing. This adjustment affects the GeneralMiddleware, Dispatcher, UniversalChannelHandler, and various example contracts, ensuring consistency in how acknowledgment behavior is managed throughout the codebase.

Changes

File Path Change Summary
contracts/base/GeneralMiddleware.sol Updated function signatures to return (AckPacket, bool skipAck) for packet processing methods.
contracts/core/Dispatcher.sol Modified response decoding in _callIfContract to handle (AckPacket, bool skipAck).
contracts/core/UniversalChannelHandler.sol Altered method signature to include bool skipAck in acknowledgment handling.
contracts/examples/Earth.sol Updated onRecvUniversalPacket method to return (AckPacket, bool skipAck).
contracts/examples/Mars.sol Changed onRecvPacket method across multiple derived contracts to return (AckPacket, bool skipAck).
bindings/go/earth/Earth.go Updated ABI and method signatures to reflect new return type including bool skipAck.
bindings/go/iuniversalchannelhandler/IUniversalChannelHandler.go Updated ABI and method signatures to include bool skipAck.
bindings/go/mars/Mars.go Updated ABI and method signatures to include bool skipAck.
bindings/go/mars/PanickingMars.go Updated ABI and method signatures to include bool skipAck.
bindings/go/mars/RevertingBytesMars.go Updated ABI and method signatures to include bool skipAck.
bindings/go/mars/RevertingEmptyMars.go Updated ABI and method signatures to include bool skipAck.
bindings/go/mars/RevertingStringMars.go Updated ABI and method signatures to include bool skipAck.
bindings/go/moon/Moon.go Updated ABI and method signatures to include bool skipAck.
bindings/go/universalchannelhandler/UniversalChannelHandler.go Updated ABI and method signatures to include bool skipAck.
test/Dispatcher/Dispatcher.t.sol Added test_skip_ack to verify acknowledgment behavior in the Pluto contract.

Possibly related PRs

Suggested labels

bug

Poem

🐰 In the meadow where packets flow,
Acknowledgments dance, a new way to show.
With skipAck now in tow,
We hop and skip, our logic aglow!
Through contracts bright, we leap and play,
Enhancing the flow, come join the fray! 🌼

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , please review it.` -- `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` -- `@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.` -- `@coderabbitai help me debug CodeRabbit configuration file.` 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 using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.