diff --git a/l1-contracts/README.md b/l1-contracts/README.md index e3b27c55388..258fb4cdedd 100644 --- a/l1-contracts/README.md +++ b/l1-contracts/README.md @@ -76,7 +76,7 @@ yarn lint --- -# Slither +# Slither & Slitherin We use slither as an automatic way to find blunders and common vulnerabilities in our contracts. It is not part of the docker image due to its slowness, but it can be run using the following command to generate a markdown file with the results: ```bash @@ -85,6 +85,6 @@ yarn slither When this command is run in CI, it will fail if the markdown file generated in docker don't match the one in the repository. -We assume that you already have slither installed. You can install it with `pip3 install slither-analyzer`. It is kept out of the bootstrap script as it is not a requirement for people who just want to run tests or are uninterested in the contracts. +We assume that you already have slither installed. You can install it with `pip3 install slither-analyzer slitherin`. It is kept out of the bootstrap script as it is not a requirement for people who just want to run tests or are uninterested in the contracts. > We are not running the `naming-convention` detector because we have our own rules for naming which is enforced by the linter. \ No newline at end of file