Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature: improve deployment instructions #316

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 34 additions & 5 deletions projects/hardhat-deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <network_name> --tags all
```

For individual deployments:
```shell
npx hardhat deploy --network <network_name>
```

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 <network_name> etherscan-verify [--api-key <etherscan-apikey>] [--api-url <url>]
```

### For Sourcify-compatible chains (Telos, etc.):
```shell
npx hardhat --network mainnet etherscan-verify [--api-key <etherscan-apikey>] [--api-url <url>]
npx hardhat --network <network_name> 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
```
```