pass shares to withdraw in megavault withdrawal query rest endpoint

[tqin7]

Changelist

example query

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
        "shares_to_withdraw": {
          "num_shares": "1000"                       
        }
      }' \
  "http://localhost:1317/dydxprotocol/vault/megavault/withdrawal_info"

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

  • Updated the MegavaultWithdrawalInfo endpoint to support POST requests, allowing for more flexible data submission.

• Bug Fixes

  • Removed the deprecated megavaultWithdrawalInfo method from the LCDQueryClient, streamlining the query functionality.

[coderabbitai]

Walkthrough

The changes in this pull request involve modifications to the LCDQueryClient class in the query.lcd.ts file, specifically removing the megavaultWithdrawalInfo method and its associated import statements. Additionally, the HTTP method for the MegavaultWithdrawalInfo RPC in the query.proto file has been updated from GET to POST, allowing for a request body. These changes reflect a shift in how withdrawal information for megavaults is queried.

Changes

File Path	Change Summary
indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/query.lcd.ts	Removed import statements for QueryMegavaultWithdrawalInfoRequest and QueryMegavaultWithdrawalInfoResponseSDKType. Removed megavaultWithdrawalInfo method from LCDQueryClient.
proto/dydxprotocol/vault/query.proto	Changed MegavaultWithdrawalInfo RPC method from GET to POST, allowing for a request body.

Possibly related PRs

• [TRA-471] update shares in vault query response to use NumShares type #1834: Modifies the QueryVaultResponse and related types, which may interact with the changes in the LCDQueryClient class in the main PR, particularly regarding how vault data is structured and queried.
• [TRA-461] Remove x/vault/MsgWithdrawFromVault #1859: Removes the withdrawFromVault functionality, which is related to the overall vault management and may connect with the changes in querying withdrawal information in the main PR.
• disable deactivating vaults with positive equity #2301: Introduces validation to prevent deactivating vaults with positive equity, which is relevant to the changes in querying withdrawal information as it affects the state of vaults being queried.
• [TRA-625] Add upgrade handler for migrating vault params. #2304: Adds a new RPC method for querying vault parameters, which aligns with the changes in the main PR regarding the querying of vault-related information.
• add megavault withdrawal info query #2316: Directly adds a method for querying megavault withdrawal information, which is closely related to the main PR's focus on modifying the LCDQueryClient to handle withdrawal queries.
• remove deprecated params from x/vault params query #2387: Removes deprecated parameters from the vault params query, which may relate to the overall structure and clarity of the queries being modified in the main PR.
• set each megavault share to be worth 0.001 usdc on 7.x upgrade #2492: Establishes a new value for megavault shares, which may influence how withdrawal queries are processed in the context of the main PR.

Suggested reviewers

• vincentwschau

🐇 In the code we hop and play,
Removing methods, come what may.
From GET to POST, we shift our way,
For megavaults, new paths display.
With each change, our queries sway! 🐇

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 962b804 and 4d7f039.

⛔ Files ignored due to path filters (2)

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

📒 Files selected for processing (2)

• indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/query.lcd.ts (1 hunks)
• proto/dydxprotocol/vault/query.proto (1 hunks)

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

• indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/query.lcd.ts
• proto/dydxprotocol/vault/query.proto

---

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]

Caution

Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments.

Actionable comments posted: 1

🛑 Comments failed to post (1)

indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/query.lcd.ts (1)

3-3: ⚠️ Potential issue

Add implementation for POST-based megavault withdrawal info query.

The import statement has been updated to remove withdrawal info types, but there's no new implementation to support the POST-based query endpoint mentioned in the PR description (/dydxprotocol/vault/megavault/withdrawal_info).

Add the following implementation:

import { 
  QueryMegavaultWithdrawalInfoRequest, 
  QueryMegavaultWithdrawalInfoResponseSDKType 
} from "./query";

// Add to LCDQueryClient class
async megavaultWithdrawalInfo(
  params: QueryMegavaultWithdrawalInfoRequest
): Promise<QueryMegavaultWithdrawalInfoResponseSDKType> {
  const endpoint = `dydxprotocol/vault/megavault/withdrawal_info`;
  return await this.req.post<QueryMegavaultWithdrawalInfoResponseSDKType>(
    endpoint,
    params
  );
}