Skip to content
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.

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

refactor(x): remove Address.String() #20048

Merged
merged 2 commits into from
Apr 15, 2024
Merged

Conversation

JulianToledano
Copy link
Contributor

@JulianToledano JulianToledano commented Apr 15, 2024

Description

ref:
#13140
#7448

This PR remove Address.String method from:

  • x/accounts
  • x/authz
  • x/circuit
  • x/consensus
  • x/mint
  • x/slashing

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

  • New Features

    • Enhanced error handling and address conversion across various modules for improved consistency and reliability.
  • Bug Fixes

    • Addressed issues in authority and sender address handling, ensuring accurate processing and error messaging.
  • Refactor

    • Standardized address conversion using a unified method, enhancing code maintainability and reducing potential errors.

@JulianToledano JulianToledano requested a review from a team as a code owner April 15, 2024 11:06
Copy link
Contributor

coderabbitai bot commented Apr 15, 2024

Walkthrough

The updates across multiple files primarily focus on enhancing how addresses are managed and converted within various functions and tests. The changes implement a consistent approach to converting addresses to strings, utilizing a new AddressCodec for error handling and data consistency. This standardization aims to improve reliability and maintainability of the codebase.

Changes

Files Change Summary
x/accounts/cli/cli.go
x/circuit/depinject.go
x/circuit/keeper/genesis_test.go
x/circuit/keeper/keeper_test.go
x/consensus/depinject.go
x/consensus/keeper/keeper_test.go
x/mint/simulation/proposals.go
x/mint/simulation/proposals_test.go
Updated handling of address conversions using AddressCodec for converting addresses to strings. This includes error handling and passing converted addresses to various functions and structs.
x/authz/keeper/keeper.go
x/slashing/keeper/signing_info.go
x/slashing/keeper/signing_info_test.go
Enhanced error handling and address conversion in error messages. Modifications include using address conversion for clearer error reporting and consistent data handling.

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

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

Copy link
Contributor

@meetrick meetrick left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 6

x/slashing/keeper/signing_info.go Show resolved Hide resolved
Comment on lines +46 to +50
addr, err := k.sk.ConsensusAddressCodec().BytesToString(consAddr)
if err != nil {
return types.ErrNoSigningInfoFound.Wrapf("could not convert consensus address to string. Error: %s", err.Error())
}
return types.ErrNoSigningInfoFound.Wrap(fmt.Sprintf("cannot tombstone validator with consensus address %s that does not have any signing information", addr))
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider enhancing the error message to include the consensus address that failed conversion.

- return types.ErrNoSigningInfoFound.Wrapf("could not convert consensus address to string. Error: %s", err.Error())
+ return types.ErrNoSigningInfoFound.Wrapf("could not convert consensus address %s to string. Error: %s", consAddr.String(), err.Error())

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
addr, err := k.sk.ConsensusAddressCodec().BytesToString(consAddr)
if err != nil {
return types.ErrNoSigningInfoFound.Wrapf("could not convert consensus address to string. Error: %s", err.Error())
}
return types.ErrNoSigningInfoFound.Wrap(fmt.Sprintf("cannot tombstone validator with consensus address %s that does not have any signing information", addr))
addr, err := k.sk.ConsensusAddressCodec().BytesToString(consAddr)
if err != nil {
return types.ErrNoSigningInfoFound.Wrapf("could not convert consensus address %s to string. Error: %s", consAddr.String(), err.Error())
}
return types.ErrNoSigningInfoFound.Wrap(fmt.Sprintf("cannot tombstone validator with consensus address %s that does not have any signing information", addr))

x/authz/keeper/keeper.go Show resolved Hide resolved
x/consensus/depinject.go Show resolved Hide resolved
x/circuit/depinject.go Show resolved Hide resolved
x/mint/simulation/proposals.go Show resolved Hide resolved
@tac0turtle tac0turtle added this pull request to the merge queue Apr 15, 2024
Merged via the queue into main with commit f499bbf Apr 15, 2024
62 of 65 checks passed
@tac0turtle tac0turtle deleted the julian/x-accString-removal branch April 15, 2024 14:01
alpe added a commit to alpe/cosmos-sdk that referenced this pull request Apr 16, 2024
* main:
  refactor(x/simulation)!: remove accounts string (cosmos#20056)
  fix(baseapp): don't share global gas meter in tx execution (cosmos#19616)
  feat(x/accounts): use router service from env (cosmos#20003)
  refactor(x): remove Address.String() (cosmos#20048)
  build(deps): Bump github.com/jhump/protoreflect from 1.15.6 to 1.16.0 in /tests (cosmos#20040)
  feat(collections): add `NewJSONValueCodec` (cosmos#19861)
alpe added a commit that referenced this pull request Apr 17, 2024
* main:
  build(deps): Bump github.com/pelletier/go-toml/v2 from 2.2.0 to 2.2.1 in /tools/confix (#20052)
  build(deps): Bump cosmossdk.io/api from 0.7.3 to 0.7.4 (#20063)
  fix: secp256r1 json missing quotes (#20060)
  fix(x/accounts): remove double execute (#20065)
  refactor(x/accounts): Skip Importing Unregistered Genesis Account Types (#20053)
  refactor(x/simulation)!: remove accounts string (#20056)
  fix(baseapp): don't share global gas meter in tx execution (#19616)
  feat(x/accounts): use router service from env (#20003)
  refactor(x): remove Address.String() (#20048)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants