fix(x/staking): query redelegation command

[akhilkumarpilli]

Description

Closes: #21855

---

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 (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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

Summary by CodeRabbit

• New Features

  • Enhanced staking functionality with updated query messages to capture additional data points.
  • The dst_validator_addr argument in the CLI is now optional, improving usability.

• Bug Fixes

  • Improved clarity in validator address types for redelegation requests, ensuring better data handling.

[coderabbitai]

Walkthrough

Walkthrough

The changes in this pull request involve significant modifications to the staking-related files in the Cosmos API. Key updates include enhancements to protocol buffer message definitions, making certain CLI arguments optional, and refining type annotations for validator addresses. These changes aim to improve the functionality and clarity of the staking commands and their underlying data structures.

Changes

File Path	Change Summary
api/cosmos/staking/v1beta1/query.pulsar.go	Updated message signatures for QueryRedelegations, QueryDelegatorDelegations, QueryValidatorDelegations, and QueryDelegatorRedelegations to include additional fields.
x/staking/autocli.go	Made dst_validator_addr positional argument optional in the AutoCLIOptions function.
x/staking/proto/cosmos/staking/v1beta1/query.proto	Changed field types for src_validator_addr and dst_validator_addr in QueryRedelegationsRequest from cosmos.AddressString to cosmos.ValidatorAddressString.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant StakingAPI
    participant QueryService

    User->>CLI: Execute query command
    CLI->>StakingAPI: Parse command arguments
    StakingAPI->>QueryService: Request redelegation info
    QueryService-->>StakingAPI: Return redelegation data
    StakingAPI-->>CLI: Send response
    CLI-->>User: Display results

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Fix the query redelegation CLI command not working (#[21855])	✅

Possibly related PRs

• chore(x/staking): revert proto breakage #21666: This PR modifies the same file as the main PR, impacting protocol buffer definitions and message structures.

Suggested labels

C:x/accounts, C:x/accounts/multisig

Suggested reviewers

• julienrbrt
• facundomedica
• testinginprod
• ziscky

---

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4666e1d and a530d7b.

Files ignored due to path filters (1)

• x/staking/types/query.pb.go is excluded by !**/*.pb.go

Files selected for processing (3)

• api/cosmos/staking/v1beta1/query.pulsar.go (1 hunks)
• x/staking/autocli.go (1 hunks)
• x/staking/proto/cosmos/staking/v1beta1/query.proto (1 hunks)

Additional context used

Path-based instructions (2)

api/cosmos/staking/v1beta1/query.pulsar.go (1)

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

x/staking/autocli.go (1)

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

Additional comments not posted (5)

x/staking/autocli.go (1)

116-116: Approved: Optional destination validator address aligns with PR objective

This change makes the dst_validator_addr argument optional, which aligns with the PR objective to fix the query redelegation command. This modification should resolve the issue described in the linked bug report (#21855).

To ensure this change doesn't introduce any inconsistencies, please verify:

1. The CLI behavior when the destination validator address is omitted.
2. Any functions that rely on this argument are updated to handle its optional nature.

Run the following script to check for potential impacts:

Verification successful

---

Verified: Optional destination validator address change has no adverse impacts

The modification to make the dst_validator_addr argument optional has been thoroughly verified. No inconsistencies or unexpected behaviors were found in other parts of the codebase as a result of this change.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for usages of Redelegations method and potential impacts

# Search for Redelegations method usage
echo "Searching for Redelegations method usage:"
rg --type go "Redelegations\(" -A 5

# Search for any code that might be affected by the optional dst_validator_addr
echo "Searching for potential impacts of optional dst_validator_addr:"
rg --type go "dst_validator_addr" -A 5

Length of output: 22143

x/staking/proto/cosmos/staking/v1beta1/query.proto (1)

307-310: Approve: Improved type specificity for validator addresses

The changes to src_validator_addr and dst_validator_addr fields in the QueryRedelegationsRequest message are appropriate and beneficial. By updating the scalar type from "cosmos.AddressString" to "cosmos.ValidatorAddressString", we achieve:

1. Better type safety: The new type more accurately represents the expected input, reducing the risk of passing incorrect address types.
2. Improved clarity: It's now explicit that these fields should contain validator addresses, not general addresses.
3. Alignment with the reported issue: This change addresses the mismatch in the expected bech32 prefix for validator addresses, as mentioned in the linked issue [Bug]: query redelegation cli command not working #21855.

These modifications should resolve the CLI command error and improve the overall robustness of the redelegation query functionality.

api/cosmos/staking/v1beta1/query.pulsar.go (3)

15716-15746: LGTM: Updates to QueryRedelegationsRequest

The addition of delegator_address, src_validator_address, dst_validator_address, and pagination fields in the QueryRedelegationsRequest message enhances the querying capabilities for redelegations. These changes align with the objectives outlined in the PR and appear to be correctly implemented.

---

15752-15794: LGTM: Modifications to QueryDelegatorValidators Messages

The updates to QueryDelegatorValidatorsRequest and QueryDelegatorValidatorsResponse messages, including the addition of the pagination field, improve the functionality for querying delegator validators with pagination support. The changes are consistent and properly structured.

---

15816-15946: LGTM: Enhancements to Query Service Methods

Multiple query service methods, such as Validators, Validator, ValidatorDelegations, and ValidatorRedelegations, have been updated to include additional parameters and pagination support. These enhancements improve the API endpoints' flexibility and usability. The changes are appropriately reflected in the descriptor bytes.

---

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
• Mastodon
• Reddit
• LinkedIn

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

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]

@akhilkumarpilli your pull request is missing a changelog!

[julienrbrt]

utACK!