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

feat: add stargate query support for staking related queries #249

Merged
merged 1 commit into from
Aug 15, 2024

Conversation

beer-1
Copy link
Contributor

@beer-1 beer-1 commented Aug 15, 2024

Description

Closes: #XXXX


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

@beer-1 beer-1 self-assigned this Aug 15, 2024
@beer-1 beer-1 requested a review from a team as a code owner August 15, 2024 05:24
Copy link

coderabbitai bot commented Aug 15, 2024

Walkthrough

Walkthrough

The recent updates enhance the NewAppKeeper function by introducing a query whitelist for the MoveKeeper, which streamlines query handling related to staking operations. A new variable, queryWhitelist, now holds specific Stargate query paths and their request-response types. This structured approach improves the configurability and efficiency of the MoveKeeper, allowing it to manage incoming staking queries more securely.

Changes

File Path Change Summary
app/keepers/keepers.go Modified NewAppKeeper to incorporate WithVMQueryWhitelist(queryWhitelist) for MoveKeeper, enhancing query handling with a defined whitelist.

Sequence Diagram(s)

sequenceDiagram
    participant AppKeeper
    participant MoveKeeper
    participant QueryWhitelist

    AppKeeper->>QueryWhitelist: Initialize query paths
    QueryWhitelist-->>AppKeeper: Provide query paths
    AppKeeper->>MoveKeeper: Create with query whitelist
    MoveKeeper->>MoveKeeper: Handle incoming staking queries
Loading

🐇 In the land of code, where queries bloom,
A whitelist was born, dispelling all gloom.
The MoveKeeper's now wise, with paths to explore,
Staking queries dance, like never before!
So hop with delight, for changes are here,
Efficiency’s anthem, let’s all give a cheer! 🎉


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>.
    • 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 show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Copy link

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Manifest Files

Copy link

codecov bot commented Aug 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 40.61%. Comparing base (9307dc0) to head (8da99af).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #249      +/-   ##
==========================================
+ Coverage   40.56%   40.61%   +0.05%     
==========================================
  Files         264      264              
  Lines       25059    25081      +22     
==========================================
+ Hits        10164    10186      +22     
  Misses      13326    13326              
  Partials     1569     1569              
Files Coverage Δ
app/keepers/keepers.go 98.43% <100.00%> (+0.07%) ⬆️

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9307dc0 and 8da99af.

Files selected for processing (1)
  • app/keepers/keepers.go (2 hunks)
Additional comments not posted (3)
app/keepers/keepers.go (3)

621-641: Well-structured initialization of queryWhitelist.

The use of movetypes.ProtoSet to define request and response types for specific Stargate query paths is a good approach. This setup enhances the configurability and security of the MoveKeeper by ensuring only whitelisted queries are processed.


Line range hint 643-661:
Enhanced MoveKeeper initialization with query whitelisting.

The inclusion of WithVMQueryWhitelist(queryWhitelist) in the MoveKeeper initialization is a commendable improvement. It allows the MoveKeeper to efficiently manage and secure staking-related queries by leveraging the defined whitelist.


Line range hint 600-700:
Overall improvements in NewAppKeeper function.

The modifications to the NewAppKeeper function, including the introduction of queryWhitelist and the enhanced MoveKeeper initialization, align well with the PR objectives. These changes effectively integrate Stargate query support for staking-related operations, enhancing the system's capabilities.

Copy link
Contributor

@Vritra4 Vritra4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@beer-1 beer-1 merged commit 95af85d into main Aug 15, 2024
10 checks passed
@beer-1 beer-1 deleted the feat/add-staking-stargate-queries branch August 15, 2024 06:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants