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 f78ebeb46c Refactor HDPrivateKey path validation 10 years ago
docs Merge pull request #862 from braydonf/docs/browser-builds 10 years ago
lib Refactor HDPrivateKey path validation 10 years ago
test Refactor HDPrivateKey path validation 10 years ago
.coveralls.yml add coveralls 11 years ago
.gitattributes sets browser bundle a binary file 11 years ago
.gitignore automate release process 10 years ago
.jsdoc.conf polish README 10 years ago
.jshintrc Relax "newcap" requirement on jshint 10 years ago
.travis.yml Update coveralls 10 years ago
CONTRIBUTING.md Added documentation to the contributing file, and adjusted formatting of section headings. 10 years ago
LICENSE polish README 10 years ago
README.md readme: Update images, gh-pages branch was deleted 10 years ago
bower.json fix(bower.json): Add better ignores 10 years ago
gulpfile.js fix releaser script 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 Bump package version to 0.8.5 10 years ago

README.md

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 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.