Manuel Araoz
3775d3c08a
|
10 years ago | |
---|---|---|
browser | 10 years ago | |
docs | 10 years ago | |
lib | 10 years ago | |
test | 10 years ago | |
.coveralls.yml | 11 years ago | |
.gitattributes | 11 years ago | |
.gitignore | 10 years ago | |
.jshintrc | 10 years ago | |
.travis.yml | 10 years ago | |
CONTRIBUTING.md | 10 years ago | |
LICENSE | 10 years ago | |
README.md | 10 years ago | |
bower.json | 10 years ago | |
gulpfile.js | 10 years ago | |
index.js | 10 years ago | |
karma.conf.js | 10 years ago | |
npm-shrinkwrap.json | 10 years ago | |
package.json | 10 years ago |
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.
Copyright 2013-2014 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.