Go to file
Braydon Fuller 77b6ce3f9e Merge pull request #790 from eordano/fix/gulpJSDOC
Fixes `gulp jsdoc` and `gulp plato`
2014-12-17 11:44:29 -05:00
docs Merge pull request #772 from braydonf/docs/block 2014-12-17 11:58:22 -03:00
lib Merge pull request #788 from eordano/feature/buffertest 2014-12-17 12:57:34 -03:00
test Merge pull request #788 from eordano/feature/buffertest 2014-12-17 12:57:34 -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 Ignore DS_Store 2014-12-16 17:34:33 -03:00
.jsdoc.conf Remove globals 2014-12-16 17:30:43 -03:00
.jshintrc update .jshintrc 2014-12-17 11:29:45 -03:00
.travis.yml make travis run all tests 2014-11-26 18:50:53 -03:00
CONTRIBUTING.md update CONTRIBUTING.md with style guide 2014-12-17 11:43:33 -03:00
LICENSE Move license notes to LICENSE 2014-12-09 13:46:14 -03:00
README.md small change 2014-12-16 19:18:50 -03:00
bower.json v0.1.36 2014-09-08 15:51:14 -07:00
gulpfile.js Fixes `gulp jsdoc` 2014-12-17 13:33:45 -03: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 Add remote ref to modified template 2014-12-16 20:59:04 -03:00

README.md

bitcore Logo

NPM Package Build Status Coverage Status

A pure and simple 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

You can run bitcore on any javascript engine. It's distributed through npm, and you can also find compiled single files here: bitcore.js and bitcore.min.js.

npm install bitcore

Using it on 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.

Security

Please use at your own risk.

Bitcore is still under heavy development and not quite ready for "drop-in" production use. If you find a security issue, please email security@bitcore.io.

Contributing

Please send pull requests for bug fixes, code optimization, and ideas for improvement.

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 tests with mocha:

gulp test:node

Run the tests with karma (uses firefox and chrome):

gulp test:browser

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

gulp coverage

License

Code released under the MIT license.

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