Bitcore Library

A pure and powerful JavaScript Bitcoin library.

Principles

Bitcoin is a powerful new peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Bitcoin 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 bitcore-lib

bower install bitcore-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 bitcore utility.

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

Examples

Security

We're using Bitcore 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 bitcore-lib full bundle for the browser:

gulp browser

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

You can also use our pre-generated files, provided for each release along with a PGP signature by one of the project's maintainers. To get them, checkout a release commit (for example, https://github.com/bitpay/bitcore-lib/commit/e33b6e3ba6a1e5830a079e02d949fce69ea33546 for v0.12.6).

To verify signatures, use the following PGP keys:

@braydonf: https://pgp.mit.edu/pks/lookup?op=get&search=0x9BBF07CAC07A276D D909 EFE6 70B5 F6CC 89A3 607A 9BBF 07CA C07A 276D
@gabegattis: https://pgp.mit.edu/pks/lookup?op=get&search=0x441430987182732C F3EA 8E28 29B4 EC93 88CB B0AA 4414 3098 7182 732C
@kleetus: https://pgp.mit.edu/pks/lookup?op=get&search=0x33195D27EF6BDB7F F8B0 891C C459 C197 65C2 5043 3319 5D27 EF6B DB7F
@matiu: https://pgp.mit.edu/pks/lookup?op=get&search=0x9EDE6DE4DE531FAC 25CE ED88 A1B1 0CD1 12CD 4121 9EDE 6DE4 DE53 1FAC

Development & Tests

git clone https://github.com/bitpay/bitcore-lib
cd bitcore-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.

Failed to load latest commit information.
benchmark	Buffer writer keeps track of total length of buffer	Feb 11, 2018
docs	Use `Buffer.from()` instead of `new Buffer()`	Apr 18, 2018
lib	Merge branch 'feature/buffer-performance' of git://github.com/micahri…	Mar 11, 2018
test	Merge branch 'segwit' of git://github.com/braydonf/btcjs into braydon…	Mar 11, 2018
.coveralls.yml	Update coveralls.	Oct 23, 2015
.gitignore	ignore browser build signatures	Feb 18, 2015
.jsdoc.conf	polish README	Dec 22, 2014
.jshintrc	Fixed issue with handling invalid output scripts	May 14, 2015
.travis.yml	more lodash aliases	Oct 25, 2017
.zuul.yml	set specific zuul platforms	Jan 8, 2015
CONTRIBUTING.md	Fix typos in documentation	Oct 22, 2015
LICENSE	Bumped version and copyright end year.	Mar 13, 2017
README.md	Bumped version and copyright end year.	Mar 13, 2017
bitcore-lib.js	reverting bitcore-lib	Feb 10, 2018
bower.json	chore(release): 5.0.0-beta.1	Aug 18, 2017
gulpfile.js	Changed package name to bitcore-lib.	Oct 15, 2015
index.js	add versionGuard tests	Oct 26, 2017
karma.conf.js	use gulp-bitcore for gulp	Jan 13, 2015
package.json	fix tests	Oct 26, 2017

bitpay/bitcore-lib

Join GitHub today

Clone with HTTPS

Launching GitHub Desktop...