Go to file
Manuel Araoz 11f51d8734 polish README 2014-12-22 18:03:27 -03:00
dist Add dist folder and update bower file 2014-12-17 19:07:16 -03:00
docs Docs: Fix capitalization in links 2014-12-21 10:21:11 -05:00
lib return comment to deterministicK 2014-12-22 17:33:00 -03:00
test lint random.js 2014-12-19 19:32:26 -03:00
.coveralls.yml add coveralls 2014-06-05 16:43:07 -03:00
.gitattributes sets browser bundle a binary file 2014-05-13 10:50:38 -03:00
.gitignore Proofread Documentation 2014-12-19 17:34:54 -05:00
.jsdoc.conf polish README 2014-12-22 18:03:27 -03:00
.jshintrc Relax "newcap" requirement on jshint 2014-12-19 16:22:58 -03:00
.travis.yml Update coveralls 2014-12-17 22:53:28 -03:00
CONTRIBUTING.md Proofread Documentation 2014-12-19 17:34:54 -05:00
LICENSE polish README 2014-12-22 18:03:27 -03:00
README.md polish README 2014-12-22 18:03:27 -03:00
bower.json version bump 2014-12-19 11:36:02 -03:00
gulpfile.js Added jsdoc2md to generate api reference documentation to markdown, and organized docs into 'api' and 'guide' 2014-12-18 18:38:47 -05:00
index.js Move: Script and Interpreter into subfolder 2014-12-16 21:11:36 -03:00
karma.conf.js make travis run all tests 2014-11-26 18:50:53 -03:00
npm-shrinkwrap.json add dependencies and update tests 2014-12-11 14:01:06 -03:00
package.json version bump 2014-12-19 11:36:02 -03:00

README.md

Bitcore

NPM Package Build Status Coverage Status

A pure and powerful JavaScript Bitcoin API.

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(address));
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 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 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.