A javascript Bitcoin library for node.js and browsers.

Find a file

Daniel Cousens 18fb33d433 Merge pull request #354 from bitcoinjs/wipscript scripts: add allowIncomplete for multisig scripts		2015-02-13 11:48:56 +11:00
src	Merge pull request #354 from bitcoinjs/wipscript	2015-02-13 11:48:56 +11:00
test	scripts: add allowIncomplete for multisig scripts	2015-02-12 19:50:00 +11:00
.gitignore	cleanup runners, add coverage script, fix typo	2014-03-11 12:23:37 -07:00
.npmignore	adds .npmignore	2015-01-13 22:24:19 +11:00
.travis.yml	package.json: add support for continuous coverage reporting	2014-05-25 18:06:37 +10:00
jshint.json	JSHint: add max line length 120	2014-06-04 15:55:25 +10:00
LICENSE	Updated license date	2015-01-01 11:41:21 +00:00
package.json	package: remove crypto-browserify specific version	2015-02-02 19:04:16 +11:00
README.md	tests/integration: add k-value derivation and private key recovery example	2014-12-09 12:23:43 +11:00

README.md

BitcoinJS (bitcoinjs-lib)

The pure JavaScript Bitcoin library for node.js and browsers. A continued implementation of the original 0.1.3 version used by over a million wallet users; the backbone for almost all Bitcoin web wallets in production today.

Features

Clean: Pure JavaScript, concise code, easy to read.
Tested: Coverage > 90%, third-party integration tests.
Careful: Two person approval process for small, focused pull requests.
Compatible: Works on Node.js and all modern browsers.
Powerful: Support for advanced features, such as multi-sig, HD Wallets.
Secure: Strong random number generation, PGP signed releases, trusted developers.
Principled: No support for browsers with crap RNG (IE < 11)
Standardized: Node community coding style, Browserify, Node's stdlib and Buffers.
Fast: Optimized code, uses typed arrays instead of byte arrays for performance.
Experiment-friendly: Bitcoin Mainnet and Testnet support.
Altcoin-ready: Capable of working with bitcoin-derived cryptocurrencies (such as Dogecoin).

Should I use this in production?

If you are thinking of using the master branch of this library in production, stop. Master is not stable; it is our development branch, and only tagged releases may be classified as stable.

If you are looking for the original, it is tagged as 0.1.3. Unless you need it for dependency reasons, it is strongly recommended that you use (or upgrade to) the newest version, which adds major functionality, cleans up the interface, fixes many bugs, and adds over 1,300 more tests.

Installation

npm install bitcoinjs-lib

Setup

Node.js

var bitcoin = require('bitcoinjs-lib')

From the repo:

var bitcoin = require('./src/index.js')

Browser

From the repository: Compile bitcoinjs-min.js with the following command:

$ npm run-script compile

From NPM:

$ npm -g install bitcoinjs-lib browserify uglify-js
$ browserify -r bitcoinjs-lib -s bitcoin | uglifyjs > bitcoinjs.min.js

After loading this file in your browser, you will be able to use the global bitcoin object.

Examples

The below examples are implemented as integration tests, they should be very easy to understand. Otherwise, pull requests are appreciated.

Projects utilizing BitcoinJS

Contributors

Stefan Thomas is the inventor and creator of this project. His pioneering work made Bitcoin web wallets possible.

Since then, many people have contributed. Click here to see the comprehensive list.

Daniel Cousens, Wei Lu, JP Richardson and Kyle Drake lead the major refactor of the library from 0.1.3 to 1.0.0.

Contributing

Join the ongoing IRC development channel at #bitcoinjs-dev on Freenode. We are always accepting of Pull requests, but we do adhere to specific standards in regards to coding style, test driven development and commit messages.

Please make your best effort to adhere to these when contributing to save on trivial corrections.

Running the test suite

$ npm test
$ npm run-script coverage