mirror of
https://github.com/privacy-scaling-explorations/zk-kit.git
synced 2026-04-22 03:00:15 -04:00
b61a381a11
Former-commit-id: 69221053bfd42ca787e405b90b7654a6320eb797 [formerly b32fc77aa40f6306e415d41807cd2582add75576] [formerly fa913c98a96f91c77d01df6725d77adb020b68aa [formerly 36fcf8482b]]
Former-commit-id: 38c46f3594790895f456019d533aa41b3d01ca31 [formerly a204a646b8d4194514d68dd922183bbecfefdffa]
Former-commit-id: d980f64fdcb24cf04c129818c19d7895605f156e
Libsemaphore
A monorepo of JavaScript libraries for Semaphore.
A library that allows for easy access and interoperability for Semaphore and RLN constructs. It is meant to be used by third-party applications to easily integrate with Seamphore and RLN. The library provides an API (Semaphore and RLN) for:
- Identity generation
- Proof generation
- Proof verification
The library is structured as a three separate npm packages:
@libsem/identity: Exposes utilities for Zk identity generation, necessary for interacting with the Zk protocols supported by this library,@libsem/protocols: Utilities for proof genration and verification for various Zk protocols,@libsem/types: Helper package which exposes the types used byidentityandprotocolspackages.
All the packages provide tests which can be used as a guide for interaction.
📦 Packages
| Package | Version | Downloads | Size |
|---|---|---|---|
| @libsem/identity |
|
|
|
| @libsem/protocols |
|
|
|
| @libsem/types |
|
|
🛠 Install
Clone this repository and install the dependencies:
$ git clone https://github.com/appliedzkp/libsemaphore.git
$ cd libsemaphore && npm i
📜 Usage
$ npm run lint # Lint all packages.
$ npm run test # Test all packages (with common coverage).
$ npm run build # Create a JS build for each package.
$ npm run publish:fp # Publish packages on npm.
You can see the other npm scripts in the package.json file.