# @nibyou/bip39

> BIP 39 Mnemonic List

Latest version **2.0.2** (published 2022-07-26) · CC-BY-SA-4.0 license · 0 weekly downloads

## Install

```sh
npm install @nibyou/bip39
pnpm add @nibyou/bip39
yarn add @nibyou/bip39
bun add @nibyou/bip39
```

## Health

**Score 25/100 (F)** — status: abandoned.

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2022-07-26 |
| First published | 2021-06-09 |
| Weekly downloads | 0 |
| License | CC-BY-SA-4.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 462.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Nibyou |
| Maintainers | luckie, nibyou-org-holder |

## Links

- npm: https://www.npmjs.com/package/@nibyou/bip39
- Repository: https://github.com/nibyou/bip-39
- Homepage: https://github.com/nibyou/bip-39#readme
- Issues: https://github.com/nibyou/bip-39/issues
- npm.io page: https://npm.io/package/@nibyou/bip39

## Recent versions

- 2.0.2 (latest) — 2022-07-26
- 2.0.1 — 2022-07-08
- 2.0.0 — 2022-07-08
- 1.1.1 — 2021-06-10
- 1.1.0 — 2021-06-09
- 1.0.0 — 2021-06-09

## README

# @nibyou/bip39
From the Bitcoin Improvement Proposal 39 (https://en.bitcoin.it/wiki/BIP_0039) (bitcoin/bips)

Mnemonic lists, basically a collection of 2048 nouns in different languages in an array.

In Bitcoin, lists like these are used to generate IDs for Wallets that humans can more easily remember than just a bunch of numbers.
At Nibyou, we use the BIP-39 representation of random bytes to generate recovery passwords in human readable form (example below)

The following languages are currently supported:

| Language            | Language Code |
|---------------------|---------------|
| German              | de_DE         |
| English             | en_US         |
| Spanish             | es_ES         |
| French              | fr_FR         |
| Italian             | it_IT         |
| Japanese            | ja_JP         |
| Korean              | ko_KP         |
| Portugese           | pt_PT         |
| Simplified Chinese  | zh_CN         |
| Traditional Chinese | zh_TW         |

# Installation
Install the package with `npm`

```
$ npm i --save @nibyou/bip39
```

or with `yarn`

```
$ yarn add @nibyou/bip39
```

Note that the `generateMnemonic()` function only works in browser contexts (i.e. where `window.crypto.getRandomValues()` is available).

# Usage

Import/Require it in you code:

```javascript
const bip39 = require("@nibyou/bip39");
// or in typescript
import bip39 from "@nibyou/bip39"
```

And finally, generate the mnemonic:

```javascript
let mnemonic = bip39.generateMnemonic(bip39.LANGUAGES.de_DE, 6, '-');
// => 'zylinder-altertum-gitarre-roggen-asteroid-eiszeit'
```

# License

[CC-BY-SA-4.0](/LICENSE)

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