Removed devDependencies that can be defined in bitcore-build. |
||
---|---|---|
docs | ||
lib | ||
test | ||
.coveralls.yml | ||
.gitattributes | ||
.gitignore | ||
.jsdoc.conf | ||
.jshintrc | ||
.travis.yml | ||
.zuul.yml | ||
CONTRIBUTING.md | ||
LICENSE | ||
README.md | ||
bower.json | ||
gulpfile.js | ||
index.js | ||
karma.conf.js | ||
npm-shrinkwrap.json | ||
package.json |
README.md
Bitcore
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.
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.