Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
LHerskind committed Jan 27, 2024
1 parent 0047a86 commit ff142d3
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions l1-contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

0 comments on commit ff142d3

Please sign in to comment.