# CashAddr.js: The new Bitcoin Cash address format for Node.js and web browsers. [![Build Status](https://travis-ci.org/ealmansi/cashaddrjs.svg?branch=master)](https://travis-ci.org/ealmansi/cashaddrjs) [![Coverage Status](https://coveralls.io/repos/github/ealmansi/cashaddrjs/badge.svg?branch=master)](https://coveralls.io/github/ealmansi/cashaddrjs?branch=master) [![NPM](https://nodei.co/npm/cashaddrjs.png?downloads=true)](https://nodei.co/npm/cashaddrjs/) JavaScript implementation for the new CashAddr address format for Bitcoin Cash. Compliant with the original CashAddr [specification](https://github.com/bitcoincashorg/bitcoincash.org/blob/master/spec/cashaddr.md) which improves upon [BIP 173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki). *Note:* This is a JavaScript implementation of the CashAddr format specification. If you are looking for a general purpose Bitcoin Cash address translation library, check out the easy-to-use and well-tested [BchAddr.js](https://github.com/ealmansi/bchaddrjs). ## Installation ### Using NPM ```bsh $ npm install --save cashaddrjs ``` ### Using Bower ```bsh $ bower install --save cashaddrjs ``` ### Manually You may also download the distribution file manually and place it within your third-party scripts directory: [dist/cashaddrjs-{{ version }}.min.js](https://unpkg.com/cashaddrjs@{{ version }}/dist/cashaddrjs-{{ version }}.min.js). ## Usage ### In Node.js ```javascript const cashaddr = require('cashaddrjs'); const address = 'bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a'; const { prefix, type, hash } = cashaddr.decode(address); console.log(prefix); // 'bitcoincash' console.log(type); // 'P2PKH' console.log(hash); // Uint8Array [ 118, 160, ..., 115 ] console.log(cashaddr.encode(prefix, type, hash)); // 'bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a' ``` *Note:* This is a JavaScript implementation of the CashAddr format specification. If you are looking for an easy-to-use and well-tested library to translate between different formats, check out [BchAddr.js](https://github.com/ealmansi/bchaddrjs). ### Browser #### Script Tag You may include a script tag in your HTML and the `cashaddr` module will be defined globally on subsequent scripts. ```html ... ... ``` ## Documentation ### Generate and Browse Locally ```bsh $ npm run docs ``` ### Online Browse automatically generated jsdocs [online](https://emilio.almansi.me/cashaddrjs/module-cashaddr.html).