Go to file

Manuel Aráoz dcbd0738b0 Merge pull request #678 from eordano/feature/privkeyhex Add functionality to create private key from a hex string		2014-12-09 11:48:40 -03:00
browser	Tests: Add browser directory	2014-12-05 10:10:15 -05:00
docs	add js tag to some code	2014-12-05 20:11:55 -03:00
lib	Add option to create private key from hex	2014-12-09 11:40:30 -03:00
test	Add option to create private key from hex	2014-12-09 11:40:30 -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	Fixes issues with errors	2014-12-03 10:06:44 -03:00
.jshintrc	100% test coverage for HDPrivateKey	2014-11-30 09:47:44 -03:00
.travis.yml	make travis run all tests	2014-11-26 18:50:53 -03:00
CONTRIBUTING.md	add contributing.mdwq	2014-05-06 15:27:40 -03:00
LICENSE	Update LICENSE	2014-02-07 21:08:22 -05:00
README.md	Refactor readme	2014-11-22 18:44:18 -03:00
bower.json	v0.1.36	2014-09-08 15:51:14 -07:00
gulpfile.js	Tests: Remove devDependency and change to relative path names	2014-12-05 09:54:58 -05:00
index.js	Payment Protocol: Restore and reorganize files for payment protocol.	2014-12-04 10:43:40 -05:00
karma.conf.js	make travis run all tests	2014-11-26 18:50:53 -03:00
npm-shrinkwrap.json	Payment Protocol: Restore and reorganize files for payment protocol.	2014-12-04 10:43:40 -05:00
package.json	Tests: Remove devDependency	2014-12-05 10:20:53 -05:00

README.md

Bitcore

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.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 dist/bitcore.js and dist/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.