LBRYCommunity/bitcoinjs-lib
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
A javascript Bitcoin library for node.js and browsers.
262 commits 10 branches 78 tags 5.8 MiB
TypeScript 69%
JavaScript 31%
Find a file
Kyle Drake ace3fd122c Merge pull request #60 from bitcoinjs/hd-keychain-structure 
HD wallet keychain structure
2014-03-17 17:00:18 -07:00
src Merge pull request #60 from bitcoinjs/hd-keychain-structure 2014-03-17 17:00:18 -07:00
test Merge pull request #60 from bitcoinjs/hd-keychain-structure 2014-03-17 17:00:18 -07:00
.gitignore cleanup runners, add coverage script, fix typo 2014-03-11 12:23:37 -07:00
.travis.yml Travis image, remove 0.6 test 2014-03-12 16:39:44 -07:00
LICENSE Updated licensing information. 2011-12-20 12:47:50 +01:00
package.json Specify static versions of dependencies 2014-03-14 13:21:24 +01:00
README.md Added DarkWallet to projects using bitcoinjs-lib 2014-03-14 21:25:38 +01:00

README.md

bitcoinjs-lib

Build Status

Browser Support

A pure JavaScript Bitcoin library for node.js and browsers. Backed by (slowly improving) testing, proven by over a million wallet users. The backbone for almost all Bitcoin web wallets in production today.

This is not the original bitcoinjs-lib that was not updated for a while. The current bitcoinjs-lib has been refactored to clean things up, add new functionality and merge improvements from the community. If you are looking for the original, it will be tagged as 0.1.3. We will use 0.2.x for releases based on these changes, so be sure to use the 0.1.3 tag if you need the original version.

Features

  • Bitcoin Testnet and Mainnet (production) support
  • HD Wallets
  • Highly secure random private key / address generation using window.crypto.getRandomValues
  • ECDSA signing and verification
  • Transaction creation (pay-to-pubkey-hash), support for multisignature transactions
  • A (somewhat incomplete) wallet implementation, improvements ongoing

Installation

npm install bitcoinjs-lib

Note: The npm version is currently out of date, are working to resolve this. The best way to use the latest code is to clone the repository.

Usage

Run the test suite

$ npm test

Node.js

var bitcoin = require('bitcoinjs-lib')

From the repo:

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

Browser

Compile bitcoinjs-min.js with the following command:

$ npm run-script compile

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

Projects utilizing bitcoinjs-lib

Feel free to send pull requests to have your project/startup listed here.

Alternatives

License

This library is free and open-source software released under the MIT license.

Copyright

BitcoinJS (c) 2011-2012 Stefan Thomas Released under MIT license http://bitcoinjs.org/

JSBN (c) 2003-2005 Tom Wu Released under BSD license http://www-cs-students.stanford.edu/~tjw/jsbn/

CryptoJS (c) 2009–2012 by Jeff Mott Released under New BSD license http://code.google.com/p/crypto-js/