.---. ,--.  ,--   ,----.   ,--.  ,--.   ,-. .----. ,------.,------,
    / .  | |   \ |  | |  ._. \  |  |  `\ . '.' /\_.-,  ||  .---'|   /`. '
   / /|  | |  . '|  | |  |_|  | |  |    \     /   |_  <(|  '--. |  |_.' |
  / '-'  |||  |\    | |  .-.  |(|  '_    /   /) .-. \  ||  .--' |  .   .'
  `---|  |'|  | \   | |  | |  | |     | /   /`  \ `-'  /|  `---.|  |\  \
      `--' `--'  `--' `--' `--' `-----' `--'     `---'' `------'`--' '--'

Table of Contents

• Table of Contents
  • Usage
  • Example Reports
  • Installation
  • Contributing

Usage

yarn analyze <BASE_PATH> <SCOPE_FILE> <GITHUB_URL>

# Example
yarn analyze contracts scope.example.txt

• 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.

Example Reports

| Repository | Report | | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | | Holograph | Report | | 3xcalibur | Report | | Inverse Finance | Report | | Paladin | Report | | zkSync | Report |

Installation

You'll need Node.js and Yarn. Then clone the repo and run:

yarn

You're all set!

Contributing

You're more than welcome to contribute! For help you can check CONTRIBUTING.md