Update reentrancy_eth.py

.github/workflows/docs.yml

@@ -0,0 +1,46 @@
+name: docs
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["master"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Single deploy job since we're just deploying
+  build:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.8'
+      - run: pip install -e ".[dev]"
+      - run: pdoc -o docs/ slither '!slither.tools' #TODO fix import errors on pdoc run
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          # Upload the doc
+          path: 'docs/'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.github/workflows/linter.yml

@@ -54,5 +54,7 @@ jobs:
           VALIDATE_EDITORCONFIG: false
           VALIDATE_JSCPD: false
           VALIDATE_PYTHON_MYPY: false
+          # Until we upgrade the super linter for actionlintÒ
+          VALIDATE_GITHUB_ACTIONS: false
           SHELLCHECK_OPTS: "-e SC1090"
           FILTER_REGEX_EXCLUDE: .*tests/.*.(json|zip|sol)

.gitignore

@@ -111,3 +111,6 @@ test_artifacts/
 
 # crytic export 
 crytic-export/
+
+# Auto-generated Github pages docs
+docs/

README.md

@@ -5,13 +5,15 @@
 [![Slack Status](https://empireslacking.herokuapp.com/badge.svg)](https://empireslacking.herokuapp.com)
 [![PyPI version](https://badge.fury.io/py/slither-analyzer.svg)](https://badge.fury.io/py/slither-analyzer)
 
-Slither is a Solidity static analysis framework written in Python 3. It runs a suite of vulnerability detectors, prints visual information about contract details, and provides an API to easily write custom analyses. Slither enables developers to find vulnerabilities, enhance their code comprehension, and quickly prototype custom analyses.
+Slither is a Solidity static analysis framework written in Python3. It runs a suite of vulnerability detectors, prints visual information about contract details, and provides an API to easily write custom analyses. Slither enables developers to find vulnerabilities, enhance their code comprehension, and quickly prototype custom analyses.
 
 - [Features](#features)
-- [Bugs and Optimizations Detection](#bugs-and-optimizations-detection)
+- [Usage](#usage)
+- [How to Install](#how-to-install)
+- [API Documentation](#api-documentation)
+- [Detectors](#detectors)
 - [Printers](#printers)
 - [Tools](#tools)
-- [How to Install](#how-to-install)
 - [Getting Help](#getting-help)
 - [FAQ](#faq)
 - [Publications](#publications)
@@ -20,35 +22,74 @@ Slither is a Solidity static analysis framework written in Python 3. It runs a s
 
 * Detects vulnerable Solidity code with low false positives (see the list of [trophies](./trophies.md))
 * Identifies where the error condition occurs in the source code
-* Easily integrates into continuous integration and Truffle builds
+* Easily integrates into continuous integration and Hardhat/Foundry builds
 * Built-in 'printers' quickly report crucial contract information
 * Detector API to write custom analyses in Python
 * Ability to analyze contracts written with Solidity >= 0.4
 * Intermediate representation ([SlithIR](https://github.com/trailofbits/slither/wiki/SlithIR)) enables simple, high-precision analyses
 * Correctly parses 99.9% of all public Solidity code
 * Average execution time of less than 1 second per contract
+* Integrates with Github's code scanning in [CI](https://github.com/marketplace/actions/slither-action)
 
+## Usage
 
-## Bugs and Optimizations Detection
-
-Run Slither on a Truffle/Embark/Dapp/Etherlime/Hardhat application:
+Run Slither on a Hardhat/Foundry/Dapp/Brownie application:
 ```bash
 slither .
 ```
+This is the preferred option if your project has dependencies as Slither relies on the underlying compilation framework to compile source code.
 
-Run Slither on a single file:
+However, you can run Slither on a single file that does not import dependencies:
 ```bash
 slither tests/uninitialized.sol
 ```
 
+
 ### Integration
 - For GitHub action integration, use [slither-action](https://github.com/marketplace/actions/slither-action).
 - To generate a Markdown report, use `slither [target] --checklist`.
 - To generate a Markdown with GitHub source code highlighting, use `slither [target] --checklist --markdown-root https://github.com/ORG/REPO/blob/COMMIT/` (replace `ORG`, `REPO`, `COMMIT`)
 
-Use [solc-select](https://github.com/crytic/solc-select) if your contracts require older versions of solc. For additional configuration, see the [usage](https://github.com/trailofbits/slither/wiki/Usage) documentation.
 
-### Detectors
+## How to install
+
+Slither requires Python 3.8+ and [solc](https://github.com/ethereum/solidity/), the Solidity compiler. We recommend using [solc-select](https://github.com/crytic/solc-select) to conveniently switch between solc versions, but it is not required. For additional configuration, see the [usage](https://github.com/trailofbits/slither/wiki/Usage) documentation.
+
+### Using Pip
+
+```bash
+pip3 install slither-analyzer
+```
+
+### Using Git
+
+```bash
+git clone https://github.com/crytic/slither.git && cd slither
+python3 setup.py install
+```
+
+We recommend using a Python virtual environment, as detailed in the [Developer Installation Instructions](https://github.com/trailofbits/slither/wiki/Developer-installation), if you prefer to install Slither via git.
+
+### Using Docker
+
+Use the [`eth-security-toolbox`](https://github.com/trailofbits/eth-security-toolbox/) docker image. It includes all of our security tools and every major version of Solidity in a single image. `/home/share` will be mounted to `/share` in the container.
+
+```bash
+docker pull trailofbits/eth-security-toolbox
+```
+
+To share a directory in the container:
+
+```bash
+docker run -it -v /home/share:/share trailofbits/eth-security-toolbox
+```
+
+
+## API Documentation
+Documentation on Slither's internals is available [here](https://crytic.github.io/slither/slither.html).
+
+
+## Detectors
 
 
 Num | Detector | What it Detects | Impact | Confidence
@@ -173,38 +214,6 @@ See the [Tool documentation](https://github.com/crytic/slither/wiki/Tool-Documen
 
 [Contact us](https://www.trailofbits.com/contact/) to get help on building custom tools.
 
-## How to install
-
-Slither requires Python 3.8+ and [solc](https://github.com/ethereum/solidity/), the Solidity compiler.
-
-### Using Pip
-
-```bash
-pip3 install slither-analyzer
-```
-
-### Using Git
-
-```bash
-git clone https://github.com/crytic/slither.git && cd slither
-python3 setup.py install
-```
-
-We recommend using a Python virtual environment, as detailed in the [Developer Installation Instructions](https://github.com/trailofbits/slither/wiki/Developer-installation), if you prefer to install Slither via git.
-
-### Using Docker
-
-Use the [`eth-security-toolbox`](https://github.com/trailofbits/eth-security-toolbox/) docker image. It includes all of our security tools and every major version of Solidity in a single image. `/home/share` will be mounted to `/share` in the container.
-
-```bash
-docker pull trailofbits/eth-security-toolbox
-```
-
-To share a directory in the container:
-
-```bash
-docker run -it -v /home/share:/share trailofbits/eth-security-toolbox
-```
 
 ## Getting Help
 

setup.py

@@ -28,6 +28,7 @@
             "numpy",
             "solc-select>=v1.0.0b1",
             "openai",
+            "pdoc",
         ]
     },
     license="AGPL-3.0",

slither/detectors/reentrancy/reentrancy_eth.py

@@ -38,7 +38,7 @@ class ReentrancyEth(Reentrancy):
 ```solidity
     function withdrawBalance(){
         // send userBalance[msg.sender] Ether to msg.sender
-        // if mgs.sender is a contract, it will call its fallback function
+        // if msg.sender is a contract, it will call its fallback function
         if( ! (msg.sender.call.value(userBalance[msg.sender])() ) ){
             throw;
         }

slither/utils/type_helpers.py

@@ -11,7 +11,7 @@
 
 ### core.declaration
 # pylint: disable=used-before-assignment
-InternalCallType = Union[Function, SolidityFunction]
-HighLevelCallType = Tuple[Contract, Union[Function, Variable]]
-LibraryCallType = Tuple[Contract, Function]
-LowLevelCallType = Tuple[Union[Variable, SolidityVariable], str]
+InternalCallType = Union["Function", "SolidityFunction"]
+HighLevelCallType = Tuple["Contract", Union["Function", "Variable"]]
+LibraryCallType = Tuple["Contract", "Function"]
+LowLevelCallType = Tuple[Union["Variable", "SolidityVariable"], str]