Skip to content

bitpay/bitcore

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Dec 24, 2014
cb0dd22 · Dec 24, 2014
Dec 24, 2014
Dec 23, 2014
Dec 24, 2014
Dec 23, 2014
Jun 5, 2014
May 13, 2014
Dec 24, 2014
Dec 22, 2014
Dec 19, 2014
Dec 18, 2014
Dec 19, 2014
Dec 22, 2014
Dec 23, 2014
Dec 24, 2014
Dec 24, 2014
Dec 17, 2014
Nov 26, 2014
Dec 11, 2014
Dec 24, 2014

Repository files navigation

Bitcore

NPM Package Build Status Coverage Status

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

Using it in Node.js:

var bitcore = require('bitcore');

assert(bitcore.Address.isValid('126vMmY1fyznpZiFTTnty3cm1Rw8wuheev'));
var simpleTx = new bitcore.Transaction();
var simpleTx.from(unspent).to(address, amount);
simpleTx.sign(privateKey);

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.

Read the Developer Guide Read the API Reference

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

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 [email protected].

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 bitcore full bundle for the browser:

gulp browser

This will generate files named browser/bitcore.js and browser/bitcore.min.js.

Tests

Run all the tests:

gulp test

Run the NodeJS tests with mocha:

gulp test:node

Run the browser tests with karma:

gulp test:browser

Create a test coverage report (you can open coverage/lcov-report/index.html to visualize it):

gulp coverage

License

Code released under the MIT license.

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