[TRA-418] Add upgrade handler and test for x/revshare module state initialization

shrenujb commented 6 days ago

Changelist

Add initialization for the x/revshare module chain state in the v6 upgrade handler Add upgrade test

Test Plan

Added test

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
- Introduced the ability to manage market revenue share parameters and details post-upgrade, enhancing market operations.
Tests
- Added checks for revenue share parameters and market details to ensure proper functionality after the upgrade.

linear[bot] commented 6 days ago

TRA-418 Upgrade Handler

coderabbitai[bot] commented 6 days ago

[!WARNING]

Rate limit exceeded

@shrenujb has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 30 seconds before requesting another review.

How to resolve this issue?
After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?
CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.

Commits
Files that changed from the base of the PR and between a7dc56e075e1b97633973e2dd0221769894f14b1 and 5b23266636c3a12710f14c8ae09f6d3921b551d3.

Walkthrough

The recent updates enhance the App struct's setupUpgradeHandlers function by including RevShareKeeper and PricesKeeper parameters. These changes facilitate initializing the revenue share module and setting market mapper revenue share parameters and details. The modifications also extend the capabilities of the upgrade system and introduce new tests to validate post-upgrade conditions effectively.

Changes

Files	Summary
`protocol/app/upgrades.go`	The `setupUpgradeHandlers` function now includes `RevShareKeeper` and `PricesKeeper`.
`protocol/app/upgrades/v6.0.0/upgrade.go`	Added functions to initialize rev share module state and include new parameters in `CreateUpgradeHandler`.
`protocol/app/upgrades/v6.0.0/upgrade_container_test.go`	Introduced `postUpgradeMarketMapperRevShareChecks` and added necessary imports.
`protocol/x/revshare/types/types.go`	Introduced the `RevShareKeeper` interface for handling market revenue share parameters and details.

Sequence Diagram(s)

sequenceDiagram
    participant App
    participant ModuleManager
    participant Configurator
    participant ClobKeeper
    participant RevShareKeeper
    participant PricesKeeper

    App->>ModuleManager: Initialize modules
    App->>Configurator: Set configurations
    App->>ClobKeeper: Manage clob operations
    App->>RevShareKeeper: Include rev share parameters
    App->>PricesKeeper: Include price parameters
    RevShareKeeper->>Market: Set revenue share parameters
    PricesKeeper->>Market: Set market price details

Poem

In lines of code, new paths will find,
RevShare and Prices now aligned.
A clever tweak, a graceful infusion,
Modules dance in sweet inclusion.
Upgrade handlers, set with care,
Lift our app up, data to share.

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 .` - `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.` - `@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 as 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. 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](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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

dydxprotocol / v4-chain