mirror of
https://github.com/privacy-scaling-explorations/zk-kit.git
synced 2026-04-22 03:00:15 -04:00
chore: update package names
This commit is contained in:
cedoor
60
README.md
60
README.md
@@ -1,16 +1,16 @@
|
||||
<p align="center">
|
||||
<h1 align="center">
|
||||
ZKit
|
||||
ZK-kit
|
||||
</h1>
|
||||
<p align="center">A monorepo of reusable JS libraries for zero-knowledge techologies.</p>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/appliedzkp/zkit/blob/master/LICENSE">
|
||||
<img alt="Github license" src="https://img.shields.io/github/license/appliedzkp/zkit.svg?style=flat-square">
|
||||
<a href="https://github.com/appliedzkp/zk-kit/blob/master/LICENSE">
|
||||
<img alt="Github license" src="https://img.shields.io/github/license/appliedzkp/zk-kit.svg?style=flat-square">
|
||||
</a>
|
||||
<a href="https://github.com/appliedzkp/zkit/actions?query=workflow%3Atest">
|
||||
<img alt="GitHub Workflow test" src="https://img.shields.io/github/workflow/status/appliedzkp/zkit/test?label=test&style=flat-square&logo=github">
|
||||
<a href="https://github.com/appliedzkp/zk-kit/actions?query=workflow%3Atest">
|
||||
<img alt="GitHub Workflow test" src="https://img.shields.io/github/workflow/status/appliedzkp/zk-kit/test?label=test&style=flat-square&logo=github">
|
||||
</a>
|
||||
<a href="https://eslint.org/">
|
||||
<img alt="Linter eslint" src="https://img.shields.io/badge/linter-eslint-8080f2?style=flat-square&logo=eslint">
|
||||
@@ -23,7 +23,7 @@
|
||||
</a>
|
||||
</p>
|
||||
|
||||
ZKit is a set of NPM modules (algorithms or utility functions) that can be reused in different projects and zero-knowledge protocols, making it easier for developers to access ready-to-use and tested libraries for common tasks.
|
||||
ZK-kit is a set of NPM modules (algorithms or utility functions) that can be reused in different projects and zero-knowledge protocols, making it easier for developers to access ready-to-use and tested libraries for common tasks.
|
||||
|
||||
---
|
||||
|
||||
@@ -37,70 +37,70 @@ ZKit is a set of NPM modules (algorithms or utility functions) that can be reuse
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="https://github.com/appliedzkp/zkit/tree/master/packages/identity">
|
||||
@zkit/identity
|
||||
<a href="https://github.com/appliedzkp/zk-kit/tree/master/packages/identity">
|
||||
@zk-kit/identity
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<!-- NPM version -->
|
||||
<a href="https://npmjs.org/package/@zkit/identity">
|
||||
<img src="https://img.shields.io/npm/v/@zkit/identity.svg?style=flat-square" alt="NPM version" />
|
||||
<a href="https://npmjs.org/package/@zk-kit/identity">
|
||||
<img src="https://img.shields.io/npm/v/@zk-kit/identity.svg?style=flat-square" alt="NPM version" />
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<!-- Downloads -->
|
||||
<a href="https://npmjs.org/package/@zkit/identity">
|
||||
<img src="https://img.shields.io/npm/dm/@zkit/identity.svg?style=flat-square" alt="Downloads" />
|
||||
<a href="https://npmjs.org/package/@zk-kit/identity">
|
||||
<img src="https://img.shields.io/npm/dm/@zk-kit/identity.svg?style=flat-square" alt="Downloads" />
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<!-- Size -->
|
||||
<a href="https://bundlephobia.com/package/@zkit/identity">
|
||||
<img src="https://img.shields.io/bundlephobia/minzip/@zkit/identity" alt="npm bundle size (scoped)" />
|
||||
<a href="https://bundlephobia.com/package/@zk-kit/identity">
|
||||
<img src="https://img.shields.io/bundlephobia/minzip/@zk-kit/identity" alt="npm bundle size (scoped)" />
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="https://github.com/appliedzkp/zkit/tree/master/packages/protocols">
|
||||
@zkit/protocols
|
||||
<a href="https://github.com/appliedzkp/zk-kit/tree/master/packages/protocols">
|
||||
@zk-kit/protocols
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<!-- NPM version -->
|
||||
<a href="https://npmjs.org/package/@zkit/protocols">
|
||||
<img src="https://img.shields.io/npm/v/@zkit/protocols.svg?style=flat-square" alt="NPM version" />
|
||||
<a href="https://npmjs.org/package/@zk-kit/protocols">
|
||||
<img src="https://img.shields.io/npm/v/@zk-kit/protocols.svg?style=flat-square" alt="NPM version" />
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<!-- Downloads -->
|
||||
<a href="https://npmjs.org/package/@zkit/protocols">
|
||||
<img src="https://img.shields.io/npm/dm/@zkit/protocols.svg?style=flat-square" alt="Downloads" />
|
||||
<a href="https://npmjs.org/package/@zk-kit/protocols">
|
||||
<img src="https://img.shields.io/npm/dm/@zk-kit/protocols.svg?style=flat-square" alt="Downloads" />
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<!-- Size -->
|
||||
<a href="https://bundlephobia.com/package/@zkit/protocols">
|
||||
<img src="https://img.shields.io/bundlephobia/minzip/@zkit/protocols" alt="npm bundle size (scoped)" />
|
||||
<a href="https://bundlephobia.com/package/@zk-kit/protocols">
|
||||
<img src="https://img.shields.io/bundlephobia/minzip/@zk-kit/protocols" alt="npm bundle size (scoped)" />
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="https://github.com/appliedzkp/zkit/tree/master/packages/types">
|
||||
@zkit/types
|
||||
<a href="https://github.com/appliedzkp/zk-kit/tree/master/packages/types">
|
||||
@zk-kit/types
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<!-- NPM version -->
|
||||
<a href="https://npmjs.org/package/@zkit/types">
|
||||
<img src="https://img.shields.io/npm/v/@zkit/types.svg?style=flat-square" alt="NPM version" />
|
||||
<a href="https://npmjs.org/package/@zk-kit/types">
|
||||
<img src="https://img.shields.io/npm/v/@zk-kit/types.svg?style=flat-square" alt="NPM version" />
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<!-- Downloads -->
|
||||
<a href="https://npmjs.org/package/@zkit/types">
|
||||
<img src="https://img.shields.io/npm/dm/@zkit/types.svg?style=flat-square" alt="Downloads" />
|
||||
<a href="https://npmjs.org/package/@zk-kit/types">
|
||||
<img src="https://img.shields.io/npm/dm/@zk-kit/types.svg?style=flat-square" alt="Downloads" />
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
@@ -115,8 +115,8 @@ ZKit is a set of NPM modules (algorithms or utility functions) that can be reuse
|
||||
Clone this repository and install the dependencies:
|
||||
|
||||
```bash
|
||||
$ git clone https://github.com/appliedzkp/zkit.git
|
||||
$ cd zkit && npm i
|
||||
$ git clone https://github.com/appliedzkp/zk-kit.git
|
||||
$ cd zk-kit && npm i
|
||||
```
|
||||
|
||||
## 📜 Usage
|
||||
|
||||
@@ -6,17 +6,17 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/appliedzkp/zkit/blob/main/LICENSE">
|
||||
<img alt="Github license" src="https://img.shields.io/github/license/appliedzkp/zkit.svg?style=flat-square">
|
||||
<a href="https://github.com/appliedzkp/zk-kit/blob/main/LICENSE">
|
||||
<img alt="Github license" src="https://img.shields.io/github/license/appliedzkp/zk-kit.svg?style=flat-square">
|
||||
</a>
|
||||
<a href="https://www.npmjs.com/package/@zkit/identity">
|
||||
<img alt="NPM version" src="https://img.shields.io/npm/v/@zkit/identity?style=flat-square" />
|
||||
<a href="https://www.npmjs.com/package/@zk-kit/identity">
|
||||
<img alt="NPM version" src="https://img.shields.io/npm/v/@zk-kit/identity?style=flat-square" />
|
||||
</a>
|
||||
<a href="https://npmjs.org/package/@zkit/identity">
|
||||
<img alt="Downloads" src="https://img.shields.io/npm/dm/@zkit/identity.svg?style=flat-square" />
|
||||
<a href="https://npmjs.org/package/@zk-kit/identity">
|
||||
<img alt="Downloads" src="https://img.shields.io/npm/dm/@zk-kit/identity.svg?style=flat-square" />
|
||||
</a>
|
||||
<a href="https://bundlephobia.com/package/@zkit/identity">
|
||||
<img alt="npm bundle size (scoped)" src="https://img.shields.io/bundlephobia/minzip/@zkit/identity" />
|
||||
<a href="https://bundlephobia.com/package/@zk-kit/identity">
|
||||
<img alt="npm bundle size (scoped)" src="https://img.shields.io/bundlephobia/minzip/@zk-kit/identity" />
|
||||
</a>
|
||||
<a href="https://eslint.org/">
|
||||
<img alt="Linter eslint" src="https://img.shields.io/badge/linter-eslint-8080f2?style=flat-square&logo=eslint" />
|
||||
@@ -32,16 +32,16 @@
|
||||
|
||||
### npm or yarn
|
||||
|
||||
Install the `@zkit/identity` package with npm:
|
||||
Install the `@zk-kit/identity` package with npm:
|
||||
|
||||
```bash
|
||||
npm i @zkit/identity
|
||||
npm i @zk-kit/identity
|
||||
```
|
||||
|
||||
or yarn:
|
||||
|
||||
```bash
|
||||
yarn add @zkit/identity
|
||||
yarn add @zk-kit/identity
|
||||
```
|
||||
|
||||
## 📜 Usage
|
||||
@@ -49,11 +49,11 @@ yarn add @zkit/identity
|
||||
**Import**
|
||||
|
||||
```typescript
|
||||
import { ZkIdentity, Identity } from "@zkit/identity"
|
||||
import { ZkIdentity, Identity } from "@zk-kit/identity"
|
||||
```
|
||||
|
||||
```javascript
|
||||
const { ZkIdentity } = require("@zkit/identity")
|
||||
const { ZkIdentity } = require("@zk-kit/identity")
|
||||
```
|
||||
|
||||
**Mainpulation**
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"name": "@zkit/identity",
|
||||
"name": "@zk-kit/identity",
|
||||
"version": "1.0.22",
|
||||
"description": "Library for managing identities for Semaphore and RLN protocols.",
|
||||
"license": "MIT",
|
||||
@@ -9,8 +9,8 @@
|
||||
"import": "./dist/index.mjs",
|
||||
"require": "./dist/index.node.js"
|
||||
},
|
||||
"repository": "https://github.com/appliedzkp/zkit",
|
||||
"homepage": "https://github.com/appliedzkp/zkit/tree/main/packages/identity",
|
||||
"repository": "https://github.com/appliedzkp/zk-kit",
|
||||
"homepage": "https://github.com/appliedzkp/zk-kit/tree/main/packages/identity",
|
||||
"scripts": {
|
||||
"clean": "rimraf ./dist",
|
||||
"build:watch": "rollup -c rollup.config.ts -w",
|
||||
@@ -25,7 +25,7 @@
|
||||
"access": "public"
|
||||
},
|
||||
"dependencies": {
|
||||
"@zkit/types": "^1.0.9",
|
||||
"@zk-kit/types": "^1.0.9",
|
||||
"bigint-conversion": "^2.1.12",
|
||||
"circomlibjs": "^0.0.8",
|
||||
"crypto": "^1.0.1",
|
||||
|
||||
@@ -6,17 +6,17 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/appliedzkp/zkit/blob/main/LICENSE">
|
||||
<img alt="Github license" src="https://img.shields.io/github/license/appliedzkp/zkit.svg?style=flat-square">
|
||||
<a href="https://github.com/appliedzkp/zk-kit/blob/main/LICENSE">
|
||||
<img alt="Github license" src="https://img.shields.io/github/license/appliedzkp/zk-kit.svg?style=flat-square">
|
||||
</a>
|
||||
<a href="https://www.npmjs.com/package/@zkit/protocols">
|
||||
<img alt="NPM version" src="https://img.shields.io/npm/v/@zkit/protocols?style=flat-square" />
|
||||
<a href="https://www.npmjs.com/package/@zk-kit/protocols">
|
||||
<img alt="NPM version" src="https://img.shields.io/npm/v/@zk-kit/protocols?style=flat-square" />
|
||||
</a>
|
||||
<a href="https://npmjs.org/package/@zkit/protocols">
|
||||
<img alt="Downloads" src="https://img.shields.io/npm/dm/@zkit/protocols.svg?style=flat-square" />
|
||||
<a href="https://npmjs.org/package/@zk-kit/protocols">
|
||||
<img alt="Downloads" src="https://img.shields.io/npm/dm/@zk-kit/protocols.svg?style=flat-square" />
|
||||
</a>
|
||||
<a href="https://bundlephobia.com/package/@zkit/protocols">
|
||||
<img alt="npm bundle size (scoped)" src="https://img.shields.io/bundlephobia/minzip/@zkit/protocols" />
|
||||
<a href="https://bundlephobia.com/package/@zk-kit/protocols">
|
||||
<img alt="npm bundle size (scoped)" src="https://img.shields.io/bundlephobia/minzip/@zk-kit/protocols" />
|
||||
</a>
|
||||
<a href="https://eslint.org/">
|
||||
<img alt="Linter eslint" src="https://img.shields.io/badge/linter-eslint-8080f2?style=flat-square&logo=eslint" />
|
||||
@@ -32,16 +32,16 @@
|
||||
|
||||
### npm or yarn
|
||||
|
||||
Install the `@zkit/protocols` package with npm:
|
||||
Install the `@zk-kit/protocols` package with npm:
|
||||
|
||||
```bash
|
||||
npm i @zkit/protocols
|
||||
npm i @zk-kit/protocols
|
||||
```
|
||||
|
||||
or yarn:
|
||||
|
||||
```bash
|
||||
yarn add @zkit/protocols
|
||||
yarn add @zk-kit/protocols
|
||||
```
|
||||
|
||||
## 📜 Usage
|
||||
@@ -49,7 +49,7 @@ yarn add @zkit/protocols
|
||||
**Import**
|
||||
|
||||
```typescript
|
||||
import { ZkIdentity, Identity } from "@zkit/identity"
|
||||
import { ZkIdentity, Identity } from "@zk-kit/identity"
|
||||
import {
|
||||
Semaphore,
|
||||
MerkleProof,
|
||||
@@ -57,12 +57,12 @@ import {
|
||||
generateMerkleProof,
|
||||
genExternalNullifier,
|
||||
genSignalHash
|
||||
} from "@zkit/protocols"
|
||||
} from "@zk-kit/protocols"
|
||||
```
|
||||
|
||||
```javascript
|
||||
const { ZkIdentity } = require("@zkit/identity")
|
||||
const { Semaphore, Rln, NRln, generateMerkleProof, genExternalNullifier, genSignalHash } = require("@zkit/protocols")
|
||||
const { ZkIdentity } = require("@zk-kit/identity")
|
||||
const { Semaphore, Rln, NRln, generateMerkleProof, genExternalNullifier, genSignalHash } = require("@zk-kit/protocols")
|
||||
```
|
||||
|
||||
**Merkle Proofs**
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"name": "@zkit/protocols",
|
||||
"name": "@zk-kit/protocols",
|
||||
"version": "1.0.27",
|
||||
"description": "Client library for generating and verifying Semaphore & RLN ZK proofs.",
|
||||
"license": "MIT",
|
||||
@@ -9,8 +9,8 @@
|
||||
"import": "./dist/index.mjs",
|
||||
"require": "./dist/index.node.js"
|
||||
},
|
||||
"repository": "https://github.com/appliedzkp/zkit",
|
||||
"homepage": "https://github.com/appliedzkp/zkit/tree/main/packages/protocols",
|
||||
"repository": "https://github.com/appliedzkp/zk-kit",
|
||||
"homepage": "https://github.com/appliedzkp/zk-kit/tree/main/packages/protocols",
|
||||
"scripts": {
|
||||
"tsc": "npx tsc src/index.ts",
|
||||
"build": "rimraf dist && rollup -c rollup.config.ts"
|
||||
@@ -24,7 +24,7 @@
|
||||
"access": "public"
|
||||
},
|
||||
"dependencies": {
|
||||
"@zkit/types": "^1.0.9",
|
||||
"@zk-kit/types": "^1.0.9",
|
||||
"circomlibjs": "^0.0.8",
|
||||
"ethers": "^5.4.7",
|
||||
"incrementalquintree": "^1.0.7",
|
||||
|
||||
@@ -6,14 +6,14 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/appliedzkp/zkit/blob/main/LICENSE">
|
||||
<img alt="Github license" src="https://img.shields.io/github/license/appliedzkp/zkit.svg?style=flat-square">
|
||||
<a href="https://github.com/appliedzkp/zk-kit/blob/main/LICENSE">
|
||||
<img alt="Github license" src="https://img.shields.io/github/license/appliedzkp/zk-kit.svg?style=flat-square">
|
||||
</a>
|
||||
<a href="https://www.npmjs.com/package/@zkit/types">
|
||||
<img alt="NPM version" src="https://img.shields.io/npm/v/@zkit/types?style=flat-square" />
|
||||
<a href="https://www.npmjs.com/package/@zk-kit/types">
|
||||
<img alt="NPM version" src="https://img.shields.io/npm/v/@zk-kit/types?style=flat-square" />
|
||||
</a>
|
||||
<a href="https://npmjs.org/package/@zkit/types">
|
||||
<img alt="Downloads" src="https://img.shields.io/npm/dm/@zkit/types.svg?style=flat-square" />
|
||||
<a href="https://npmjs.org/package/@zk-kit/types">
|
||||
<img alt="Downloads" src="https://img.shields.io/npm/dm/@zk-kit/types.svg?style=flat-square" />
|
||||
</a>
|
||||
<a href="https://eslint.org/">
|
||||
<img alt="Linter eslint" src="https://img.shields.io/badge/linter-eslint-8080f2?style=flat-square&logo=eslint" />
|
||||
@@ -29,16 +29,16 @@
|
||||
|
||||
### npm or yarn
|
||||
|
||||
Install the `@zkit/types` package with npm:
|
||||
Install the `@zk-kit/types` package with npm:
|
||||
|
||||
```bash
|
||||
npm i @zkit/types
|
||||
npm i @zk-kit/types
|
||||
```
|
||||
|
||||
or yarn:
|
||||
|
||||
```bash
|
||||
yarn add @zkit/types
|
||||
yarn add @zk-kit/types
|
||||
```
|
||||
|
||||
## 📜 Usage
|
||||
@@ -46,5 +46,5 @@ yarn add @zkit/types
|
||||
**Import**
|
||||
|
||||
```typescript
|
||||
import { Identity, IProof, MerkleProof } from "@zkit/types"
|
||||
import { Identity, IProof, MerkleProof } from "@zk-kit/types"
|
||||
```
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "@zkit/types",
|
||||
"name": "@zk-kit/types",
|
||||
"version": "1.0.9",
|
||||
"description": "Common type definitions for Semaphore modules.",
|
||||
"license": "MIT",
|
||||
"main": "src/index.ts",
|
||||
"types": "dist/index.d.ts",
|
||||
"repository": "https://github.com/appliedzkp/zkit",
|
||||
"homepage": "https://github.com/appliedzkp/zkit/tree/main/packages/protocols",
|
||||
"repository": "https://github.com/appliedzkp/zk-kit",
|
||||
"homepage": "https://github.com/appliedzkp/zk-kit/tree/main/packages/protocols",
|
||||
"scripts": {
|
||||
"tsc": "npx tsc src/index.ts",
|
||||
"build": "npm run clean && tsc -p .",
|
||||
|
||||
Reference in New Issue
Block a user