https://github.com/bitpay/bitcore-message

Bitcoin Message Verification and Signing for Bitcore
https://github.com/bitpay/bitcore-message

Last synced: about 2 months ago
JSON representation

Bitcoin Message Verification and Signing for Bitcore

• Host: GitHub
• URL: https://github.com/bitpay/bitcore-message
• Owner: bitpay
• Created: 2015-02-04T18:09:22.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-03-08T08:43:47.000Z (over 1 year ago)
• Last Synced: 2024-07-25T05:03:42.928Z (about 2 months ago)
• Language: JavaScript
• Size: 568 KB
• Stars: 88
• Watchers: 22
• Forks: 243
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

• awesome-cryptocoinjs - bitcoin

README

        


# 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.