search

ondoprotocol / usdy-noble

Ondo's US Dollar Yield Token on Noble
Other
5 stars 10 forks source link

feat: implement blocked channels #7

Closed johnletey closed 4 months ago

johnletey commented 4 months ago

This PR implements a blocklist approach to IBC transfers.

A new E2E test has been added to demonstrate this feature:

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

[!WARNING]

Review failed

The pull request is closed.

Walkthrough

The updates to the Aura module introduce robust functionality for managing blocked IBC channels. New commands, message types, and state management functions allow blocking and unblocking channels, ensuring controlled transfers. Consistent command descriptions, comprehensive tests, and various related updates further stabilize and validate these changes. The enhancements ensure improved transfer restrictions and administrative control over IBC channels.

Changes

Files Change Summary
x/aura/client/cli/tx.go Added commands for blocked channels and updated existing ones for consistency.
x/aura/keeper/... Added logic for sending restrictions based on blocked channels and associated tests.
x/aura/spec/... Added new sections for blocked channels in documentation files.
x/aura/types/... Introduced message types and codec registration for managing blocked channels.
e2e/main_test.go Updated tests to include scenarios for IBC transfers and blocked channels.

Sequence Diagram(s)

sequenceDiagram
    participant User as User
    participant CLI as CLI
    participant MsgServer as MsgServer
    participant Keeper as Keeper
    participant Blockchain as Blockchain

    User->>CLI: Execute "block channel" command
    CLI->>MsgServer: Sends blocking request
    MsgServer->>Keeper: Add channel to blocked list
    Keeper->>Blockchain: Update state with blocked channel
    Note right of Keeper: Emit BlockedChannelAdded event

    User->>CLI: Execute "unblock channel" command
    CLI->>MsgServer: Sends unblocking request
    MsgServer->>Keeper: Remove channel from blocked list
    Keeper->>Blockchain: Update state removing the blocked channel
    Note right of Keeper: Emit BlockedChannelRemoved event
sequenceDiagram
    participant User as User
    participant CLI as CLI
    participant MsgServer as MsgServer
    participant Keeper as Keeper
    participant Blockchain as Blockchain

    User->>Blockchain: Initiate IBC Transfer
    Blockchain->>Keeper: Check SendRestrictionFn
    Keeper->>Keeper: Validate blocked channels
    Keeper-->>Blockchain: Allow/Deny based on channel status
    Blockchain-->>User: Transfer result

Poem

In the realm of blockchain's song,
Channels locked and blocked along,
Now commands both bold and bright,
Guard the paths and set things right.
Transfers flow or find their end,
With rules that Keeper doth defend.
🌟✨🐇

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 .` - `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.` - `@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 as 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. 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](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.
codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

:loudspeaker: Thoughts on this report? Let us know!