# @digix/bitcore-mnemonic

> BIP39 Mnemonics implemented for Bitcore.

Latest version **1.5.2** (published 2018-12-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @digix/bitcore-mnemonic
pnpm add @digix/bitcore-mnemonic
yarn add @digix/bitcore-mnemonic
bun add @digix/bitcore-mnemonic
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.2 |
| Published | 2018-12-03 |
| First published | 2018-12-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 223.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 157 |
| Author | BitPay |
| Maintainers | francisdigix, mandres_digix, mikej.digix, mrenoon, rbanate, rohitn, tymat, veelab8 |
| Keywords | bitcoin, bitcore, mnemonic, crypto, cryptography, encryption |

## Links

- npm: https://www.npmjs.com/package/@digix/bitcore-mnemonic
- Repository: https://github.com/bitpay/bitcore-mnemonic
- Homepage: https://github.com/bitpay/bitcore-mnemonic#readme
- Issues: https://github.com/bitpay/bitcore-mnemonic/issues
- npm.io page: https://npm.io/package/@digix/bitcore-mnemonic

## Dependencies (2)

- [unorm](https://npm.io/package/unorm.md) ^1.4.1
- [bitcore-lib](https://npm.io/package/bitcore-lib.md) 0.15.0

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 1.5.2 (latest) — 2018-12-03
- 1.5.1 — 2018-12-03
- 1.5.0 — 2018-12-03

## README

<img src="http://bitcore.io/css/images/module-mnemonic.png" alt="bitcore mnemonics" height="35">
BIP39 Mnemonics for bitcore
=======

[![NPM Package](https://img.shields.io/npm/v/bitcore-mnemonic.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-mnemonic)
[![Build Status](https://img.shields.io/travis/bitpay/bitcore-mnemonic.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore-mnemonic)
[![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore-mnemonic.svg?style=flat-square)](https://coveralls.io/r/bitpay/bitcore-mnemonic)

A module for [bitcore](https://github.com/bitpay/bitcore) that implements [Mnemonic code for generating deterministic keys](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki).

## Getting Started

This library is distributed in both the npm packaging systems.

```sh
npm install bitcore-lib  # this to install bitcore-lib since it is a peerDependecy
npm install bitcore-mnemonic
```

There are many examples of how to use it on the developer guide [section for mnemonic](http://bitcore.io/guide/module/mnemonic/index.html). For example, the following code would generate a new random mnemonic code and convert it to a `HDPrivateKey`.

```javascript
var Mnemonic = require('bitcore-mnemonic');
var code = new Mnemonic(Mnemonic.Words.SPANISH);
code.toString(); // natal hada sutil año sólido papel jamón combate aula flota ver esfera...
var xpriv = code.toHDPrivateKey();
```

## Contributing

See [CONTRIBUTING.md](https://github.com/bitpay/bitcore/blob/master/CONTRIBUTING.md) on the main bitcore repo for information about how to contribute.

## License

Code released under [the MIT license](https://github.com/bitpay/bitcore/blob/master/LICENSE).

Copyright 2013-2015 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.

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