|
|
@ -1,25 +1,31 @@ |
|
|
|
# bitcoinjs-lib |
|
|
|
|
|
|
|
A library containing Bitcoin client-side functionality in JavaScript, |
|
|
|
most notably ECDSA signing and verification. |
|
|
|
Bitcoin library for node.js and browsers. |
|
|
|
|
|
|
|
[Website](http://bitcoinjs.org/) • [Mailing List](https://groups.google.com/group/bitcoinjs) • [Twitter](https://twitter.com/bitcoinjs) |
|
|
|
|
|
|
|
# Status |
|
|
|
# Features |
|
|
|
|
|
|
|
This is currently pretty raw code. We're planning to clean it up, |
|
|
|
convert everything into CommonJS modules and put a flexible build |
|
|
|
system in place. |
|
|
|
- [HD Wallets](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) |
|
|
|
- Transaction creation and signing |
|
|
|
- ECDSA signing and verification |
|
|
|
|
|
|
|
Prototype software, use at your own peril. |
|
|
|
# Installation |
|
|
|
|
|
|
|
# How to use |
|
|
|
`npm install bitcoinjs-lib` |
|
|
|
|
|
|
|
* Run `npm run-script compile` to compile to a browser-friendly minified |
|
|
|
file. Once in the browser, the global Bitcoin object will contain everything |
|
|
|
you need. |
|
|
|
* To use in NodeJS, install this package as you would any other and |
|
|
|
put in `var Bitcoin = require('bitcoinjs-lib')`. |
|
|
|
## Building (for browsers) |
|
|
|
|
|
|
|
`npm run-script compile` |
|
|
|
|
|
|
|
# Usage |
|
|
|
|
|
|
|
## node.js |
|
|
|
|
|
|
|
`var Bitcoin = require('bitcoinjs-lib')` |
|
|
|
|
|
|
|
## Browser |
|
|
|
|
|
|
|
Use the global `Bitcoin` object. |
|
|
|
|
|
|
|
# License |
|
|
|
|
|
|
@ -28,14 +34,14 @@ license. |
|
|
|
|
|
|
|
# Copyright |
|
|
|
|
|
|
|
BitcoinJS (c) 2011-2012 Stefan Thomas |
|
|
|
Released under MIT license |
|
|
|
BitcoinJS (c) 2011-2012 Stefan Thomas |
|
|
|
Released under MIT license |
|
|
|
http://bitcoinjs.org/ |
|
|
|
|
|
|
|
JSBN (c) 2003-2005 Tom Wu |
|
|
|
Released under BSD license |
|
|
|
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 |
|
|
|
CryptoJS (c) 2009–2012 by Jeff Mott |
|
|
|
Released under New BSD license |
|
|
|
http://code.google.com/p/crypto-js/ |
|
|
|