# bip39-mnemonic

> BIP39 mnemonic for key derivation schemes

Latest version **2.5.0** (published 2025-07-10) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install bip39-mnemonic
pnpm add bip39-mnemonic
yarn add bip39-mnemonic
bun add bip39-mnemonic
```

## Health

**Score 25/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.5.0 |
| Published | 2025-07-10 |
| First published | 2025-02-25 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 853.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Holepunch Inc |
| Maintainers | mafintosh |

## Links

- npm: https://www.npmjs.com/package/bip39-mnemonic
- Repository: https://github.com/holepunchto/bip39
- Homepage: https://github.com/holepunchto/bip39#readme
- Issues: https://github.com/holepunchto/bip39/issues
- npm.io page: https://npm.io/package/bip39-mnemonic

## Dependencies (3)

- [b4a](https://npm.io/package/b4a.md) ^1.6.6
- [nanoassert](https://npm.io/package/nanoassert.md) ^2.0.0
- [sodium-universal](https://npm.io/package/sodium-universal.md) ^5.0.1

## Recent versions

- 2.5.0 (latest) — 2025-07-10
- 2.4.0 — 2025-04-29
- 2.3.0 — 2025-04-12
- 2.2.0 — 2025-02-25

## README

# bip39-mnemonic

## Usage

```js
const { generateMnemonic, mnemonicToSeed } = require('bip39-mnemonic')

const mnemonic = generateMnemonic()
const seed = mnemonicToSeed(mnemonic)
```

## API

#### `const mnemonic = generateMnemonic({ entropy, language })`

Generate a new mnemonic.

Optionally pass existing `entropy`.

`language` can be any of the following:
- `chinese_simplified`
- `czech`
- `french`
- `japanese`
- `portuguese`
- `spanish`
- `chinese_traditional`
- `english` (default)
- `italian`
- `korean`
- `russian`
- `turkish`

#### `const mnemomic = entropyToMnemonic(entropy, { language = 'english })`

Alias for generateMnemomic called with explicit entropy

#### `const entropy = mnemonicToEntropy(mnemonic)`

Returns the entropy for a given mnemonic

#### `const seed = await mnemonicToSeed(mnemonic)`

Derive a seed from `mnemonic`. This seed should be used to seed a kdf derivation.

#### `const valid = validateMnemonic(mnemonic)`

Check whether a given mnemonic is valid

#### `const entropy = generateEntropy()`

Helper to generate 32 bytes of entropy suitable for deriving a mnemonic.

## License

Apache-2.0

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