OpenZeppelin / OpenZeppelin/contracts-wizard

Support out of sync version for upgradeable contracts

Open
#113 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
294
Forks
186
Avg merge
6h 46m
Merged PRs (30d)
22

Description

Sometimes the versioning for @openzeppelin/contracts and @openzeppelin/contracts-upgradeable gets out of sync because we need to release fixes specific for the upgradeable contracts. This is not supported in Wizard currently and we were not able to merge https://github.com/OpenZeppelin/contracts-wizard/pull/96 as a result. The specific problem is that the version included in the source code when opening in Remix is taken from the non-upgradeable contracts. We need to be aware of both versions and choose accordingly.

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 tracing how the Wizard selects the version embedded in generated source code opened in Remix, then inspect the handling of @openzeppelin/contracts and @openzeppelin/contracts-upgradeable versions described in pull request #96. Done means the Wizard can account for both versions and choose the appropriate one for upgradeable contracts without breaking the existing non-upgradeable case.

Written by the indexing model from the issue text.

Assessment

Tech stack
solidity, typescript
Domain
blockchain, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.