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.
 
Braydon Fuller 32ac9bb63e Change utility naming 10 years ago
browser Tests: Add browser directory 10 years ago
docs Merge pull request #713 from braydonf/ref/private-key-network 10 years ago
lib Change utility naming 10 years ago
test Standardized toJSON, fromJSON, toString and fromString interfaces 10 years ago
.coveralls.yml add coveralls 11 years ago
.gitattributes sets browser bundle a binary file 11 years ago
.gitignore Fixes issues with errors 10 years ago
.jshintrc tweak cyclomatic complexity jshint config 10 years ago
.travis.yml make travis run all tests 10 years ago
CONTRIBUTING.md Add two more rules to CONTRIBUTING 10 years ago
LICENSE Move license notes to LICENSE 10 years ago
README.md Refactor readme 10 years ago
bower.json v0.1.36 10 years ago
gulpfile.js Refactor transaction to match new API 10 years ago
index.js remove script_interpreter for partial commit 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 dependencies and update tests 10 years ago

README.md

Bitcore

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