docs(eddsa-proof): add package to list & update description

aakansha1234 · Feb 10, 2024 · b06b525 · b06b525
1 parent 3d4c042
commit b06b525
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -302,6 +302,34 @@
                 </a>
             </td>
         </tr>
+        <tr>
+            <td>
+                <a href="https://github.com/privacy-scaling-explorations/zk-kit/tree/main/packages/eddsa-proof">
+                    @zk-kit/eddsa-proof
+                </a>
+                 <a href="https://zkkit.pse.dev/modules/_zk_kit_eddsa_proof.html">
+                    (docs)
+                </a>
+            </td>
+            <td>
+                <!-- NPM version -->
+                <a href="https://npmjs.org/package/@zk-kit/eddsa-proof">
+                    <img src="https://img.shields.io/npm/v/@zk-kit/eddsa-proof.svg?style=flat-square" alt="NPM version" />
+                </a>
+            </td>
+            <td>
+                <!-- Downloads -->
+                <a href="https://npmjs.org/package/@zk-kit/eddsa-proof">
+                    <img src="https://img.shields.io/npm/dm/@zk-kit/eddsa-proof.svg?style=flat-square" alt="Downloads" />
+                </a>
+            </td>
+            <td>
+                <!-- Size -->
+                <a href="https://bundlephobia.com/package/@zk-kit/eddsa-proof">
+                    <img src="https://img.shields.io/bundlephobia/minzip/@zk-kit/eddsa-proof" alt="npm bundle size (scoped)" />
+                </a>
+            </td>
+        </tr>
         <tr>
             <td>
                 <a href="https://github.com/privacy-scaling-explorations/zk-kit/tree/main/packages/groth16">

diff --git a/packages/eddsa-proof/README.md b/packages/eddsa-proof/README.md
@@ -2,7 +2,7 @@
     <h1 align="center">
         Eddsa proof
     </h1>
-    <p align="center">A library to generate and verify Eddsa proofs.</p>
+    <p align="center">A library to generate and verify EdDSA proofs.</p>
 </p>
 
 <p align="center">
@@ -41,12 +41,12 @@
     </h4>
 </div>
 
-| This zero-knowledge library allows you to prove and verify that you have the private key of a Semaphore identity. It will be mainly used on-chain because you can get the same result off-chain using eddsa signatures with the `@semaphore-protocol/identity` package. It facilitates the demonstration of having an Eddsa hash pre-image while keeping the pre-image value confidential. Additionally, it offers a mechanism to prevent the same proof from being reused. The circuit that forms the foundation of this library is accessible via this [link](https://github.com/privacy-scaling-explorations/zk-kit/blob/main/packages/circuits/templates/eddsa-proof.circom). |
+| This zero-knowledge library allows you to prove and verify that you have the private key of a Semaphore identity. It will be mainly used on-chain because you can get the same result off-chain using EdDSA signatures with the `@semaphore-protocol/identity` package. It facilitates the demonstration of having an EdDSA hash pre-image while keeping the pre-image value confidential. Additionally, it offers a mechanism to prevent the same proof from being reused. The circuit that forms the foundation of this library is accessible via this [link](https://github.com/privacy-scaling-explorations/zk-kit/blob/main/packages/circuits/templates/eddsa-proof.circom). |
 | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 
 The Snark artifacts (`.wasm` and `.zkey` files) can be specified or not in the `generate` function parameters and can possibly be downloaded using the following URLs:
 
-https://github.com/privacy-scaling-explorations/zk-kit/blob/feat/eddsa-proof-package/packages/eddsa-proof/src/config.ts#L3-L4
+https://github.com/privacy-scaling-explorations/zk-kit/blob/main/packages/eddsa-proof/src/config.ts#L3-L4
 
 > [!WARNING]  
 > The Snark artifacts currently used to generate zero-knowledge proofs are the result of an unsecure trusted setup, and the library has not yet been audited. Therefore, it is advised not to use it in production.

diff --git a/packages/eddsa-proof/package.json b/packages/eddsa-proof/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@zk-kit/eddsa-proof",
     "version": "0.1.0",
-    "description": "A library to generate and verify Poseidon proofs using eddsa.",
+    "description": "A library to generate and verify EdDSA proofs.",
     "license": "MIT",
     "main": "dist/index.node.js",
     "exports": {