[TRA-531] When market pair changes, disable old market and enable new market

[chenyaoy]

Changelist

[Describe or list the changes made in this PR]

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

• If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
• If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
• If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
• If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
• If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
• Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

• New Features

  • Enhanced handling of market parameters for better management of currency pairs.
  • Introduced a method to disable markets, providing users with more control over market states.

• Bug Fixes

  • Improved error handling for enabling and disabling markets with specific error messages.

• Tests

  • Added a new test to validate market parameter modifications and their impact on market states.

[linear]

TRA-531 When changing market pair name, set in the marketmap enabled to false for the old pair and to true for the new pair

[coderabbitai]

Walkthrough

The changes in this pull request enhance the handling of market parameters in the ModifyMarketParam function, including the removal of old currency pairs and the enabling of new ones. New error variables improve error handling for market operations, while a new method in the MarketMapKeeper interface allows for market deactivation. Additionally, a new test function validates the behavior of market parameters, ensuring correct enabling and disabling of markets based on updates.

Changes

File Path	Change Summary
protocol/x/prices/keeper/market_param.go	Enhanced ModifyMarketParam function to handle market pair modifications with error handling.
protocol/x/prices/keeper/market_param_test.go	Added TestModifyMarketParamUpdatesMarketmap to validate market parameter updates and map behavior.
protocol/x/prices/types/errors.go	Introduced ErrMarketCouldNotBeDisabled and ErrMarketCouldNotBeEnabled for better error handling.
protocol/x/prices/types/expected_keepers.go	Added DisableMarket method to MarketMapKeeper interface for market deactivation.

Possibly related PRs

• [TRA-530] When changing market pair name, validate that new pair exists in the market map #2151: Enhances validation logic in ModifyMarketParam, ensuring the new market pair exists in the market map.

Suggested labels

bug, protocol

Poem

🐰 In the market's dance, we hop and play,
Old pairs retire, new ones sway.
With errors caught, and tests in line,
Our markets thrive, oh how they shine!
A keeper's grace, to disable with ease,
In this code garden, we plant the seeds! 🌼

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5f97bdd and 5828856.

Files selected for processing (4)

• protocol/x/prices/keeper/market_param.go (1 hunks)
• protocol/x/prices/keeper/market_param_test.go (1 hunks)
• protocol/x/prices/types/errors.go (1 hunks)
• protocol/x/prices/types/expected_keepers.go (1 hunks)

Additional comments not posted (8)

protocol/x/prices/types/expected_keepers.go (1)

38-38: LGTM!

The addition of the DisableMarket method to the MarketMapKeeper interface is a valuable enhancement for market management functionality. It complements the existing EnableMarket method and allows for deactivating markets based on the provided tickerStr.

The method signature is consistent with the other methods in the interface, taking ctx sdk.Context and tickerStr string as parameters and returning an error.

Implementations of this interface will need to provide the logic for disabling markets accordingly.

protocol/x/prices/types/errors.go (2)

34-34: LGTM!

The error variable ErrMarketCouldNotBeDisabled is declared correctly with a unique error code and a clear error message.

---

35-35: LGTM!

The error variable ErrMarketCouldNotBeEnabled is declared correctly with a unique error code and a clear error message.

protocol/x/prices/keeper/market_param.go (4)

69-84: LGTM!

The code segment correctly handles the case when the market pair has been changed. It removes the old cache entry, disables the old market, and has appropriate error handling. The code is well-structured and readable.

---

86-101: LGTM!

The code segment correctly handles adding the new cache entry and enabling the new market. It has appropriate error handling and is well-structured and readable.

---

71-77: LGTM!

The code segment correctly handles the conversion of the existing market pair to a currency pair and has appropriate error handling.

---

88-93: LGTM!

The code segment correctly handles the conversion of the updated market pair to a currency pair and has appropriate error handling.

protocol/x/prices/keeper/market_param_test.go (1)

106-166: LGTM!

The test function TestModifyMarketParamUpdatesMarketmap is a valuable addition to the test suite. It thoroughly validates the behavior of market parameters in relation to the market map, ensuring that:

1. The market is enabled for the existing currency pair when a market parameter is created.
2. A new market with a different pair is initially disabled.
3. After modifying the market parameter to the new pair, the old market is disabled, and the new market is enabled.

This test enhances the testing coverage for market parameter modifications and their effects on the market map, providing confidence that the enabling and disabling of markets is correctly handled based on parameter updates.

---

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>, please review it.
  -- 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 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.
  -- @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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