@venusprotocol/venus-protocol 9.5.0-dev.1 → 9.5.0-dev.2

package/README.md

@@ -80,7 +80,7 @@ Contract tests are defined under the [tests directory](https://github.com/VenusP
 
 ```
 
-- To run fork tests add `FORK=true`, `FORKED_NETWORK` and one `ARCHIVE_NODE` var in the `.env` file.
+- To run fork tests set the`FORKED_NETWORK` var in the `.env` file. An env variable with the name `ARCHIVE_NODE_<FORKED_NETWORK>` is also required.
 
 ## Code Coverage
 
@@ -107,6 +107,16 @@ npx hardhat deploy
   - In the deployment scripts you have added `tags` for example: - `func.tags = ["MockTokens"];`
   - Once this is done, adding `--tags "<tag_name>,<tag_name>..."` to the deployment command will execute only the scripts containing the tags.
 
+### Dry Run / Forked Deployments
+
+To simulate what contracts would be deployed on a given network the deployment scripts support running on a forked network. To run the deployment scripts on a forked network the `HARDHAT_FORK_NETWORK` env variable needs to be set.
+
+For example
+
+```bash
+HARDHAT_FORK_NETWORK=ethereum npx hardhat deploy
+```
+
 ### Deployed Contracts
 
 Contract addresses deployed before `hardhat-deploy` was adopted are available in the `networking` directory in JSON files by network name.