diff --git a/README.md b/README.md index fd20f7b797..ce80eac14f 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,16 @@ Connect MetaMask to `http://localhost:8545`. When freshly starting a node it is usually nedessary to also reset Metamask Account being used: - Click on Account top right icon -> settings -> advanced -> Reset Account +### Running Smoke Tests + +Smoke tests can be ran in 2 modes: +- Run `scripts/test/smokeTest.sh` to launch interactive mode. All the "before contract changes" parts of tests + will execute and wait for the user to manually using a console performs contract changes. Once those are done + hit "Enter" in the smoke test console and the second part of the tests shall be ran that validate that contract + changes haven't broken basic functionality. +- Run `scripts/test/smokeTest.sh --deployid [numeric_id_of_deploy]` will run smoke tests against a specific + deployid. Validating that that deploy didn't break basic functionality. + ### Runnning on Mainnet fork This repository also supports running a local node via the Hardhat EVM fork implementation.