# @tkey/core

> TKey Core library

Latest version **18.0.0** (published 2026-11-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @tkey/core
pnpm add @tkey/core
yarn add @tkey/core
bun add @tkey/core
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 18.0.0 |
| Published | 2026-11-19 |
| First published | 2020-09-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=24.22.0 |
| Dependencies | 3 |
| Unpacked size | 439.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 181 |
| Author | Torus Labs |
| Maintainers | chaitanyapotti, himanshuconsensys |
| Keywords | customauth, torus-threshold-bak, threshold-bak, torus nodes, torus-embed, direct auth, tkey |

## Links

- npm: https://www.npmjs.com/package/@tkey/core
- Repository: https://github.com/tkey/tkey
- Homepage: https://github.com/tkey/tkey#readme
- Issues: https://github.com/tkey/tkey/issues
- npm.io page: https://npm.io/package/@tkey/core

## Dependencies (3)

- [@tkey/common-types](https://npm.io/package/@tkey/common-types.md) ^18.0.0
- [json-stable-stringify](https://npm.io/package/json-stable-stringify.md) ^1.3.0
- [@toruslabs/metadata-helpers](https://npm.io/package/@toruslabs/metadata-helpers.md) ^9.0.0

## Alternatives

- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads
- [escher-request](https://npm.io/package/escher-request.md) — 545 weekly downloads

## Recent versions

- 18.0.0 (latest) — 2026-11-19
- 13.0.0-alpha.7 (next) — 2024-06-25
- 17.2.0 — 2026-03-20
- 17.1.0 — 2026-03-05
- 17.0.0 — 2026-03-03
- 16.0.1-alpha.0 — 2025-06-06
- 16.0.0 — 2025-03-14
- 15.2.1-alpha.0 — 2024-11-08
- 15.2.0-alpha.0 — 2024-11-04
- 15.1.0 — 2024-10-09
- 15.0.2 — 2024-08-20
- 15.0.1 — 2024-08-12
- 15.0.0 — 2024-08-12
- 15.1.0-alpha.0 — 2024-08-08
- 14.0.0 — 2024-07-15
- … 93 more at https://npm.io/package/@tkey/core/versions

## README

# tKey

![npm](https://img.shields.io/npm/dw/@tkey/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.

> **v16 Breaking Change:** All cryptographic primitives have been migrated from `bn.js`/`elliptic`/`Buffer` to native `bigint`/`@noble/curves`/`Uint8Array`. See the [Migration Guide](#migration-guide) below.

## The `tKey` SDK

The `tKey` SDK manages private keys by generating shares of it using Shamir Secret Sharing. For example, for a 2 out of 3 (2/3) setup, we give the
user three shares: ShareA, ShareB, and ShareC.

- **ShareA** is stored on the user’s device: Implementation is device and system specific. For example, on mobile devices, the share could be stored
  in device storage secured via biometrics.
- **ShareB** is managed and split across Web3Auth's Auth Network, accessed by an OAuth login provider that a user owns.
- **ShareC** is a recovery share: An extra share to be kept by the user, possibly kept on a separate device, downloaded or based on user input with
  enough entropy (eg. password, security questions, hardware device etc.).

Similar to existing 2FA systems, a user needs to prove ownership of at least 2 out of 3 (2/3) shares, in order to retrieve his private key.

For more information, check out the [technical overview](https://hackmd.io/Tej2tf83SZOxZmz70ObEpg). Before integrating you can also check out the example for [tKey](https://github.com/tkey/tkey-example).

### To use the SDK in your application, please refer to our [SDK Reference](https://web3auth.io/docs/sdk/self-host/installation) in Web3Auth Documentation

## Features

- Typescript compatible. Includes Type definitions
- Fully composable API
- Module support (Include only those modules which you require)
- Modern cryptography via [`@noble/curves`](https://github.com/paulmillr/noble-curves) (secp256k1, ed25519)
- Zero dependency on `Buffer` — uses native `Uint8Array`
- [Audited](https://github.com/tkey/audit)

## 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        |
| 🏠 **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                             |
| 🔌 **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                                 |
| 🐉 **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      |

## Migration Guide

### v16: `bigint` / `@noble/curves` / `Uint8Array`

v16 removes all legacy cryptography dependencies in favor of modern, audited alternatives:

| Before                    | After                     |
| ------------------------- | ------------------------- |
| `bn.js` (`BN`)            | Native `bigint`           |
| `elliptic`                | `@noble/curves/secp256k1` |
| `@toruslabs/tweetnacl-js` | `@noble/curves/ed25519`   |
| `Buffer`                  | `Uint8Array`              |

**What you need to change:**

- **Private keys and share values** are now `bigint` instead of `BN`. Replace `new BN(hex, 16)` with `BigInt(\`0x${hex}\`)`.
- **Public keys and encrypted data** are now `Uint8Array` instead of `Buffer`. Use `hexToBytes` / `bytesToHex` from `@toruslabs/metadata-helpers` for conversions.
- **`BNString` type** has been removed. APIs now use `bigint` directly (was `BN | string`).
- **JSON serialization** of objects containing `bigint` requires the `bigIntReplacer` from `@tkey/common-types`:
  ```js
  import { bigIntReplacer } from "@tkey/common-types";
  JSON.stringify(thresholdKey, bigIntReplacer);
  ```
- **`@tkey/tss`** has been removed from this package and will be migrated separately.

## Building the SDK Locally

### Requirements

- Node >=24.22.0
- npm >=12

### Installation

```
npm install
npm run pack
```

## Bundling

Each package publishes two builds and the TypeScript declarations:

- `module`, `unpkg`, and `jsdelivr` point at `dist/lib.esm/index.js`
- `main` points at `dist/lib.cjs/index.js`
- `types` points at `dist/lib.cjs/index.d.ts`

There is no UMD build and no `@babel/runtime` peer dependency.

### Directly in Browser

CDN's serve the non-core-js polyfilled version by default. You can use a different

jsdeliver

```js
<script src="https://cdn.jsdelivr.net/npm/<MODULE_NAME>"></script>
```

unpkg

```js
<script src="https://unpkg.com/<MODULE_NAME>"></script>
```

### Tips for NUXT

This is a plugin that works [only on the client side](https://nuxtjs.org/guide/plugins/#client-side-only). So please register it as a ssr-free plugin.

---
_Source: https://npm.io/package/@tkey/core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
