sync master <> dev

[0xalpharush]

Summary by CodeRabbit

• New Features

  • Introduced new test cases and utility functions for a mutator tool, enhancing comprehensive testing capabilities.
  • Added an immutable payable address variable and a new function send_immutable() in Solidity smart contracts for secure fund transfers.

• Bug Fixes

  • Corrected typos and improved descriptions in various files for enhanced clarity.
  • Updated logic in test files to utilize msg.sender for safer ETH transfers.

• Chores

  • Updated versions of GitHub Actions (docker/build-push-action to v6 and pypa/gh-action-pypi-publish to v1.9.0).
  • Added make package installation to Dockerfile.

• Refactor

  • Improved type annotations and import statements for better code readability and maintainability.
  • Enhanced Solidity smart contracts with immutable variables and new functions.

• Documentation

  • Added a new README.md with initialization instructions.
  • Introduced foundry.toml for Foundry tool configuration.

[coderabbitai]

Walkthrough

Walkthrough

The changes encompass updates to various scripts, configuration files, and source code within the project. Key modifications include updates to test execution directories, Dockerfile dependencies, action versions in workflow files, and enhancements in the slither package with improved logic and typing. New test files and utilities have been added, and there are corrections to typos and descriptions.

Changes

Files/Groups	Summary
.github/scripts/tool_test_runner.sh	Updated pytest command to run tests from a different directory.
.github/workflows/docker.yml	Updated docker/build-push-action version from v5 to v6.
.github/workflows/publish.yml	Updated pypa/gh-action-pypi-publish version from v1.8.14 to v1.9.0.
Dockerfile	Added make package installation in python-wheels stage.
slither/detectors/attributes/incorrect_solc.py	Enhanced _check_version logic to check if bugs_by_version length is non-zero.
slither/detectors/functions/arbitrary_send_eth.py	Added import for StateVariable and introduced checks for immutable state variables.
slither/detectors/functions/dead_code.py	Corrected typo in DeadCode class description.
slither/tools/mutator/__main__.py	Modified type annotation for mutators_list parameter.
slither/tools/mutator/mutators/LIR.py	Updated conditional checks to consider "int" instead of just "uint".
slither/tools/mutator/mutators/abstract_mutator.py	Modified typing imports and updated return statements in mutate method.
slither/tools/mutator/utils/file_handling.py	Added condition to check if file_name is a file before processing.
slither/tools/mutator/utils/testing_generated_mutant.py	Added default parameter values to run_test_cmd function.
slither/tools/mutator/test_mutator.py	Introduced new test file with various test cases and utility functions.
tests/e2e/detectors/snapshots/...	Updated test methods and dangerous calls in arbitrary_send_eth_sol files to use msg.sender. Adjusted line numbers in 0.7.6 version.
tests/e2e/detectors/test_data/...	Introduced new immutable variable and function in arbitrary_send_eth.sol.
tests/tools/mutator/test_data/...	Added new test files (README.md, foundry.toml, Counter.s.sol, Counter.sol, Counter.t.sol) with instructions, configurations, and test contracts.
setup.py	Updated prettytable package version requirement.
slither/printers/summary/loc.py	Updated HELP string for LocPrinter class.
slither/tools/mutator/mutators/AOR.py	Added imports and logic to handle special cases for dynamic arrays.
slither/utils/command_line.py	Enhanced output_printers function to clean up multi-line help information.
slither/utils/myprettytable.py	Added max_width parameter to MyPrettyTable class and refined table width handling logic.

Sequence Diagrams

Diagram generation not applicable due to the nature of the changes.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.
  • @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 as 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.

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

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.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
6 out of 7 committers have signed the CLA.

✅ DarkaMaul
✅ 0xalpharush
✅ smonicas
✅ ThomasHeim11
✅ QiuhaoLi
✅ elopez
❌ MukulKolpe
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9a5b4f5 and 7c7b71f.

Files ignored due to path filters (2)

• tests/e2e/detectors/test_data/arbitrary-send-eth/0.6.11/arbitrary_send_eth.sol-0.6.11.zip is excluded by !**/*.zip
• tests/e2e/detectors/test_data/arbitrary-send-eth/0.7.6/arbitrary_send_eth.sol-0.7.6.zip is excluded by !**/*.zip

Files selected for processing (22)

