Files
zk-kit/packages/identity
cedoor 46aa315787 chore: set tsconfig paths for all zk-kit packages
Former-commit-id: 92f063bf3794f022233565633299610938e62e09 [formerly 9fb0532beafe80f1591bd9aa3b083dfd55469611] [formerly 3b14775151319fe357ebbe82a4931f85c15a3bbd [formerly 87dbdfb166]]
Former-commit-id: 28a49fe4119f800a610d6a1c0315baf31f598fe0 [formerly 346fea95b7b9f2d17c928a5019cbcfb664b0fdfc]
Former-commit-id: 65d03434f0522b0ef27ef74ef456099e4db9309a
2022-01-23 14:10:03 +01:00
..
2022-01-21 13:56:04 +01:00
2022-01-21 13:56:04 +01:00
2022-01-23 12:26:40 +01:00
2022-01-21 22:43:14 +01:00
2022-01-20 14:05:43 +01:00

ZK identities

Library for managing identities for Semaphore and RLN protocols.

Github license NPM version Downloads npm bundle size (scoped) Linter eslint Code style prettier


🛠 Install

npm or yarn

Install the @zk-kit/identity package with npm:

npm i @zk-kit/identity

or yarn:

yarn add @zk-kit/identity

📜 Usage

Creating an identity with a random strategy:

import { ZkIdentity } from "@zk-kit/identity"
// const { ZkIdentity } = require("@zk-kit/identity") // with commonJS

const identity = new ZkIdentity()

const trapdoor = identity.getTrapdoor()
const nullifier = identity.getNullifier()
const secret = identity.getSecret()
const multipartSecret = identity.getMultipartSecret()

const identityCommitment = identity.genIdentityCommitment()

Creating an identity with a message strategy:

import { ZkIdentity, Strategy } from "@zk-kit/identity"

const identity = new ZkIdentity(Strategy.MESSAGE, "message")

Creating an identity with a serialized strategy:

import { ZkIdentity, Strategy } from "@zk-kit/identity"

const identity = new ZkIdentity()
const serializedIdentity = identity.serializeIdentity()

const identity2 = new ZkIdentity(Strategy.SERIALIZED, serializedIdentity)