polymerdao / ibc-go

Interblockchain Communication Protocol (IBC) implementation in Golang.
https://ibc.cosmos.network/
MIT License
11 stars 13 forks source link

Better Multihop Abstraction #43

Open AdityaSripal opened 10 months ago

AdityaSripal commented 10 months ago

Description

This is a POC of a better abstraction of multihop proofs in my opinion. It moves multihop concerns down to the 03-connection layer so verification is opaque from 04 point of view whether it is multihop proof or not.

It requires breaking the connection verify APIs but since this should only be called by other core libraries i think this is ok.

There are still 2 places where multihop is explicitly handled by 04-channel. It is used in ChanCloseFrozen which I think is fine, since this is an explicit handler for the multihop case. And it is needed in timeout packet since we need to get the timestamp of the counterparty consensus state through the multiple hops as part of 04-channel logic. Perhaps there's a cleaner way to abstract this.

closes: #XXXX

Commit Message / Changelog Entry

type: commit message

see the guidelines for commit messages. (view raw markdown for examples)


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.

Summary by CodeRabbit

coderabbitai[bot] commented 10 months ago

Walkthrough

The Cosmos SDK has evolved to enhance inter-blockchain communication with multi-hop verification capabilities. This update streamlines the verification process across multiple blockchain hops, allowing for more complex routing of data and ensuring the integrity of cross-chain interactions. The modifications uniformly apply multi-hop verification logic to connections, channels, and packet handling, simplifying the codebase and expanding the functionality of the IBC protocol.

Changes

File Path Change Summary
.../03-connection/keeper/multihop.go Introduced multi-hop membership and non-membership proof functionality.
.../03-connection/keeper/verify.go Updated verification functions to handle multi-hop scenarios using connectionHops.
.../04-channel/keeper/handshake.go Added commitmenttypes import and modified channel handling logic for multi-hop proofs.
.../04-channel/keeper/packet.go Unified packet commitment verification logic for single and multi-hop scenarios.
.../04-channel/keeper/timeout.go Consolidated timeout verification logic for packet sequences and receipts for all scenarios.
.../04-channel/types/expected_keepers.go Modified ConnectionKeeper interface to support multi-hop verification methods.

"In the ledger's weave, where data hops and skips, 🐰 A rabbit conjures code with adept little flips. Through Cosmos it bounds, with proofs in its grip, Ensuring each blockchain can make its own trip."

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's AI: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - 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 tests 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 from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid.` - `@coderabbitai read the files in the src/scheduler package and generate 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. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
dshiell commented 10 months ago

@coderabbitai review

dshiell commented 10 months ago

If it helps, you can run all multi-hop tests like:

go test ./modules/core/04-channel/keeper -run TestMultihopTestSuite -v

The channel, packet, timeout single hop test cases were replicated for multi-hop (plus some extra cases).

See modules/core/04-channel/keeper --> multihop_*_test.go