mirror of
https://github.com/privacy-scaling-explorations/zk-kit.git
synced 2026-04-22 03:00:15 -04:00
8620137acffb31abea0406bc4c14d79bf2a8c4e9
Former-commit-id: 5bf94b96f6a662a0e7a2511919b4812151c675d5 [formerly 341607693c]
Former-commit-id: 3c8f4d259930b4b7ea4fd4ea390ca1cc73102a76
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%