Have ideas to improve npm?Join in the discussion! »

    cashaddrjs
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/cashaddrjs package

    0.4.4 • Public • Published

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

    Build Status Coverage Status

    NPM

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

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

    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.

    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.4.4.min.js.

    Usage

    In Node.js

    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.

    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://unpkg.com/cashaddrjs@0.4.4/dist/cashaddrjs-0.4.4.min.js"></script>
      </head>
      ...
    </html>

    Documentation

    Generate and Browse Locally

    $ npm run docs
    

    Online

    Browse automatically generated jsdocs online.

    Install

    npm i cashaddrjs

    DownloadsWeekly Downloads

    14,717

    Version

    0.4.4

    License

    MIT

    Unpacked Size

    110 kB

    Total Files

    14

    Last publish

    Collaborators

    • avatar