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 argument assertion on staking slashing #157

Merged
merged 2 commits into from
Oct 31, 2024

Conversation

beer-1
Copy link
Member

@beer-1 beer-1 commented Oct 31, 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

Summary by CodeRabbit

  • New Features

    • Introduced a new constant for invalid slash fractions to enhance error handling during slashing operations.
  • Bug Fixes

    • Improved validation by ensuring that only valid fractions are processed during slashing, preventing potential issues.

@beer-1 beer-1 requested a review from a team as a code owner October 31, 2024 04:18
Copy link

coderabbitai bot commented Oct 31, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce a new constant, EINVALID_SLASH_FRACTION, with a value of 17 to the initia_std::staking module. This constant is used to signify an invalid slash fraction during slashing operations involving unbonding coins. Additionally, the slash_unbonding_for_chain function has been updated to include an assertion that ensures the provided fraction is less than or equal to one, thereby enhancing error handling and preventing the processing of invalid fractions.

Changes

File Path Change Summary
precompile/modules/initia_stdlib/sources/staking.move Added constant EINVALID_SLASH_FRACTION: u64 = 17; and modified slash_unbonding_for_chain function to include an assertion for valid fractions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant StakingModule
    User->>StakingModule: Request slashing operation
    StakingModule->>StakingModule: Check fraction validity
    alt Valid fraction
        StakingModule->>StakingModule: Process slashing
    else Invalid fraction
        StakingModule-->>User: Return error (EINVALID_SLASH_FRACTION)
    end
Loading

🐰 "In the land of code where rabbits play,
A constant was born to brighten the day.
With fractions now checked, no errors in sight,
Our slashing is safe, oh what a delight!
So hop with joy, let the functions flow,
In the world of staking, we’re ready to grow!" 🌼

Possibly related PRs

Suggested reviewers

  • sh-cha

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.

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

🧹 Outside diff range and nitpick comments (1)
precompile/modules/initia_stdlib/sources/staking.move (1)

183-184: Fix typo in error constant name

The error constant name has a typo: "FRACHTION" should be "FRACTION".

-    const EINVALID_SLASH_FRACHTION: u64 = 17;
+    const EINVALID_SLASH_FRACTION: u64 = 17;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7255fbd and ece4739.

📒 Files selected for processing (1)
  • precompile/modules/initia_stdlib/sources/staking.move (2 hunks)
🔇 Additional comments (1)
precompile/modules/initia_stdlib/sources/staking.move (1)

627-628: LGTM! Good validation of slashing fraction

The assertion correctly validates that the slashing fraction is less than or equal to one, which is a critical check to prevent invalid slashing operations that could harm the staking system.

Copy link
Contributor

@sh-cha sh-cha left a comment

Choose a reason for hiding this comment

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

small typo exists. LGTM

precompile/modules/initia_stdlib/sources/staking.move Outdated Show resolved Hide resolved
@beer-1 beer-1 merged commit 7d2dbd5 into main Oct 31, 2024
@beer-1 beer-1 deleted the fix/add-assertion-on-slashing branch October 31, 2024 04:48
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