Awesome 社區模塊

BitcoinJS (bitcoinjs-lib)

Build Status NPM tip for next commit

js-standard-style

The pure JavaScript Bitcoin library for node.js and browsers. Estimated to be in use by over 15 million wallet users and is 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,

Installation

1
npm install bitcoinjs-lib

Setup

Node.js

1
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 may not be suitable for your application.

Browserify

For your project, create anindex.js

1 2 3 4 5 6 7 8 9 10
let bitcoin = require('bitcoinjs-lib') // your code here function myFunction () { return bitcoin.ECPair.makeRandom().toWIF() } module.exports = { myFunction }

Now, to compile for the browser:

1
browserify index.js --standalone foo > app.js

You can now put<script src="app.js" />foo.myFunction

NOTEBigIntegerECPairPoint

Example:

1
uglifyjs ... --mangle reserved=['BigInteger','ECPair','Point']

NOTE--transform babelifybrowserifyes2015

NOTE

Typescript or VSCode users

Type declarations for Typescript are available for version^3.0.0

1
npm install @types/bitcoinjs-lib

You can now usebitcoinjs-lib

1
import { HDNode, Transaction } from 'bitcoinjs-lib'

For VSCode (and other editors), users are advised to install the type declarations, as Intellisense uses that information to help you code (autocompletion, static analysis).

Report any typescript related bugs at

Flow

Definitions for

You can either download them directly

1 2
# 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 definitions are complete and up to date with version 2.2.0. The definitions are maintained by

Examples

The below examples are implemented as integration tests, they should be very easy to understand. Otherwise, pull requests are appreciated. Some examples interact (via HTTPS) with a 3rd Party Blockchain Provider (3PBP).

If you have a use case that you feel could be listed here, please

Projects utilizing BitcoinJS

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

1 2
npm test npm run-script coverage

Complementing Libraries

Alternatives

LICENSE