Skip to content

Document viem support for Hardhat Upgrades#188

Draft
ericglau wants to merge 13 commits into
OpenZeppelin:mainfrom
ericglau:hardhatupgradesviem
Draft

Document viem support for Hardhat Upgrades#188
ericglau wants to merge 13 commits into
OpenZeppelin:mainfrom
ericglau:hardhatupgradesviem

Conversation

@ericglau

Copy link
Copy Markdown
Member

Documentation Pull Request

Summary

Updates the Hardhat Upgrades docs to cover using the plugin with viem, alongside the existing ethers usage.

  • Using with Hardhat – install snippet now shows the plugin plus either the ethers or viem peer dependencies; adds "if you are using viem" sections for scripts and tests (import from @openzeppelin/hardhat-upgrades/viem, contracts by name, viem contract instances) and a short note on how it differs from ethers.
  • Hardhat Upgrades API – reframes the intro for both ethers and viem, adds the viem setup/import, and notes viem's transaction-option differences.
  • Migration guide – corrects the viem note and checklist to point at the viem API.

Emphasizes throughout that viem users must import from @openzeppelin/hardhat-upgrades/viem, since the examples otherwise use ethers.

Type of Change

  • New documentation
  • Documentation update/revision
  • Fix typos or grammar
  • Restructure/reorganize content
  • Add examples or tutorials
  • Update API documentation
  • Other: ___________

Related Issues

OpenZeppelin/openzeppelin-upgrades#1279

Checklist

@netlify

netlify Bot commented Jun 22, 2026

Copy link
Copy Markdown

Deploy Preview for openzeppelin-docs-v2 ready!

Name Link
🔨 Latest commit 96e61d5
🔍 Latest deploy log https://app.netlify.com/projects/openzeppelin-docs-v2/deploys/6a3c54cc2fd91e000858056a
😎 Deploy Preview https://deploy-preview-188--openzeppelin-docs-v2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant