diff --git a/projects/hardhat-deploy/README.md b/projects/hardhat-deploy/README.md index 97f35a0bf..00e3a9b83 100644 --- a/projects/hardhat-deploy/README.md +++ b/projects/hardhat-deploy/README.md @@ -2,17 +2,46 @@ Network config must be created in [config folder](./utils/config/) for deployment -to deploy run: +## Deployment + +For a fresh deployment of the entire test suite on a new chain, use: +```shell +npx hardhat deploy --network --tags all +``` + +For individual deployments: ```shell npx hardhat deploy --network ``` -to verify after deploy run: +## Contract Verification + +Different chains use different verification methods: + +### For Etherscan-compatible chains (Ethereum, BSC, Polygon, etc.): +```shell +npx hardhat --network etherscan-verify [--api-key ] [--api-url ] +``` + +### For Sourcify-compatible chains (Telos, etc.): ```shell -npx hardhat --network mainnet etherscan-verify [--api-key ] [--api-url ] +npx hardhat --network sourcify ``` -to do integration tests of contracts to deploy: +### Verification Support by Chain: +- Etherscan API: + - Ethereum (Mainnet & testnets) + - BSC + - Polygon + - Avalanche + - (and other chains using Etherscan-compatible explorers) +- Sourcify: + - Telos + - (other chains that don't support Etherscan API) + +## Testing + +To run integration tests of contracts to deploy: ```shell npx hardhat test -``` +``` \ No newline at end of file