slither-organizer

A tool to organize slither logs in JSON files, sorted by vulnerability and organized in keywords.

Setup

Install slither

Visit https://github.com/crytic/slither for informations about slither installation and setup

Create the output directory

Create a directory named 'output' in the parent directory, it will be the output directory of slither findings.

Analyze slither contracts and produce outputs

To analyze contracts, run

yarn run analyze

Configuration

To configure the parameters see organize.ts file.

Configure logs path

Logs path is the path containing slither outputs, set to default as output.

Path can be changed by editing the variable logsPath.

Configure keywords for organized logs

Organized logs are a set of objects that can be defined to organize logs based on keywords.

To edit or add keywords(objects of which key is a string), edit inside the organizedLogs object.

Configure excluded keywords

Excluded keywords are a set of keywords indicating the logs to exclude based on keywords.
By setting an excluded keyword, all logs containing it will be automatically skipped.

To edit or add excluded keywords(strings), edit the excludedKeywords object.

Usage

To organize logs, run

yarn run organize

Bonus

The tool includes also a built-in merge functions to facilitate slither analysis on larger contracts.

To merge contracts, run

yarn run merge