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

cannon: Handle div by zero in MIPS.sol #10468

Merged
merged 2 commits into from May 13, 2024
Merged

cannon: Handle div by zero in MIPS.sol #10468

merged 2 commits into from May 13, 2024

Conversation

Inphi
Copy link
Contributor

@Inphi Inphi commented May 9, 2024

Ensure MIPS.sol does not generate a Panic exception when dividing by zero.

@Inphi Inphi requested a review from clabby May 9, 2024 16:05
@Inphi Inphi requested a review from a team as a code owner May 9, 2024 16:05
Copy link
Contributor

coderabbitai bot commented May 9, 2024

Walkthrough

Walkthrough

The recent modifications to the MIPS contract include a version increment from "1.0.0" to "1.0.1" and the addition of input validation for division by zero in the div and divu functions. Tests test_div_byZero_fails() and test_divu_byZero_fails() were also included to verify the new error handling.

Changes

File Path Change Summary
.../src/cannon/MIPS.sol Updated version to "1.0.1". Added input validation for division by zero in div and divu.
.../test/cannon/MIPS.t.sol Added tests to validate error handling for division by zero scenarios.

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 54f614d and 9e1bd16.
Files ignored due to path filters (1)
  • packages/contracts-bedrock/semver-lock.json is excluded by !**/*.json
Files selected for processing (2)
  • packages/contracts-bedrock/src/cannon/MIPS.sol (2 hunks)
  • packages/contracts-bedrock/test/cannon/MIPS.t.sol (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • packages/contracts-bedrock/src/cannon/MIPS.sol
  • packages/contracts-bedrock/test/cannon/MIPS.t.sol

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration 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

codecov bot commented May 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 43.45%. Comparing base (1c33c39) to head (9e1bd16).
Report is 4 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop   #10468      +/-   ##
===========================================
+ Coverage    42.31%   43.45%   +1.14%     
===========================================
  Files           73       41      -32     
  Lines         4838     3979     -859     
  Branches       766      614     -152     
===========================================
- Hits          2047     1729     -318     
+ Misses        2682     2141     -541     
  Partials       109      109              
Flag Coverage Δ
cannon-go-tests 81.59% <ø> (ø)
chain-mon-tests 27.14% <ø> (ø)
common-ts-tests ?
contracts-ts-tests 12.25% <ø> (ø)
core-utils-tests ?
sdk-tests 40.27% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 32 files with indirect coverage changes

@clabby clabby added this pull request to the merge queue May 13, 2024
Merged via the queue into develop with commit 625054c May 13, 2024
72 checks passed
@clabby clabby deleted the inphi/mips-div-zero branch May 13, 2024 16:30
Inphi added a commit that referenced this pull request May 14, 2024
* cannon: Handle div by zero in MIPS.sol

* fix revert stmt style
clabby pushed a commit that referenced this pull request May 14, 2024
* cannon: Handle div by zero in MIPS.sol

* fix revert stmt style
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.

None yet

2 participants