Merge pull request #71 from liquity/slither

chore: Add slither config and instructions
liquity · Apr 26, 2024 · f1c59eb · f1c59eb
2 parents 3998fd0 + 32649c6
commit f1c59eb
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 4 deletions.
diff --git a/contracts/.gitignore b/contracts/.gitignore
@@ -19,6 +19,9 @@ cache_hardhat
 
 coverage/
 coverage.json
+
+.venv
+
 mochaOutput.json
 testMatrix.json
 /deployment-context-latest.json
diff --git a/contracts/README.md b/contracts/README.md
@@ -57,10 +57,29 @@ $ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --pri
 $ cast <subcommand>
 ```
 
-### Help
+## Slither
+
+Create a local Python env:
+
+```shell
+python3 -m venv .venv
+```
+
+Install slither:
+
+```shell
+pip3 install -r requirements.txt
+```
+
+Install and use Solidity compiler:
+
+```shell
+solc-select install 0.8.18
+solc-select use 0.8.18
+```
+
+Run slither:
 
 ```shell
-$ forge --help
-$ anvil --help
-$ cast --help
+slither src
 ```
diff --git a/contracts/requirements.txt b/contracts/requirements.txt
@@ -0,0 +1,2 @@
+slither-analyzer==0.10.0
+slitherin==0.5.0
diff --git a/contracts/slither.config.json b/contracts/slither.config.json
@@ -0,0 +1,4 @@
+{
+  "detectors_to_exclude": "naming-convention,similar-names,incorrect-equality,uninitialized-local,solc-version,reentrancy-no-eth,reentrancy-benign,reentrancy-events,timestamp,pess-unprotected-setter,pess-readonly-reentrancy",
+  "filter_paths": "lib|test|TestContracts|Dependencies|Integrations|Interfaces"
+}