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

fix: audit #83

Merged
merged 2 commits into from
Oct 28, 2024
Merged

fix: audit #83

merged 2 commits into from
Oct 28, 2024

Conversation

beer-1
Copy link
Collaborator

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

  • Bug Fixes

    • Improved error handling for out-of-gas scenarios in the CosmosPrecompile functionality, providing clearer error messages.
    • Streamlined error assertions in test cases to focus on specific errors rather than gas usage validation.
  • Chores

    • Removed obsolete constants related to filter capabilities from the JSON-RPC server configuration.

@beer-1 beer-1 requested a review from a team as a code owner October 25, 2024 00:58
Copy link

coderabbitai bot commented Oct 25, 2024

Walkthrough

This pull request involves the removal of the DefaultFilterCap constant in the jsonrpc/config/config.go file, which defined the maximum number of filters that could be created. Additionally, the error handling in the ExtendedRun method of the CosmosPrecompile struct in x/evm/precompiles/cosmos/contract.go has been modified to enhance clarity regarding out-of-gas scenarios. Corresponding updates were made in the test cases to align with these changes in error handling.

Changes

File Path Change Summary
jsonrpc/config/config.go Removed constant: DefaultFilterCap. DefaultLogsCap remains unchanged.
x/evm/precompiles/cosmos/contract.go Modified ExtendedRun method to change error handling for out-of-gas scenarios; updated method to clarify that CosmosPrecompile operates only with ExtendedRun.
x/evm/precompiles/cosmos/contract_test.go Updated test functions to focus on error assertions rather than gas usage validation, specifically checking for vm.ErrOutOfGas in several tests.

Possibly related PRs

Poem

In the code where rabbits hop,
Constants gone, we won't stop!
Out of gas? We now declare,
Errors clear, with utmost care.
Tests refined, we leap with glee,
Hopping high, as code runs free! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3df3d1f and 7c64bbb.

📒 Files selected for processing (1)
  • jsonrpc/config/config.go (0 hunks)
💤 Files with no reviewable changes (1)
  • jsonrpc/config/config.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.

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)
x/evm/precompiles/cosmos/contract.go (1)

Line range hint 89-102: Consider enhancing panic recovery with additional context

While the out-of-gas error handling is correct, consider improving the panic recovery to provide more context for other types of panics. This would help with debugging and monitoring in production.

 defer func() {
   if r := recover(); r != nil {
     switch r.(type) {
     case storetypes.ErrorOutOfGas:
       usedGas = suppliedGas
       err = vm.ErrOutOfGas
     default:
-      panic(r)
+      err = fmt.Errorf("cosmos precompile panic: %v", r)
+      usedGas = suppliedGas
     }
   }
 }()
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 63688ba and 3df3d1f.

📒 Files selected for processing (3)
  • jsonrpc/config/config.go (0 hunks)
  • x/evm/precompiles/cosmos/contract.go (1 hunks)
  • x/evm/precompiles/cosmos/contract_test.go (8 hunks)
💤 Files with no reviewable changes (1)
  • jsonrpc/config/config.go
🔇 Additional comments (2)
x/evm/precompiles/cosmos/contract.go (1)

96-97: LGTM! Improved out-of-gas error handling

The changes correctly handle out-of-gas scenarios by:

  1. Setting used gas to the supplied gas amount, accurately reflecting that all gas was consumed
  2. Returning vm.ErrOutOfGas, which is the standard EVM error for this condition

This fix properly propagates out-of-gas errors and aligns with expected EVM behavior.

x/evm/precompiles/cosmos/contract_test.go (1)

84-85: LGTM! Consistent error handling for out-of-gas scenarios.

The error handling modifications across all test functions follow a consistent and correct pattern for testing out-of-gas scenarios:

  1. Call ExtendedRun with (required gas - 1)
  2. Verify that vm.ErrOutOfGas is returned

This ensures that the gas requirements are properly enforced for each precompile method.

Also applies to: 129-130, 174-175, 204-205, 244-245, 331-332, 377-378, 418-419

Copy link

codecov bot commented Oct 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 27.77%. Comparing base (a2bc6ca) to head (7c64bbb).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #83   +/-   ##
=======================================
  Coverage   27.77%   27.77%           
=======================================
  Files         124      124           
  Lines       13818    13818           
=======================================
  Hits         3838     3838           
  Misses       9419     9419           
  Partials      561      561           
Files with missing lines Coverage Δ
jsonrpc/config/config.go 0.00% <ø> (ø)
x/evm/precompiles/cosmos/contract.go 49.56% <100.00%> (ø)

@beer-1 beer-1 merged commit a9ca6c4 into main Oct 28, 2024
9 checks passed
@beer-1 beer-1 deleted the fix/audit branch October 28, 2024 03:42
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.

1 participant