Skip to content

Latest commit

 

History

History
162 lines (132 loc) · 10.2 KB

README.md

File metadata and controls

162 lines (132 loc) · 10.2 KB
Raw

BitGo UTXO library (bitgo-utxo-lib)

Build Status NPM Known Vulnerabilities

js-standard-style

Originally a fork of bitcoinjs-lib; we evolved this library to support the transaction building process of different UTXO based coins.

Supported coins

  • Bitcoin
  • Bitcoin Cash
  • Bitcoin Gold
  • Bitcoin SV (Satoshi Vision)
  • Dash
  • Litecoin
  • Zcash (Sapling compatible)

Features

  • Clean: Pure JavaScript, concise code, easy to read.
  • Tested: Coverage > 90%, third-party integration tests.
  • 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 RNG (IE < 11)
  • Standardized: Node community coding style, Browserify, Node's stdlib and Buffers.
  • Experiment-friendly: Mainnet and Testnet support.
  • Multicoin support: Configurable behaviour based on network objects.
  • Backed by BitGo

Installation

npm install bitgo-utxo-lib

Setup

Node.js

var bitGoUTXO = require('bitgo-utxo-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 is assumed to be installed for these steps.

For your project, create an index.js file

let bitGoUTXO = require('bitgo-utxo-lib')

// your code here
function myFunction () {
	return bitGoUTXO.ECPair.makeRandom().toWIF()
}

module.exports = {
	myFunction
}

Now, to compile for the browser:

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

You can now put <script src="app.js" /> in your web page, using foo.myFunction to create a new Bitcoin private key.

NOTE: If you uglify the javascript, you must exclude the following variable names from being mangled: BigInteger, ECPair, Point. This is because of the function-name-duck-typing used in typeforce.

Example:

uglifyjs ... --mangle --reserved 'BigInteger,ECPair,Point'

NOTE: This library tracks Node LTS features, if you need strict ES5, use --transform babelify in conjunction with your browserify step (using an es2015 preset).

NOTE: If you expect this library to run on an iOS 10 device, ensure that you are using [email protected] or greater.

Typescript or VSCode users

Type declarations for Typescript are available for version ^3.0.0 of the library.

npm install @types/bitgo-utxo-lib

You can now use bitgo-utxo-lib as a typescript compliant library.

import { HDNode, Transaction } from 'bitgo-utxo-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).

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).

Bitcoin

If you have a use case that you feel could be listed here, please ask for it!

Running the test suite

npm test
npm run-script coverage

Complementing Libraries

  • BIP21 - A BIP21 compatible URL encoding utility library
  • BIP38 - Passphrase-protected private keys
  • BIP39 - Mnemonic generation for deterministic keys
  • BIP32-Utils - A set of utilities for working with BIP32
  • BIP66 - Strict DER signature decoding
  • BIP69 - Lexicographical Indexing of Transaction Inputs and Outputs
  • Base58 - Base58 encoding/decoding
  • Base58 Check - Base58 check encoding/decoding
  • Bech32 - A BIP173 compliant Bech32 encoding library
  • coinselect - A fee-optimizing, transaction input selection module for bitcoinjs-lib.
  • merkle-lib - A performance conscious library for merkle root and tree calculations.
  • minimaldata - A module to check bitcoin policy: SCRIPT_VERIFY_MINIMALDATA

LICENSE MIT