add documentation for deployment and source code verification

README.md

@@ -7,47 +7,93 @@ https://github.com/compound-finance/compound-protocol/tree/a3214f67b73310d547e00
 ### Prerequisites
 
 - NodeJS - 12.x
+
 - Solc - v0.8.13 (https://github.com/ethereum/solidity/releases/tag/v0.8.13)
 
 ### Installing
 
 ```
+
 yarn install
+
 ```
 
 ### Run Tests
 
 ```
+
 yarn test
+
 yarn hardhat:test
+
 ```
 
 - To run fork tests add FORK_MAINNET=true and QUICK_NODE_KEY in the .env file.
 
+### Deployment
+
+```
+
+npx hardhat deploy
+
+```
+
+- This command will execute all the deployment scripts in `./deploy` directory - It will skip only deployment scripts which implement a `skip` condition - Here is example of a skip condition: - Skipping deployment script on `bsctestnet` network `func.skip = async (hre: HardhatRuntimeEnvironment) => hre.network.name !== "bsctestnet";`
+- The default network will be `hardhat`
+- Deployment to another network: - Make sure the desired network is configured in `hardhat.config.ts` - Add `MNEMONIC` variable in `.env` file - Execute deploy command by adding `--network <network_name>` in the deploy command above - E.g. `npx hardhat deploy --network bsctestnet`
+- Execution of single or custom set of scripts is possible, if:
+  - 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.
+
+### Source Code Verification
+
+In order to verify the source code of already deployed contracts, run:
+`npx hardhat etherscan-verify --network <network_name>`
+
+Make sure you have added `ETHERSCAN_API_KEY` in `.env` file.
+
 ### Hardhat Commands
 
 ```
+
 npx hardhat accounts
+
 npx hardhat compile
+
 npx hardhat clean
+
 npx hardhat test
+
 npx hardhat node
+
 npx hardhat help
+
 REPORT_GAS=true npx hardhat test
+
 npx hardhat coverage
-npx hardhat run scripts/deploy.ts
+
 TS_NODE_FILES=true npx ts-node scripts/deploy.ts
+
 npx eslint '**/*.{js,ts}'
+
 npx eslint '**/*.{js,ts}' --fix
+
 npx prettier '**/*.{json,sol,md}' --check
+
 npx prettier '**/*.{json,sol,md}' --write
+
 npx solhint 'contracts/**/*.sol'
+
 npx solhint 'contracts/**/*.sol' --fix
 
+
+
 MNEMONIC="<>" BSC_API_KEY="<>" npx hardhat run ./script/hardhat/deploy.ts --network testnet
+
 ```
 
 ### Documentation
 
 Documentation is autogenerated using [solidity-docgen](https://github.com/OpenZeppelin/solidity-docgen).
+
 They can be generated by running `yarn docgen`