cancel existing orders when setting a vault to deactivated or stand-by

[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 method to cancel vault CLOB orders when a vault's status changes to deactivated or stand-by.
  • Enhanced management of vault states to ensure appropriate cancellation of orders.

• Bug Fixes

  • Improved error handling and logging during the cancellation of vault orders.

• Tests

  • Added new test cases to validate the behavior of vault parameters and ensure correct order cancellation during status changes.

[linear]

TRA-623 when a vault is set to deactivated or stand-by, cancel any existing orders

[coderabbitai]

Walkthrough

The pull request introduces a new method, TryToCancelVaultClobOrder, to the Keeper struct, facilitating the cancellation of vault CLOB orders based on vault and client IDs. The RefreshVaultClobOrders function is refactored to utilize this new method, enhancing control flow and error handling. Additionally, the SetVaultParams method is updated to cancel orders when a vault's status changes to deactivated or stand-by. New test cases validate these functionalities and ensure proper order management.

Changes

File	Change Summary
protocol/x/vault/keeper/orders.go	Added TryToCancelVaultClobOrder method; refactored RefreshVaultClobOrders to use this method.
protocol/x/vault/keeper/orders_test.go	Introduced new test cases in TestRefreshVaultClobOrders for various vault status changes.
protocol/x/vault/keeper/params.go	Updated SetVaultParams method to cancel orders when vault status changes to deactivated or stand-by.
protocol/x/vault/keeper/params_test.go	Added test cases in TestGetSetVaultParams to validate vault parameter changes and order cancellations.

Possibly related PRs

• Sp/vault post only orders #2198: Modifies GetVaultClobOrders in orders.go, focusing on order management within vaults.
• add megavault withdrawal fee estimation #2242: Involves changes in params.go related to vault management, similar to the main PR.
• allow megavault operator to set vault params #2262: Allows megavault operators to set vault parameters, relevant to vault management.
• [TRA-572] Send upsert vault event when setting parameters of vault. #2287: Implements upsert vault events when parameters are set, tying into operational changes in the main PR.
• add quoting logic of deactivated, stand-by, close-only modes of vaults #2299: Adds quoting logic for different vault modes, directly related to vault order management.
• disable deactivating vaults with positive equity #2301: Introduces restrictions on deactivating vaults with positive equity, relevant to vault state management.
• exclude deactivated vaults from megavault equity #2308: Ensures deactivated vaults are excluded from equity calculations, relating to vault management.

Suggested labels

indexer, proto

Suggested reviewers

• vincentwschau

Poem

In the vaults where orders play,
A rabbit hops with joy today.
Cancellations now swift and neat,
As statuses change, a rhythmic beat.
With tests that dance and flows refined,
A brighter future we shall find! 🐇✨

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5ec24df and 4d86c73.

Files selected for processing (4)

• protocol/x/vault/keeper/orders.go (2 hunks)
• protocol/x/vault/keeper/orders_test.go (1 hunks)
• protocol/x/vault/keeper/params.go (2 hunks)
• protocol/x/vault/keeper/params_test.go (5 hunks)

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

• protocol/x/vault/keeper/orders.go
• protocol/x/vault/keeper/orders_test.go
• protocol/x/vault/keeper/params.go
• protocol/x/vault/keeper/params_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.

[coderabbitai]

Actionable comments posted: 5

Outside diff range and nitpick comments (1)

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

Line range hint 269-300: Refactor repeated assertions into a helper function

The assertions checking the number of vault orders before and after setting vault parameters are repeated in both the error and success cases. To enhance code maintainability and readability, consider refactoring these assertions into a helper function.

Create a helper function to encapsulate the repeated assertions:

func assertVaultOrderCounts(t *testing.T, ctx sdk.Context, tApp *testapp.TestApplication, k keeper.Keeper, expectedCount int, vaultId vaulttypes.VaultId) {
    require.Len(t, tApp.App.ClobKeeper.GetAllStatefulOrders(ctx), expectedCount)
    require.Len(t, k.GetMostRecentClientIds(ctx, vaultId), expectedCount)
}

Then, replace the repeated assertions with calls to this helper function:

// Before setting vault params
assertVaultOrderCounts(t, ctx, tApp, k, int(tc.numVaultOrdersPreSet), tc.vaultId)

// After setting vault params (in both error and success cases)
assertVaultOrderCounts(t, ctx, tApp, k, int(tc.numVaultOrdersPostSet), tc.vaultId)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 18f76cc and 5ec24df.

Files selected for processing (4)

• protocol/x/vault/keeper/orders.go (2 hunks)
• protocol/x/vault/keeper/orders_test.go (1 hunks)
• protocol/x/vault/keeper/params.go (2 hunks)
• protocol/x/vault/keeper/params_test.go (5 hunks)

Additional comments not posted (2)

protocol/x/vault/keeper/orders_test.go (2)

748-841: LGTM!

The TestRefreshVaultClobOrders function is well-structured and comprehensive. It covers various scenarios for refreshing vault orders, such as status changes, equity changes, and more. The test cases are properly set up, perform the necessary actions, and verify the expected behavior of the refreshed orders.

---

Line range hint 1-747: LGTM!

The TestGetVaultClobOrders function is well-structured and comprehensive. It covers various scenarios for getting vault orders, such as different vault statuses, quoting parameters, leverage, and more. The test cases are properly set up, calculate the expected order details based on the provided formulas and logic, and verify the expected orders against the actual orders retrieved from the vault. The function also covers error scenarios, ensuring the proper handling of edge cases.