Merge pull request #397 from crytic/slither

Slither docs

Author: montyly

.github/dependabot.yml

@@ -4,3 +4,23 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+  - package-ecosystem: "gitsubmodule"
+    directory: "/program-analysis/medusa"
+    schedule:
+      interval: "daily" # Check for updates daily
+    commit-message:
+      prefix: "Update medusa"
+    assignees:
+      - ggrieco-tob
+    reviewers:
+      - ggrieco-tob
+  - package-ecosystem: "gitsubmodule"
+    directory: "/program-analysis/slither"
+    schedule:
+      interval: "daily" # Check for updates daily
+    commit-message:
+      prefix: "Update slither"
+    assignees:
+      - ggrieco-tob
+    reviewers:
+      - ggrieco-tob

.github/workflows/lint_format.yml

@@ -32,6 +32,10 @@ jobs:
           rm -rf program-analysis/medusa/fuzzing
           rm program-analysis/medusa/docs/theme/highlight.js
 
+      - name: Remove slither uncessary files
+        run: |
+          rm -rf program-analysis/slither
+
       - name: Run lint
         run: |
           npm run lint:format

.github/workflows/slither.yml

@@ -1,3 +1,7 @@
 [submodule "program-analysis/medusa"]
 	path = program-analysis/medusa
 	url = https://github.com/crytic/medusa.git
+[submodule "program-analysis/slither"]
+	path = program-analysis/slither
+	url = https://github.com/crytic/slither.git
+	branch = master

.gitmodules

@@ -31,7 +31,7 @@ Brought to you by [Trail of Bits](https://www.trailofbits.com/), this repository
 - [Program Analysis](./program-analysis): Using automated tools to secure contracts
   - [Echidna](./program-analysis/echidna): A fuzzer that checks your contract's properties
   - [Medusa](./program-analysis/medusa/docs/src): A next-gen fuzzer that checks your contract's properties
-  - [Slither](./program-analysis/slither): A static analyzer with both CLI and scriptable interfaces
+  - [Slither](./program-analysis/slither/docs/src/): A static analyzer with both CLI and scriptable interfaces
   - [Manticore](./program-analysis/manticore): A symbolic execution engine that proves the correctness of properties
   - For each tool, this training material provides:
     - A theoretical introduction, an API walkthrough, and a set of exercises

README.md

@@ -73,6 +73,7 @@
     - [Int as boolean](./not-so-smart-contracts/ton/int_as_boolean/README.md)
 
 - [Program Analysis](./program-analysis/README.md)
+
   - [Echidna](./program-analysis/echidna/README.md)
     - [Introduction](./program-analysis/echidna/introduction/README.md)
       - [Installation](./program-analysis/echidna/introduction/installation.md)
@@ -169,12 +170,38 @@
       - [Example](./program-analysis/manticore/exercises/example.md)
       - [Exercise 1](./program-analysis/manticore/exercises/exercise1.md)
       - [Exercise 2](./program-analysis/manticore/exercises/exercise2.md)
-  - [Slither](./program-analysis/slither/README.md)
-    - [Static Analysis](./program-analysis/slither/static_analysis.md)
-    - [API](./program-analysis/slither/api.md)
-    - [Exercise 1](./program-analysis/slither/exercise1.md)
-    - [Exercise 2](./program-analysis/slither/exercise2.md)
-    - [Exercise 3](./program-analysis/slither/exercise3.md)
+  - [Slither](./program-analysis/slither/docs/src/README.md)
+    - [Usage](./program-analysis/slither/docs/src/Usage.md)
+    - [API](./program-analysis/slither/docs/src/api/README.md)
+      - [Static Analysis](./program-analysis/slither/docs/src/api/static_analysis.md)
+      - [API](./program-analysis/slither/docs/src/api/api.md)
+      - [SlithIR](./program-analysis/slither/docs/src/api/SlithIR.md)
+      - [SSA](./program-analysis/slither/docs/src/api/SlithIR-SSA.md)
+      - [Data dependency](./program-analysis/slither/docs/src/api/Data-dependency.md)
+      - [JSON output](./program-analysis/slither/docs/src/api/JSON-output.md)
+    - [Detectors](./program-analysis/slither/docs/src/detectors/Detector-Documentation.md)
+      - [Detectors](./program-analysis/slither/docs/src/detectors/Detector-Documentation.md)
+      - [Adding a detector](./program-analysis/slither/docs/src/detectors/Adding-a-new-detector.md)
+    - [Printers](./program-analysis/slither/docs/src/printers/Printer-documentation.md)
+    - [Tools](./program-analysis/slither/docs/src/tools/README.md)
+      - [Adding a new tool](./program-analysis/slither/docs/src/tools/Adding-a-new-utility.md)
+      - [Code Similarity](./program-analysis/slither/docs/src/tools/Code-Similarity-Detector.md)
+      - [Contract Flattening](./program-analysis/slither/docs/src/tools/Contract-Flattening.md)
+      - [Documentation](./program-analysis/slither/docs/src/tools/Documentation.md)
+      - [Doctor](./program-analysis/slither/docs/src/tools/Doctor.md)
+      - [ERC Conformance](./program-analysis/slither/docs/src/tools/ERC-Conformance.md)
+      - [Interface](./program-analysis/slither/docs/src/tools/Interface.md)
+      - [Mutator](./program-analysis/slither/docs/src/tools/Mutator.md)
+      - [Path Finding Utility](./program-analysis/slither/docs/src/tools/Path-Finding-Utility.md)
+      - [Property Generation](./program-analysis/slither/docs/src/tools/Property-generation.md)
+      - [Read Storage](./program-analysis/slither/docs/src/tools/ReadStorage.md)
+      - [Format](./program-analysis/slither/docs/src/tools/Slither-format.md)
+      - [Upgradeability checks](./program-analysis/slither/docs/src/tools/Upgradeability-Checks.md)
+    - [Tutorials](./program-analysis/slither/docs/src/tutorials/README.md)
+      - [Exercise 1](./program-analysis/slither/docs/src/tutorials/exercise1.md)
+      - [Exercise 2](./program-analysis/slither/docs/src/tutorials/exercise2.md)
+      - [Exercise 3](./program-analysis/slither/docs/src/tutorials/exercise3.md)
+
 - [Resources](./resources/tob_blogposts.md)
   - [Security contact](./resources/contact.md)
   - [Blog posts](./resources/tob_blogposts.md)