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

allow megavault operator to set vault params #2262

Merged
merged 3 commits into from
Sep 17, 2024
Merged

allow megavault operator to set vault params #2262

merged 3 commits into from
Sep 17, 2024

Conversation

tqin7
Copy link
Contributor

@tqin7 tqin7 commented Sep 16, 2024

Changelist

allow megavault operator (in addition to governance) to set vault params

Test Plan

  • unit tests
  • tested on localnet that both governance and operator can set vault params (and non-operator cannot)
  • future integration test on overall megavault flow

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 authority validation for setting vault parameters, allowing both module authority and operator to set parameters.
    • Introduced new command for setting vault parameters via CLI, enabling detailed configuration.
    • Added functionality to interpret vault statuses from string inputs for improved usability.
  • Bug Fixes

    • Removed deprecated message types related to vault operations, streamlining the functionality.
  • Tests

    • Updated test cases to include operator roles and improve clarity in authority validation scenarios.
    • Added tests for new message types related to vault parameter settings.

@tqin7 tqin7 requested a review from a team as a code owner September 16, 2024 18:19
Copy link

linear bot commented Sep 16, 2024

Copy link
Contributor

coderabbitai bot commented Sep 16, 2024

Walkthrough

The changes involve the removal of two message types related to vault operations from the internal_msgs.go file, along with corresponding updates in the test cases and internal message validation logic. The authority validation logic in the SetVaultParams function has been modified to include an operator as a valid authority. Additionally, test cases have been updated to reflect these changes, including the introduction of an operator field and updates to error handling. New commands for managing vault parameters have also been added to the CLI.

Changes

File Path Change Summary
protocol/app/msgs/internal_msgs.go Removed message types: "/dydxprotocol.vault.MsgSetVaultParams" and "/dydxprotocol.vault.MsgSetVaultParamsResponse".
protocol/app/msgs/internal_msgs_test.go Removed message types from the TestInternalMsgSamples_Gov_Key test function.
protocol/lib/ante/internal_msg.go Removed vault.MsgSetVaultParams from the IsInternalMsg validation list.
protocol/app/msgs/normal_msgs.go Added message types: "/dydxprotocol.vault.MsgSetVaultParams" and "/dydxprotocol.vault.MsgSetVaultParamsResponse".
protocol/app/msgs/normal_msgs_test.go Added new message types to the TestNormalMsgs_Key function.
protocol/x/vault/keeper/msg_server_set_vault_params.go Updated authority validation logic to allow both module authority and operator as valid authorities.
protocol/x/vault/keeper/msg_server_set_vault_params_test.go Updated test cases to include an operator field, renamed variables, and modified error handling.
protocol/x/vault/client/cli/tx.go Added new command CmdSetVaultParams for managing vault parameters via CLI.
protocol/x/vault/client/cli/util.go Added function GetVaultStatusFromString to convert string representations of vault statuses.

Possibly related PRs

  • add megavault operator params and update message #2259: The changes in this PR involve the addition of MsgUpdateOperatorParams and related functionality, which is directly related to the vault operations and message types that were removed in the main PR. This indicates a shift in how vault parameters are managed, aligning with the deprecation of the previous message types.

Suggested labels

indexer, proto

Poem

In the vault where secrets lay,
A rabbit hops, brightening the day.
With messages trimmed, the path is clear,
New rules for the operator, let’s give a cheer!
Hopping through tests, with joy we proclaim,
Changes are here, and nothing's the same! 🐇✨


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8690f55 and c460f9f.

Files selected for processing (2)
  • protocol/x/vault/client/cli/tx.go (3 hunks)
  • protocol/x/vault/client/cli/util.go (1 hunks)
Additional comments not posted (2)
protocol/x/vault/client/cli/util.go (1)

19-38: LGTM!

The new GetVaultStatusFromString function is a valuable addition that enhances the functionality and usability of the code. It correctly maps string inputs to their corresponding VaultStatus constants and provides appropriate error handling for invalid inputs.

The function is well-structured, follows the existing coding style and conventions, and does not introduce any breaking changes or dependencies.

protocol/x/vault/client/cli/tx.go (1)

79-143: LGTM!

The CmdSetVaultParams function is a well-implemented addition to the CLI for setting vault parameters. Here are the key points:

  • The function correctly parses and validates the required arguments.
  • The parsing of vault type and status is delegated to helper functions for better code organization.
  • The optional quoting parameters are handled correctly, allowing flexibility in vault configuration.
  • The MsgSetVaultParams message is created with the parsed arguments and validated before being broadcasted or generated as a transaction.
  • The necessary transaction flags are added to the command.

Overall, the function adds a useful capability to set vault parameters from the CLI while ensuring proper argument handling and validation.


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
Labels
Development

Successfully merging this pull request may close these issues.

2 participants