RN-BitcoinJS (rn-bitcoinjs-lib)

Note: Great news! This library is no longer required for bitcoinjs-lib versions 5.1 and up. Please use this Gist instead to get your RN project up and running.

This is a React Native compatible version of bitcoinjs-lib, a javascript Bitcoin library for node.js and browsers. Written in TypeScript, but committing the JS files to verify.

Released under the terms of the MIT LICENSE.

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.

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 (5.0.5) in your RN project, please follow the how-to below: RN BitcoinJS-Lib (5.0.5) Setup

If you have any difficulty with the setup instructions below and need a repo for reference, feel free to clone, review and experiment with the pre-built RN repo here: RNBitcoinJS

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 prettier 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

Typically we support the Node Maintenance LTS version. If in doubt, see the .travis.yml for what versions are used by our continuous integration tests.

WARNING: We presently don't provide any tooling to verify that the release on npm matches GitHub. As such, you should verify anything downloaded by npm against your own verified copy.

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 && cd node_modules/bs58 && yarn add [email protected] && cd ../../"

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

Crypto is hard.

When working with private keys, the random number generator is fundamentally one of the most important parts of any software you write. For random number generation, we default to the randombytes module, which uses window.crypto.getRandomValues in the browser, or Node js' crypto.randomBytes, depending on your build system. Although this default is ~OK, there is no simple way to detect if the underlying RNG provided is good enough, or if it is catastrophically bad. You should always verify this yourself to your own standards.

This library uses tiny-secp256k1, which uses RFC6979 to help prevent k re-use and exploitation. Unfortunately, this isn't a silver bullet. Often, Javascript itself is working against us by bypassing these counter-measures.

Problems in Buffer (UInt8Array), for example, can trivially result in catastrophic fund loss without any warning. It can do this through undermining your random number generation, accidentally producing a duplicate k value, sending Bitcoin to a malformed output script, or any of a million different ways. Running tests in your target environment is important and a recommended step to verify continuously.

Finally, adhere to best practice. We are not an authorative source of best practice, but, at the very least:

Don't re-use addresses.
Don't share BIP32 extended public keys ('xpubs'). They are a liability, and it only takes 1 misplaced private key (or a buggy implementation!) and you are vulnerable to catastrophic fund loss.
Don't use Math.random - in any way - don't.
Enforce that users always verify (manually) a freshly-decoded human-readable version of their intended transaction before broadcast.
Don't ask users to generate mnemonics, or 'brain wallets', humans are terrible random number generators.
Lastly, if you can, use Typescript or similar.

Node.js

Use bitcoinjs-lib

Browser

Use bitcoinjs-lib

Typescript or VSCode users

Type declarations for Typescript are included in this library. Normal installation should include all the needed type information.

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

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

coreyphillips / rn-bitcoinjs-lib

Programming Languages

Labels

Projects that are alternatives of or similar to rn-bitcoinjs-lib