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.
npm install bitcoinjs-lib
var bitcoin = require('bitcoinjs-lib')
If you're familiar with how to use browserify, ignore this and proceed normally. These steps are advisory only, and may not be necessary for your application.
Browserify is assumed to be installed for these steps.
From your repository, create an
Install each of the above packages locally
npm install bs58 bitcoinjs-lib ecurve bigi buffer
After installation, use browserify to compile
index.js for use in the browser:
$ browserify index.js --standalone foo > app.js
You will now be able to use
<script src="app.js" /> in your browser, with each of the above exports accessible via the global
foo object (or whatever you chose for the
--standalone parameter above).
NOTE: See our package.json for the currently supported version of browserify used by this repository.
This is because of the function-name-duck-typing used in typeforce.
uglifyjs ... --mangle --reserved 'Array,BigInteger,Boolean,Buffer,ECPair,Function,Number,Point'
Definitions for Flow typechecker are available in flow-typed repository.
You can either download them directly from the repo, or with the flow-typed CLI
# npm install -g flow-typed $ flow-typed install -f 0.27 email@example.com # 0.27 for flow version, 2.2.0 for bitcoinjs-lib version
The definitions are complete and up to date with version 2.2.0. The definitions are maintained by @runn1ng.
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!
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.
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.
$ npm test $ npm run-script coverage
BitcoinJS (c) 2011-2016 bitcoinjs-lib contributors
Released under MIT license