mirror of
https://github.com/privacy-scaling-explorations/zk-kit.git
synced 2026-04-22 03:00:15 -04:00
e33e5ea5bb23b75b945185aa53a0894f31bef8e4
Former-commit-id: e3629137163458a4d044207546421fd684fe2324 [formerly 78705ca073]
Former-commit-id: e3294d86e46a84c284cf07aa7dc17cb79af5bb3e
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.
Languages
TypeScript
95.5%
TeX
4.4%