Skip to content

Commit

Permalink
remove Hardhat and Surya mentions in README
Browse files Browse the repository at this point in the history
docgen docs are already included in the repo. Surya is unneeded.
  • Loading branch information
ChaoticWalrus committed Apr 25, 2023
1 parent 054288b commit b15a63e
Showing 1 changed file with 0 additions and 24 deletions.
24 changes: 0 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,15 +154,8 @@ See the [Foundry Docs](https://book.getfoundry.sh/) for more info on installatio
```bash
foundryup
forge install
npm install
```

### Natspec Documentation

You will notice that we also have hardhat installed in this repo. This is only used to generate natspec [docgen](https://github.com/OpenZeppelin/solidity-docgen). This is our workaround until foundry [finishes implementing](https://github.com/foundry-rs/foundry/issues/1675) the `forge doc` command.

To generate the docs, run `npx hardhat docgen` (you may need to run `npm install` first). The output is located in `docs/docgen`

### Run Tests

Prior to running tests, you should set up your environment. At present this repository contains fork tests against ETH mainnet; your environment will need an `RPC_MAINNET` key to run these tests. See the `.env.example` file for an example -- two simple options are to copy the LlamaNodes RPC url to your `env` or use your own infura API key in the provided format.
Expand All @@ -176,20 +169,3 @@ The main command to run tests is:
`solhint 'src/contracts/**/*.sol'`

`slither .`

### Generate Inheritance and Control-Flow Graphs

first [install surya](https://github.com/ConsenSys/surya/)

then run

`surya inheritance ./src/contracts/**/*.sol | dot -Tpng > InheritanceGraph.png`

and/or

`surya graph ./src/contracts/middleware/*.sol | dot -Tpng > MiddlewareControlFlowGraph.png`

and/or

`surya mdreport surya_report.md ./src/contracts/**/*.sol`

0 comments on commit b15a63e

Please sign in to comment.