Static Analyzer for Solidity

History

rajeevgopalakrishna ebb5502ac9 Adds support for crytic_compile cryticparser.		6 years ago
..
tests	Adds support for inheritance in naming-convention of modifier uses.	6 years ago
.gitignore	Moves the inheritance testing to existing test.	6 years ago
README.md	Adds minor formatting edits to README.md	6 years ago
__init__.py	All changes specific to slither-format tool, excluding the dependencies on slither parsing/core and detectors. Single commit because of checking out utils/slither_format from dev-slither-format into this branch.	6 years ago
__main__.py	Adds support for crytic_compile cryticparser.	6 years ago
format_constable_states.py	Updates format_constable_states to use filename_absolute. test_constable_states passes.	6 years ago
format_constant_function.py	Refined format_constant_function to focus on the specific (view\|pure\|constant) string.	6 years ago
format_external_function.py	Simplifies format_external_function to focus on public/implicit visibility specifier.	6 years ago
format_naming_convention.py	Adds support for inheritance in naming-convention of modifier uses.	6 years ago
format_pragma.py	Updates format_pragma to use filename_absolute and, directive name instead of the earlier expression name. test_pragma passes. Removes patch_file check for now. Need to change verbose output to JSON format and include patch_file then.	6 years ago
format_solc_version.py	Updates format_solc_version to use filename_absolute and, directive name instead of the earlier expression name. test_solc_version passes. Removes patch_file check for now. Need to change verbose output to JSON format and include patch_file then.	6 years ago
format_unused_state.py	Updates format_unused_state to use filename_absolute and apply only to variable types. test_unused_state_vars passes.	6 years ago
slither_format.py	Fixes uninitialised variable bugh! Manifests when patch count is zero.	6 years ago

README.md

Slither-format: Automatic Code Improvements

Slither-format is a Slither utility tool which uses Slither detectors to identify code patterns of concern (w.r.t security, readability and optimisation) and automatically fix those code patterns with suggested changes.

Slither detectors highlight names, context and source-mapping of code constructs which are then used by Slither-format to programmatically locate those constructs in the Solidity files and then replace them with changes based on best practices. Lexical analysis for identification of such constructs is confined to the smallest possible region to avoid conflicts with similarly named constructs (with potentially different types or signatures) in other scopes, functions or contracts within the same file (because of shadowing, overloading etc.).

Features

Removes declarations of unused state variables
Changes the visibility of public (explicit or implicit until solc 0.5.0) functions to external where possible
Declares state variables as constant where possible
Removes pure/view/constant attributes of functions when they are incorrectly used
Replaces old/buggy/too-recent versions of solc with either 0.4.25 or 0.5.3
Replaces use of different solc versions with either 0.4.25 or 0.5.3
Replaces names of various program constructs to adhere to Solidity naming convention:
- Contract names are converted to CapWords in contract definitions and uses
- Structure names are converted to CapWords in structure declarations and uses
- Event names are converted to CapWords in event declarations and calls
- Enum names are converted to CapWords in enum declarations and uses
- State variables:
  - If constant, are converted to UPPERCASE
  - If private, are converted to mixedCase with underscore
  - If not private, are converted to mixedCase
- Function names are converted to mixedCase in function definitions and calls
- Function parameters are converted to CapWords beginning with underscores in parameter declaration and uses
- Function modifiers are converted to mixedCase in modifier definitions and calls

Usage

Run Slither-format on a single file:

$ python3 -m slither-format ./utils/slither_format/tests/test_data/constant.sol

This produces constant.sol.format file which has all the feature replacements.

Dependencies

Slither-format requires Slither and all its dependencies

Known Limitations

Naming convention formatting on parameter uses does not work for NatSpec @param attributes
Naming convention formatting on parameter uses does not work for variables used as indices on LHS (e.g. _to in balances[_to] = 100)

Developer Testing

$ python3 ./slither_format/tests/test_unused_state_vars.py
$ python3 ./slither_format/tests/test_external_function.py
$ python3 ./slither_format/tests/test_constable_states.py
$ python3 ./slither_format/tests/test_constant_function.py
$ python3 ./slither_format/tests/test_solc_version.py
$ python3 ./slither_format/tests/test_pragma.py
$ python3 ./slither_format/tests/test_naming_convention.py
$ python3 ./slither_format/tests/run_all_tests.py