mirror of
https://github.com/vacp2p/zerokit.git
synced 2026-01-07 21:04:02 -05:00
# Bring Back WebAssembly Support for ZeroKit - Update minor versions of all dependencies. - Update documentation to reflect these changes. - ~~Vendor `wasmer` v4.4.0 in [my git repository](https://github.com/vinhtc27/wasmer) for `ark-circom` v0.5.0.~~ - Resolve `wasm-pack` build failures (`os error 2`) caused by a Node.js version mismatch. - Restore the previous CI pipeline for the `rln-wasm` feature and update to the stable toolchain. - ~~Use `ark-circom` with the `wasm` feature for WebAssembly compatibility and the `rln.wasm` file for witness calculation.~~ - ~~Fix dependency issues related to `ark-circom` v0.5.0, which currently uses `wasmer` v4.4.0 and is affected by this [issue](https://github.com/rust-lang/rust/issues/91632#issuecomment-1477914703).~~ - Install WABT with `brew` and `apt-get` instead of cloning to fix `wasm-strip not found` issue in the CI workflow. - Install `wasm-pack` with `curl` instead of using `wasm-pack-action` to fix parse exception error in the CI workflow. - Use the `.wasm` file with JS bindings for witness calculation, which is generated from [`iden3/circom`](https://github.com/iden3/circom) during circuit compilation. This allows witness computation outside RLN instance. - Refactor the `rln` module by moving circuit-related files to the `src/circuit` folder for better organization. - Remove `ark-circom` and `wasmer` by cloning the [CircomReduction](3c95ed98e2/src/circom/qap.rs (L12)) struct and the [read_zkey](3c95ed98e2/src/zkey.rs (L53)) function into the `rln` module, which reduces the repository's build size and speeds up compilation time and the CI workflow duration. - These change also address [#282](https://github.com/vacp2p/zerokit/issues/282) by removing `wasmer` and `wasmer-wasix`, which lack x32 system support. - Benchmark `rln-wasm` with `wasm_bindgen_test`, covering RLN instance creation, key generation, witness calculation, proving, and verification. Also, add them to `v0.6.1` in [benchmark-v0.6.1](https://github.com/vacp2p/zerokit/tree/benchmark-v0.6.1) for comparison. - Add `arkzkey` feature for rln-wasm, including tests, benchmarks, CI workflow updates, and related documentation. - Benchmark rln-wasm in the browser using HTML, covering initialization, RLN instance creation, proving, and verification; fork to the `benchmark-v0.7.0` branch for later use [here](https://github.com/vacp2p/zerokit/tree/benchmark-v0.7.0). - Fix clippy error: "this `repeat().take()` can be written more concisely" on CI workflow for `utils` module. ([error](https://github.com/vacp2p/zerokit/actions/runs/14258579070/job/39965568013)) - Update Makefile.toml to be able to run `make build`, `make test`, and `make bench` from root and inside each modules.
1.6 KiB
1.6 KiB
CHANGE LOG
2023-02-28 v0.2
This release contains:
- Improved code quality
- Allows consumers of zerokit RLN to set leaves to the Merkle Tree from an arbitrary index. Useful for batching updates to the Merkle Tree.
- Improved performance for proof generation and verification
- rln_wasm which allows for the consumption of RLN through a WebAssembly interface
- Refactored to generate Semaphore-compatible credentials
- Dual License under Apache 2.0 and MIT
- RLN compiles as a static library, which can be consumed through a C FFI
2022-09-19 v0.1
Initial beta release.
This release contains:
- RLN Module with API to manage, compute and verify RLN zkSNARK proofs and RLN primitives.
- This can be consumed either as a Rust API or as a C FFI. The latter means it can be easily consumed through other environments, such as Go or Nim.
It also contains the following examples and experiments:
- Basic example wrapper around a simple Circom circuit to show Circom integration through ark-circom and FFI.
- Experimental Semaphore wrapper.
Feedback welcome! You can either open an issue or come talk to us in our Vac Discord #zerokit channel.