interchain-security icon indicating copy to clipboard operation
interchain-security copied to clipboard

feat: add a query to retrieve validator set that was last sent to the consumer chain

Open insumity opened this issue 9 months ago • 1 comments

Description

Closes: #XXXX

This PR introduces a query to retrieve the validator set that was last sent to the consumer chain. Note that this does not necessarily mean that the consumer chain is using this validator set because a VSCPacket could be delayed, etc.


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
  • [ ] Added ! to the type prefix if the change is state-machine breaking
  • [x] 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
  • [x] Included the necessary unit and integration tests
  • [x] Added a changelog entry to CHANGELOG.md
  • [ ] Included comments for documenting Go code
  • [x] 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

  • New Features
    • Introduced a new query feature to fetch the latest set of consumer validators for a specific consumer chain. This enhancement allows users to retrieve up-to-date validator information efficiently.

insumity avatar May 08 '24 11:05 insumity

[!WARNING]

Rate Limit Exceeded

@insumity has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 6 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between edef130ffaf0a49583b2cb00bc87af4b103e8101 and 258a807b6837a8c3c158b6df43d5f088d1729b27.

Walkthrough

The update introduces a new query, consumer-validators, to fetch the latest set of consumer validators for a specified consumer chain. This involves adding a new RPC method, message types, CLI command, and corresponding tests. Documentation has been updated to reflect these changes, including instructions on how to use the new query and a warning about the possible discrepancy between the returned validators and the current validator set.

Changes

Files / Paths Change Summary
.changelog/unreleased/features/provider/1867-add-query-for-latest-consumer-validator-set.md Added summary for the new consumer-validators query.
proto/interchain_security/ccv/provider/v1/query.proto Introduced QueryConsumerValidators RPC method and associated message types.
x/ccv/provider/client/cli/query.go Added CmdConsumerValidators() command to query consumer validators by chain ID.
x/ccv/provider/keeper/grpc_query.go Added QueryConsumerValidators function to retrieve consumer validators for a chain.
x/ccv/provider/keeper/grpc_query_test.go Added tests for various query scenarios related to consumer validators.
docs/docs/validators/partial-set-security-for-validators.md Updated section header and added instructions on retrieving consumer validators, including a warning.

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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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.

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.
  • Please see the configuration documentation 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar May 08 '24 11:05 coderabbitai[bot]