cashaddrjs-slp

SLP & Bitcoin Cash cashaddr address format support for Node.js and web browsers.

0.2.12
latest
Source
npm

Version published: 5 years ago

Maintainers: 1

Created: 6 years ago

Source

SLP 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 and SLP.

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

Using Bower

$ bower install --save cashaddrjs-slp

Manually

You may also download the distribution file manually and place it within your third-party scripts directory: dist/cashaddrjs-0.2.9.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://cdn.rawgit.com/bitcoincashjs/cashaddrjs/master/dist/cashaddrjs-0.2.9.min.js"></script>
  </head>
  ...
</html>

Documentation

Generate and Browse Locally

$ npm run docs

Online

Browse automatically generated jsdocs online.

Keywords

FAQs

What is cashaddrjs-slp?

Is cashaddrjs-slp well maintained?

Package last updated on 31 Oct 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install