Epic: Noir.js first release

[Savio-Sou]

Prerequisite

Preview Give feedback

1. Epic: E2E headless browser tests #2163
   7 of 7
   +0
   

As a Noir app developer, I would like to make use of one Noir.js package to carry out everything Noir-related in JavaScript environments, so I can worry less about importing and managing multiple packages and ease my coding.

The app development workflow would start in the CLI:

1. Compile Noir programs into ACIRs with Nargo
2. Generate Solidity verifiers for the Noir programs with Nargo
3. Deploy the Solidity verifiers with any preferred EVM tooling (e.g. hardhat, forge)

Then in browser, developers should be able to build their app where their users can:

4. Install Noir.js to their project using NPM
5. Users can generate their desired set of inputs for the Noir program with the help of Noir.js
6. Generate witnesses with Noir.js
7. Prove the ACIRs + witnesses with any Noir compatible proving backends' packages (e.g. barretenberg's bb.js)
8. Submit proofs to the Solidity verifiers with any preferred EVM tooling (e.g. ethers.js)

Note: This is meant to illustrate the E2E workflow for a Noir app developer. Noir.js's focus would be on steps (4) to (6) instead of all of the above.

Tasks

Preview Give feedback

1. Package acvm_js into Noir.js for step Planning#31
   +0
   
2. Package noirc_abi_wasm into Noir.js for step Planning#32
   +0
   
3. NPM release for step (4): https://www.npmjs.com/package/@noir-lang/noir_js
4. Test noir_js in CI #2738
   enhancement +1
   
5. Correct noirc_abi dependency problem #2819
   +0
6. Make @noir-lang/noir_js CJS accessible #2821
   +0
   
7. Abstract away witness generation within noir_js #2836
   +0
   
8. More descriptive and easier abstraction for recursive proofs generation #2838
   +0
   

   
9. feat: Add bb interface implementation #2902
   +0
10. chore: add init method to Noir class for web #2920
    +0
11. chore: compile types package #2921
    +0
12. chore: Fix barretenberg noir typescript wrapper #2922
    +0
13. Add Noir.Js as a required test #2930
    bug +1
    
14. Fix publishing workflows #2881
    +0
    
15. Publish js packages into Releases (incl. Nightly) #2882
    +0
    
16. Ensure @noir-lang/backend_barretenberg will get published on release #2945
    +0
    
17. Ensure @noir-lang/types will get published on release #2946
    +0
    
18. Clean up the old @noir-lang/noir-ts npm package

Open to further discussions

Should we name it:

• Noir.js as it seems the most intuitive
• Nargo.js as parity with Nargo is largely what we're aiming for
  • An outlier would be helper functions that could later be provided by this package but not necessarily provided by Nargo.
• Something else?

Additional context

Developers might want to prove and verify Noir programs using the package as well, but as Noir is proving backend agnostic that would be left as proving backend packages' responsibilities (e.g. bb.js) for now.

We can revisit the need for tighter integration with backend packages at a later date.

[kobyhallx]

What would be use cases one would came to this package for?

[Savio-Sou]

Intention is for this package to be the go-to for docs, tutorials, etc.
Making this the package for most Noir devs to carry out everything-Noir in JavaScript.

Subsequently, the individual sub-packages would be documented in separate "advanced" sections.

[Savio-Sou]

Renamed the Epic for accuracy, as we should sync Noir.js's releases with Noir's / Nargo's rather than having its own set of version numbers.