❤
npm
Sign UpSign In

rpgaddrjs

1.0.0 • Public • Published

RpgAddr.js: Rpgcoin general purpose address translation for Node.js and web browsers.

JavaScript Style Guide

JavaScript Style Guide

Plug & Play JavaScript library for all Rpgcoin address format translation needs. Easy-to-use, thoroughly tested, and feature complete.

Installation

Using NPM

$ npm install --save rpgaddrjs

Using Bower

$ bower install --save rpgaddrjs

Manually

You may also download the distribution file manually and place it within your third-party scripts directory: [dist/rpgaddrjs-{{ version }}.min.js](https://cdn.rawgit.com/RPGCoin/rpgaddrjs/master/dist/rpgaddrjs-{{ version }}.min.js).

Usage

In Node.js

var rpgaddr = require('rpgaddrjs');

Browser

Script Tag

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

<html>
  <head>
    ...
    <script src="https://cdn.rawgit.com/RPGCoin/rpgaddrjs/master/dist/rpgaddrjs-{{ version }}.min.js"></script>
  </head>
  ...
</html>

Code Examples

Supported formats, networks and address types.

var Format = rpgaddr.Format; // Legacy, Rpg2addr.
var Network = rpgaddr.Network; // Mainnet or Testnet.
var Type = rpgaddr.Type; // P2PKH or P2SH.

Test for address format.

var isLegacyAddress = rpgaddr.isLegacyAddress;
var isRpg2Address = rpgaddr.isRpg2Address;

isLegacyAddress('1B9UNtBfkkpgt8kVbwLN9ktE62QKnMbDzR')
isLegacyAddress('qph5kuz78czq00e3t85ugpgd7xmer5kr7c5f6jdpwk')
isRpg2Address('qph5kuz78czq00e3t85ugpgd7xmer5kr7c5f6jdpwk')
isRpg2Address('CScMwvXjdooDnGevHgfHjGWFi9cjk75Aaj')

Test for address network.

var isMainnetAddress = rpgaddr.isMainnetAddress;
var isTestnetAddress = rpgaddr.isTestnetAddress;

isMainnetAddress('1P238gziZdeS5Wj9nqLhQHSBK2Lz6zPSke')
isMainnetAddress('mnbGP2FeRsbgdQCzDT35zPWDcYSKm4wrcg')
isTestnetAddress('qqdcsl6c879esyxyacmz7g6vtzwjjwtznsggspc457')
isTestnetAddress('CeUvhjLnSgcxyedaUafcyo4Cw9ZPwGq9JJ')

Test for address type.

var isP2PKHAddress = rpgaddr.isP2PKHAddress;
var isP2SHAddress = rpgaddr.isP2SHAddress;

isP2PKHAddress('1Mdob5JY1yuwoj6y76Vf3AQpoqUH5Aft8z')
isP2PKHAddress('2NFGG7yRBizUANU48b4dASrnNftqsNwzSM1')
isP2SHAddress('H92i9XpREZiBscxGu6Vx3M8jNGBKqscBBB')
isP2SHAddress('CeUvhjLnSgcxyedaUafcyo4Cw9ZPwGq9JJ')

Detect address format.

var detectAddressFormat = rpgaddr.detectAddressFormat;

detectAddressFormat('qqdcsl6c879esyxyacmz7g6vtzwjjwtznsggspc457') // Format.Rpg2addr

Detect address network.

var detectAddressNetwork = rpgaddr.detectAddressNetwork;

detectAddressNetwork('1P238gziZdeS5Wj9nqLhQHSBK2Lz6zPSke') // Network.Mainnet
detectAddressNetwork('qqdcsl6c879esyxyacmz7g6vtzwjjwtznsggspc457') // Network.Testnet

Detect address type.

var detectAddressType = rpgaddr.detectAddressType;

detectAddressType('1P238gziZdeS5Wj9nqLhQHSBK2Lz6zPSke') // Type.P2PKH
detectAddressType('3NKpWcnyZtEKttoQECAFTnmkxMkzgbT4WX') // Type.P2SH

Translate address from any address format into a specific format.

var toLegacyAddress = rpgaddr.toLegacyAddress;
var toRpg2Address = rpgaddr.toRpg2Address;

toLegacyAddress('qph5kuz78czq00e3t85ugpgd7xmer5kr7c5f6jdpwk') // 1B9UNtBfkkpgt8kVbwLN9ktE62QKnMbDzR
toRpg2Address('1B9UNtBfkkpgt8kVbwLN9ktE62QKnMbDzR') // ravh5kuz78czq00e3t85ugpgd7xmer5kr7c5f6jdpwk

Documentation

Generate and Browse Locally

$ npm run docs

Online

Browse automatically generated jsdocs online.

Readme

Keywords

Package Sidebar

Install

npm i rpgaddrjs

Repository

github.com/RPGCoin/rpgaddrjs

Homepage

github.com/RPGCoin/rpgaddrjs#readme

Weekly Downloads

2

Version

1.0.0

License

MIT

Unpacked Size

1.35 MB

Total Files

40

Last publish

Collaborators

  • silence480
Try on RunKit
Report malware