A javascript Bitcoin library for node.js and browsers.

Find a file

Karel Bílek 66baeb088f Adding Flow definitions link		2016-07-22 23:58:46 +02:00
src	script: enforce PUSH_DATA codes for witness outputs	2016-07-12 12:32:29 +10:00
test	tests: avoid superfluous ECPair creation	2016-07-22 13:34:23 +10:00
.gitignore	Update wif to 2.0.1	2016-02-24 13:08:40 +03:00
.travis.yml	Add Node.js v6 to .travis.yml	2016-04-29 16:03:41 +04:00
CHANGELOG.md	CHANGELOG: add PR numbers	2016-02-05 15:35:28 +11:00
LICENSE	LICENSE: update copyright to 2016	2015-12-17 16:24:46 +11:00
package.json	Update wif to 2.0.1	2016-02-24 13:08:40 +03:00
README.md	Adding Flow definitions link	2016-07-22 23:58:46 +02:00

README.md

BitcoinJS (bitcoinjs-lib)

The pure JavaScript Bitcoin library for node.js and browsers. Used by over a million wallet users and 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.

Installation

npm install bitcoinjs-lib

Setup

Node.js

var bitcoin = require('bitcoinjs-lib')

Browser

If you're familiar with how to use browserify, ignore this and proceed normally. These steps are advisory only and allow you to use the API to its full extent.

Browserify is assumed to be installed for these steps.

From your repository, create a foo.js file

var foobar = {
  base58: require('bs58'),
  bitcoin: require('bitcoinjs-lib'),
  ecurve: require('ecurve'),
  BigInteger: require('bigi'),
  Buffer: require('buffer')
}

module.exports = foobar

Each of these included packages are separate to bitcoinjs-lib, and must be npm install'd individually.

Using browserify, compile foo.js for use in the browser:

$ browserify foo.js -s foobar > bar.js

You will then be able to load bar.js into your browser, with each of the dependencies above accessible from the global foobar object.

NOTE: See our package.json for the currently supported version of browserify used by this repository.

NOTE: When uglifying the javascript, you must exclude the following variable names from being mangled: Array, BigInteger, Boolean, Buffer, ECPair, Function, Number, Point and Script. This is because of the function-name-duck-typing used in typeforce. Example:

uglifyjs ... --mangle --reserved 'Array,BigInteger,Boolean,Buffer,ECPair,Function,Number,Point'

Flow

Definition for Flow typechecker are available in flow-typed repository.

You can either download them direcly from the repo, or with the flow-typed CLI

# npm install -g flow-typed
$ flow-typed install -f 0.27 bitcoinjs-lib@2.2.0 # 0.27 for flow version, 2.2.0 for bitcoinjs-lib version

The definition should be complete and cover all the functions and classes in the API.

Examples

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

If you have a use case that you feel could be listed here, please ask for it!

Projects utilizing BitcoinJS

Contributors

Stefan Thomas is the inventor and creator of this project. His pioneering work made Bitcoin web wallets possible. Daniel Cousens, Wei Lu, JP Richardson and Kyle Drake lead the major refactor of the library from 0.1.3 to 1.0.0.

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

Contributing

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

Complementing Libraries

BIP21 - A BIP21 compatible URL encoding utility library
BIP38 - Passphrase-protected private keys
BIP39 - Mnemonic generation for deterministic keys
BIP32-Utils - A set of utilities for working with BIP32
BIP32-Wallet - A BIP32 Wallet backed by bitcoinjs-lib, lite on features but heavily tested
BIP66 - Strict DER signature decoding
BIP69 - Lexicographical Indexing of Transaction Inputs and Outputs
Base58 - Base58 encoding/decoding
Base58 Check - Base58 check encoding/decoding
BCoin - BIP37 / Bloom Filters / SPV client
insight - A bitcoin blockchain API for web wallets.

Alternatives

LICENSE MIT

Copyright

Released under MIT license