[OTE-244] Add upgrade handler for OIMF caps

[teddyding]

Changelist

Initialize lower and upper caps in upgrade handler

Test Plan

TODO

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.

[linear]

OTE-244 Initialize soft lower and upper caps in upgrade handler

[coderabbitai]

Walkthrough

The recent update introduces a function to initialize Open Interest Margin Finance (OIMF) caps for different liquidity tiers, adjusting specific caps for each tier and incorporating logging for these events. Additionally, support for retrieving all liquidity tiers has been added, alongside adjustments to the open interest caps for the Safety liquidity tier in the genesis configuration. These enhancements aim to refine liquidity management and logging within the protocol.

Changes

File Path	Change Summary
protocol/app/upgrades/v5.0.0/upgrade.go	Added initializeOIMFCaps function to set OIMF caps for liquidity tiers and emit logger events.
protocol/mocks/PerpetualsKeeper.go protocol/x/perpetuals/types/types.go	Added GetAllLiquidityTiers to retrieve all liquidity tiers.
protocol/testing/genesis.sh	Adjusted open interest caps for Safety liquidity tier in genesis.sh.

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>.
  • Generate unit-tests 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 tests 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 tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[teddyding]

Based on values here

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 4379b48 and df63f17.

Files ignored due to path filters (1)

• protocol/scripts/genesis/sample_pregenesis.json is excluded by: !**/*.json

Files selected for processing (4)

• protocol/app/upgrades/v5.0.0/upgrade.go (2 hunks)
• protocol/mocks/PerpetualsKeeper.go (1 hunks)
• protocol/testing/genesis.sh (1 hunks)
• protocol/x/perpetuals/types/types.go (1 hunks)

Additional comments: 4

protocol/x/perpetuals/types/types.go (1)

• 121-121: The addition of GetAllLiquidityTiers to the PerpetualsKeeper interface aligns with the PR's objectives to manage liquidity tiers effectively. Ensure that all concrete types implementing this interface provide a correct implementation of this method.

protocol/app/upgrades/v5.0.0/upgrade.go (2)

• 101-147: The initializeOIMFCaps function correctly sets OIMF caps for different liquidity tiers based on tier IDs. Consider making the OIMF caps configurable rather than using hardcoded values to enhance flexibility and maintainability. Ensure that errors are handled gracefully in the broader context of the upgrade process, even though panicking is typical in upgrade scripts.
• 166-168: The invocation of initializeOIMFCaps within CreateUpgradeHandler is correctly placed to apply the necessary upgrade logic for initializing OIMF caps during the upgrade process.

protocol/mocks/PerpetualsKeeper.go (1)

• 85-103: The addition of the GetAllLiquidityTiers mock function is appropriate for simulating the retrieval of liquidity tier information, facilitating the testing of the upgrade handler's functionality. Ensure to utilize this mock effectively in tests to cover various scenarios.