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

Compute offset to contracts #2382

Closed
wants to merge 11 commits into from
Closed

Conversation

frabert
Copy link

@frabert frabert commented Mar 28, 2024

The alternative would be to make Contract inherit from TopLevel, but I'm not confident that wouldn't break other things

Summary by CodeRabbit

  • Refactor
    • Enhanced type checking to include Contract objects, improving reliability.

0xalpharush and others added 11 commits February 29, 2024 14:30
assignement -> assignment
chore: remove repetitive word
chore: remove repetitive words
The alternative would be to make `Contract`  inherit from `TopLevel`, but I'm not confident that wouldn't break other things
Copy link

coderabbitai bot commented Mar 28, 2024

Walkthrough

The core adjustment in this update involves refining type checks within the Slither tool. By expanding the isinstance function to recognize Contract objects alongside TopLevel entities, the modification enhances Slither's ability to accurately identify and interact with different components of Solidity contracts, potentially improving analysis precision and error detection capabilities.

Changes

Files Change Summary
slither/core/slither_core.py Extended isinstance check to include Contract alongside TopLevel.

Possibly related issues

  • [Bug]: lowering of InitArray fails #2210: The issue focuses on addressing a type-related error during compilation which might indirectly benefit from the improved type checks introduced in this PR. Enhanced type recognition could aid in preventing or more accurately reporting similar errors in future analyses.

Poem

In the code where bytes and bits align,
A rabbit hopped, leaving trails in time.
With a tweak and hop, it made a change,
Now Contract and TopLevel within range.

"To improve, to fix, to make it right,"
Whispered the rabbit, under the moonlight.
🌙✨🐇
With each hop forward, the code did shine,
Reflecting the glow of the moon so fine.

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-tests 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 tests 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 tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 13d7d9f and e8bd8e1.
Files selected for processing (1)
  • slither/core/slither_core.py (1 hunks)
Additional comments (1)
slither/core/slither_core.py (1)
  • 212-212: The extension of the isinstance check to include Contract alongside TopLevel aligns with the PR's objectives and appears to be correctly implemented. However, it's crucial to verify that this change does not inadvertently affect other parts of the system that rely on the original isinstance behavior.
Verification successful

The extension of the isinstance check to include Contract alongside TopLevel aligns with the PR's objectives and appears to be correctly implemented. However, it's crucial to verify that this change does not inadvertently affect other parts of the system that rely on the original isinstance behavior.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Verify that the extended isinstance check does not affect other parts of the system.
# This script is a placeholder and should be replaced with specific verification steps as needed.
echo "Verification steps to ensure system-wide compatibility with the extended isinstance check."

Length of output: 190



Script:

#!/bin/bash
# Search for references to the TopLevel and Contract classes in the codebase to assess their usage.
echo "Searching for references to TopLevel and Contract classes..."
rg "TopLevel|Contract" --vimgrep

Length of output: 290626

@0xalpharush 0xalpharush changed the base branch from master to dev March 28, 2024 18:09
@0xalpharush
Copy link
Contributor

I included this in #2376 bc I wanted to run the tests with it but the histories were incompatible and prevented merging the branches

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.

6 participants