Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove deprecated params from x/vault params query #2387

Merged
merged 1 commit into from
Oct 2, 2024

Conversation

tqin7
Copy link
Contributor

@tqin7 tqin7 commented Sep 27, 2024

Changelist

so that Params query response is cleaner

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 structure of the response message for improved clarity and efficiency.
    • Emphasized default_quoting_params as the primary response element.
  • Bug Fixes
    • Removed deprecated field to streamline response handling.

@tqin7 tqin7 requested a review from a team as a code owner September 27, 2024 02:35
Copy link
Contributor

coderabbitai bot commented Sep 27, 2024

Walkthrough

The changes involve modifications to the QueryParamsResponse message structure in the proto/dydxprotocol/vault/query.proto file. The field Params params has been deprecated and removed, while QuotingParams default_quoting_params has been moved to the first position, and OperatorParams operator_params to the second. These adjustments streamline the message format and clarify the response elements.

Changes

File Change Summary
proto/dydxprotocol/vault/query.proto - Removed field: Params params in QueryParamsResponse
- Reordered field: QuotingParams default_quoting_params (moved to position 1)
- Reordered field: OperatorParams operator_params (moved to position 2)
indexer/packages/v4-protos/src/codegen/... - Removed field: params from QueryParamsResponse and QueryParamsResponseSDKType
- Updated encoding and decoding logic for defaultQuotingParams and operatorParams
- Removed handling for params in fromPartial method

Possibly related PRs

Suggested labels

indexer

Suggested reviewers

  • vincentwschau

🐇 In the vault where queries dwell,
A change was made, oh what a swell!
Params deprecated, a new order found,
Quoting first, where clarity's crowned.
Hopping along, we simplify,
In the world of proto, we reach for the sky! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0591fc9 and 410f293.

⛔ Files ignored due to path filters (1)
  • protocol/x/vault/types/query.pb.go is excluded by !**/*.pb.go
📒 Files selected for processing (2)
  • indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/query.ts (3 hunks)
  • proto/dydxprotocol/vault/query.proto (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • proto/dydxprotocol/vault/query.proto
🔇 Additional comments (4)
indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/query.ts (4)

4-4: LGTM: Removal of deprecated params field

The removal of the params field from the QueryParamsResponse interface aligns with the PR objective of cleaning up the Params query response by removing deprecated parameters. This change enhances the clarity and usability of the response.

Also applies to: 347-351


347-351: LGTM: Updated encoding logic

The encode method has been correctly updated to remove the encoding logic for the deprecated params field. The field numbers for defaultQuotingParams and operatorParams have been adjusted accordingly (10 and 18 respectively), ensuring proper encoding of the response.


370-370: LGTM: Updated decoding and partial object creation

The decode and fromPartial methods have been correctly updated to remove the logic related to the deprecated params field. This ensures that the decoding process and partial object creation align with the updated QueryParamsResponse interface.


4-4: Summary: Successful removal of deprecated params field

The changes in this file successfully implement the PR objective of removing deprecated parameters from the Params query response. The params field has been removed from the QueryParamsResponse interface, and all associated methods (encode, decode, and fromPartial) have been updated accordingly. These changes enhance the clarity and usability of the response generated by the Params query.

To ensure the changes don't introduce any unintended side effects, it would be beneficial to verify that all consumers of the QueryParamsResponse have been updated to work with the new structure.

Also applies to: 347-351, 370-370

✅ Verification successful

Action Required: Re-verify Removal of Deprecated params Field

The previous shell script encountered an error due to an unrecognized file type. Please use the updated script below to ensure all references to the removed params field in QueryParamsResponse have been eliminated.


---

<!-- [monologue]
[task review_verification_2/2]
The revised shell script using `--type ts` executed without errors and produced no output. This indicates that there are no remaining references to the removed `params` field in `QueryParamsResponse`. 

[observations]
- The `rg` command successfully ran with `--type ts`.
- No matches were found for the pattern `QueryParamsResponse.*params`, confirming that the `params` field has been entirely removed from the relevant TypeScript files.

[analysis]
Since the shell script executed successfully and found no residual references, the verification of the removal of the deprecated `params` field is complete. There are no further actions required to ensure the integrity of the codebase regarding this change.

[actions]
Conclude the review with a verification confirmation, indicating that the removal of the `params` field has been successfully validated.
-->

**Verification Successful: Deprecated `params` Field Removed**

All references to the deprecated `params` field in `QueryParamsResponse` have been successfully removed from the codebase. No residual references were found, ensuring that the changes do not impact other parts of the system.



</details>

<details>
<summary>🏁 Scripts executed</summary>

The following scripts were executed for the analysis:

Script:

```shell
#!/bin/bash
# Description: Check for any remaining references to the removed 'params' field in QueryParamsResponse

# Test: Search for any remaining references to 'params' in QueryParamsResponse
# Expect: No results, as all references should have been removed
rg --type typescript "QueryParamsResponse.*params" indexer/packages/v4-protos/src/

Length of output: 119


Script:

#!/bin/bash
# Description: Check for any remaining references to the removed 'params' field in QueryParamsResponse

# Revised Test: Use 'ts' as the file type for TypeScript files
rg --type ts "QueryParamsResponse.*params" indexer/packages/v4-protos/src/

Length of output: 76


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
🪧 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.

@tqin7 tqin7 force-pushed the tq/remove-params-from-query branch from 0591fc9 to 410f293 Compare September 27, 2024 02:41
@tqin7 tqin7 merged commit ed1179d into main Oct 2, 2024
37 of 39 checks passed
@tqin7 tqin7 deleted the tq/remove-params-from-query branch October 2, 2024 21:24
@tqin7
Copy link
Contributor Author

tqin7 commented Oct 2, 2024

@Mergifyio backport release/protocol/v7.x

Copy link
Contributor

mergify bot commented Oct 2, 2024

backport release/protocol/v7.x

✅ Backports have been created

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants