fix!: apply audit suggestions

[insumity]

Description

Closes (partially): https://github.com/cosmos/interchain-security/issues/1926

Attached Audit Report

This PR applies some of the suggestions suggested by the audit team in regards to PSS. The change in NoMoreThanPercentOfTheSum on how we compute maxPower might have as a result, different powers being sent down to a consumer chain. Therefore, this is a breaking change and I'm not backporting it to v4.2.x or v4.2.x-lsm.

This PR also introduces new checks on the returner error from ComputeMinPowerToOptIn. Thanks to @sainoe for pointing this out!

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...

• [x] Included the correct type prefix in the PR title
• [x] Added ! to the type prefix if the change is state-machine breaking
• [ ] Confirmed this PR does not introduce changes requiring state migrations, OR migration code has been added to consumer and/or provider modules
• [x] Targeted the correct branch (see PR Targeting)
• [ ] Provided a link to the relevant issue or specification
• [ ] Followed the guidelines for building SDK modules
• [ ] Included the necessary unit and integration tests
• [ ] Added a changelog entry to CHANGELOG.md
• [ ] Included comments for documenting Go code
• [ ] Updated the relevant documentation or specification
• [x] Reviewed "Files changed" and left comments if necessary
• [ ] Confirmed all CI checks have passed
• [ ] If this PR is library API breaking, bump the go.mod version string of the repo, and follow through on a new major release

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...

• [ ] confirmed the correct type prefix in the PR title
• [ ] confirmed ! the type prefix if the change is state-machine breaking
• [ ] confirmed this PR does not introduce changes requiring state migrations, OR confirmed migration code has been added to consumer and/or provider modules
• [ ] confirmed all author checklist items have been addressed
• [ ] reviewed state machine logic
• [ ] reviewed API design and naming
• [ ] reviewed documentation is accurate
• [ ] reviewed tests and test coverage

Summary by CodeRabbit

• Refactor

  • Enhanced validation logic for handling opt-ins and chain validation.
  • Updated computation methods for determining minimum power and maximum power for validators.
  • Renamed functions for better clarity and streamlined logic.

• Bug Fixes

  • Fixed issues with parameter handling in opt-in functions to improve reliability and accuracy.

• Tests

  • Adjusted test cases to align with the updated function parameters and logic.
  • Renamed test functions to match the new function names and improved test coverage.

[coderabbitai[bot]]

Walkthrough

## Walkthrough The recent changes focus on refining the `HandleOptIn`, `ComputeMinPowerToOptIn`, and `NoMoreThanPercentOfTheSum` functions within the `provider/keeper` package. These adjustments enhance validation logic, improve computational accuracy, and simplify function signatures. Additionally, the `FilterOptedInAndAllowAndDenylistedPredicate` function has been renamed to `CanValidateChain` with updated logic. The `QueueVSCPackets` function now directly uses `chain.Top_N` for determining top validators, and test cases have been updated accordingly. ## Changes | File Path | Change Summary | |-----------|----------------| | `x/ccv/provider/keeper/partial_set_security.go` | Modified `HandleOptIn` to accept a string for `consumerKey`, adjusted `ComputeMinPowerToOptIn` validation logic, refined `NoMoreThanPercentOfTheSum` computation, renamed and updated `FilterOptedInAndAllowAndDenylistedPredicate` to `CanValidateChain`. | | `x/ccv/provider/keeper/relay.go` | Updated `QueueVSCPackets` to use `chain.Top_N` directly for top validators and adjusted `minPower` computation. | | `x/ccv/provider/keeper/partial_set_security_test.go` | Adjusted test cases for `HandleOptIn`, `ComputeMinPowerToOptIn`, and renamed `FilterOptedInAndAllowAndDenylistedPredicate` to `CanValidateChain`. | | `x/ccv/provider/keeper/proposal.go` | Modified `MakeConsumerGenesis` to remove `chainID` argument from `ComputeMinPowerToOptIn` and added error handling. | ## Sequence Diagram(s) (Beta) ```mermaid sequenceDiagram participant User participant Keeper participant Module User->>Keeper: Call HandleOptIn(chainID, providerAddr, consumerKey) Keeper->>Keeper: Validate consumerKey Keeper->>Module: ComputeMinPowerToOptIn(chainID, bondedValidators, topN) Module-->>Keeper: Return minPower Keeper->>User: Return success/failure User->>Keeper: Call QueueVSCPackets() Keeper->>Keeper: Check chain.Top_N Keeper->>Module: ComputeMinPowerToOptIn(chainID, bondedValidators, chain.Top_N) Module-->>Keeper: Return minPower Keeper->>User: Return success/failure ``` This diagram visualizes the primary interactions for the `HandleOptIn` and `QueueVSCPackets` functions, highlighting the changes in the validation and computation logic.

---

Recent review details

**Configuration used: .coderabbit.yml** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between 1d13c9bef15a8941ebc67a63b6119d8927fb4a1b and 54afcba8149fe017e91158b006360bf3cf9994a3.

Files ignored due to path filters (2)

* `go.mod` is excluded by `!**/*.mod` * `go.sum` is excluded by `!**/*.sum`

Files selected for processing (9)

* .changelog/unreleased/dependencies/1924-bump-ibc.md (1 hunks) * .github/workflows/docker-publish.yml (1 hunks) * .github/workflows/proto-registry.yml (1 hunks) * .github/workflows/proto.yml (1 hunks) * x/ccv/provider/keeper/keeper.go (5 hunks) * x/ccv/provider/keeper/partial_set_security.go (9 hunks) * x/ccv/provider/keeper/partial_set_security_test.go (5 hunks) * x/ccv/provider/keeper/proposal.go (1 hunks) * x/ccv/provider/keeper/relay.go (1 hunks)

Files skipped from review due to trivial changes (3)

* .github/workflows/docker-publish.yml * .github/workflows/proto-registry.yml * .github/workflows/proto.yml

Files skipped from review as they are similar to previous changes (4)

* x/ccv/provider/keeper/keeper.go * x/ccv/provider/keeper/partial_set_security.go * x/ccv/provider/keeper/partial_set_security_test.go * x/ccv/provider/keeper/relay.go

Additional context used

Path-based instructions (1)

x/ccv/provider/keeper/proposal.go (1)

Pattern `**/*.go`: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Markdownlint

.changelog/unreleased/dependencies/1924-bump-ibc.md

3-3: null (MD047, single-trailing-newline) Files should end with a single newline character

--- 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.