Fix vaults PnL endpoint.

[vincentwschau]

Changelist

Filter out any subaccounts not in the list of subaccounts before grouping.

Test Plan

Unit tests / other environments.

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 filtering for historical profit and loss data to ensure accuracy by including only valid vault subaccounts.

• Bug Fixes

  • Improved data integrity in the getVaultsHistoricalPnl method.

[coderabbitai]

Walkthrough

The changes in this pull request involve a modification to the getVaultsHistoricalPnl method in the VaultController class. A new filtering step is introduced to ensure that only PnL ticks corresponding to valid vault subaccounts are processed. While the method signature remains unchanged, the internal logic now includes this filtering, which may affect the returned data. The overall structure and control flow of the method remain consistent with prior implementations.

Changes

File Path	Change Summary
indexer/services/comlink/src/controllers/api/v4/vault-controller.ts	Modified getVaultsHistoricalPnl to add filtering of pnlTickFromDatabase based on subaccountId in vaultSubaccounts.

Possibly related PRs

• Add current equity as a pnl tick. #2335: Adds functionality to retrieve current equity for vaults, relevant to PnL calculations.
• Use vault table rather than placeholder config flags to fetch vaults. #2364: Modifies vault-controller.ts to fetch vaults directly from the database, relating to the new filtering logic.
• Include getting main subaccount equity / pnl for megavault PnL query. #2376: Enhances handling of vault subaccounts and equity calculations, impacting the filtering logic in getVaultsHistoricalPnl.
• Filter out to single tick per interval. #2403: Introduces filtering logic for PnL ticks based on resolution, aligning with the new filtering step in the main PR.
• Fix bug with PnL aggregation. #2446: Addresses PnL aggregation logic, relevant to the processing of PnL ticks in the main PR.
• De-duplicate and filter out invalid pnl ticks for megavault. #2540: Focuses on de-duplicating and filtering invalid PnL ticks, closely related to the new filtering step.
• Allow configuring day vault PnL starts. #2570: Introduces configuration for the start date of PnL calculations, potentially influencing historical PnL data processing.

Suggested labels

indexer

Suggested reviewers

• shrenujb

Poem

In the vaults where numbers play,
A filter joins the fray today.
Only valid ticks will dance,
In this PnL-enhanced romance.
Hops of data, clear and bright,
Guiding us through the financial night! 🐇✨

---

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: 0

🧹 Outside diff range and nitpick comments (1)

indexer/services/comlink/src/controllers/api/v4/vault-controller.ts (1)

166-166: Fix typo in parameter name

The parameter name has a typo: pnlTickFromDatabsae should be pnlTickFromDatabase.

-      .filter((pnlTickFromDatabsae: PnlTicksFromDatabase): boolean => {
+      .filter((pnlTickFromDatabase: PnlTicksFromDatabase): boolean => {

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 744a58b and a27a69b.

📒 Files selected for processing (1)

• indexer/services/comlink/src/controllers/api/v4/vault-controller.ts (1 hunks)

🔇 Additional comments (2)

indexer/services/comlink/src/controllers/api/v4/vault-controller.ts (2)

166-168: LGTM! The filter implementation looks good

The implementation correctly filters out PnL ticks for subaccounts that are not present in the vaultSubaccounts mapping, which aligns with the PR objective.

---

Line range hint 166-196: LGTM! The filter integration is well-placed

The filter is correctly positioned in the processing chain:

1. First, invalid subaccounts are filtered out
2. Then, the remaining data is grouped and transformed
3. Error handling for undefined perpetual markets remains robust

This ensures that only valid data flows through the transformation pipeline.

[tqin7]

what was the impact before this fix?

[vincentwschau]

Individual vaults pnl endpoint running into errors.