Document viem support for Hardhat Upgrades#188
Conversation
✅ Deploy Preview for openzeppelin-docs-v2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Review criteria: (1) ethers content unchanged except for added viem mentions or wording generalized to cover both; (2) viem content mirrors ethers except for parameter-type differences, viem-specific options, or ethers-only options unsupported by viem; (3) content unrelated to ethers/viem unchanged; (4) every ethers-specific description or code block has an equivalent viem one with only the minimal required adaptations. Review notes: For each function, compared the viem and ethers tabs against the actual plugin source (option types and signatures) plus the viem type-check test, confirming the option lists, parameter types (address vs. contract instance), return types, and address types all match the real API and stay consistent between the two tabs. Tabs are balanced, and the pages were previewed to confirm they render and the ethers/viem toggle flips everything together. |
Documentation Pull Request
Summary
Updates the Hardhat Upgrades docs to cover using the plugin with viem, alongside the existing ethers usage.
@openzeppelin/hardhat-upgrades/viem, contracts by name, viem contract instances) and a short note on how it differs from ethers.Emphasizes throughout that viem users must import from
@openzeppelin/hardhat-upgrades/viem, since the examples otherwise use ethers.Type of Change
Related Issues
OpenZeppelin/openzeppelin-upgrades#1279
Checklist
pnpm run buildpnpm run check