OpenZeppelin / OpenZeppelin/compact-tools

Improve witness handling

Open
#65 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
4
Forks
5
Avg merge
15h 28m
Merged PRs (30d)
31

Description

I suspect that if we change how the simulator package consumes witnesses and PS, we can decouple the witness file from the generated mock artifacts. Basically, I think we can make a generic witness file with default logic. And in the simulator instance (for testing or whatever case), users create the witness instance from the generated artifacts in the contract simulator file/instance

https://github.com/OpenZeppelin/midnight-apps/pull/290#discussion_r2788539794

This may not require refactoring simulator logic; rather, it might just require a new pattern for how witnesses are passed to the sim object

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked discussion and inspect the simulator package, witness handling, generated mock artifacts, and the contract simulator file or instance. Clarify whether a generic witness file and instance-created witnesses are the intended design, then define tests showing that witnesses are decoupled from generated artifacts.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
testing, tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.