• .github/scripts/tool_test_runner.sh (1 hunks)
• .github/workflows/docker.yml (1 hunks)
• .github/workflows/publish.yml (1 hunks)
• Dockerfile (1 hunks)
• slither/detectors/attributes/incorrect_solc.py (1 hunks)
• slither/detectors/functions/arbitrary_send_eth.py (2 hunks)
• slither/detectors/functions/dead_code.py (1 hunks)
• slither/tools/mutator/main.py (2 hunks)
• slither/tools/mutator/mutators/LIR.py (2 hunks)
• slither/tools/mutator/mutators/abstract_mutator.py (4 hunks)
• slither/tools/mutator/utils/file_handling.py (1 hunks)
• slither/tools/mutator/utils/testing_generated_mutant.py (1 hunks)
• tests/e2e/detectors/snapshots/detectors__detector_ArbitrarySendEth_0_6_11_arbitrary_send_eth_sol__0.txt (1 hunks)
• tests/e2e/detectors/snapshots/detectors__detector_ArbitrarySendEth_0_7_6_arbitrary_send_eth_sol__0.txt (1 hunks)
• tests/e2e/detectors/test_data/arbitrary-send-eth/0.6.11/arbitrary_send_eth.sol (1 hunks)
• tests/e2e/detectors/test_data/arbitrary-send-eth/0.7.6/arbitrary_send_eth.sol (1 hunks)
• tests/tools/mutator/test_data/test_source_unit/README.md (1 hunks)
• tests/tools/mutator/test_data/test_source_unit/foundry.toml (1 hunks)
• tests/tools/mutator/test_data/test_source_unit/script/Counter.s.sol (1 hunks)
• tests/tools/mutator/test_data/test_source_unit/src/Counter.sol (1 hunks)
• tests/tools/mutator/test_data/test_source_unit/test/Counter.t.sol (1 hunks)
• tests/tools/mutator/test_mutator.py (1 hunks)

Files skipped from review due to trivial changes (10)

• .github/workflows/docker.yml
• .github/workflows/publish.yml
• Dockerfile
• slither/detectors/functions/dead_code.py
• slither/tools/mutator/utils/file_handling.py
• slither/tools/mutator/utils/testing_generated_mutant.py
• tests/e2e/detectors/snapshots/detectors__detector_ArbitrarySendEth_0_7_6_arbitrary_send_eth_sol__0.txt
• tests/tools/mutator/test_data/test_source_unit/README.md
• tests/tools/mutator/test_data/test_source_unit/foundry.toml
• tests/tools/mutator/test_data/test_source_unit/src/Counter.sol

Additional comments not posted (21)

.github/scripts/tool_test_runner.sh (2)

5-5: LGTM!

The pytest command has been correctly updated to run tests from the tests/tools directory.

---

9-9: LGTM!

The pytest command has been correctly updated to run tests from the tests/tools directory when no arguments are provided.

tests/tools/mutator/test_data/test_source_unit/script/Counter.s.sol (1)

1-12: LGTM!

The Solidity script correctly defines the CounterScript contract with setUp and run functions, and uses the forge-std/Script.sol library appropriately.

tests/e2e/detectors/snapshots/detectors__detector_ArbitrarySendEth_0_6_11_arbitrary_send_eth_sol__0.txt (2)

1-3: LGTM!

The snapshot correctly identifies dangerous calls in the direct test case.

---

5-7: LGTM!

The snapshot correctly identifies dangerous calls in the indirect test case.

tests/tools/mutator/test_data/test_source_unit/test/Counter.t.sol (1)

1-24: LGTM!

The Solidity test correctly defines the CounterTest contract with setUp, test_Increment, and testFuzz_SetNumber functions, and uses the forge-std/Test.sol library appropriately.

tests/e2e/detectors/test_data/arbitrary-send-eth/0.6.11/arbitrary_send_eth.sol (3)

4-4: Ensure Consistency with Solidity Versions.

The immutable keyword is supported from Solidity version 0.6.5 onwards. Ensure the Solidity compiler version specified in the project is compatible with this feature.

---

8-8: Correctly Initialize Immutable Variables.

The destination_imm is initialized to msg.sender in the constructor. Ensure this behavior aligns with the intended design, especially in scenarios where the contract is deployed by a different address than the one interacting with it.

---

12-14: Security Review: Ensure Safe Ether Transfer.

The send_immutable function transfers the entire contract balance to destination_imm. Ensure this transfer aligns with the intended security model and does not expose the contract to reentrancy attacks or other vulnerabilities.

