You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Yemel Jardi 256d2cfbb0 Merge pull request #810 from braydonf/update/reademe-docs 10 years ago
dist Add dist folder and update bower file 10 years ago
docs Fix docs links 10 years ago
lib Dont lose sighash when signing with multiple keys 10 years ago
test Update transaction test data 10 years ago
.coveralls.yml add coveralls 11 years ago
.gitattributes sets browser bundle a binary file 11 years ago
.gitignore Add dist folder and update bower file 10 years ago
.jsdoc.conf Remove globals 10 years ago
.jshintrc update .jshintrc 10 years ago
.travis.yml Update coveralls 10 years ago
CONTRIBUTING.md update CONTRIBUTING.md with style guide 10 years ago
LICENSE Move license notes to LICENSE 10 years ago
README.md Moved doc links to the documentation section of the readme 10 years ago
bower.json Update bower.json 10 years ago
gulpfile.js Add istanbul to dev-deps, for test coverage reports 10 years ago
index.js Move: Script and Interpreter into subfolder 10 years ago
karma.conf.js make travis run all tests 10 years ago
npm-shrinkwrap.json add dependencies and update tests 10 years ago
package.json Add istanbul to dev-deps, for test coverage reports 10 years ago

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, but we're still working on the quality and design of this API reference.

Read the Developer Guide Read the API Reference

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.