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

Marker param store migration #1934

Merged
merged 6 commits into from
Apr 16, 2024

Conversation

nullpointer0x00
Copy link
Contributor

@nullpointer0x00 nullpointer0x00 commented Apr 16, 2024

Description

Removes the use of param store in the marker 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 new function for migrating marker parameters during system upgrades.
    • Added new tests to validate the migration of marker parameters.
  • Refactor

    • Reorganized parameter handling in the marker module, shifting from parameter space to module store.
    • Simplified parameter retrieval methods in the marker module.
  • Documentation

    • Updated the CHANGELOG to reflect recent changes in marker module parameter handling.
  • Tests

    • Enhanced testing suite to support new parameter migration logic during upgrades.
  • Chores

    • Removed deprecated parameter handling code and unused imports across various files in the marker module.

Copy link
Contributor

coderabbitai bot commented Apr 16, 2024

Walkthrough

The changes revolve around migrating module parameters from the deprecated params module to internal management within the respective modules, focusing primarily on the marker module. This migration involves restructuring parameter handling, eliminating dependencies on params, and updating tests to accommodate these adjustments.

Changes

Files Change Summary
app/app.go Reorganized parameters in New function; removed paramsKeeper.Subspace usage.
app/upgrades.go, app/upgrades_test.go Introduced migrateMarkerParams function and associated tests for parameter migration during upgrades.
x/marker/keeper/... (multiple files) Removed paramtypes imports; updated NewKeeper function; refactored parameter handling.
x/marker/types/... (multiple files) Added a new parameter store key and enhanced parameter management.

Possibly related issues

🐇✨
A hop, a skip, a code deploy,
From old params to new, oh boy!
Refactoring's done, no more dismay,
On blockchain fields, we now frolic and play.
🚀🌟


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 20dd216 and 21b6722.
Files selected for processing (1)
  • CHANGELOG.md (1 hunks)

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 16, 2024 19:12
@nullpointer0x00 nullpointer0x00 requested a review from a team as a code owner April 16, 2024 19:12
@nullpointer0x00 nullpointer0x00 enabled auto-merge (squash) April 16, 2024 19:12
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: 0

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

Line range hint 66-73: Consider using asterisks (*) instead of dashes (-) for unordered list items to maintain consistency with Markdown standards.

