[TRA-513] Deprecate exchange config json and min exchanges

chenyaoy commented 3 weeks ago

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

Release Notes

New Features
- Enhanced market configuration capabilities, including detailed management for affiliate tiers, assets, and price parameters.
- Improved handling of market update transactions with comprehensive validation checks.
Bug Fixes
- Updated deprecation notes for properties in market parameters to reflect changes since version 8.x.
- Streamlined validation logic for market parameters by removing checks for MinExchanges and ExchangeConfigJson.
Tests
- Expanded test coverage for market update transactions and validation logic.
- Removed outdated test cases related to deprecated fields, focusing on relevant parameters.
Chores
- General cleanup and reorganization of test files for improved clarity and maintainability.

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The pull request updates various files related to market parameters and their validation within the protocol. Key changes include the modification of deprecation notes for specific properties in interfaces and messages, the removal of certain test cases that check for the validity of the ExchangeConfigJson field, and enhancements to the test suite for market updates. Additionally, the genesis configuration and script have been significantly restructured to include new parameters and improve functionality.

Changes

File	Change Summary
`indexer/packages/v4-protos/src/codegen/dydxprotocol/prices/market_param.ts`	Updated deprecation notes for `exponent`, `minExchanges`, and `exchangeConfigJson` properties in `MarketParam` and `MarketParamSDKType` interfaces to indicate deprecation since v8.x.
`proto/dydxprotocol/prices/market_param.proto`	Modified deprecation notes for `exponent`, `min_exchanges`, and `exchange_config_json` fields in `MarketParam` message to reflect deprecation since v8.x.
`protocol/app/ante/market_update_test.go`	Enhanced test suite for market updates, adding scenarios and modifying existing tests for validation of market update messages. Added `CreateTestTx` function.
`protocol/daemons/pricefeed/client/types/price_feed_mutable_market_configs_test.go`	Removed specific test cases related to `exchangeConfigJson` and reorganized import statements.
`protocol/scripts/genesis/sample_pregenesis.json`	Comprehensive updates to the genesis file, adding new parameters across multiple sections including affiliate tiers, assets, and price configurations.
`protocol/testing/genesis.sh`	Extensive modifications to the genesis configuration script, adding market configurations, liquidity tiers, and enhancing functionality.
`protocol/x/prices/keeper/market_param_test.go`	Removed specific test cases from `TestModifyMarketParam_Errors`, focusing on critical error scenarios.
`protocol/x/prices/keeper/market_test.go`	Removed test case for validating minimum exchanges parameter from `TestCreateMarket_Errors`.
`protocol/x/prices/keeper/slinky_adapter_test.go`	Removed `MinExchanges` from parameters in `CreateMarket` function call, affecting market creation validation.
`protocol/x/prices/module_test.go`	Simplified structure of `genesisJson` strings in `ValidateGenesisErr` test case.
`protocol/x/prices/types/genesis_test.go`	Removed `ExchangeConfigJson` field from various test cases, streamlining validation tests.
`protocol/x/prices/types/market_param.go`	Removed checks for `mp.MinExchanges` being zero and JSON validity from the `Validate` method.
`protocol/x/prices/types/market_param_test.go`	Removed test cases validating the `ExchangeConfigJson` field, focusing on `Pair` and `MinPriceChangePpm`.
`protocol/x/prices/types/message_create_oracle_market_test.go`	Removed tests related to `ExchangeConfigJson`, adjusting `MarketParam` structure in test cases.
`protocol/x/prices/types/message_update_market_param_test.go`	Removed test case for "Failure: 0 MinExchanges" and adjusted `MarketParam` structure in tests.

Possibly related PRs

#1755: Involves setting market mapper revenue share during market creation, related to market parameter handling.
#1960: Requires a market to exist in the market map when creating a new oracle market, directly connecting to market parameter validation.
#1962: Introduces validation to prevent modifying the enabled field during market updates, relevant to market parameter integrity.
#2072: Moves the currency pair ID cache to a store, impacting market parameter management.
#2151: Enhances the ModifyMarketParam function to validate new market pairs, directly related to this PR's focus.
#2280: Adds tests for scenarios when market pair names change, ensuring robust validation of market parameters.
#2324: Focuses on retrieving the market price exponent from the market map, relevant to market parameter management.
#2431: Updates large cap parameters in genesis, affecting the initial state of market parameters.
#2464: Prevents initialization of a megavault subaccount if the balance is zero, relating to liquidity management.
#2467: Removes a megavault subaccount from the sample pregenesis, impacting market parameter setup.

Suggested labels

pml

Suggested reviewers

vincentwschau

🐇 In the fields where markets grow,
Changes made, as we all know.
With parameters set just right,
Our protocol shines, a true delight!
From genesis to tests, all refined,
A hop towards progress, perfectly aligned! 🐇

📜 Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

📥 Commits

Files that changed from the base of the PR and between 756af23fb8c541cb746ea034d3079a645e8bf591 and 7c3133740580a37db722e1a6e394988cb0babac7.

📒 Files selected for processing (1)

* protocol/x/prices/types/message_update_market_param_test.go (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

* protocol/x/prices/types/message_update_market_param_test.go

--- 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

linear[bot] commented 3 weeks ago

TRA-513 Deprecate ExchangeConfigJSON in pricestypes.MarketParam

dydxprotocol / v4-chain