set each megavault share to be worth 0.001 usdc on 7.x upgrade

[tqin7]

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

  • Introduced a migration strategy for vault shares, adjusting how owner equities are calculated and managed.

• Bug Fixes

  • Refined expected equity calculations for users, ensuring more accurate share distributions post-upgrade.

• Documentation

  • Updated comments for clarity on new equity calculations and share rounding processes.

• Changes

  • Updated valuation of megavault shares from 1 USDC to 0.001 USDC.

[linear]

TRA-726 set each share to be worth 0.01 usdc in upgrade handler

[coderabbitai]

Walkthrough

The changes in the upgrade.go and upgrade_container_test.go files for the v_7_0_0 package include significant updates to the handling of megavault shares and the associated upgrade logic. The constant QUOTE_QUANTUMS_PER_MEGAVAULT_SHARE was modified to reflect a new valuation. A new function for migrating vault shares was added, while existing functions were retained with minor adjustments. The test file was updated to align expected equity and share calculations with these changes, ensuring accuracy in the testing framework.

Changes

File	Change Summary
protocol/app/upgrades/v7.0.0/upgrade.go	- Updated QUOTE_QUANTUMS_PER_MEGAVAULT_SHARE from 1_000_000 to 1_000. - Retained initializeModuleAccs, initCurrencyPairIDCache, and migrateVaultQuotingParamsToVaultParams functions. - Added migrateVaultSharesToMegavaultShares function for migrating vault shares. - Updated initListingModuleState for listing module state initialization. - CreateUpgradeHandler orchestrates the upgrade process.
protocol/app/upgrades/v7.0.0/upgrade_container_test.go	- Updated postUpgradeMegavaultSharesCheck function with refined expected equity and owner shares for Alice, Bob, and Carl. - Comments updated for clarity on new calculations.

Possibly related PRs

• add v6 upgrade handler for x/vault (backport #2040) #2080: This PR adds a v6 upgrade handler for the vault module, which includes modifications to the CreateUpgradeHandler function that are relevant to the changes in the main PR regarding vault shares and their management.
• initialize megavault module account in 7.0.0 upgrade handler #2394: This PR focuses on initializing the megavault module account in the v7.0.0 upgrade handler, which directly relates to the changes in the main PR that involve the management of megavault shares.
• [TRA-654] add listing module state init into v7 upgrade handler #2432: This PR integrates the listing module state initialization into the v7 upgrade handler, which is relevant as it involves changes to the upgrade process that may interact with the vault and megavault functionalities discussed in the main PR.

Suggested labels

pml

Suggested reviewers

• vincentwschau
• shrenujb

Poem

In the vaults where numbers play,
A rabbit hops, brightening the day.
Shares now gleam with a new delight,
Megavaults shine, oh what a sight!
With every leap, we calculate,
Upgrades bring joy, let’s celebrate! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 560fab6 and d5f6b8a.

📒 Files selected for processing (1)

• protocol/app/upgrades/v7.0.0/upgrade_container_test.go (1 hunks)

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

• protocol/app/upgrades/v7.0.0/upgrade_container_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
• 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 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 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.

[vincentwschau]

nit: 1000? If we are in the sub-cent range, it will probably mean less rounding errors that can be seen.

[tqin7]

@Mergifyio backport release/protocol/v7.x

[mergify]

backport release/protocol/v7.x

✅ Backports have been created

• #2501 set each megavault share to be worth 0.001 usdc on 7.x upgrade (backport #2492) has been created for branch release/protocol/v7.x