Have ideas to improve npm?Join in the discussion! »

b4bcoinjs-lib

3.1.3 • Public • Published

B4BcoinJS (b4bcoinjs-lib)

js-standard-style

The pure JavaScript B4Bcoin library for node.js and browsers. Used by over a million wallet users and the backbone for almost all B4Bcoin 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, 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: B4Bcoin Mainnet and Testnet support.
  • Altcoin-ready: Capable of working with b4bcoin-derived cryptocurrencies.

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 b4bcoinjs-lib

Setup

Node.js

var b4bcoin = require('b4bcoinjs-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 necessary for your application.

Browserify is assumed to be installed for these steps.

From your repository, create an index.js file

module.exports = {
  base58: require('bs58'),
  b4bcoin: require('b4bcoinjs-lib'),
  ecurve: require('ecurve'),
  BigInteger: require('bigi')
}

Install each of the above packages locally

npm install bs58 b4bcoinjs-lib ecurve bigi

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.

NOTE: When uglifying the javascript, you must exclude the following variable names from being mangled: Array, BigInteger, Boolean, 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,ECPair,Function,Number,Point'

NOTE: If you expect this library to run on an iOS 10 device, ensure that you are using buffer@5.0.5 or greater.

Examples

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 for B4Bcoin
  • BIP39 - Mnemonic generation for deterministic keys
  • BIP66 - Strict DER signature decoding
  • coinselect-b4bcoin - A fee-optimizing, transaction input selection module for b4bcoinjs-lib.

Alternatives

LICENSE MIT

Copyright

B4BcoinJS (c) 2011-2019 b4bcoinjs-lib contributors

Released under MIT license

Install

npm i b4bcoinjs-lib

DownloadsWeekly Downloads

2

Version

3.1.3

License

MIT

Unpacked Size

139 kB

Total Files

51

Last publish

Collaborators

  • avatar