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

include operator params in vault params query #2281

Merged
merged 2 commits into from
Sep 17, 2024
Merged

include operator params in vault params query #2281

merged 2 commits into from
Sep 17, 2024

Conversation

tqin7
Copy link
Contributor

@tqin7 tqin7 commented Sep 17, 2024

Changelist

include operator params in params query

Test Plan

localnet testing

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 query responses with the addition of operator-specific parameters, allowing for more detailed and flexible queries related to operator configurations.
    • Updated API to include new field operator_params in the response structure, improving the overall data retrieval capabilities.

These changes enhance the functionality and usability of the API for users needing detailed operator settings.

@tqin7 tqin7 requested a review from a team as a code owner September 17, 2024 20:27
Copy link

linear bot commented Sep 17, 2024

Copy link
Contributor

coderabbitai bot commented Sep 17, 2024

Walkthrough

The changes introduce a new field, operatorParams, to the QueryParamsResponse interface and its corresponding SDK type, enhancing the response structure to include operator-specific parameters. This addition is reflected in the TypeScript interface, the Protocol Buffers definition, and the Go implementation, ensuring that the new field is properly serialized and deserialized. The modifications expand the API's capabilities by allowing more detailed queries related to operator configurations.

Changes

Files Change Summary
indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/query.ts, proto/dydxprotocol/vault/query.proto Added operatorParams?: OperatorParams in TypeScript and OperatorParams operator_params in Protocol Buffers for QueryParamsResponse.
protocol/x/vault/keeper/grpc_query.go Modified Params function in Keeper to include OperatorParams in the returned QueryParamsResponse.
protocol/x/vault/keeper/grpc_query_test.go Updated TestQueryParams to initialize OperatorParams in the test setup for QueryParamsResponse.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Keeper

    Client->>API: Request QueryParamsResponse
    API->>Keeper: Call Params()
    Keeper-->>API: Return QueryParamsResponse with OperatorParams
    API-->>Client: Send QueryParamsResponse
Loading

🐇 "In the vault where parameters play,
New fields hop in, brightening the way.
OperatorParams join the fun,
Enhancing queries, one by one!
With every change, our paths align,
In the world of code, all things intertwine!" 🌟

Possibly related PRs


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9c1da25 and b8c916a.

Files selected for processing (1)
  • protocol/x/vault/keeper/grpc_query_test.go (2 hunks)
Additional comments not posted (1)
protocol/x/vault/keeper/grpc_query_test.go (1)

28-30: LGTM!

The test case has been updated to include the new OperatorParams field in the expected response, aligning with the changes made to the QueryParamsResponse struct. The use of constants.GovAuthority for the Operator field ensures consistency with the expected behavior.


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 generate interesting stats about this repository and render them as a table.
    -- @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.

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