# @owstack/btc-mnemonic

> BIP39 Mnemonics support.

Latest version **0.0.4** (published 2017-12-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @owstack/btc-mnemonic
pnpm add @owstack/btc-mnemonic
yarn add @owstack/btc-mnemonic
bun add @owstack/btc-mnemonic
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2017-12-20 |
| First published | 2017-10-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | niahmiah, ajp8164 |
| Keywords | bitcoin, btc, mnemonic, crypto, cryptography, encryption |

## Links

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

## Dependencies (2)

- [unorm](https://npm.io/package/unorm.md) ^1.3.3
- [@owstack/btc-lib](https://npm.io/package/@owstack/btc-lib.md) ^0.0.4

## 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

- 0.0.4 (latest) — 2017-12-20
- 0.0.3 — 2017-10-30
- 0.0.2 — 2017-10-30
- 0.0.1 — 2017-10-27

## README

Btc BIP39 Mnemonics
=======

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

A module for [btc](https://github.com/owstack/btc) 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 and bower packaging systems.

```sh
npm install btc-mnemonic
bower install btc-mnemonic
```

There are many examples of how to use it on the developer guide [section for mnemonic](http://btc.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('@owstack/btc-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/owstack/btc/blob/master/CONTRIBUTING.md) on the main btc repo for information about how to contribute.

## License

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

Copyright 2017 Open Wallet Stack.

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