OpenZeppelin / OpenZeppelin/compact-contracts
Improve `initialize` pattern
Open
Nobody has claimed this yet.
2-low
effort: 3-M
feat:utils
stale
- Dominant language
- TypeScript
- Stars
- 55
- Forks
- 29
- Avg merge
- 5d 7h
- Merged PRs (30d)
- 25
Description
The current pattern for modules is to use an initialize circuit which calls the Initializable mod's initialize (Initializable_initialize with prefix). The naming conventions here can be confusing. This should be reconsidered to improve clarity
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the module pattern described in the issue, especially the initialize circuit and the prefixed Initializable_initialize call. Establish a clearer naming convention and determine which affected modules would need to follow it; the issue does not specify a finished convention or affected files.
Written by the indexing model from the issue text.
Assessment
- Domain
- blockchain
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100