fix: query balances with --resolve-denom panics on invalid metadata.Display

[arlai-mk]

Description

Closes: #23147

This PR checks that the metadata.Display is a valid denom when querying bank balances with --resolve-denom flag set, so that the query does not panic anymore if the Display field is not a valid denom. It should fall back to the original denom.

---

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

• Bug Fixes
  • Improved denomination validation in balance retrieval to prevent potential errors with coin metadata.
  • Enhanced error handling for balance-related gRPC queries.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request addresses a bug in the x/bank module's balance query functionality. Specifically, it modifies the AllBalances method to handle cases where token metadata lacks a display field. The change introduces a validation check for the denomination, ensuring that when the display field is empty or invalid, the method falls back to using the base denomination from the key. This prevents panics during balance queries with the --resolve-denom flag and improves error handling for tokens with incomplete metadata.

Changes

File	Change Summary
x/bank/keeper/grpc_query.go	Added denomination validation in AllBalances method, with fallback to base denomination when metadata display is invalid

Assessment against linked issues

Objective	Addressed	Explanation
Prevent panic when metadata lacks display field [#23147]	✅
Fallback to base denom when display is missing	✅

Possibly related PRs

• fix(x/bank): Better handling of negative spendable balances #21407: Changes related to balance calculations in the BaseKeeper struct

Suggested labels

C:x/bank, backport/v0.52.x

Suggested reviewers

• julienrbrt
• sontrinh16
• facundomedica
• JulianToledano

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

x/bank/keeper/grpc_query.go (1)

68-70: Consider adding explicit handling or logging for the fallback scenario.

When metadata.Display is invalid, the code defaults to using key.K2(). While this behavior is correct, it would be helpful to add a comment or log message to clarify that the fallback is triggered due to metadata.Display being invalid. This will improve the code's maintainability and debuggability.

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d39d0bc and 4fea281.

📒 Files selected for processing (1)

• x/bank/keeper/grpc_query.go (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

x/bank/keeper/grpc_query.go (1)

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

[aljo242]

@arlai-mk looks good! can you add a test for this case?