bellcore-lib v0.16.21

Bellcore Library

A pure and powerful JavaScript Bellcoin library.

Principles

Bellcoin is a powerful new peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Bellcoin network allows for highly resilient bitcoin infrastructure, and the developer community needs reliable, open-source tools to implement bitcoin apps and services.

Get Started

npm install bellcore-lib

bower install bellcore-lib

Documentation

The complete docs are hosted here: bitcore documentation. There's also a bitcore API reference available generated from the JSDocs of the project, where you'll find low-level details on each bellcore utility.

• Read the Developer Guide
• Read the API Reference

To get community assistance and ask for help with implementation questions, please use our community forums.

Examples

• Generate a random address
• Generate a address from a SHA256 hash
• Import an address via WIF
• Create a Transaction
• Sign a Bellcoin message
• Verify a Bellcoin message
• Create an OP RETURN transaction
• Create a 2-of-3 multisig P2SH address
• Spend from a 2-of-2 multisig P2SH address

Security

We're using Bellcore in production, as are many others, 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 security@bitpay.com.

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

Building the Browser Bundle

To build a bellcore-lib full bundle for the browser:

gulp browser

This will generate files named bellcore-lib.js and bellcore-lib.min.js.

Development & Tests

git clone https://github.com/bellcoin-electrum/bellcore-lib
cd bellcore-lib
npm install

Run all the tests:

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.

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