From 16c047fb146cb39ab10efbd8ac0ea97d24aef6d5 Mon Sep 17 00:00:00 2001 From: Andrija Novakovic Date: Fri, 22 Oct 2021 22:13:48 +0200 Subject: [PATCH] update readme --- packages/identity/README.md | 10 +++++----- packages/identity/package.json | 2 +- packages/protocols/README.md | 11 ++--------- packages/protocols/package.json | 2 +- 4 files changed, 9 insertions(+), 16 deletions(-) diff --git a/packages/identity/README.md b/packages/identity/README.md index 97f9f05..9d8d032 100644 --- a/packages/identity/README.md +++ b/packages/identity/README.md @@ -59,14 +59,14 @@ const { ZkIdentity } = require("@libsem/identity") **Mainpulation** ```typescript -const identity: Identity = ZkIdentity.genIdentity() -const identityCommitment: bigint = ZkIdentity.genIdentityCommitment(identity) +const identity: ZkIdentity = new ZkIdentity(); +const identityCommitment: bigint = identity.genIdentityCommitment(); ``` **Serialization** ```typescript -const identity: Identity = ZkIdentity.genIdentity() -const serialized: string = ZkIdentity.serializeIdentity(identity) -const unserialized: Identity = ZkIdentity.unSerializeIdentity(serialized) +const identity: ZkIdentity = new ZkIdentity(); +const serialized: string = identity.serializeIdentity() +const unserialized: ZkIdentity = ZkIdentity.genFromSerialized(serialized); ``` diff --git a/packages/identity/package.json b/packages/identity/package.json index 540db9b..7975d28 100644 --- a/packages/identity/package.json +++ b/packages/identity/package.json @@ -1,6 +1,6 @@ { "name": "@libsem/identity", - "version": "1.0.12", + "version": "1.0.13", "description": "Library for managing identites for Semaphore and Rln protocols.", "main": "dist/index.node.js", "types": "dist/types/index.d.ts", diff --git a/packages/protocols/README.md b/packages/protocols/README.md index 0e47ed0..b442b2a 100644 --- a/packages/protocols/README.md +++ b/packages/protocols/README.md @@ -70,7 +70,8 @@ Generate merkle proof for your identity given the array of registered identity c ```typescript const identityCommitments: Array = [...]; -const identityCommitment: bigint = ZkIdentity.genIdentityCommitment(identity); +const identity: ZkIdentity = new ZkIdentity(); +const identityCommitment: bigint = identity.genIdentityCommitment(); const merkleProof: MerkleProof = generateMerkleProof(TREE_DEPTH, ZERO_VALUE, NUMBER_OF_LEAVES_PER_NODE, identityCommitments, identityCommitment); ``` @@ -84,14 +85,6 @@ const witness = Semaphore.genWitness(identity, merkleProof, externalNullifier, s const fullProof = await Semaphore.genProof(witness, wasmFilePath, finalZkeyPath) ``` -**Serialization** - -```typescript -const identity: Identity = ZkIdentity.genIdentity() -const serialized: string = ZkIdentity.serializeIdentity(identity) -const unserialized: Identity = ZkIdentity.unSerializeIdentity(serialized) -``` - ## 📜 Final Note For full examples of how to integrate with contracts check https://github.com/appliedzkp/semaphore repository. diff --git a/packages/protocols/package.json b/packages/protocols/package.json index fde039a..6839fb8 100644 --- a/packages/protocols/package.json +++ b/packages/protocols/package.json @@ -1,6 +1,6 @@ { "name": "@libsem/protocols", - "version": "1.0.13", + "version": "1.0.14", "description": "Client library for generating and verifying Semaphore & Rln ZK proofs.", "main": "dist/index.node.js", "types": "dist/types/index.d.ts",