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

Name param store migration #1937

Merged
merged 7 commits into from
Apr 18, 2024

Conversation

nullpointer0x00
Copy link
Contributor

@nullpointer0x00 nullpointer0x00 commented Apr 17, 2024

Description

Removes the use of param store in the name module and uses module's store for params.

closes: #XXXX


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer
  • Review Codecov Report in the comment section below once CI passes

Summary by CodeRabbit

  • New Features

    • Introduced a migration function for handling parameters related to the Name module.
    • Added a new global variable for the marker module's parameters.
  • Refactor

    • Simplified parameter handling in the Name module by removing redundant initializations and querying processes.
    • Updated function signatures and test cases to align with new parameter naming conventions.
  • Documentation

    • Updated comments to reflect changes in parameter keys and module descriptions.

Copy link
Contributor

coderabbitai bot commented Apr 17, 2024

Walkthrough

The update focuses on migrating and internalizing parameter management for the Name module in the Provenance project. It involves adjusting parameter handling functions, simplifying parameter retrieval, and removing outdated dependencies to enhance module independence and configuration management.

Changes

Files Change Summary
app/app.go, app/upgrades.go, app/upgrades_test.go Modifications related to NameKeeper initialization and parameter migrations for the Name module.
x/name/keeper/keeper.go, x/name/keeper/params.go, x/name/keeper/query_server.go Removal of paramSpace and streamlining parameter handling within the Keeper struct.
x/name/types/keys.go, x/name/types/params.go, x/name/types/params_test.go Introducing new keys and renaming parameters for the Name module.
x/marker/types/key.go Minor key description renaming for clarity.
x/name/keeper/proposal_handler_test.go, x/name/simulation/proposals_test.go Test setup modifications reflecting changes in function signatures and initialization processes.

Possibly related issues

  • provenance-io/provenance#1935: This issue tracks parameter migrations for various modules including Name, aligning with the PR's handling of Name module parameter migration.
  • provenance-io/provenance#554: The PR's effort to refactor and internalize parameter management in the Name module aligns with the goal of moving away from the deprecated x/params module as outlined in this issue.

Poem

🐇✨
In the fields of code, where parameters roam,
A rabbit hops, making blockchain its home.
With each leap and bound, the old ways shed,
New paths are formed, as the Name module is led.
Oh, what joy these changes bring,
As I dance and code and sing!
🌟🐰


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 8f2f066 and a87e104.
Files selected for processing (6)
  • x/marker/keeper/params.go (2 hunks)
  • x/marker/types/key.go (1 hunks)
  • x/msgfees/keeper/params.go (2 hunks)
  • x/msgfees/types/keys.go (1 hunks)
  • x/name/keeper/params.go (1 hunks)
  • x/name/types/keys.go (1 hunks)
Files skipped from review as they are similar to previous changes (3)
  • x/marker/types/key.go
  • x/name/keeper/params.go
  • x/name/types/keys.go
Additional comments not posted (5)
x/msgfees/types/keys.go (1)

36-36: Renaming ParamStoreKey to MsgFeesParamStoreKey enhances clarity and consistency within the module.

x/msgfees/keeper/params.go (2)

14-14: The use of MsgFeesParamStoreKey in GetParams aligns with the renaming in keys.go and ensures consistency across the module.


25-25: Using MsgFeesParamStoreKey in SetParams maintains consistency with the GetParams function and the key definition in keys.go.

x/marker/keeper/params.go (2)

18-18: The use of MarkerParamStoreKey in GetParams aligns with the intended renaming for clarity within the marker module.


29-29: Using MarkerParamStoreKey in SetParams maintains consistency with the GetParams function and enhances clarity in the module.


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.

@nullpointer0x00 nullpointer0x00 marked this pull request as ready for review April 17, 2024 17:04
@nullpointer0x00 nullpointer0x00 requested a review from a team as a code owner April 17, 2024 17:04
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

Actionable comments outside the diff hunks (1)
CHANGELOG.md (1)

Line range hint 73-312: Use asterisks for unordered list items for consistency in Markdown formatting.

- -
+ *

x/name/types/keys.go Outdated Show resolved Hide resolved
@nullpointer0x00 nullpointer0x00 enabled auto-merge (squash) April 17, 2024 17:26
@nullpointer0x00 nullpointer0x00 merged commit 5aaecbd into main Apr 18, 2024
19 of 36 checks passed
@nullpointer0x00 nullpointer0x00 deleted the nullpointer0x00/name-param-store-migration branch April 18, 2024 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants