OpenZeppelin / OpenZeppelin/compact-contracts
dev: rename the V1 multisig preset after its composition
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 55
- Forks
- 29
- Avg merge
- 5d 7h
- Merged PRs (30d)
- 25
Description
multisig/presets/ShieldedMultiSig is the only preset still named after nothing in particular. It composes Zswap-key signers, a public proposal lifecycle and the stateful ShieldedTreasury, so it is the stateful sibling of NativeShieldedStatelessTreasury. Its asserts mix two prefixes (ShieldedMultiSig: and Multisig:), its circuits carry no @circuitInfo, and its ledger fields have no docs.
Rename the preset, its example, mock and spec to NativeShieldedTreasury; unify the assert prefix; add measured @circuitInfo tags and ledger docs; restyle the header to the section taxonomy the other presets use. Circuits and the generated artifact stay unchanged.
Part of #886.
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 multisig/presets/ShieldedMultiSig and locate its example, mock, and spec. Rename those items to NativeShieldedTreasury, then verify the assert prefix, circuitInfo tags, ledger docs, and header match the requested conventions while circuits and the generated artifact remain unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- blockchain
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100