# digibyte

> A pure and powerful JavaScript DigiByte library.

Latest version **0.15.8** (published 2019-11-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install digibyte
pnpm add digibyte
yarn add digibyte
bun add digibyte
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.15.8 |
| Published | 2019-11-17 |
| First published | 2017-04-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/digibyte) |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 4.5 MB |
| Known vulnerabilities | 0 (+10 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 15 |
| Author | DigiByte |
| Maintainers | digibyte |
| Keywords | bitcoin, digibyte, transaction, address, p2p, ecies, cryptocurrency, blockchain, payment, bip21, bip32, bip37, bip69, bip70, multisig |

## Links

- npm: https://www.npmjs.com/package/digibyte
- Repository: https://github.com/digicontributer/digibyte-js
- Homepage: https://github.com/digicontributer/digibyte-js#readme
- Issues: https://github.com/digicontributer/digibyte-js/issues
- npm.io page: https://npm.io/package/digibyte

## Dependencies (7)

- [bs58](https://npm.io/package/bs58.md) =4.0.1
- [bn.js](https://npm.io/package/bn.js.md) =4.11.8
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [elliptic](https://npm.io/package/elliptic.md) =6.4.0
- [inherits](https://npm.io/package/inherits.md) =2.0.1
- [node-rsa](https://npm.io/package/node-rsa.md) latest
- [sffc-encoder](https://npm.io/package/sffc-encoder.md) ^0.1.9

## 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.15.8 (latest) — 2019-11-17
- 0.15.7 — 2019-11-16
- 0.15.6 — 2019-08-06
- 0.15.5 — 2019-07-06
- 0.15.4 — 2019-07-03
- 0.15.3 — 2019-07-02
- 0.15.2 — 2019-06-28
- 0.15.1 — 2019-06-27
- 0.15.0 — 2019-06-27
- 0.14.9 — 2019-06-07
- 0.14.81 — 2019-05-22
- 0.14.8 — 2018-05-19
- 0.14.7 — 2018-05-11
- 0.14.6 — 2018-04-16
- 0.14.5 — 2018-04-06
- … 5 more at https://npm.io/package/digibyte/versions

## README

DigiByte.JS
=======

[![NPM Package](https://img.shields.io/npm/v/bitcore-lib.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-lib)
[![Build Status](https://img.shields.io/travis/digibyte/digibyte.js.svg?branch=master&style=flat-square)](https://travis-ci.org/digibyte/digibyte.js)
[![Coverage Status](https://img.shields.io/coveralls/digibyte/digibyte.js.svg?style=flat-square)](https://coveralls.io/r/digibyte/digibyte.js)

A pure and powerful JavaScript DigiByte library.

## Principles

DigiByte is a powerful new peer-to-peer platform for the next generation of financial technology. The decentralized nature of the DigiByte network allows for highly resilient digibyte infrastructure, and the developer community needs reliable, open-source tools to implement digibyte apps and services.

## Get Started

```
npm install digibyte
```

```
bower install digibyte
```

## Documentation

The complete docs are hosted here: [digibyte.js documentation](http://docs.digibyte.co).

## Examples

* [Generate a random address](https://github.com/digibyte/digibyte.js/blob/master/docs/examples.md#generate-a-random-address)
* [Generate a address from a SHA256 hash](https://github.com/digibyte/digibyte.js/blob/master/docs/examples.md#generate-a-address-from-a-sha256-hash)
* [Import an address via WIF](https://github.com/digibyte/digibyte.js/blob/master/docs/examples.md#import-an-address-via-wif)
* [Create a Transaction](https://github.com/digibyte/digibyte.js/blob/master/docs/examples.md#create-a-transaction)
* [Sign a DigiByte message](https://github.com/digibyte/digibyte.js/blob/master/docs/examples.md#sign-a-bitcoin-message)
* [Verify a DigiByte message](https://github.com/digibyte/digibyte.js/blob/master/docs/examples.md#verify-a-bitcoin-message)
* [Create an OP RETURN transaction](https://github.com/digibyte/digibyte.js/blob/master/docs/examples.md#create-an-op-return-transaction)
* [Create a 2-of-3 multisig P2SH address](https://github.com/digibyte/digibyte.js/blob/master/docs/examples.md#create-a-2-of-3-multisig-p2sh-address)
* [Spend from a 2-of-2 multisig P2SH address](https://github.com/digibyte/digibyte.js/blob/master/docs/examples.md#spend-from-a-2-of-2-multisig-p2sh-address)


## Security

We're using DigiByte.JS in production, but please use common sense when doing anything related to finances! We take no responsibility for your implementation decisions.

If you find a security issue, please email dev@digibyte.co.

## 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/digibyte/digibyte.js/blob/master/CONTRIBUTING.md) file.

## Building the Browser Bundle

To build a digibyte.js full bundle for the browser:

```sh
gulp browser
```

This will generate files named `digibyte.js` and `digibyte.min.js`.


## Development & Tests

```sh
git clone https://github.com/digicontributer/digibyte-js.git
cd digibyte.js
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/digibyte/digibyte.js/blob/master/LICENSE).

Copyright 2017 Digibyte, Co.

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