exclude deactivated vaults from megavault equity

[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

  • Enhanced documentation for VAULT_STATUS_DEACTIVATED, clarifying conditions for vault deactivation.
  • Added a new test case for withdrawing shares from a megavault, excluding deactivated sub-vaults.

• Bug Fixes

  • Improved logic in equity calculations to exclude deactivated vaults.

• Documentation

  • Updated comments to reflect changes in vault processing and equity calculations.

[linear]

TRA-622 deactivated vaults don't count towards megavault equity (i.e. deposit and withdrawal)

[coderabbitai]

Walkthrough

The changes across multiple files focus on clarifying the conditions under which a vault can be deactivated, specifically emphasizing that a vault may only be set to VAULT_STATUS_DEACTIVATED if its equity is non-positive. Documentation and comments have been updated to reflect this condition, and tests have been added to ensure proper functionality when dealing with deactivated vaults. Additionally, logic has been modified in functions handling equity calculations and withdrawals to exclude deactivated vaults from processing.

Changes

Files	Change Summary
indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/vault.ts, proto/dydxprotocol/vault/vault.proto	Updated documentation comments for VAULT_STATUS_DEACTIVATED to specify it can only be set if equity is non-positive.
protocol/x/vault/keeper/msg_server_withdraw_from_megavault_test.go	Added a new test case simulating a withdrawal scenario that excludes a deactivated sub-vault from calculations.
protocol/x/vault/keeper/vault.go	Modified logic in GetMegavaultEquity to include only vaults that are not deactivated and have positive equity in the equity calculation.
protocol/x/vault/keeper/vault_test.go	Updated comment in TestGetMegavaultEquity to clarify that the deactivated vault is not counted in the expected output.
protocol/x/vault/keeper/withdraw.go	Added a check in WithdrawFromMegavault to skip processing for deactivated vaults, enhancing control flow by ensuring they are not considered in withdrawal operations.

Possibly related PRs

• add megavault withdrawal fee estimation #2242: Introduces a test case simulating a withdrawal scenario involving a deactivated vault, related to vault deactivation conditions.
• allow megavault operator to set vault params #2262: Allows the megavault operator to set vault parameters, potentially including conditions related to vault statuses.
• include operator params in vault params query #2281: Includes operator parameters in vault queries, which may relate to the operational status of vaults.
• add megavault withdrawal msg #2288: Adds functionality for withdrawing from a megavault, directly related to vault deactivation conditions.
• disable deactivating vaults with positive equity #2301: Addresses the restriction on deactivating vaults with positive equity, central to the conditions for vault status changes.

Suggested labels

protocol, indexer, proto

Poem

🐇 In the vaults where bunnies play,
Deactivated, they must stay.
With equity low, they take a rest,
While active vaults are at their best.
So hop along, with shares in tow,
To brighter days where profits grow! 🌼

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5a02618 and d0ff653.

Files ignored due to path filters (1)

• protocol/x/vault/types/vault.pb.go is excluded by !**/*.pb.go

Files selected for processing (6)

• indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/vault.ts (2 hunks)
• proto/dydxprotocol/vault/vault.proto (1 hunks)
• protocol/x/vault/keeper/msg_server_withdraw_from_megavault_test.go (1 hunks)
• protocol/x/vault/keeper/vault.go (2 hunks)
• protocol/x/vault/keeper/vault_test.go (1 hunks)
• protocol/x/vault/keeper/withdraw.go (1 hunks)

Files skipped from review due to trivial changes (1)

• protocol/x/vault/keeper/vault_test.go

Additional comments not posted (6)

proto/dydxprotocol/vault/vault.proto (1)

30-30: LGTM!

The comment accurately specifies the conditions under which a vault can be set to the VAULT_STATUS_DEACTIVATED status. This clarifies the intended usage of the enum value and enhances the understanding of the code.

indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/vault.ts (2)

58-61: LGTM!

The updated documentation comment provides a helpful clarification on the conditions required for setting a vault to the deactivated status. This additional detail enhances the understanding of the status's constraints and could help prevent misuse or confusion.

---

80-83: This code segment has the same changes as the previous one, and the same review comment applies.

protocol/x/vault/keeper/vault.go (1)

21-21: LGTM!

The changes correctly implement the exclusion of deactivated vaults from the megavault equity calculation:

• The function comment has been updated to clearly specify the new behavior.
• The additional conditional check correctly skips deactivated vaults during the iteration over vault parameters.

These changes align with the PR objective and ensure that only active vaults with positive equity contribute to the megavault equity.

Also applies to: 35-38

protocol/x/vault/keeper/withdraw.go (1)

168-174: LGTM!

The code changes correctly skip processing for deactivated vaults based on the VaultStatus_VAULT_STATUS_DEACTIVATED status. This aligns with the PR objective of excluding deactivated vaults from the megavault equity calculations.

The vaultParams variable is also declared at the correct location within the loop to avoid redundancy.

protocol/x/vault/keeper/msg_server_withdraw_from_megavault_test.go (1)

188-215: LGTM!

The test case looks good and verifies the correct behavior of excluding deactivated sub-vaults from the withdrawal calculations. It sets up the main vault and sub-vault with appropriate balances and checks that the withdrawal succeeds with the expected outcomes.

Key aspects covered:

• Deactivated sub-vault is excluded from the calculations.
• Main vault's balance is used for the calculations.
• Total shares, owner shares, and redeemed quote quantums are updated correctly.

---

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.