Add Hardhat Ignition to hardhat-toolbox

[zoeyTM]

Updates the @nomicfoundation/hardhat-toolbox and @nomicfoundation/hardhat-toolbox-viem packages to include Hardhat Ignition.

This includes

• Updated sample projects with Hardhat Ignition files
• Added Hardhat Ignition to hardhat-toolbox and hardhat-toolbox-viem
• Updated relevant docs to use Hardhat Ignition where relevant

A sibling PR to update hardhat-boilerplate has also been opened.

resolves NomicFoundation/hardhat-ignition#614
resolves NomicFoundation/hardhat-ignition#613

Manual Testing Instructions

To manually create HH projects with the new toolbox:

1. Pull the branch locally
2. Install the new deps: pnpm install
3. Apply the changeset versioning locally: npx changeset version
4. Run the build pnpm build
5. Start a new verdaccio instance and login (see https://www.notion.so/nomicfoundation/Using-verdaccio-e15e379b59a64ef8a82fe0c1a6b93dd8?pvs=4)
6. publish hardhat to verdaccio:

cd packages/hardhat-core
pnpm publish --registry=http://localhost:4873/ --no-git-check

7. publish @nomicfoundation/hardhat-toolbox to verdaccio:

cd packages/hardhat-toolbox
pnpm publish --registry=http://localhost:4873/ --no-git-check

8. publish @nomicfoundation/hardhat-toolbox-viem to verdaccio:

cd packages/hardhat-toolbox-viem
pnpm publish --registry=http://localhost:4873/ --no-git-check

9. Install the new hardhat globally from verdaccio (is there a better approach? Also you might want to do this outside a volta controller directory):

npm install -g [email protected] --registry=http://localhost:4873/

10. Create your new sample project with the globally installed hardhat:

hardhat --version
# 2.20.2
echo "registry=http://localhost:4873" > .npmrc
hardhat init

11. Run the docs locally:

cd docs
pnpm install
pnpm dev

Questions and decisions

• Are we happy with the failing CI Test - yes a local manual run with updated versions counts as a pass
• How do we approach scripting in the docs given that it is currently about deploymeent
  • Remove the scripts from the sample projects
  • Remove the scripting guide from basic, move it to advanced and show a replacement script story (e.g. "how long left in timelock")
• Confirm whether we are updating the verification guide - yes
  • short intro going through ignition verification
  • follow on section for manual verification based on existing guide
• Are we updating the deployment contracts to reflect the danger of msg.sender in a create2 context?
  • no - lets see if anyone raises it as an issue and reconsider

TODO

• Confirm whether we are updating the hackathon guide
• Manually test the new sample projects
• Investigate assert.isDefined issue - see comment in PR
• Investigate no ignition in tasks issue - see comment in PR
• Update verification guide in HH
• Update docs to move scripts from basic to advanced
• Remove scripts from sample project + update their readmes
• Update sample projects with a parameters json file
• Review example to work better with Ignition, specifically it is a complicated example that needs lots of Ignition Module features explained.
• Run through the Tutorial section of the docs manually @ChristopherDedominici
• Run through the Guides section of the docs manually, key areas of focus: @schaable
  • Setting up a project
  • Testing contracts
  • Deploying your contracts
  • Verifying your contracts
  • Writing tasks
• Run through hardhat-boilerplate @kanej
• Run through the Scripts section of Advanced in the docs manually @kanej
• Local manual run of end to end tests with bumped versions
• Double check typescript peer dependency constraint as raised here: chore(hardhat-viem,hardhat-toolbox-viem): updated package.json with loosen version constraints for typescript #4955 @kanej

[changeset-bot]

🦋 Changeset detected

Latest commit: 26720f8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages

Name	Type
hardhat	Patch
@nomicfoundation/hardhat-toolbox	Major
@nomicfoundation/hardhat-toolbox-viem	Major
benchmark	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
hardhat	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 14, 2024 1:30pm

[kanej]

I have run the e2e tests locally. They are failing due to the new toolboxes not being in npm.