# node-lisk-vanitygen

> LISK vanitygen

Latest version **1.0.0** (published 2017-11-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-lisk-vanitygen
pnpm add node-lisk-vanitygen
yarn add node-lisk-vanitygen
bun add node-lisk-vanitygen
```

## 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.0 |
| Published | 2017-11-17 |
| First published | 2017-11-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Radosław Wiliński |
| Maintainers | radoslaw-wilinski |
| Keywords | node, lisk, vanitygen, bitcoin |

## Links

- npm: https://www.npmjs.com/package/node-lisk-vanitygen
- Repository: https://github.com/rwilinski/node-lisk-vanitygen
- Homepage: https://github.com/rwilinski/node-lisk-vanitygen#readme
- Issues: https://github.com/rwilinski/node-lisk-vanitygen/issues
- npm.io page: https://npm.io/package/node-lisk-vanitygen

## Dependencies (3)

- [bip39](https://npm.io/package/bip39.md) ^2.4.0
- [bignum](https://npm.io/package/bignum.md) ^0.12.5
- [sodium](https://npm.io/package/sodium.md) ^2.0.1

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-11-17

## README

Node LISK Vanitygen
===================

Fast Vanity LISK address generator.

Getting Started
---------------

Install `node-lisk-vanitygen` into your project:

```bash
$ npm install node-lisk-vanitygen --save
```

Create a `app.js` file and add the following:

```js
const LiskVanitygen = require('node-lisk-vanitygen');

let liskVanitygen = new LiskVanitygen({
    pattern: 123456
});

liskVanitygen.run((data) => {
    console.log('found: ', data);
}, (data) => {
    console.log('status: ', data);
});
```
Run your `app.js` file:

```bash
$ node app.js
```

API
---

```js
let liskVanitygen = new LiskVanitygen(config);
```

`config` properties:

Name            | Default | Type                       | Required | Description
----------------|---------|----------------------------|----------|------------
pattern         | -       | number or array of numbers | Yes      | Pattern(s) to find.
continue        | true    | boolean                    | No       | Should continue after first found?
messageInterval | 1000    | number                     | No       | Interval in ms between status callback.

```js
liskVanitygen.run(foundCallback, statusCallback);
```

Name           | Type     | Required | Description
---------------|----------|----------|------------
foundCallback  | function | Yes      | Callback when key was found.
statusCallback | function | No       | Callback with status information.

Example
-------

```js
const LiskVanitygen = require('node-lisk-vanitygen');
const fs = require('fs');

let liskVanitygen = new LiskVanitygen({
    pattern: [123456, 987654, 555555],
    continue: true,
    messageInterval: 5000
});

liskVanitygen.run((data) => {
    let txt = `
Pattern:    ${data.pattern}
Address:    ${data.address}
Passphrase: ${data.passphrase}
`;

    fs.appendFileSync('found.txt', txt, (error) => {});
}, (data) => {
    let txt = `\r\rCount: ${data.count} | Time: ${data.time} s. | Avg: ${data.avg} keys/s | Found: ${data.foundCount}`;
    process.stdout.write(txt); // to back cursor to the start of the line (in console.log doesn't work)
});
```

License
-------

MIT © [Radosław Wiliński](https://github.com/rwilinski)

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