Package Exports

cashaddrjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cashaddrjs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

CashAddr.js: The new Bitcoin Cash address format for Node.js and web browsers.

JavaScript implementation for the new CashAddr address format for Bitcoin Cash.

Compliant with the original CashAddr specification which improves upon BIP 173.

Installation

Using NPM

$ npm install --save cashaddrjs

Using Bower

$ bower install --save cashaddrjs

Manually

You may also download the distribution file manually and place it within your third-party scripts directory: dist/cashaddrjs-0.1.5.min.js.

Usage

In Node.js

const cashaddr = require('cashaddrjs');

const hash = [
  118, 160, 64,  83, 189,
  160, 168, 139, 218, 81,
  119, 184, 106, 21, 195,
  178, 159, 85,  152, 115
];

const address = cashaddr.encode('bitcoincash', 'P2PKH', hash);
console.log(address); // 'bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a'

const decoded = cashaddr.decode(address);
console.log(decoded.prefix); // 'bitcoincash'
console.log(decoded.type); // 'P2KH'
console.log(decoded.hash); // [ 118, 160, ..., 115 ]

Browser

Script Tag

You may include a script tag in your HTML and the cashaddr module will be defined globally on subsequent scripts.

<html>
  <head>
    ...
    <script src="https://cdn.rawgit.com/bitcoincashjs/cashaddrjs/master/dist/cashaddrjs-0.1.5.min.js"></script>
  </head>
  ...
</html>

Documentation

Generate and Browse Locally

$ npm run docs

Online

Browse automatically generated jsdocs online.