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

refactor(x/slashing): remove extra get #22376

Merged
merged 4 commits into from
Oct 28, 2024
Merged

Conversation

tac0turtle
Copy link
Member

@tac0turtle tac0turtle commented Oct 26, 2024

Description

this pr removes an extra get in the slashing module that duplicates unmarshaling of a validator


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 (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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

Summary by CodeRabbit

  • Bug Fixes
    • Improved efficiency in the handling of validator states for slashing and jailing by eliminating redundant checks.
    • Maintained existing error handling and logging mechanisms to ensure proper issue reporting.

Copy link
Contributor

coderabbitai bot commented Oct 26, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request focus on optimizing the HandleValidatorSignatureWithParams method in the infractions.go file of the keeper package. The primary modification involves removing redundant logic that checks if a validator is jailed before slashing. The updated code directly slashes and jails the validator if it has missed too many blocks, streamlining the control flow while preserving existing error handling and logging functionalities.

Changes

File Path Change Summary
x/slashing/keeper/infractions.go Optimized HandleValidatorSignatureWithParams by removing redundant checks and streamlining slashing logic.

Suggested reviewers

  • testinginprod
  • julienrbrt
  • raynaudoe

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6111a2e and 2231642.

📒 Files selected for processing (1)
  • x/slashing/keeper/infractions.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • x/slashing/keeper/infractions.go

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.

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
Contributor

@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

🧹 Outside diff range and nitpick comments (1)
x/slashing/keeper/infractions.go (1)

140-140: LGTM! Efficient reuse of the validator instance.

The change correctly eliminates a redundant validator fetch by reusing the already retrieved val variable, which improves performance while maintaining the same validation logic.

Consider adding a debug log when skipping the slash due to the validator being jailed, similar to the "not found" case, to maintain consistent logging:

 if val != nil && !val.IsJailed() {
     // Downtime confirmed: slash and jail the validator
     ...
 } else {
+    reason := "not found in store"
+    if val != nil && val.IsJailed() {
+        reason = "already jailed"
+    }
     k.Logger.Info(
-        "validator would have been slashed for downtime, but was either not found in store or already jailed",
+        "validator would have been slashed for downtime, but was " + reason,
         "validator", consStr,
     )
 }
📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 51d8acf and 6111a2e.

📒 Files selected for processing (1)
  • x/slashing/keeper/infractions.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
x/slashing/keeper/infractions.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

return err
}
if validator != nil && !validator.IsJailed() {
if val != nil && !val.IsJailed() {
Copy link
Member

Choose a reason for hiding this comment

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

hmmm do we need to check here, IsJailed is already checked above and if the val is nil then probably it already return an err when we get it

Copy link
Member Author

Choose a reason for hiding this comment

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

this is true, this function could probably be cleaned up

@julienrbrt julienrbrt changed the title chore(slashing): remove extra get refactor(x/slashing): remove extra get Oct 26, 2024
@tac0turtle tac0turtle enabled auto-merge October 28, 2024 13:27
@tac0turtle tac0turtle added this pull request to the merge queue Oct 28, 2024
Merged via the queue into main with commit 22231f7 Oct 28, 2024
76 of 77 checks passed
@tac0turtle tac0turtle deleted the marko/remove_double_get branch October 28, 2024 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants