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/evidence)!: remove Address.String() #20016

Merged
merged 2 commits into from
Apr 12, 2024

Conversation

JulianToledano
Copy link
Contributor

@JulianToledano JulianToledano commented Apr 11, 2024

Description

ref:
#13140
#7448


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 the Submit Evidence functionality to accept a string argument for increased flexibility.
  • Refactor

    • Improved address handling in evidence submission processes to ensure robust and error-free operations.
  • Tests

    • Updated and expanded test cases to align with the new address handling and evidence submission requirements.

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

coderabbitai bot commented Apr 11, 2024

Walkthrough

Walkthrough

The changes involve updating the evidence module in the Cosmos SDK to handle addresses as strings rather than specific address types. This includes modifications in message handling, tests, and keeper setups to accommodate and utilize the new address handling approach, aligning with broader SDK goals to decouple from specific address encodings.

Changes

Files Summary of Changes
x/evidence/CHANGELOG.md Updated NewMsgSubmitEvidence to accept a string argument instead of an AccAddress.
x/evidence/keeper/..., x/evidence/types/... Integrated new address handling using addressCodec and consAddressCodec, updated tests and types accordingly.
x/evidence/keeper/msg_server_test.go Adjusted address handling in test cases for evidence submission.
x/evidence/types/msgs.go Changed parameter type in NewMsgSubmitEvidence and modified Submitter assignment.

Possibly related issues

  • Issue EPIC: remove global bech32 #13140: This issue discusses removing global bech32 prefix usage and replacing it with localized address codecs, which aligns with the changes made in this PR to handle addresses as strings and use codecs for conversion.
    • Reasoning: The PR's shift to string-based address handling and the introduction of localized codecs for address conversion directly support the objectives of reducing global dependency on specific address formats and using codecs instead.

Recent Review Details

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between d197f06 and 719a9e0.
Files selected for processing (1)
  • x/evidence/CHANGELOG.md (1 hunks)
Additional Context Used
Path-based Instructions (1)
x/evidence/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

Additional comments not posted (1)
x/evidence/CHANGELOG.md (1)

32-32: The description of the change in NewAppModule is clear and concise.


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

@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: 1

x/evidence/CHANGELOG.md Outdated Show resolved Hide resolved
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: 2

x/evidence/CHANGELOG.md Show resolved Hide resolved
x/evidence/CHANGELOG.md Show resolved Hide resolved
@JulianToledano JulianToledano added this pull request to the merge queue Apr 12, 2024
Merged via the queue into main with commit 62d2da5 Apr 12, 2024
65 checks passed
@JulianToledano JulianToledano deleted the julian/evidence-accString-removal branch April 12, 2024 11:39
alpe added a commit to alpe/cosmos-sdk that referenced this pull request Apr 15, 2024
* main: (25 commits)
  fix: Implement gogoproto customtype to secp256r1 keys (cosmos#20027)
  fix(x/epochs): avoid invalid epoch duration in simulation (cosmos#20030)
  fix(x/bank): align query with multi denoms for send-enabled (cosmos#20028)
  refactor(x/slashing)!: remove Accounts String (cosmos#20026)
  refactor(x/evidence)!: remove Address.String() (cosmos#20016)
  chore: make telemetry consistent (cosmos#20025)
  chore: prepare x/tx changelog (cosmos#20015)
  build(deps): Bump actions/add-to-project from 1.0.0 to 1.0.1 (cosmos#20018)
  feat(x/bank): support depinject for send restrictions (cosmos#20014)
  feat: Conditionally emit metrics based on enablement (cosmos#19903)
  fix(store): fix the typo (cosmos#20011)
  docs(x/feegrant): fix allowance typo (cosmos#20000)
  chore(confix): update latest config value (cosmos#20012)
  refactor(x/auth): auth module can recognize x/accounts account (cosmos#20002)
  fix(mempool): use no-op mempool as default (cosmos#19970)
  fix(simapp): add epoch store to upgrade (cosmos#20007)
  test(kv): add unit tests for the helpers functions kv.AssertKeyAtLeas… (cosmos#19965)
  feat(x/tx): Rename custom Amino JSON encoder to "inline_json" (cosmos#19919)
  refactor(x/auth): use transaction service (cosmos#19967)
  fix(client/v2): add encoder for `cosmos.base.v1beta1.DecCoin` (cosmos#19976)
  ...
alpe added a commit that referenced this pull request Apr 15, 2024
* main:
  fix: Implement gogoproto customtype to secp256r1 keys (#20027)
  fix(x/epochs): avoid invalid epoch duration in simulation (#20030)
  fix(x/bank): align query with multi denoms for send-enabled (#20028)
  refactor(x/slashing)!: remove Accounts String (#20026)
  refactor(x/evidence)!: remove Address.String() (#20016)
  chore: make telemetry consistent (#20025)
  chore: prepare x/tx changelog (#20015)
  build(deps): Bump actions/add-to-project from 1.0.0 to 1.0.1 (#20018)
  feat(x/bank): support depinject for send restrictions (#20014)
  feat: Conditionally emit metrics based on enablement (#19903)
  fix(store): fix the typo (#20011)
  docs(x/feegrant): fix allowance typo (#20000)
  chore(confix): update latest config value (#20012)
@coderabbitai coderabbitai bot mentioned this pull request May 3, 2024
12 tasks
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.

3 participants