OpenZeppelin / OpenZeppelin/compact-contracts
Add types to Contracts
Open
Nobody has claimed this yet.
2-low
effort: 4-L
feat:utils
stale
- Dominant language
- TypeScript
- Stars
- 55
- Forks
- 29
- Avg merge
- 5d 7h
- Merged PRs (30d)
- 25
Description
Compact 0.28.0 introduced type aliases and nominally typed aliases which allows us to improve both the readability and safety of our library.
The purpose of this issue to define how we want to name things, what types should be defined, and the high level architecture of a reusable types file that each contract module may use
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 with the linked Compact 0.28.0 changelog entry, then review the existing contract modules to understand current naming and type usage. The issue is complete when the naming scheme, types to define, and reusable types-file architecture are agreed for contract modules.
Written by the indexing model from the issue text.
Assessment
- Domain
- blockchain
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100