tests/e2e/detectors/test_data/arbitrary-send-eth/0.7.6/arbitrary_send_eth.sol (3)

4-4: Ensure Consistency with Solidity Versions.

The immutable keyword is supported from Solidity version 0.6.5 onwards. Ensure the Solidity compiler version specified in the project is compatible with this feature.

---

8-8: Correctly Initialize Immutable Variables.

The destination_imm is initialized to msg.sender in the constructor. Ensure this behavior aligns with the intended design, especially in scenarios where the contract is deployed by a different address than the one interacting with it.

---

12-14: Security Review: Ensure Safe Ether Transfer.

The send_immutable function transfers the entire contract balance to destination_imm. Ensure this transfer aligns with the intended security model and does not expose the contract to reentrancy attacks or other vulnerabilities.

slither/tools/mutator/mutators/LIR.py (2)

34-34: Ensure Correct Handling of Integer Types.

The check for int types has been added. Ensure that all relevant integer types are correctly handled and tested.

---

66-66: Ensure Correct Handling of Integer Types.

The check for int types has been added. Ensure that all relevant integer types are correctly handled and tested.

tests/tools/mutator/test_mutator.py (1)

1-133: Comprehensive Test Coverage.

The test cases added provide good coverage for the mutator tool functions. Ensure that the tests cover edge cases and potential failure scenarios.

slither/detectors/functions/arbitrary_send_eth.py (2)

33-33: Import added for StateVariable.

The import statement for StateVariable is correctly added to support the new functionality in the code.

---

71-72: Check for immutable state variable added.

The check correctly skips over destinations that are immutable state variables, enhancing the security of the contract analysis.

slither/detectors/attributes/incorrect_solc.py (1)

74-74: Check for non-empty bug list added.

The additional check ensures that the bug list for a given version is not empty before appending bug details. This is a good practice to avoid unnecessary processing.

slither/tools/mutator/mutators/abstract_mutator.py (2)

4-4: Type annotation updated to use Union.

The type annotations are updated to use Union, which is more explicit and improves readability.

---

30-30: Type annotation for solc_remappings updated to use Union.

This change aligns with the updated type annotations and improves code clarity.

slither/tools/mutator/__main__.py (1)

119-119: Type annotation for mutators_list updated to use Union.

The type annotation is updated to use Union, which is more explicit and improves readability.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7c7b71f and 16cfaa7.

Files selected for processing (5)

• setup.py (1 hunks)
• slither/printers/summary/loc.py (1 hunks)
• slither/tools/mutator/mutators/AOR.py (2 hunks)
• slither/utils/command_line.py (1 hunks)
• slither/utils/myprettytable.py (5 hunks)

Files skipped from review due to trivial changes (1)

• slither/printers/summary/loc.py

Additional comments not posted (10)

setup.py (1)

16-16: Verify compatibility with other dependencies.

Ensure that the updated version of prettytable (>=3.10.2) is compatible with other dependencies and does not introduce any breaking changes.

slither/utils/myprettytable.py (5)

1-1: LGTM! Import statement is appropriate.

The import of get_terminal_size from shutil is necessary for determining terminal size.

---

11-16: LGTM! New parameter max_width is well-integrated.

The addition of the max_width parameter with a default value of "max" is a useful enhancement.

---

28-37: LGTM! Logic for setting self.max_width is correct.

The logic for setting self.max_width based on the terminal size or the provided value is correctly implemented.

---

48-49: LGTM! Table width setting is correct.

The logic to set max_table_width of the table if self.max_width is not None is correctly implemented.

---

86-86: LGTM! Simplification of table.add_row is correct.

The simplification of the table.add_row call in the make_pretty_table function is correct and improves readability.

slither/tools/mutator/mutators/AOR.py (3)

7-10: LGTM! Import statements are appropriate.

The imports of CallExpression, MemberAccess, Identifier, and ArrayType are necessary for handling special cases in the mutation logic.

---

36-50: LGTM! Special cases for .push and .pop are well-handled.

The logic for handling special cases for .push and .pop on dynamic arrays is correctly implemented.

---

51-65: LGTM! Logic for skipping specific IR operations is correct.

The logic to skip specific IR operations based on the type of expression being mutated is correctly implemented.

slither/utils/command_line.py (1)

363-364: LGTM! Help information cleanup is well-implemented.

The logic to clean up multi-line help information by joining and stripping each line is correctly implemented and improves readability.