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: bring v4.3.0 changelog to main #1980

Closed mpoke closed 1 week ago

mpoke commented 2 weeks 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 2 weeks ago
Walkthrough ## Walkthrough In version 4.3.0 of the `interchain-security` project, several updates were made, including bug fixes for computing maximum capped power, changes to error output, new features like parameter adjustments for consumer chains, and improvements in reward distribution. Additionally, significant renaming and state-breaking changes were implemented. The release notes now refer to the project as "Interchain Security" instead of "Replicated Security". There were no alterations to the declarations of exported or public entities. ## Changes | Files | Change Summary | |----------------------------------------|-----------------------------------------------------------------------------------------------------| | .changelog/v4.3.0/bug-fixes/provider/1925-apply-audit-suggestions.md | Bug fix for computing maximum capped power by applying audit suggestions. | | .changelog/v4.3.0/summary.md | Date-related change, specifically noting "June 20, 2024." | | CHANGELOG.md | Detailed version 4.3.0 changes including bug fixes, new features, and state-breaking changes. | | RELEASE_NOTES.md | Renaming the feature from "Replicated Security" to "Interchain Security" in the release notes. | ## Sequence Diagrams The changes described do not include modifications to control flows or new features that would benefit from a sequence diagram visualization. Hence, this section is not applicable.
Recent review details **Configuration used: .coderabbit.yml** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 060c943b2f17b2696e668c669352a366d3610d5d and ae5cd28e011657570f26fa3a3ddf4e2e036f2aa5.
Files selected for processing (4) * .changelog/v4.3.0/bug-fixes/provider/1925-apply-audit-suggestions.md (1 hunks) * .changelog/v4.3.0/summary.md (1 hunks) * CHANGELOG.md (1 hunks) * RELEASE_NOTES.md (1 hunks)
Files skipped from review due to trivial changes (1) * .changelog/v4.3.0/summary.md
Additional context used
Path-based instructions (2)
RELEASE_NOTES.md (1) Pattern `**/*.md`: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness. Please DO NOT report any missing or superfluous newlines, in particular at the end or beginning of files."
CHANGELOG.md (1) Pattern `**/*.md`: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness. Please DO NOT report any missing or superfluous newlines, in particular at the end or beginning of files."
Markdownlint
RELEASE_NOTES.md
16-16: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings) Headings should be surrounded by blank lines --- 17-17: null (MD037, no-space-in-emphasis) Spaces inside emphasis markers --- 17-17: null (MD037, no-space-in-emphasis) Spaces inside emphasis markers --- 25-25: null (MD037, no-space-in-emphasis) Spaces inside emphasis markers --- 25-25: null (MD037, no-space-in-emphasis) Spaces inside emphasis markers
CHANGELOG.md
380-380: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 381-381: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 382-382: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 390-390: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 391-391: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 392-392: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 393-393: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 394-394: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 395-395: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 396-396: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 397-397: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 403-403: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 404-404: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 412-412: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 419-419: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 425-425: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 431-431: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 432-432: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 448-448: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 449-449: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 450-450: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 451-451: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 455-455: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 456-456: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 457-457: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 458-458: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 459-459: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 460-460: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 461-461: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 462-462: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 463-463: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 464-464: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 465-465: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 466-466: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 467-467: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 468-468: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 469-469: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 470-470: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 471-471: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 472-472: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 473-473: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 474-474: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 475-475: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 476-476: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 477-477: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 478-478: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 479-479: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 480-480: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 481-481: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 482-482: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 483-483: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 484-484: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 485-485: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 486-486: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 522-522: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 523-523: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 529-529: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 530-530: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 531-531: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 532-532: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 536-536: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 537-537: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 543-543: Expected: dash; Actual: asterisk (MD004, ul-style) Unordered list style --- 180-180: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces) Trailing spaces --- 390-390: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces) Trailing spaces --- 391-391: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces) Trailing spaces --- 397-397: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces) Trailing spaces --- 442-442: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces) Trailing spaces --- 483-483: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces) Trailing spaces --- 559-559: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces) Trailing spaces --- 560-560: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces) Trailing spaces --- 562-562: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces) Trailing spaces --- 563-563: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces) Trailing spaces --- 572-572: Expected: 1; Actual: 2 (MD012, no-multiple-blanks) Multiple consecutive blank lines --- 418-418: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings) Headings should be surrounded by blank lines --- 247-247: null (MD031, blanks-around-fences) Fenced code blocks should be surrounded by blank lines --- 255-255: null (MD031, blanks-around-fences) Fenced code blocks should be surrounded by blank lines --- 419-419: null (MD032, blanks-around-lists) Lists should be surrounded by blank lines --- 5-5: null (MD036, no-emphasis-as-heading) Emphasis used instead of a heading --- 104-104: null (MD036, no-emphasis-as-heading) Emphasis used instead of a heading --- 114-114: null (MD036, no-emphasis-as-heading) Emphasis used instead of a heading --- 155-155: null (MD036, no-emphasis-as-heading) Emphasis used instead of a heading --- 209-209: null (MD036, no-emphasis-as-heading) Emphasis used instead of a heading --- 281-281: null (MD036, no-emphasis-as-heading) Emphasis used instead of a heading --- 401-401: null (MD036, no-emphasis-as-heading) Emphasis used instead of a heading --- 408-408: null (MD036, no-emphasis-as-heading) Emphasis used instead of a heading --- 247-247: null (MD040, fenced-code-language) Fenced code blocks should have a language specified --- 81-81: Expected: asterisk; Actual: underscore (MD049, emphasis-style) Emphasis style --- 81-81: Expected: asterisk; Actual: underscore (MD049, emphasis-style) Emphasis style --- 81-81: Expected: asterisk; Actual: underscore (MD049, emphasis-style) Emphasis style --- 81-81: Expected: asterisk; Actual: underscore (MD049, emphasis-style) Emphasis style --- 549-549: Expected: asterisk; Actual: underscore (MD049, emphasis-style) Emphasis style --- 549-549: Expected: asterisk; Actual: underscore (MD049, emphasis-style) Emphasis style --- 550-550: Expected: asterisk; Actual: underscore (MD049, emphasis-style) Emphasis style --- 550-550: Expected: asterisk; Actual: underscore (MD049, emphasis-style) Emphasis style --- 550-550: Expected: asterisk; Actual: underscore (MD049, emphasis-style) Emphasis style --- 550-550: Expected: asterisk; Actual: underscore (MD049, emphasis-style) Emphasis style
LanguageTool
CHANGELOG.md
[uncategorized] ~378-~378: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA) Context: ...h removes the panic in the consumer ccv module which would occur in an emergency scena... --- [style] ~394-~394: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE) Context: ...cosmos/ibc-go/releases/tag/v7.1.0). * Bump [CometBFT](https://github.com/cometbft/... --- [style] ~444-~444: ‘due to the fact that’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_DUE_TO_THE_FACT_THAT) Context: ...pear from other releases below. This is due to the fact that ICS v1.1.0 deviates from the commit ord... --- [uncategorized] ~446-~446: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL) Context: ...es thereafter are based on v1.1.0. ### High level changes included in v2.0.0 * MVP for s... --- [style] ~490-~490: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM) Context: ...mos Hub community through Proposal 687. In an effort to move quickly, this release also include... --- [uncategorized] ~490-~490: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE) Context: ...multisig fix that is effective only for provider. It shouldn't affect the consumer modul... --- [style] ~510-~510: Consider using a different verb for a more formal wording. (FIX_RESOLVE) Context: ...nted anyway. We have verified that this fixes the problem. ### Distribution fix The... --- [style] ~518-~518: Consider using a different verb for a more formal wording. (FIX_RESOLVE) Context: ...ore ICS led us to this realization. To fix this problem, we have re-blocked the Fe... --- [uncategorized] ~558-~558: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE) Context: ...ce proposal must be sent to the provider and it must receive the necessary votes. - ... --- [uncategorized] ~563-~563: The preposition ‘to’ seems more likely in this position. (AI_HYDRA_LEO_REPLACE_ON_TO) Context: ...nsferred, these rewards are distributed on the provider using the protocol in the ... --- [uncategorized] ~570-~570: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL) Context: ...*: Enables the provider to slow down a "worst case scenario" attack where a malicious cons...
Additional comments not posted (3)
.changelog/v4.3.0/bug-fixes/provider/1925-apply-audit-suggestions.md (1)
`1-3`: **Well-documented changelog entry.** The entry clearly describes the bug fix and appropriately links to the related GitHub issue. Good job maintaining clarity and conciseness in documentation.
RELEASE_NOTES.md (1)
`9-9`: **Title format updated correctly.** The title has been updated to reflect the new feature name "Interchain Security". This aligns with the rebranding mentioned in the PR summary.
CHANGELOG.md (1)
`7-19`: **Comprehensive and well-documented changelog entries.** The bug fixes, dependency updates, and feature additions are well-documented with appropriate links to the corresponding pull requests. This provides clear traceability and accountability.
--- 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.