Skip to content

Commit

Permalink
Merge pull request #1 from tkey/tkey-mpc
Browse files Browse the repository at this point in the history 
Tkey mpc
  • Loading branch information
@chaitanyapotti
chaitanyapotti authored Oct 3, 2023
2 parents d9567b5 + 2e34b0d commit d988662
Show file tree
Hide file tree
Showing 77 changed files with 4,059 additions and 733 deletions.
2 changes: 1 addition & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ typings/
.node_repl_history

# Output of 'npm pack'
*.tgz
# *.tgz

# Yarn Integrity file
.yarn-integrity
Expand Down
36 changes: 18 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
![npm](https://img.shields.io/npm/dw/@tkey/core)
![npm](https://img.shields.io/npm/dw/@tkey-mpc/core)

tKey is the underlying SDK used to implement [Web3Auth Plug n Play](https://github.com/web3auth/web3auth). This package can also be used to self host Web3Auth in your own system. tKey stands for Threshold Key, which refers to the management keys & shares generated using threshold cryptography.

Expand Down Expand Up @@ -32,26 +32,26 @@ For more information, check out the [technical overview](https://hackmd.io/Tej2t

## Packages

| Packages | `@latest` Version | Size | Description |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------- |
| 🐉 **tKey Standard Package** |
| `@tkey/default` | [![npm version](https://img.shields.io/npm/v/@tkey/default?label=%22%22)](https://www.npmjs.com/package/@tkey/default/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey/default?label=%22%22)](https://bundlephobia.com/result?p=@tkey/default@latest) | Bundles `Core` and `Modules` into one importable package |
| Packages | `@latest` Version | Size | Description |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------- |
| 🐉 **tKey Standard Package** |
| `@tkey-mpc/default` | [![npm version](https://img.shields.io/npm/v/@tkey-mpc/default?label=%22%22)](https://www.npmjs.com/package/@tkey-mpc/default/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey-mpc/default?label=%22%22)](https://bundlephobia.com/result?p=@tkey-mpc/default@latest) | Bundles `Core` and `Modules` into one importable package |
| 🏠 **Core** |
| `@tkey/core` | [![npm version](https://img.shields.io/npm/v/@tkey/core?label=%22%22)](https://www.npmjs.com/package/@tkey/core/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey/core?label=%22%22)](https://bundlephobia.com/result?p=@tkey/core@latest) | Core functionalities for creating a tkey |
| 🐕‍🦺 **Service Provider** |
| `@tkey/service-provider-torus` | [![npm version](https://img.shields.io/npm/v/@tkey/service-provider-torus?label=%22%22)](https://www.npmjs.com/package/@tkey/service-provider-torus/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey/service-provider-torus?label=%22%22)](https://bundlephobia.com/result?p=@tkey/service-provider-torus@latest) | `@service-provider-base` with DirectAuth functionality |
| 🗳 **Storage Layer** |
| `@tkey/storage-layer-torus` | [![npm version](https://img.shields.io/npm/v/@tkey/storage-layer-torus?label=%22%22)](https://www.npmjs.com/package/@tkey/storage-layer-torus/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey/storage-layer-torus?label=%22%22)](https://bundlephobia.com/result?p=@tkey/storage-layer-torus@latest) | get/set metadata for various shares |
| `@tkey-mpc/core` | [![npm version](https://img.shields.io/npm/v/@tkey-mpc/core?label=%22%22)](https://www.npmjs.com/package/@tkey-mpc/core/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey-mpc/core?label=%22%22)](https://bundlephobia.com/result?p=@tkey-mpc/core@latest) | Core functionalities for creating a tkey |
| 🐕‍🦺 **Service Provider** |
| `@tkey-mpc/service-provider-torus` | [![npm version](https://img.shields.io/npm/v/@tkey-mpc/service-provider-torus?label=%22%22)](https://www.npmjs.com/package/@tkey-mpc/service-provider-torus/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey-mpc/service-provider-torus?label=%22%22)](https://bundlephobia.com/result?p=@tkey-mpc/service-provider-torus@latest) | `@service-provider-base` with DirectAuth functionality |
| 🗳 **Storage Layer** |
| `@tkey-mpc/storage-layer-torus` | [![npm version](https://img.shields.io/npm/v/@tkey-mpc/storage-layer-torus?label=%22%22)](https://www.npmjs.com/package/@tkey-mpc/storage-layer-torus/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey-mpc/storage-layer-torus?label=%22%22)](https://bundlephobia.com/result?p=@tkey-mpc/storage-layer-torus@latest) | get/set metadata for various shares |
| 🔌 **Modules** |
| `@tkey/chrome-storage` | [![npm version](https://img.shields.io/npm/v/@tkey/chrome-storage?label=%22%22)](https://www.npmjs.com/package/@tkey/chrome-storage/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey/chrome-storage?label=%22%22)](https://bundlephobia.com/result?p=@tkey/chrome-storage@latest) | Add/remove a share from chrome extension storage |
| `@tkey/web-storage` | [![npm version](https://img.shields.io/npm/v/@tkey/web-storage?label=%22%22)](https://www.npmjs.com/package/@tkey/web-storage/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey/web-storage?label=%22%22)](https://bundlephobia.com/result?p=@tkey/web-storage@latest) | Add/remove a share from local and file storage |
| `@tkey/security-questions` | [![npm version](https://img.shields.io/npm/v/@tkey/security-questions?label=%22%22)](https://www.npmjs.com/package/@tkey/security-questions/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey/security-questions?label=%22%22)](https://bundlephobia.com/result?p=@tkey/security-questions@latest) | Add/remove a security question and password as a share for tkey |
| `@tkey/share-transfer` | [![npm version](https://img.shields.io/npm/v/@tkey/share-transfer?label=%22%22)](https://www.npmjs.com/package/@tkey/share-transfer/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey/share-transfer?label=%22%22)](https://bundlephobia.com/result?p=@tkey/share-transfer@latest) | Transfer share from another device |
| `@tkey/seed-phrase` | [![npm version](https://img.shields.io/npm/v/@tkey/seed-phrase?label=%22%22)](https://www.npmjs.com/package/@tkey/seed-phrase/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey/seed-phrase?label=%22%22)](https://bundlephobia.com/result?p=@tkey/seed-phrase@latest) | Store and use seedphrases on metadata |
| `@tkey/private-keys` | [![npm version](https://img.shields.io/npm/v/@tkey/private-keys?label=%22%22)](https://www.npmjs.com/package/@tkey/private-keys/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey/private-keys?label=%22%22)](https://bundlephobia.com/result?p=@tkey/private-keys@latest) | Store extra private keys on tKey metadata |
| `@tkey/share-serialization` | [![npm version](https://img.shields.io/npm/v/@tkey/share-serialization?label=%22%22)](https://www.npmjs.com/package/@tkey/share-serialization/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey/share-serialization?label=%22%22)](https://bundlephobia.com/result?p=@tkey/share-serialization@latest) | Import/export a share from tKey |
| `@tkey-mpc/chrome-storage` | [![npm version](https://img.shields.io/npm/v/@tkey-mpc/chrome-storage?label=%22%22)](https://www.npmjs.com/package/@tkey-mpc/chrome-storage/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey-mpc/chrome-storage?label=%22%22)](https://bundlephobia.com/result?p=@tkey-mpc/chrome-storage@latest) | Add/remove a share from chrome extension storage |
| `@tkey-mpc/web-storage` | [![npm version](https://img.shields.io/npm/v/@tkey-mpc/web-storage?label=%22%22)](https://www.npmjs.com/package/@tkey-mpc/web-storage/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey-mpc/web-storage?label=%22%22)](https://bundlephobia.com/result?p=@tkey-mpc/web-storage@latest) | Add/remove a share from local and file storage |
| `@tkey-mpc/security-questions` | [![npm version](https://img.shields.io/npm/v/@tkey-mpc/security-questions?label=%22%22)](https://www.npmjs.com/package/@tkey-mpc/security-questions/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey-mpc/security-questions?label=%22%22)](https://bundlephobia.com/result?p=@tkey-mpc/security-questions@latest) | Add/remove a security question and password as a share for tkey |
| `@tkey-mpc/share-transfer` | [![npm version](https://img.shields.io/npm/v/@tkey-mpc/share-transfer?label=%22%22)](https://www.npmjs.com/package/@tkey-mpc/share-transfer/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey-mpc/share-transfer?label=%22%22)](https://bundlephobia.com/result?p=@tkey-mpc/share-transfer@latest) | Transfer share from another device |
| `@tkey-mpc/seed-phrase` | [![npm version](https://img.shields.io/npm/v/@tkey-mpc/seed-phrase?label=%22%22)](https://www.npmjs.com/package/@tkey-mpc/seed-phrase/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey-mpc/seed-phrase?label=%22%22)](https://bundlephobia.com/result?p=@tkey-mpc/seed-phrase@latest) | Store and use seedphrases on metadata |
| `@tkey-mpc/private-keys` | [![npm version](https://img.shields.io/npm/v/@tkey-mpc/private-keys?label=%22%22)](https://www.npmjs.com/package/@tkey-mpc/private-keys/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey-mpc/private-keys?label=%22%22)](https://bundlephobia.com/result?p=@tkey-mpc/private-keys@latest) | Store extra private keys on tKey metadata |
| `@tkey-mpc/share-serialization` | [![npm version](https://img.shields.io/npm/v/@tkey-mpc/share-serialization?label=%22%22)](https://www.npmjs.com/package/@tkey-mpc/share-serialization/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey-mpc/share-serialization?label=%22%22)](https://bundlephobia.com/result?p=@tkey-mpc/share-serialization@latest) | Import/export a share from tKey |
| 🐉 **Low-Level** |
| `@tkey/common-types` | [![npm version](https://img.shields.io/npm/v/@tkey/common-types?label=%22%22)](https://www.npmjs.com/package/@tkey/common-types/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey/common-types?label=%22%22)](https://bundlephobia.com/result?p=@tkey/common-types@latest) | Shared [TypeScript](https://www.typescriptlang.org/) Types |
| `@tkey-mpc/common-types` | [![npm version](https://img.shields.io/npm/v/@tkey-mpc/common-types?label=%22%22)](https://www.npmjs.com/package/@tkey-mpc/common-types/v/latest) | [![minzip](https://img.shields.io/bundlephobia/minzip/@tkey-mpc/common-types?label=%22%22)](https://bundlephobia.com/result?p=@tkey-mpc/common-types@latest) | Shared [TypeScript](https://www.typescriptlang.org/) Types |

## Building the SDK Locally

Expand Down
2 changes: 1 addition & 1 deletion lerna.json
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "11.0.3",
"version": "8.2.2",
"packages": ["packages/*"],
"npmClient": "npm"
}
Loading

0 comments on commit d988662

Please sign in to comment.