# npm2-wiseplat-keyfile-recognizer

> Checks for valid structure of wiseplat web3-secret-storage/presale keyfiles

Latest version **1.0.2** (published 2018-04-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install npm2-wiseplat-keyfile-recognizer
pnpm add npm2-wiseplat-keyfile-recognizer
yarn add npm2-wiseplat-keyfile-recognizer
bun add npm2-wiseplat-keyfile-recognizer
```

## 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.0.2 |
| Published | 2018-04-24 |
| First published | 2018-04-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 8.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Luca Zeug |
| Maintainers | wiseplat |
| Keywords | wiseplat, blockchain, web3, web3-secret-storage, keyfile, gwsh, wsh, parity, wiseplatj, wiseplatjs, pywiseplat |

## Links

- npm: https://www.npmjs.com/package/npm2-wiseplat-keyfile-recognizer
- Repository: https://github.com/wiseplat/npm2-wiseplat-keyfile-recognizer
- Homepage: https://github.com/wiseplat/npm2-wiseplat-keyfile-recognizer#readme
- Issues: https://github.com/wiseplat/npm2-wiseplat-keyfile-recognizer/issues
- npm.io page: https://npm.io/package/npm2-wiseplat-keyfile-recognizer

## Dependencies (2)

- [underscore](https://npm.io/package/underscore.md) ^1.8.3
- [json-structure-diff](https://npm.io/package/json-structure-diff.md) 0.0.2

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2018-04-24

## README

# npm2-wiseplat-keyfile-recognizer

[![Build Status](https://travis-ci.org/wiseplat/npm2-wiseplat-keyfile-recognizer.svg?branch=master)](https://travis-ci.org/wiseplat/npm2-wiseplat-keyfile-recognizer)

Checks for structural sanity (key-names and value-types) of `json`-keyfiles.

Currently recognized keyfiles:
 - Wisesale
 - [web3-secret-storage](https://github.com/wiseplat/wiki/wiki/Web3-Secret-Storage-Definition) (v3)
  - scrypt
  - pbkdf2

## Installation

```shell
npm install --save npm2-wiseplat-keyfile-recognizer
```

## Usage

```javascript
var fs = require('fs');
var recognizer = require('npm2-wiseplat-keyfile-recognizer');

fs.readFile('keyfile.json', (err, data) => {
    var json = JSON.parse(data);
    var result = recognizer(json);
    /** result
     *               [ 'web3', 3 ]   web3 (v3) keyfile
     *  [ 'wisesale', undefined ]   Wisesale keyfile
     *                        null     invalid keyfile
     */
}));
```

## Development

To build and run the tests:

```shell
$ npm install
$ npm test
```

## Contributions

Contributions welcome - see [CONTRIBUTING.md](CONTRIBUTING.md)

## License

MIT - see [LICENSE.md](LICENSE.md)

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