8000 fix: validators query to prevent returning unbonding validators by beer-1 · Pull Request #403 · initia-labs/initia · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix: validators query to prevent returning unbonding validators #403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
May 15, 2025
Merged

fix: validators query to prevent returning unbonding validators #403

merged 1 commit into from
May 15, 2025

Conversation

beer-1
Copy link
Member
@beer-1 beer-1 commented May 14, 2025

Description

Fix validators query to prevent returning unbonding validators which are in whitelist but not in BondedStatus due to the max num of validators.

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

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

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 all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

@beer-1
fix validators query to prevent returning unbonding validators which …
c55eae3 
…are in whitelist but not in bonded state due to max num of validators
@beer-1 beer-1 requested a review from sh-cha May 14, 2025 08:22
@beer-1 beer-1 self-assigned this May 14, 2025
@beer-1 beer-1 requested a review from a team as a code owner May 14, 2025 08:22
@coderabbitai coderabbitai
Copy link
coderabbitai bot commented May 14, 2025 •
edited
Loading
📝 Walkthrough

Walkthrough

The Validators query logic in the staking module was updated to use a two-step filtered pagination approach, introducing a caching mechanism keyed by hex-encoded addresses to efficiently filter validators by status. Corresponding tests were updated to set a maximum validator count and verify correct filtering of bonded versus unbonding validators.

Changes

File(s) Change Summary
x/mstaking/keeper/grpc_query.go Refactored the Validators method to use filtered pagination with a caching layer and hex keys.
x/mstaking/keeper/grpc_query_test.go Updated tests to set MaxValidators, add an unbonding validator, and assert correct filtering.

Poem

In the garden of code, where validators grow,
A cache now remembers, as queries flow.
Hex keys unlock, the status is clear,
Bonded or not, the results appear.
With tests as our sunlight, correctness in bloom—
The staking patch hops forward, dispelling all gloom!
🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d2e4b37 and c55eae3.

📒 Files selected for processing (2)
  • x/mstaking/keeper/grpc_query.go (2 hunks)
  • x/mstaking/keeper/grpc_query_test.go (1 hunks)
🔇 Additional comments (4)
x/mstaking/keeper/grpc_query.go (2)

5-5: Added encoding/hex import to support address encoding in the Validators query

The import is used for hex encoding validator addresses as cache keys in the updated implementation.

47-59: Great implementation of filtered pagination for bonded validators!

This implementation elegantly solves the issue of unbonding validators being included in query results when the maximum number of validators is reached. The two-step approach using a caching mechanism is efficient:

  1. First filters validators by status before pagination
  2. Uses a cache keyed by hex-encoded addresses to avoid repeated store lookups
  3. Only includes validators with the requested bonded status

This ensures that only truly bonded validators are returned in the response, addressing the issue described in the PR objectives.

x/mstaking/keeper/grpc_query_test.go (2)

18-24: Good test setup for MaxValidators parameter

The test now explicitly sets the maximum validators to 2, which creates the right conditions to test the fix for the unbonding validator query issue.

25-28: Effective test case with appropriate validator configuration

This setup creates exactly the right scenario to test the fix:

  • Two validators with higher power (2M tokens each) will take the bonded slots
  • The third validator with less power (1M tokens) will be forced into the unbonding state
  • When querying for bonded validators, we can verify the filtering works correctly

This validates that the query properly filters out unbonding validators, directly addressing the issue from the PR objectives.

✨ Finishing Touches
  • 📝 Generate Docstrings
🪧 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

@github-actions GitHub Actions
Copy link

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@codecov Codecov
Copy link
codecov bot commented May 14, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 70.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 40.10%. Comparing base (d2e4b37) to head (c55eae3).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
x/mstaking/keeper/grpc_query.go 70.00% 2 Missing and 1 partial ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #403   +/-   ##
=======================================
  Coverage   40.10%   40.10%           
=======================================
  Files         295      295           
  Lines       27679    27687    +8     
=======================================
+ Hits        11100    11105    +5     
- Misses      14873    14875    +2     
- Partials     1706     1707    +1
Files with missing lines Coverage Δ
x/mstaking/keeper/grpc_query.go 48.89% <70.00%> (+0.22%) ⬆️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

sh-cha
sh-cha approved these changes May 15, 2025
View reviewed changes
Copy link
Contributor
@sh-cha sh-cha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@beer-1 beer-1 merged commit 92996f0 into main May 15, 2025
8 checks passed
@beer-1 beer-1 deleted the fix/validators-query branch May 15, 2025 04:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sh-cha sh-cha sh-cha approved these changes

Assignees

@beer-1 beer-1

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@beer-1 @sh-cha
0