46 lines
1.9 KiB
Markdown
46 lines
1.9 KiB
Markdown
BIP70 Payment Protocol support for bitcore
|
|
=======
|
|
|
|
[](https://www.npmjs.org/package/bitcore-payment-protocol)
|
|
[](https://travis-ci.org/bitpay/bitcore-payment-protocol)
|
|
[](https://coveralls.io/r/bitpay/bitcore-payment-protocol)
|
|
|
|
A module for [bitcore](https://github.com/bitpay/bitcore) that implements [Payment Protocol](https://github.com/bitcoin/bips/blob/master/bip-0070.mediawiki) and other related BIPs.
|
|
|
|
## Getting Started
|
|
|
|
This library is distributed in both the npm and bower packaging systems.
|
|
|
|
```sh
|
|
npm install bitcore-payment-protocol
|
|
bower install bitcore-payment-protocol
|
|
```
|
|
|
|
There are many examples of how to use it on the developer guide [section for payment protocol](http://bitcore.io/guide/paymentprotocol.html). For example, the following code would verify a payment request:
|
|
|
|
```javascript
|
|
var PaymentProtocol = require('bitcore-payment-protocol');
|
|
|
|
var body = PaymentProtocol.PaymentRequest.decode(rawbody);
|
|
var request = new PaymentProtocol().makePaymentRequest(body);
|
|
|
|
var version = pr.get('payment_details_version');
|
|
var pki_type = pr.get('pki_type');
|
|
var pki_data = pr.get('pki_data');
|
|
var serializedDetails = pr.get('serialized_payment_details');
|
|
var signature = pr.get('signature');
|
|
|
|
// Verify the signature
|
|
var verified = request.verify();
|
|
```
|
|
|
|
## Contributing
|
|
|
|
See [CONTRIBUTING.md](https://github.com/bitpay/bitcore) 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.
|