refactor(x/feegrant): remove Address.String()

[JulianToledano]

Description

ref:
#13140
#7448

Also removes a couple of calls I forgot to remove in gov.

---

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

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

• Refactor
  • Updated the createGrant function in the Fee Grant module to use a new addressCodec parameter for address encoding and decoding.
  • Enhanced the Fee Grant simulation by incorporating an addressCodec parameter in the genFeeGrants function for address conversion, improving error handling.
  • Modified the Governance module to improve address data handling in events and proposal attributes.

[coderabbitai]

Walkthrough

The changes involve updating the cosmos-sdk to enhance address handling by introducing addressCodec parameters across various modules for address encoding and decoding. This update is part of a broader initiative to remove global bech32 prefix usage, aiming to improve code modularity and reduce reliance on global configurations.

Changes

File Path	Change Summary
x/feegrant/client/cli/tx_test.go x/feegrant/simulation/genesis.go	Introduced addressCodec parameter for address encoding and decoding. Updated function signatures and usage.
x/gov/keeper/deposit.go x/gov/keeper/proposal.go	Modified address handling before emitting events and updating attribute values.

Related issues

• EPIC: remove global bech32 #13140: The changes align with the objective to remove global bech32 usage and improve address handling by using addressCodec. This indicates a direct effort to address the outlined goals of eliminating global variables and enhancing modularity.

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-tests 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 tests 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 tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between def211d and 82e309c.

Files selected for processing (4)

• x/feegrant/client/cli/tx_test.go (28 hunks)
• x/feegrant/simulation/genesis.go (3 hunks)
• x/gov/keeper/deposit.go (1 hunks)
• x/gov/keeper/proposal.go (1 hunks)

Additional comments: 7

x/feegrant/simulation/genesis.go (1)

• 17-30: The introduction of the addressCodec parameter in the genFeeGrants function and its usage for converting addresses using BytesToString method is a good practice for handling address conversions more flexibly. However, it's important to ensure that the addressCodec is properly instantiated and passed to this function wherever it's called to avoid runtime errors.

x/gov/keeper/proposal.go (1)

• 159-159: Updating the attribute value for types.AttributeKeyProposalProposer to use proposerAddr instead of proposer.String() is a positive change that aligns with the objective of removing direct calls to the String() method. This enhances consistency in address handling.

x/gov/keeper/deposit.go (1)

• 184-191: Converting the depositor address to a string using addressCodec.BytesToString before emitting an event in the AddDeposit function is a good practice. It ensures that address data is handled consistently across the module. Just ensure that addressCodec is reliably provided to this function to avoid runtime issues.

x/feegrant/client/cli/tx_test.go (4)

• 122-136: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [94-129]

Introducing the addressCodec parameter in the createGrant function and using it for address conversions is a good practice that aligns with the broader refactor goals. This change ensures that address handling is consistent and flexible. Make sure that all calls to createGrant are updated to pass the addressCodec correctly.

• 153-157: Using the addressCodec for converting addresses in test setup is consistent with the changes made in the main codebase. This ensures that tests remain aligned with the implementation they are meant to verify.
• 446-456: The usage of addressCodec for address conversions in test scenarios is correctly applied, ensuring consistency with the main codebase's approach to address handling. This is crucial for maintaining the integrity and relevance of the tests.
• 562-570: Applying the addressCodec for address conversions in the TestFilteredFeeAllowance test case is in line with the refactor's objectives. It's important to ensure that such practices are consistently applied across all test cases for uniformity.