Compare commits
11 Commits
Author | SHA1 | Date |
---|---|---|
Jack Grigg | 14452dee12 | |
Braydon Fuller | 0c0db03a7b | |
Braydon Fuller | 16c0c34ac5 | |
Jason Dreyzehner | f960a09557 | |
Braydon Fuller | c58a1da918 | |
Braydon Fuller | dbf3698f5f | |
Jason Dreyzehner | 51718e48e2 | |
Braydon Fuller | 740fc74546 | |
Braydon Fuller | 895c8277cd | |
Braydon Fuller | a45082415d | |
Braydon Fuller | 2ca899e6fc |
10
README.md
10
README.md
|
@ -6,25 +6,25 @@
|
||||||
[![Build Status](https://img.shields.io/travis/bitpay/bitcore-message.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/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)
|
[![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.
|
bitcore-message-zcash adds support for verifying and signing zcash messages in [Node.js](http://nodejs.org/) and web browsers.
|
||||||
|
|
||||||
See [the main bitcore repo](https://github.com/bitpay/bitcore) for more information.
|
See [the main bitcore repo](https://github.com/bitpay/bitcore) for more information.
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
npm install bitcore-message
|
npm install bitcore-message-zcash
|
||||||
```
|
```
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
bower install bitcore-message
|
bower install bitcore-message-zcash
|
||||||
```
|
```
|
||||||
|
|
||||||
To sign a message:
|
To sign a message:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
var bitcore = require('bitcore');
|
var bitcore = require('bitcore-lib-zcash');
|
||||||
var Message = require('bitcore-message');
|
var Message = require('bitcore-message-zcash');
|
||||||
|
|
||||||
var privateKey = bitcore.PrivateKey.fromWIF('cPBn5A4ikZvBTQ8D7NnvHZYCAxzDZ5Z2TSGW2LkyPiLxqYaJPBW4');
|
var privateKey = bitcore.PrivateKey.fromWIF('cPBn5A4ikZvBTQ8D7NnvHZYCAxzDZ5Z2TSGW2LkyPiLxqYaJPBW4');
|
||||||
var signature = Message('hello, world').sign(privateKey);
|
var signature = Message('hello, world').sign(privateKey);
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
{
|
{
|
||||||
"name": "bitcore-message",
|
"name": "bitcore-message",
|
||||||
"main": "./bitcore-message.min.js",
|
"main": "./bitcore-message.min.js",
|
||||||
"version": "0.11.0",
|
"version": "1.0.2",
|
||||||
"homepage": "https://github.com/bitpay/bitcore-message",
|
"homepage": "https://github.com/bitpay/bitcore-message",
|
||||||
"authors": [
|
"authors": [
|
||||||
"BitPay"
|
"BitPay"
|
||||||
|
|
|
@ -1,33 +1,24 @@
|
||||||
---
|
|
||||||
title: Message Verification and Signing
|
|
||||||
description: Bitcoin Message Verification and Signing.
|
|
||||||
---
|
|
||||||
# Message Verification and Signing
|
# Message Verification and Signing
|
||||||
|
Bitcore implementation of [bitcoin message signing and verification](http://bitcoin.stackexchange.com/questions/3337/what-are-the-safety-guidelines-for-using-the-sign-message-feature/3339#3339). This is used to cryptographically prove that a certain message was signed by the holder of an address private key.
|
||||||
## Description
|
|
||||||
|
|
||||||
Bitcore implementation of [bitcoin message signing and verification]
|
|
||||||
(http://bitcoin.stackexchange.com/questions/3337/what-are-the-safety-guidelines-for-using-the-sign-message-feature/3339#3339).
|
|
||||||
This is used to cryptographically prove that a certain message was signed by the holder of an address private key.
|
|
||||||
|
|
||||||
For more information refer to the [bitcore-message](https://github.com/bitpay/bitcore-message) github repo.
|
For more information refer to the [bitcore-message](https://github.com/bitpay/bitcore-message) github repo.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Message Verification and Signing is implemented as a separate module and you must add it to your dependencies:
|
Message Verification and Signing is implemented as a separate module and you must add it to your dependencies:
|
||||||
|
|
||||||
For node projects:
|
For node projects:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install bitcore-message --save
|
npm install bitcore-message --save
|
||||||
```
|
```
|
||||||
|
|
||||||
For client-side projects:
|
For client-side projects:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
bower install bitcore-message --save
|
bower install bitcore-message --save
|
||||||
```
|
```
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
To sign a message:
|
To sign a message:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
|
|
2
index.js
2
index.js
|
@ -1,4 +1,4 @@
|
||||||
var bitcore = require('bitcore');
|
var bitcore = require('bitcore-lib-zcash');
|
||||||
bitcore.Message = require('./lib/message');
|
bitcore.Message = require('./lib/message');
|
||||||
|
|
||||||
module.exports = bitcore.Message;
|
module.exports = bitcore.Message;
|
|
@ -1,6 +1,6 @@
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
var bitcore = require('bitcore');
|
var bitcore = require('bitcore-lib-zcash');
|
||||||
var _ = bitcore.deps._;
|
var _ = bitcore.deps._;
|
||||||
var PrivateKey = bitcore.PrivateKey;
|
var PrivateKey = bitcore.PrivateKey;
|
||||||
var PublicKey = bitcore.PublicKey;
|
var PublicKey = bitcore.PublicKey;
|
||||||
|
|
14
package.json
14
package.json
|
@ -1,7 +1,7 @@
|
||||||
{
|
{
|
||||||
"name": "bitcore-message",
|
"name": "bitcore-message-zcash",
|
||||||
"version": "0.11.0",
|
"version": "1.0.2",
|
||||||
"description": "Bitcoin Messages for Bitcore",
|
"description": "Zcash Messages for Bitcore",
|
||||||
"author": "BitPay <dev@bitpay.com>",
|
"author": "BitPay <dev@bitpay.com>",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
@ -11,7 +11,7 @@
|
||||||
"build": "gulp"
|
"build": "gulp"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"bitcoin",
|
"zcash",
|
||||||
"bitcore",
|
"bitcore",
|
||||||
"btc",
|
"btc",
|
||||||
"satoshi",
|
"satoshi",
|
||||||
|
@ -20,13 +20,13 @@
|
||||||
],
|
],
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/bitpay/bitcore-message.git"
|
"url": "https://github.com/str4d/bitcore-message-zcash.git"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"bitcore": "^0.12.7"
|
"bitcore-lib-zcash": "str4d/bitcore-lib-zcash"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"bitcore-build": "bitpay/bitcore-build",
|
"bitcore-build-zcash": "str4d/bitcore-build-zcash",
|
||||||
"brfs": "^1.3.0",
|
"brfs": "^1.3.0",
|
||||||
"chai": "~1.10.0",
|
"chai": "~1.10.0",
|
||||||
"gulp": "^3.8.10"
|
"gulp": "^3.8.10"
|
||||||
|
|
|
@ -4,7 +4,7 @@ var chai = require('chai');
|
||||||
var expect = chai.expect;
|
var expect = chai.expect;
|
||||||
var should = chai.should();
|
var should = chai.should();
|
||||||
|
|
||||||
var bitcore = require('bitcore');
|
var bitcore = require('bitcore-lib-zcash');
|
||||||
var Address = bitcore.Address;
|
var Address = bitcore.Address;
|
||||||
var Signature = bitcore.crypto.Signature;
|
var Signature = bitcore.crypto.Signature;
|
||||||
var Message = require('../');
|
var Message = require('../');
|
||||||
|
|
Loading…
Reference in New Issue