OpenZeppelin / OpenZeppelin/compact-contracts
Rename `ZOwnablePK` to `ShieldedOwnable` and decouple owner identity from Zswap
Open
Nobody has claimed this yet.
1-medium
effort: 3-M
feat:access
- Dominant language
- TypeScript
- Stars
- 55
- Forks
- 29
- Avg merge
- 5d 7h
- Merged PRs (30d)
- 25
Description
The ZOwnablePK name implies the identity model depends on the Zswap coin
public key, but the privacy guarantee comes from the secret nonce. The Zswap
key is incidental.
Proposed:
- Rename module to
ShieldedOwnable(update refs, tests, docs). - Refactor owner-id logic to drop
ZswapCoinPublicKey. - Breaking change: note migration implications.
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
Search the repository for ZOwnablePK, ZswapCoinPublicKey, owner-id logic, tests, and documentation. Read the current module and its tests first, then trace every reference before assessing the migration impact. Done means the module and references use ShieldedOwnable, owner identity no longer depends on ZswapCoinPublicKey, tests and docs are updated, and the breaking change is documented.
Written by the indexing model from the issue text.
Assessment
- Domain
- authorization, blockchain
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100