OpenZeppelin / OpenZeppelin/openzeppelin-upgrades

Support using with hardhat-deploy

Open
#680 1 comment 9 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
658
Forks
286
PR merge metrics
No merged PRs in 30d

Description

I have set up my project with hardhat-deploy, which enables me to save all my recent deployments per network as contract artifacts and see the addresses inside of them. It's one of the main features of my project structure. Because I use these artifacts to create npm packages for other repos.

And the problem is, which is weird for me, that the hardhat-upgrades library is not compatible with one of the hardhat's core plugins: hardhat-deploy.
And in a result, part of my contracts are deployed normally and I have artifacts for them inside my deployments folder.
But for upgradeable contracts I don't have artifacts, I have only the .openzeppelin/network*.json file which stores proxies and implementation libraries and just proposes a different approach for saving data and forces me to parse and stick these things.
together.
But that's a very simple problem I have, but hardhat-deploy gives me more options and useful toolings I couldn't have worked with your library.

For now, the best option for me is to handle upgradeability myself with core hardhat functionality, because I don't require more complex configurations that your library could provide to me. But for the future, I would be very glad if your tool was compatible with one of the most standard community plugins hardhat-deploy

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how hardhat-deploy stores contract artifacts and how hardhat-upgrades records deployments in .openzeppelin/network*.json. Then inspect the compatibility requirements described in the issue; done should mean the two plugins can be used together while preserving deployment information in the expected artifacts.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
blockchain, devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.