@ensdomains/address-encoder

address-encoder

This typescript library encodes and decodes address formats for various cryptocurrencies.

Text-format addresses are decoded into their native binary representations, and vice-versa. In the case of Bitcoin-derived chains, this means their scriptPubKey; for Ethereum-derived chains this is their hash.

This library was written for use with EIP 2304, but may be useful for anyone looking for a general purpose cryptocurrency address codec.

Installation

Using NPM

npm install --save @ensdomains/address-encoder

Usage

import { formatsByName, formatsByCoinType } from '@ensdomains/address-encoder';

const data = formatsByName['BTC'].decoder('1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa');
console.log(data.toString('hex')); // 76a91462e907b15cbf27d5425399ebf6f0fb50ebb88f1888ac
const addr = formatsByCoinType[0].encoder(data);
console.log(addr); // 1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa

Supported cryptocurrencies

This library currently supports the following cryptocurrencies and address formats (ordered alphabetically):

• ADA (bech32)
• AIB (base58check P2PKH and P2SH)
• ALGO (checksummed-base32)
• ARK (base58check)
• ATOM (bech32)
• BCH (base58check and cashAddr; decodes to cashAddr)
• BNB (bech32)
• BPS (base58check P2PKH and P2SH)
• BTC (base58check P2PKH and P2SH, and bech32 segwit)
• CCA (base58check P2PKH and P2SH)
• CCXX (base58check P2PKH and P2SH, and bech32 segwit)
• CELO (checksummed-hex)
• DASH (base58check P2PKH and P2SH)
• DCR (base58, no check)
• DIVI (base58check P2PKH and P2SH)
• DOGE (base58check P2PKH and P2SH)
• DOT (ss58)
• EGLD (bech32)
• ELA (base58)
• EOS
• ETC (checksummed-hex)
• ETH (checksummed-hex)
• FIL (base10 + leb128 and base32 + blake2b checksum)
• HBAR
• HIVE (base58+ripemd160-checksum)
• HNS
• ICX
• IOTX (bech32)
• KSM (ss58)
• LRG (base58check P2PKH and P2SH)
• LTC (base58check P2PHK and P2SH, and bech32 segwit)
• MONA (base58check P2PKH and P2SH, and bech32 segwit)
• NANO (nano-base32)
• NEM(XEM) (base32)
• NEO (base58check)
• ONE (bech32)
• ONT (base58check)
• PPC (base58check P2PKH and P2SH)
• QTUM (base58check)
• RDD (base58check P2PKH and P2SH)
• RSK (checksummed-hex)
• SOL (base58, no check)
• STEEM (base58+ripemd160-checksum)
• SYS (base58check P2PKH and P2SH, and bech32 segwit)
• TRX (base58check)
• VET (checksummed-hex)
• XDAI (checksummed-hex)
• XLM (ed25519 public key)
• XRP (base58check-ripple)
• XTZ (base58check)
• ZEC (transparent addresses: base58check P2PKH and P2SH, and Sapling shielded payment addresses: bech32; doesn't support Sprout shielded payment addresses)
• ZIL (bech32)

PRs to add additional chains and address types are welcome.