# @mattrglobal/bls12381-key-pair

> A library for using BLS 12-381 key pairs with BBS+ signatures

Latest version **2.0.0** (published 2024-10-15) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @mattrglobal/bls12381-key-pair
pnpm add @mattrglobal/bls12381-key-pair
yarn add @mattrglobal/bls12381-key-pair
bun add @mattrglobal/bls12381-key-pair
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2024-10-15 |
| First published | 2020-05-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=18.0.0 |
| Dependencies | 3 |
| Unpacked size | 101 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 17 |
| Author | Mattr |
| Maintainers | npmjs_ci_public_mattr |

## Links

- npm: https://www.npmjs.com/package/@mattrglobal/bls12381-key-pair
- Repository: https://github.com/mattrglobal/bls12381-key-pair
- Issues: https://github.com/mattrglobal/bls12381-key-pair/issues
- npm.io page: https://npm.io/package/@mattrglobal/bls12381-key-pair

## Dependencies (3)

- [bs58](https://npm.io/package/bs58.md) 6.0.0
- [rfc4648](https://npm.io/package/rfc4648.md) 1.5.3
- [@mattrglobal/bbs-signatures](https://npm.io/package/@mattrglobal/bbs-signatures.md) 2.0.0

## Recent versions

- 2.0.0 (latest) — 2024-10-15
- 1.2.3-unstable.363e527 (unstable) — 2024-10-15
- 1.2.3-unstable.6d0d0c2 — 2024-09-19
- 1.2.3-unstable.71b78c6 — 2024-09-08
- 1.2.2 — 2024-07-28
- 1.2.2-unstable.665ef03 — 2024-07-26
- 1.2.2-unstable.774a1b4 — 2024-06-16
- 1.2.2-unstable.c6da561 — 2024-04-12
- 1.2.2-unstable.f2f9d96 — 2024-02-18
- 1.2.1 — 2023-10-04
- 1.2.1-unstable.66159b3 — 2023-10-04
- 1.2.1-unstable.924e886 — 2023-10-04
- 1.2.0 — 2023-09-29
- 1.1.1-unstable.d479c72 — 2023-09-29
- 1.1.1-unstable.9485f66 — 2023-09-28
- … 65 more at https://npm.io/package/@mattrglobal/bls12381-key-pair/versions

## README

[![MATTR](./docs/assets/mattr-logo-square.svg)](https://github.com/mattrglobal)

# bls12381-key-pair

![npm-version](https://badgen.net/npm/v/@mattrglobal/bls12381-key-pair)
![npm-unstable-version](https://badgen.net/npm/v/@mattrglobal/bls12381-key-pair/unstable)
![push-master](https://github.com/mattrglobal/bls12381-key-pair/workflows/push-master/badge.svg)
![push-release](https://github.com/mattrglobal/bls12381-key-pair/workflows/push-release/badge.svg)
![codecov](https://codecov.io/gh/mattrglobal/bls12381-key-pair/branch/master/graph/badge.svg)

This library supports generating [BLS12-381](https://tools.ietf.org/html/draft-irtf-cfrg-pairing-friendly-curves-02#section-2.4) key pairs and supports the
signing and verification of [BBS+ signatures](https://github.com/mattrglobal/bbs-signatures-spec).

## Getting started

To use this package within your project simply run

```
npm install @mattrglobal/bls12381-key-pair
```

Or with [Yarn](https://yarnpkg.com/)

```
yarn add @mattrglobal/bls12381-key-pair
```

## Getting started as a contributor

The following describes how to get started as a contributor to this project

### Prerequisites

The following is a list of dependencies you must install to build and contribute to this project

- [Yarn](https://yarnpkg.com/)

For more details see our [contribution guidelines](./docs/CONTRIBUTING.md)

#### Install

To install the package dependencies run:

```
yarn install --frozen-lockfile
```

#### Build

To build the project run:

```
yarn build
```

#### Test

To run the test in the project run:

```
yarn test
```

## Security Policy

Please see our [security policy](./SECURITY.md) for additional details about responsible disclosure of security related issues.

---

<p align="center"><a href="https://mattr.global" target="_blank"><img height="40px" src ="./docs/assets/mattr-logo-tm.svg"></a></p><p align="center">Copyright © MATTR Limited. <a href="./LICENSE">Some rights reserved.</a><br/>“MATTR” is a trademark of MATTR Limited, registered in New Zealand and other countries.</p>

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