# @owstack/key-lib

> A JavaScript cryptocurrency key library.

Latest version **0.0.41** (published 2019-05-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @owstack/key-lib
pnpm add @owstack/key-lib
yarn add @owstack/key-lib
bun add @owstack/key-lib
```

## 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.41 |
| Published | 2019-05-16 |
| First published | 2018-10-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 266.5 KB |
| Known vulnerabilities | 0 (+9 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | ajp8164, niahmiah |
| Keywords | transaction, address, p2p, ecies, cryptocurrency, blockchain, payment, bip21, bip32, bip37, bip44, bip69, bip70, multisig |

## Links

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

## Dependencies (4)

- [acorn](https://npm.io/package/acorn.md) ^6.0.7
- [elliptic](https://npm.io/package/elliptic.md) =6.4.1
- [@owstack/ows-common](https://npm.io/package/@owstack/ows-common.md) ^0.0.17
- [@owstack/network-lib](https://npm.io/package/@owstack/network-lib.md) ^0.0.31

## Recent versions

- 0.0.41 (latest) — 2019-05-16
- 0.0.40 — 2019-05-16
- 0.0.39 — 2019-04-26
- 0.0.38 — 2019-04-26
- 0.0.37 — 2019-02-27
- 0.0.36 — 2019-02-06
- 0.0.35 — 2019-02-06
- 0.0.34 — 2019-02-06
- 0.0.33 — 2019-01-08
- 0.0.32 — 2019-01-08
- 0.0.31 — 2019-01-03
- 0.0.30 — 2018-12-27
- 0.0.29 — 2018-12-26
- 0.0.28 — 2018-12-26
- 0.0.27 — 2018-12-22
- … 26 more at https://npm.io/package/@owstack/key-lib/versions

## README

KeyLib
=======

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

A JavaScript cryptocurrency key library.

## Get Started

```
npm install @owstack/key-lib
```

## Documentation

The complete docs are hosted here: [keyLib documentation](docs/index.md).

## Examples

* [Generate a random key](https://github.com/owstack/key-lib/blob/master/docs/examples.md#generate-a-random-address)
* [Generate a key from a SHA256 hash](https://github.com/owstack/key-lib/blob/master/docs/examples.md#generate-a-address-from-a-sha256-hash)
* [Import an address via WIF](https://github.com/owstack/key-lib/blob/master/docs/examples.md#import-an-address-via-wif)

## Security

If you find a security issue, please email security@openwalletstack.com.

## Contributing

Please send pull requests for bug fixes, code optimization, and ideas for improvement. For more information on how to contribute, please refer to our [CONTRIBUTING](https://github.com/owstack/key-lib/blob/master/CONTRIBUTING.md) file.

## Building the Browser Bundle

To build a key-lib full bundle for the browser:

```sh
gulp browser
```

This will generate files named `key-lib.js` and `key-lib.min.js`.

## Development & Tests

```sh
git clone https://github.com/owstack/key-lib
cd key-lib
npm install
```

Run all the tests:

```sh
gulp test
```

You can also run just the Node.js tests with `gulp test:node`, just the browser tests with `gulp test:browser`
or create a test coverage report (you can open `coverage/lcov-report/index.html` to visualize it) with `gulp coverage`.

## License

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

Copyright 2018 Open Wallet Stack.

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