You'll need Node.js and Yarn. Then clone the repo and run:
yarn or npm
npm i @solidity-parser/parser
npm i ast-node-builder
You're all set!
yarn analyze <BASE_PATH> <SCOPE_FILE> <GITHUB_URL>
yarn analyze contracts scope.txt https://github.com/repo/repo
BASE_PATH
is a relative path to the folder containing the smart contracts.SCOPE_FILE
is an optional file containing a specific smart contracts scope (see scope.example.txt)GITHUB_URL
is an optional url to generate links to github in the report- For remappings, add remappings.txt to
BASE_PATH
. - The output will be saved in a
report.md
file.
You're more than welcome to contribute! For help you can check CONTRIBUTING.md