OpenZeppelin / OpenZeppelin/compact-tools
Return `proofData` from circuitProxies in `simulator` package
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 4
- Forks
- 5
- Avg merge
- 15h 28m
- Merged PRs (30d)
- 31
Description
At this time, the Simulator returns circuit results and discards all other data returned from a circuit execution. In order to test our privacy assumptions, we must also return proofData from the circuit proxies to examine the generated publicTranscript
This is a breaking API change that would require significant refactoring across all our test files.
Contributor guide
No contributing guide indexed for this repository
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 in the simulator package by tracing the circuitProxies entry point into the Simulator result handling. Review the existing test files that cover circuit execution and identify how returned data is currently discarded. Done means proofData, including the generated publicTranscript, is available to callers and the affected tests pass with the breaking API update.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, testing-qa
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100