refactor(x/bank): audit QA

[akhilkumarpilli]

Description

ref: #20955

---

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

  • Introduced a new test for gRPC queries related to denomination metadata, enhancing test coverage.

• Improvements

  • Simplified address handling in tests for better clarity and maintainability.
  • Updated authority address retrieval to use constants instead of hardcoded strings, improving code reliability.

• Bug Fixes

  • Enhanced consistency in address encoding within test cases.

[coderabbitai]

Walkthrough

Walkthrough

The changes involve modifications to several test files and a simulation proposal file within the x/bank module. Key updates include the removal of hardcoded strings in favor of constants for authority retrieval, streamlining address handling in tests, and the addition of a new test function for denomination metadata queries. These adjustments enhance code clarity and maintainability while preserving existing functionalities.

Changes

Files	Change Summary
x/bank/keeper/genesis_test.go	Simplified getTestBalancesAndSupply function by hardcoding addresses as strings and modifying total supply calculation for clarity and efficiency.
x/bank/keeper/grpc_query_test.go	Replaced address encoding method to use authKeeper, added TestGRPCDenomMetadataV2 for testing denomination metadata queries under various conditions.
x/bank/simulation/proposals.go	Updated authority address retrieval from hardcoded string "gov" to types.GovModuleName for improved clarity and maintainability.
x/bank/simulation/proposals_test.go	Changed authority derivation in TestProposalMsgs from address.Module("gov") to address.Module(types.GovModuleName) for consistency and maintainability.

---

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

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 17d864f and 5d8481f.

Files selected for processing (4)

• x/bank/keeper/genesis_test.go (2 hunks)
• x/bank/keeper/grpc_query_test.go (5 hunks)
• x/bank/simulation/proposals.go (1 hunks)
• x/bank/simulation/proposals_test.go (1 hunks)

Files skipped from review due to trivial changes (2)

• x/bank/keeper/genesis_test.go
• x/bank/simulation/proposals_test.go

Additional context used

Path-based instructions (2)

x/bank/simulation/proposals.go (1)

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

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

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

---

Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

Additional comments not posted (6)

x/bank/simulation/proposals.go (1)

37-37: LGTM!

The change to use types.GovModuleName instead of a hardcoded string "gov" improves code maintainability and reduces the risk of errors.

x/bank/keeper/grpc_query_test.go (5)

24-24: LGTM!

The change to use suite.authKeeper.AddressCodec().BytesToString(addr) instead of codectestutil.CodecOptions{}.GetAddressCodec().BytesToString(addr) improves consistency and potentially improves the reliability of address handling within the tests.

---

110-110: LGTM!

The change to use suite.authKeeper.AddressCodec().BytesToString(addr) instead of codectestutil.CodecOptions{}.GetAddressCodec().BytesToString(addr) improves consistency and potentially improves the reliability of address handling within the tests.

---

183-183: LGTM!

The change to use suite.authKeeper.AddressCodec().BytesToString(addr) instead of codectestutil.CodecOptions{}.GetAddressCodec().BytesToString(addr) improves consistency and potentially improves the reliability of address handling within the tests.

---

Line range hint 200-200: LGTM!

The change to use suite.authKeeper.AddressCodec().BytesToString(addr) instead of codectestutil.CodecOptions{}.GetAddressCodec().BytesToString(addr) improves consistency and potentially improves the reliability of address handling within the tests.

---

601-693: LGTM!

The new test function TestGRPCDenomMetadataV2 enhances the overall test coverage for the bank module, particularly for the new metadata functionalities.

[tac0turtle]

nice cleanup!!

[julienrbrt]

lgtm!