search

cosmos / interchain-security

Replicated security (aka interchain security V1) is an open sourced IBC application which allows cosmos blockchains to lease their proof-of-stake security to one another.
https://cosmos.github.io/interchain-security/
Other
152 stars 108 forks source link

docs: introduce ADR for permissionless ICS #2001

Open insumity opened 5 days ago

insumity commented 5 days ago

Description

Closes: #XXXX

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.

I have...

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.

I have...

Summary by CodeRabbit

coderabbitai[bot] commented 4 days ago

[!NOTE]

Reviews paused

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Walkthrough

The changes introduce "Permissionless Interchain Security (ICS)," allowing consumer chains to join ICS via transactions without requiring a governance proposal. Key additions include using consumerID instead of chainID to prevent chain-ID squatting, incorporating ConsumerChainRecord for managing chain information, and adding new messages (MsgLaunchConsumerChain, MsgUpdateConsumerChain, MsgStopConsumerChain) to handle consumer chain lifecycle management.

Changes

File Path Change Summary
docs/docs/adrs/adr-018-permissionless-ics.md New file introducing "Permissionless Interchain Security (ICS)" allowing Opt In consumer chains to join ICS without a governance proposal, using transactions. Key changes include the introduction of consumerID for indexing, the addition of ConsumerChainRecord, and new messages for managing consumer chains.

Sequence Diagram(s)

sequenceDiagram
    participant Consumer as Consumer Chain
    participant Hub as ICS Hub
    participant Registry as Chain Registry
    Consumer->>Hub: MsgLaunchConsumerChain
    Hub->>Registry: Register Consumer with consumerID
    Registry-->Hub: Acknowledge Registration
    Hub-->Consumer: Consumer Chain Launched

    Consumer->>Hub: MsgUpdateConsumerChain
    Hub->>Registry: Update Consumer Chain Record
    Registry-->Hub: Acknowledge Update
    Hub-->Consumer: Consumer Chain Updated

    Consumer->>Hub: MsgStopConsumerChain
    Hub->>Registry: Remove Consumer Chain Record
    Registry-->Hub: Acknowledge Removal
    Hub-->Consumer: Consumer Chain Stopped

Possibly related issues

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.
p-offtermatt commented 3 days ago

@coderabbitai pause I thought I turned the bot off on markdown files :(

coderabbitai[bot] commented 3 days ago

@p-offtermatt: I couldn't locate a specific CodeRabbit configuration file in the repository. To exclude markdown files from the review process, you can add a path_filters configuration in your .coderabbit.yml or equivalent configuration file. Here is an example:

path_filters:
  exclude:
    - "**/*.md"

This will ensure that markdown files are ignored during the review process. If you need further assistance, please let me know.

Analysis chain @p-offtermatt: I will pause the bot as requested. If you need help with the configuration to exclude markdown files from the review process, please let me know. --- --- --- ---
Scripts executed The following scripts were executed for the analysis: --- Script: ```shell #!/bin/bash # Dump the current configuration to check if markdown files are excluded from the review process. gh api repos/cosmos/interchain-security/actions/workflows --jq '.workflows[] | select(.name == "CodeRabbit Configuration") | .path' ``` Length of output: 133 --- --- Script: ```shell #!/bin/bash # Search for the CodeRabbit configuration file in the repository. fd -e yml -e yaml -e json -e toml -e ini -e conf -e cfg -e config --type f --name '*coderabbit*' --exec cat ``` Length of output: 378 --- --- Script: ```shell #!/bin/bash # Correct the fd command to search for the CodeRabbit configuration file in the repository. fd -e yml -e yaml -e json -e toml -e ini -e conf -e cfg -e config 'coderabbit' --type f --exec cat ``` Length of output: 98 --- --- Script: ```shell #!/bin/bash # Use rg to search for "CodeRabbit" within the repository to identify where the configuration might be stored. rg -i 'CodeRabbit' ``` Length of output: 18 --- --- Script: ```shell #!/bin/bash # Search for common configuration file names related to CodeRabbit in the repository. fd -e yml -e yaml -e json -e toml -e ini -e conf -e cfg -e config --type f --exec echo ``` Length of output: 1018
Learnings used ``` Learnt from: p-offtermatt PR: cosmos/interchain-security#2001 File: docs/docs/adrs/adr-018-permissionless-ics.md:195-195 Timestamp: 2024-07-03T10:36:06.506Z Learning: When reviewing documentation for the Interchain Security project, remember that the `ConsumerAdditionProposal`s should use the `consumerID` instead of using both `chainID` and `consumerID`. ```
Actions performed Reviews paused.