- * Bump cosmos-SDK to `v0.50.2` (from `v0.46.13-pio-2`) [#1772](https://github.com/provenance-io/provenance/issues/1772).
- * Add store for crisis module for sdk v0.50 [#1760](https://github.com/provenance-io/provenance/issues/1760).
- * Add PreBlocker support for sdk v0.50 [#1760](https://github.com/provenance-io/provenance/issues/1760).
- * Add the Sanction module back in [#1922](https://github.com/provenance-io/provenance/pull/1922).
- * Add the Quarantine module back in [#1926](https://github.com/provenance-io/provenance/pull/1926).
+ * Bump cosmos-SDK to `v0.50.2` (from `v0.46.13-pio-2`) [#1772](https://github.com/provenance-io/provenance/issues/1772).
+ * Add store for crisis module for sdk v0.50 [#1760](https://github.com/provenance-io/provenance/issues/1760).
+ * Add PreBlocker support for sdk v0.50 [#1760](https://github.com/provenance-io/provenance/issues/1760).
+ * Add the Sanction module back in [#1922](https://github.com/provenance-io/provenance/pull/1922).
+ * Add the Quarantine module back in [#1926](https://github.com/provenance-io/provenance/pull/1926).

Line range hint 142-153: Consider using asterisks (*) instead of dashes (-) for unordered list items to maintain consistency with Markdown standards.

- * Remove unsupported database types [#1760](https://github.com/provenance-io/provenance/issues/1760).
- * Update ibc and migrate params [#1760](https://github.com/provenance-io/provenance/issues/1760).
- * Replace ModuleBasics with BasicModuleManager [#1760](https://github.com/provenance-io/provenance/issues/1760).
- * Remove handlers from provenance modules [#1760](https://github.com/provenance-io/provenance/issues/1760).
- * Updated app.go to use RegisterStreamingServices on BaseApp [#1760](https://github.com/provenance-io/provenance/issues/1760).
- * Bump the SDK to `v0.50.5-pio-1` (from an earlier ephemeral version) [#1897](https://github.com/provenance-io/provenance/pull/1897).
- * Removed `rewards` module [#1905](https://github.com/provenance-io/provenance/pull/1905).
- * Remove unused navs [#1920](https://github.com/provenance-io/provenance/issues/1920).
- * Update genutil for sdk 50 [#1760](https://github.com/provenance-io/provenance/issues/1760).
- * Migrate module params from param space to module store.
+ * Remove unsupported database types [#1760](https://github.com/provenance-io/provenance/issues/1760).
+ * Update ibc and migrate params [#1760](https://github.com/provenance-io/provenance/issues/1760).
+ * Replace ModuleBasics with BasicModuleManager [#1760](https://github.com/provenance-io/provenance/issues/1760).
+ * Remove handlers from provenance modules [#1760](https://github.com/provenance-io/provenance/issues/1760).
+ * Updated app.go to use RegisterStreamingServices on BaseApp [#1760](https://github.com/provenance-io/provenance/issues/1760).
+ * Bump the SDK to `v0.50.5-pio-1` (from an earlier ephemeral version) [#1897](https://github.com/provenance-io/provenance/pull/1897).
+ * Removed `rewards` module [#1905](https://github.com/provenance-io/provenance/pull/1905).
+ * Remove unused navs [#1920](https://github.com/provenance-io/provenance/issues/1920).
+ * Update genutil for sdk 50 [#1760](https://github.com/provenance-io/provenance/issues/1760).
+ * Migrate module params from param space to module store.

Line range hint 202-303: Consider using asterisks (*) instead of dashes (-) for unordered list items to maintain consistency with Markdown standards.

- * Remove deleted marker send deny entries [#1666](https://github.com/provenance-io/provenance/issues/1666).
- * Update protos, naming, and documentation to use mills for NAVs [#1813](https://github.com/provenance-io/provenance/issues/1813).
- * Update marker transfer to work with groups [#1818](https://github.com/provenance-io/provenance/issues/1818).
- * Prevent funds from going to or from a marker without the transfer agent having deposit or withdraw access (respectively) [#1834](https://github.com/provenance-io/provenance/issues/1834).
- * Ensure the store loader isn't nil when the handling an upgrade [PR 1852](https://github.com/provenance-io/provenance/pull/1852).
- * Fix `MarkerTransferAuthorization` validation to ensure the coins and addresses are all valid [PR 1856](https://github.com/provenance-io/provenance/pull/1856).
- * In `MarketCommitmentSettle`, only consume the settlement fee if the settlement succeeds [#1703](https://github.com/provenance-io/provenance/issues/1703).
+ * Remove deleted marker send deny entries [#1666](https://github.com/provenance-io/provenance/issues/1666).
+ * Update protos, naming, and documentation to use mills for NAVs [#1813](https://github.com/provenance-io/provenance/issues/1813).
+ * Update marker transfer to work with groups [#1818](https://github.com/provenance-io/provenance/issues/1818).
+ * Prevent funds from going to or from a marker without the transfer agent having deposit or withdraw access (respectively) [#1834](https://github.com/provenance-io/provenance/issues/1834).
+ * Ensure the store loader isn't nil when the handling an upgrade [PR 1852](https://github.com/provenance-io/provenance/pull/1852).
+ * Fix `MarkerTransferAuthorization` validation to ensure the coins and addresses are all valid [PR 1856](https://github.com/provenance-io/provenance/pull/1856).
+ * In `MarketCommitmentSettle`, only consume the settlement fee if the settlement succeeds [#1703](https://github.com/provenance-io/provenance/issues/1703).

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: 0

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

Line range hint 67-303: Consider using a consistent style for unordered list items throughout the document. It's recommended to use asterisks (*) instead of dashes (-) for list items to maintain consistency.

- -
+ *

Line range hint 767-767: Remove the extra blank line to improve the readability of the document.

-

Line range hint 1168-1168: Remove the extra blank line to improve the readability of the document.

-

Line range hint 1185-1185: Remove the extra blank line to improve the readability of the document.

-

Line range hint 1237-1237: Remove the extra blank line to improve the readability of the document.

-

Line range hint 1341-1341: Remove the extra blank line to improve the readability of the document.

-

@nullpointer0x00 nullpointer0x00 merged commit 3d1eae1 into main Apr 16, 2024
19 of 36 checks passed
@nullpointer0x00 nullpointer0x00 deleted the nullpointer0x00/marker-param-store-migration branch April 16, 2024 20:06
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