Skip to content

Commit

Permalink
docs(groth16): add more details to the readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
cedoor authored Oct 12, 2023
1 parent 12ce6bc commit 4aeaf50
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions packages/groth16/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@
| This package contains [SnarkJS](https://github.com/iden3/snarkjs) functions for generating and verifying zero knowledge proofs with Groth16 specifically. In addition to the original code it also uses the cached `bn128` curve if it already exists, making verification and generation of consecutive proofs faster. |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

Some advantages of using this package instead of `snarkjs` directly are:
* It only includes code to verify and generate Groth16 proofs, making your final bundle lighter.
* It doesn't call the [ffjavascript](https://github.com/iden3/ffjavascript) `buildBn128` function if a `bn128` cached curve already exists, making verification and generation of consecutive proofs much faster (e.g. verification seems to be ~9 times faster after the first one).
* It includes TS types.
* It provides an ESM bundle that is compatible with browsers. So there is no need to add any polyfill or additional configuration.

## 🛠 Install

### npm or yarn
Expand Down

0 comments on commit 4aeaf50

Please sign in to comment.