Update ignition verification guide to include all supported services and clarify CLI command options#242
Conversation
…and clarify CLI command options
|
@manuelwedler is attempting to deploy a commit to the Nomic Foundation Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
Pull request overview
This PR updates the Ignition verification documentation to reflect Hardhat’s expanded verification support beyond Etherscan (per changes introduced in hardhat#7967).
Changes:
- Update the
--verifyCLI option description to indicate verification runs across all enabled backends. - Expand the verification guide to mention Etherscan, Blockscout, and Sourcify, and adjust wording to reflect multi-service verification.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
src/content/docs/ignition/docs/reference/cli-commands.mdx |
Updates --verify help text to reflect multi-verifier behavior. |
src/content/docs/ignition/docs/guides/verify.mdx |
Broadens the guide from Etherscan-only to all supported verification services and tweaks related copy. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| If you want to verify your contracts on Etherscan, you need an API key from Etherscan. Otherwise, Etherscan will be skipped and your contracts will be verified on the other services.. | ||
|
|
||
| To get an API key, go to [their site](https://etherscan.io/login), sign in (or create an account if you don't have one) and open the "API Keys" tab. Then click the "Add" button and give a name to the API key you are creating (e.g. "Hardhat"). After that you'll see the newly created key in the list. |
There was a problem hiding this comment.
There’s an extra period at the end of the sentence (“other services..”). Please remove the duplicate punctuation.
| If you want to verify your contracts on Etherscan, you need an API key from Etherscan. Otherwise, Etherscan will be skipped and your contracts will be verified on the other services.. | ||
|
|
||
| To get an API key, go to [their site](https://etherscan.io/login), sign in (or create an account if you don't have one) and open the "API Keys" tab. Then click the "Add" button and give a name to the API key you are creating (e.g. "Hardhat"). After that you'll see the newly created key in the list. | ||
|
|
||
| Open your Hardhat config and add the API key you just created as a configuration variable: |
There was a problem hiding this comment.
This section explains Etherscan verification config, but the config snippet below uses a top-level etherscan field. Elsewhere in the docs (e.g. the smart contract verification guide and tutorial) the configuration lives under verify: { etherscan: ... }. If etherscan is no longer supported (or only kept for backward compatibility), this guide should be updated to use the current verify config shape to avoid confusing readers.
| --reset Wipes the existing deployment state before deploying (default: false) | ||
| --strategy Set the deployment strategy to use (default: basic) | ||
| --verify Verify the deployment on Etherscan (default: false) | ||
| --verify Verify the deployment on all enabled verifiers (default: false) |
There was a problem hiding this comment.
The option description uses the term “enabled verifiers”, but this doc page elsewhere describes verification in terms of “configured block explorers”. Consider aligning terminology (e.g., “all enabled verification services” or “configured explorers/services”) so users don’t think --verify only affects a subset of backends.
| --verify Verify the deployment on all enabled verifiers (default: false) | |
| --verify Verify the deployment on all configured block explorers (default: false) |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-project-automation
Bot
moved this from Sprint - Blocked
to Sprint - Done
in Sourcify Public
Update docs to reflect changes of NomicFoundation/hardhat#7967