rn-bitcoinjs-lib

BitcoinJS (bitcoinjs-lib)

This is a React Native compatible version of bitcoinjs-lib, a javascript Bitcoin library for node.js and browsers.

Released under the terms of the MIT LICENSE.

You shouldn't trust or rely on this repo for anything other than testing. To setup bitcoinjs-lib (4.0.2) in your RN project, please follow the how-to below:

RN BitcoinJS-Lib (4.0.2) Setup

Can I trust this code?

Don't trust. Verify.

You shouldn't trust or rely on this repo for anything other than testing. To setup bitcoinjs-lib (4.0.2) in your RN project, please follow the how-to below:

RN BitcoinJS-Lib (4.0.2) Setup

We recommend every user of this library and the bitcoinjs ecosystem audit and verify any underlying code for its validity and suitability.

Mistakes and bugs happen, but with your help in resolving and reporting issues, together we can produce open source software that is:

• Easy to audit and verify,
• Tested, with test coverage >95%,
• Advanced and feature rich,
• Standardized, using standard and Node Buffer's throughout, and
• Friendly, with a strong and helpful community, ready to answer questions.

Documentation

Presently, we do not have any formal documentation other than our examples, please ask for help if our examples aren't enough to guide you.

Installation

yarn add rn-bitcoinjs-lib

Setup

React Native

Install the following dependencies:

yarn add buffer-reverse react-native-randombytes crypto buffer@5
yarn add --dev rn-nodeify
react-native link react-native-randombytes

Add the following to your script in package.json:

"postinstall": "rn-nodeify --install buffer,stream,assert,events,crypto,vm --hack"

Install any remaining dependencies and run postinstall. NOTE: (If you receive an error about "shim.js" not existing just run yarn install again):

yarn install

Add the following to shim.js:

if (typeof Buffer.prototype.reverse === 'undefined') {
  var bufferReverse = require('buffer-reverse');

  Buffer.prototype.reverse = function () {
    return bufferReverse(this);
  };
}

Add/Uncomment "require('crypto')" at the bottom of shim.js:

require('crypto')

Finally:

yarn install

Usage

import "./shim";
const bitcoin = require("rn-bitcoinjs-lib");
const keyPair = bitcoin.ECPair.makeRandom();
const { address } = bitcoin.payments.p2pkh({ pubkey: keyPair.publicKey });
console.log(address);

Node.js

Use bitcoinjs-lib

Browser

Use bitcoinjs-lib

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

• Generate a random address
• Generate an address from a SHA256 hash
• Import an address via WIF
• Generate a 2-of-3 P2SH multisig address
• Generate a SegWit address
• Generate a SegWit P2SH address
• Generate a SegWit 3-of-4 multisig address
• Generate a SegWit 2-of-2 P2SH multisig address
• Support the retrieval of transactions for an address (3rd party blockchain)
• Generate a Testnet address
• Generate a Litecoin address
• Create a 1-to-1 Transaction
• Create a 2-to-2 Transaction
• Create (and broadcast via 3PBP) a typical Transaction
• Create (and broadcast via 3PBP) a Transaction with an OP_RETURN output
• Create (and broadcast via 3PBP) a Transaction with a 2-of-4 P2SH(multisig) input
• Create (and broadcast via 3PBP) a Transaction with a SegWit P2SH(P2WPKH) input
• Create (and broadcast via 3PBP) a Transaction with a SegWit P2WPKH input
• Create (and broadcast via 3PBP) a Transaction with a SegWit P2PK input
• Create (and broadcast via 3PBP) a Transaction with a SegWit 3-of-4 P2SH(P2WSH(multisig)) input
• Verify a Transaction signature
• Import a BIP32 testnet xpriv and export to WIF
• Export a BIP32 xpriv, then import it
• Export a BIP32 xpub
• Create a BIP32, bitcoin, account 0, external address
• Create a BIP44, bitcoin, account 0, external address
• Create a BIP49, bitcoin testnet, account 0, external address
• Use BIP39 to generate BIP32 addresses
• Create (and broadcast via 3PBP) a Transaction where Alice can redeem the output after the expiry (in the past)
• Create (and broadcast via 3PBP) a Transaction where Alice can redeem the output after the expiry (in the future)
• Create (and broadcast via 3PBP) a Transaction where Alice and Bob can redeem the output at any time
• Create (but fail to broadcast via 3PBP) a Transaction where Alice attempts to redeem before the expiry
• Recover a private key from duplicate R values
• Recover a BIP32 parent private key from the parent public key, and a derived, non-hardened child private key
• Generate a single-key stealth address
• Generate a single-key stealth address (randomly)
• Recover parent recipient.d, if a derived private key is leaked (and nonce was revealed)
• Generate a dual-key stealth address
• Generate a dual-key stealth address (randomly)

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

Contributing

See CONTRIBUTING.md.

Running the test suite

npm test
npm run-script coverage

Complementing Libraries

• BIP21 - A BIP21 compatible URL encoding 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
• BIP68 - Relative lock-time encoding library
• 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

Alternatives

• BCoin
• Bitcore
• Cryptocoin

LICENSE MIT