github/zk-kit

mirror of https://github.com/privacy-scaling-explorations/zk-kit.git synced 2026-04-22 03:00:15 -04:00

Go to file

bdim1 70e5358a79 README.md updates & inconsistencies fix

2021-10-20 23:36:10 +02:00

.github/workflows

ci: remove npm-publish workflow

2021-10-19 12:19:12 +02:00

README.md updates & inconsistencies fix

2021-10-20 23:36:10 +02:00

.editorconfig

pretier and lerna build

2021-10-19 00:06:09 +02:00

.eslintignore

new version with submodules

2021-10-18 19:43:40 +02:00

.eslintrc.json

chore: update eslint config file format

2021-10-19 12:18:43 +02:00

.gitignore

new version with submodules

2021-10-18 19:43:40 +02:00

jest.config.json

temporary skip coverage

2021-10-19 00:32:04 +02:00

lerna.json

fix: update packages path

2021-10-19 12:19:50 +02:00

package-lock.json

clean & publish scripts

2021-10-19 12:31:34 +02:00

package.json

make protocols and identity packages public

2021-10-19 12:40:13 +02:00

README.md

README.md updates & inconsistencies fix

2021-10-20 23:36:10 +02:00

tsconfig.json

style: format syntax

2021-10-19 12:22:21 +02:00

README.md

libsemaphore

Description

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:

identity - Exposes utilities for Zk identity generation, necessary for interacting with the Zk protocols supported by this library
protocols - Utilities for proof genration and verification for various Zk protocols
types - Helper package which exposes the types used by identity and protocols packages.

Please refer to the identityand protocols packages accordingly for installation and usage instructions. The packages also provide tests which can be used as a guide for interaction.