# bitcore-message

> Bitcoin Messages for Bitcore

Latest version **1.0.4** (published 2017-03-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install bitcore-message
pnpm add bitcore-message
yarn add bitcore-message
bun add bitcore-message
```

## 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.4 |
| Published | 2017-03-15 |
| First published | 2015-02-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 88 |
| Author | BitPay |
| Maintainers | braydonf, ematiu, gabegattis, kleetus, patrickbitpay |
| Keywords | bitcoin, bitcore, btc, satoshi, message, signing |

## Links

- npm: https://www.npmjs.com/package/bitcore-message
- Repository: https://github.com/bitpay/bitcore-message
- Homepage: https://github.com/bitpay/bitcore-message#readme
- Issues: https://github.com/bitpay/bitcore-message/issues
- npm.io page: https://npm.io/package/bitcore-message

## Dependencies (1)

- [bitcore-lib](https://npm.io/package/bitcore-lib.md) ^0.13.7

## Recent versions

- 1.0.4 (latest) — 2017-03-15
- 1.0.2 — 2015-10-21
- 1.0.1 — 2015-10-16
- 0.12.1 — 2015-10-14
- 0.12.0 — 2015-08-19
- 0.11.1 — 2015-06-03
- 0.11.0 — 2015-04-29
- 0.10.1 — 2015-03-31
- 0.10.0 — 2015-02-11
- 0.9.0 — 2015-02-05

## README

<img src="http://bitcore.io/css/images/module-message.png" alt="bitcore message" height="35">
# Bitcoin Message Verification and Signing for Bitcore


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

bitcore-message adds support for verifying and signing bitcoin messages in [Node.js](http://nodejs.org/) and web browsers.

See [the main bitcore repo](https://github.com/bitpay/bitcore) for more information.

## Getting Started

```sh
npm install bitcore-message
```

```sh
bower install bitcore-message
```

To sign a message:

```javascript
var bitcore = require('bitcore-lib');
var Message = require('bitcore-message');

var privateKey = bitcore.PrivateKey.fromWIF('cPBn5A4ikZvBTQ8D7NnvHZYCAxzDZ5Z2TSGW2LkyPiLxqYaJPBW4');
var signature = Message('hello, world').sign(privateKey);
```

To verify a message:

```javascript
var address = 'n1ZCYg9YXtB5XCZazLxSmPDa8iwJRZHhGx';
var signature = 'H/DIn8uA1scAuKLlCx+/9LnAcJtwQQ0PmcPrJUq90aboLv3fH5fFvY+vmbfOSFEtGarznYli6ShPr9RXwY9UrIY=';
var verified = Message('hello, world').verify(address, signature);
```

## Contributing

See [CONTRIBUTING.md](https://github.com/bitpay/bitcore/blob/master/CONTRIBUTING.md) on the main bitcore repo for information about how to contribute.

## License

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

Copyright 2013-2015 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.

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