Multicoin address validator for Bitcoin and other altcoins.
npm install trezor-address-validatorForked from ryanralph/altcoin-address.
File size is ~65 kB (minifed and gzipped).
npm install trezor-address-validator
$3
html
`API
##### validate (address [, currency = 'bitcoin'[, networkType = 'prod']])
###### Parameters
* address - Wallet address to validate.
* currency - Optional. Currency name or symbol, e.g.
(default), 'litecoin' or 'LTC'
* networkType - Optional. Use (default) to enforce standard address, 'testnet' to enforce testnet address and 'both' to enforce nothing.> Returns true if the address (string) is a valid wallet address for the crypto currency specified, see below for supported currencies.
##### getAddressType (address [, currency = 'bitcoin'[, networkType = 'prod']])
###### Parameters
* address - Wallet address to validate.
* currency - Optional. Currency name or symbol, e.g.
'bitcoin' (default), 'litecoin' or 'LTC'
* networkType - Optional. Use (default) to enforce standard address, 'testnet' to enforce testnet address and 'both' to enforce nothing.> Returns address type (
'address' | 'p2pkh' | 'p2wpkh' | 'p2wsh' | 'p2sh' | 'p2tr' | 'pw-unknown') of the address or undefined if the address is invalid.
$3
* 0x/zrx
'0x' or 'zrx'
* Aave/lend or 'lend'
* Abyss Token/abyss or 'abyss'
* AdEx/adx or 'adx'
* adToken/adt or 'adt'
* aelf/elf or 'elf'
* Aeron/arn or 'arn'
* Aeternity/ae or 'ae'
* Agrello/dlt or 'dlt'
* All Sports/soc or 'soc'
* Ambrosus/amb or 'amb'
* Ankr/ankr or 'ankr'
* AppCoins/appc or 'appc'
* Aragon/ant or 'ant'
* Arcblock/abt or 'abt'
* Ardor/ardr or 'ardr'
* ATLANT/atl or 'atl'
* Augur/rep or 'rep'
* AuroraCoin/aur or 'aur'
* aXpire/axpr or 'axpr'
* Bancor/bnt or 'bnt'
* Band Protocol/band or 'band'
* Bankex/bkx or 'bkx'
* Basic Attention Token/bat or 'bat'
* BeaverCoin/bvc or 'bvc'
* BetterBetting/betr or 'betr'
* Binance/bnb or 'bnb'
* Binance Smart Chain/bsc or 'bsc'
* Binance USD/busd or 'busd'
* BioCoin/bio or 'bio'
* Bitcoin/btc or 'btc'
* Bitcoin Diamond/bcd or 'bcd'
* Bitcoin SV/bsv or 'bsv'
* BitcoinCash/bch or 'bch'
* BitcoinGold/btg or 'btg'
* BitcoinPrivate/btcp or 'btcp'
* BitcoinZ/btcz or 'btcz'
* BitDegree/bdg or 'bdg'
* BitKan/kan or 'kan'
* BlitzPredict/xbp or 'xbp'
* Blockmason Credit Protocol/bcpt or 'bcpt'
* Blocktrade Token/btt or 'btt'
* BLOCKv/vee or 'vee'
* Blox/cdt or 'cdt'
* Bluzelle/blz or 'blz'
* Bread/brd or 'brd'
* BTU Protocol/btu or 'btu'
* Callisto/clo or 'clo'
* Cardano/ada or 'ada'
* Celer Network/celr or 'celr'
* Chainlink/link or 'link'
* Chiliz/chz or 'chz'
* Chronobank/time or 'time'
* Cindicator/cnd or 'cnd'
* Civic/cvc or 'cvc'
* Cocos-BCX/cocos or 'cocos'
* Coinlancer/cl or 'cl'
* COS/cos or 'cos'
* Cosmo Coin/cosm or 'cosm'
* Cosmos/atom or 'atom'
* Covesting/cov or 'cov'
* Cred/lba or 'lba'
* Crypterium/crpt or 'crpt'
* Crypto.com Coin/cro or 'cro'
* CryptoBossCoin/cbc or 'cbc'
* CryptoFranc/xchf or 'xchf'
* Daneel/dan or 'dan'
* Dash/dash or 'dash'
* Decentraland/mana or 'mana'
* Decred/dcr or 'dcr'
* Dent/dent or 'dent'
* Dentacoin/dcn or 'dcn'
* DigiByte/dgb or 'dgb'
* Digitex Futures/dgtx or 'dgtx'
* DigixDAO/dgd or 'dgd'
* District0x/dnt or 'dnt'
* Dock/dock or 'dock'
* DogeCoin/doge or 'doge'
* DomRaider/drt or 'drt'
* Dusk Network/dusk or 'dusk'
* Edgeless/edg or 'edg'
* Eidoo/edo or 'edo'
* Electrify.Asia/elec or 'elec'
* Enigma/eng or 'eng'
* Enjin Coin/enj or 'enj'
* EOS/eos or 'eos'
* Ethereum/eth or 'eth'
* EthereumClassic/etc or 'etc'
* Etherparty/fuel or 'fuel'
* EtherZero/etz or 'etz'
* Everex/evx or 'evx'
* Exchange Union/xuc or 'xuc'
* Expanse/exp or 'exp'
* Fantom/ftm or 'ftm'
* Fetch.ai/fet or 'fet'
* FirmaChain/fct or 'fct'
* FirstBlood/1st or '1st'
* Fortuna/fota or 'fota'
* FreiCoin/frc or 'frc'
* GameCredits/game or 'game'
* GarliCoin/grlc or 'grlc'
* Gemini Dollar/gusd or 'gusd'
* Genesis Vision/gvt or 'gvt'
* Gifto/gto or 'gto'
* Gnosis/gno or 'gno'
* Golem/gnt or 'gnt'
* Groestlcoin/grs or 'grs'
* Hedera Hashgraph/hbar or 'hbar'
* HedgeTrade/hedg or 'hedg'
* Holo/hot or 'hot'
* HOQU/hqx or 'hqx'
* Humaniq/hmq or 'hmq'
* Huobi Token/ht or 'ht'
* Hush/hush or 'hush'
* HyperSpace/xsc or 'xsc'
* ICON/icx or 'icx'
* iExec RLC/rlc or 'rlc'
* IHT Real Estate Protocol/iht or 'iht'
* Insolar/ins or 'ins'
* Internet of Services/IOST or 'IOST'
* Iota/iota or 'iota'
* IoTeX/iotx or 'iotx'
* Kcash/kcash or 'kcash'
* KEY/key or 'key'
* KickToken/kick or 'kick'
* Komodo/kmd or 'kmd'
* Kyber Network/knc or 'knc'
* Lambda/lamb or 'lamb'
* Lamden/tau or 'tau'
* LBRY Credits/lbc or 'lbc'
* LIFE/life or 'life'
* LinkEye/let or 'let'
* Lisk/lsk or 'lsk'
* LiteCoin/ltc or 'ltc'
* LockTrip/loc or 'loc'
* Loki/loki or 'loki'
* Loom Network/loom or 'loom'
* Loopring/lrc or 'lrc'
* Luniverse/luniverse or 'luniverse'
* Lunyr/lun or 'lun'
* Mainframe/mft or 'mft'
* Maker/mkr or 'mkr'
* Matchpool/gup or 'gup'
* Matic Network/matic or 'matic'
* MCO/mco or 'mco'
* Measurable Data Token/mdt or 'mdt'
* MegaCoin/mec or 'mec'
* Melon/mln or 'mln'
* Menlo One/one or 'one'
* Metal/mtl or 'mtl'
* Mithril/mith or 'mith'
* Moeda Loyalty Points/mda or 'mda'
* Molecular Future/mof or 'mof'
* MonaCoin/mona or 'mona'
* Monero/xmr or 'xmr'
* Monetha/mth or 'mth'
* Monolith/tkn or 'tkn'
* Multi-collateral DAI/dai or 'dai'
* Mysterium/myst or 'myst'
* NAGA/ngc or 'ngc'
* NameCoin/nmc or 'nmc'
* Nano/nano or 'nano'
* Nem/xem or 'xem'
* Neo/neo or 'neo'
* NeoGas/gas or 'gas'
* NetKoin/ntk or 'ntk'
* Nexo/nexo or 'nexo'
* Noah Coin/noah or 'noah'
* Nucleus Vision/ncash or 'ncash'
* Numeraire/nmr or 'nmr'
* NXT/nxt or 'nxt'
* OAX/oax or 'oax'
* Ocean Protocol/ocean or 'ocean'
* Odyssey/ocn or 'ocn'
* OmiseGO/omg or 'omg'
* Ontology/ont or 'ont'
* ORS Group/ors or 'ors'
* OST/ost or 'ost'
* Own/chx or 'chx'
* Patientory/ptoy or 'ptoy'
* Patron/pat or 'pat'
* Paxos Standard/pax or 'pax'
* Peculium/pcl or 'pcl'
* PeerCoin/ppc or 'ppc'
* Perlin/perl or 'perl'
* Pillar/plr or 'plr'
* PIVX/pivx or 'pivx'
* Po.et/poe or 'poe'
* Polymath/poly or 'poly'
* Populous/ppt or 'ppt'
* Power Ledger/powr or 'powr'
* Presearch/pre or 'pre'
* PrimeCoin/xpm or 'xpm'
* ProtoShares/pts or 'pts'
* PumaPay/pma or 'pma'
* Pundi X/npxs or 'npxs'
* Qtum/qtum or 'qtum'
* Quant/qnt or 'qnt'
* Quantstamp/qsp or 'qsp'
* QuarkChain/qkc or 'qkc'
* RaiBlocks/xrb or 'xrb'
* Raiden Network Token/rdn or 'rdn'
* Ravencoin/rvn or 'rvn'
* Refereum/rfr or 'rfr'
* Ren/ren or 'ren'
* Request/req or 'req'
* Revain/r or 'r'
* Ripio Credit Network/rcn or 'rcn'
* Ripple/xrp or 'xrp'
* Salt/salt or 'salt'
* Scopuly/sky or 'sky'
* Sentinel/sent or 'sent'
* SiaCashCoin/scc or 'scc'
* Siacoin/sc or 'sc'
* SingularDTV/sngls or 'sngls'
* SingularityNET/agi or 'agi'
* SIRIN LABS Token/srn or 'srn'
* SkinCoin/skin or 'skin'
* SnowGem/sng or 'sng'
* Solana/sol or 'sol'
* SolarCoin/slr or 'slr'
* SOLVE/solve or 'solve'
* SoMee.Social/ong or 'ong'
* SONM/snm or 'snm'
* Spendcoin/spnd or 'spnd'
* STASIS EURO/eurs or 'eurs'
* Status/snt or 'snt'
* STEEM/steem or 'steem'
* Stellar/xlm or 'xlm'
* Storj/storj or 'storj'
* Storm/storm or 'storm'
* Stox/stx or 'stx'
* Stratis/strat or 'strat'
* Streamr DATAcoin/data or 'data'
* Substratum/sub or 'sub'
* SunContract/snc or 'snc'
* Swarm City/swt or 'swt'
* SwftCoin/swftc or 'swftc'
* Synthetix Network/snx or 'snx'
* Syscoin/sys or 'sys'
* Tael/wabi or 'wabi'
* Telcoin/tel or 'tel'
* TEMCO/temco or 'temco'
* TenX/pay or 'pay'
* Tether/usdt or 'usdt'
* Tezos/xtz or 'xtz'
* Tierion/tnt or 'tnt'
* Time New Bank/tnb or 'tnb'
* Tripio/trio or 'trio'
* Tron/trx or 'trx'
* TrueUSD/tusd or 'tusd'
* USD Coin/usdc or 'usdc'
* USDT ERC-20/usdt20 or 'usdt20'
* Utrust/utk or 'utk'
* VeChain/ven or 'ven'
* VeChain Mainnet/vet or 'vet'
* Verge/xvg or 'xvg'
* VertCoin/vtc or 'vtc'
* VIBE/vibe or 'vibe'
* Viberate/vib or 'vib'
* VoteCoin/vot or 'vot'
* Waltonchain/wtc or 'wtc'
* Waves/waves or 'waves'
* WePower/wpr or 'wpr'
* WeTrust/trst or 'trst'
* Wings/wings or 'wings'
* YOU COIN/you or 'you'
* Zap/zap or 'zap'
* ZCash/zec or 'zec'
* ZClassic/zcl or 'zcl'
* ZenCash/zen or 'zen'
* Zilliqa/zil or 'zil'$3
#### Node
javascript
var WAValidator = require('trezor-address-validator');var valid = WAValidator.validate('1KFzzGtDdnq5hrwxXGjwVnKzRbvf8WVxck', 'BTC');
if(valid)
console.log('This is a valid address');
else
console.log('Address INVALID');
// This will log 'This is a valid address' to the console.
`javascript
var WAValidator = require('trezor-address-validator');var valid = WAValidator.validate('1KFzzGtDdnq5hrwxXGjwVnKzRbvf8WVxck', 'litecoin', 'testnet');
if(valid)
console.log('This is a valid address');
else
console.log('Address INVALID');
// As this is a invalid litecoin address 'Address INVALID' will be logged to console.
`javascript
var WAValidator = require('trezor-address-validator');var currency = WAValidator.findCurrency('xrp');
if(currency)
console.log('This currency exists');
else
console.log('Currency INVALID');
// As this is a valid currency symbol 'This currency exists' will be logged to console.
`javascript
var WAValidator = require('trezor-address-validator');var currency = WAValidator.findCurrency('random');
if(currency)
console.log('This currency exists');
else
console.log('Currency INVALID');
// As this is not a valid currency symbol 'Currency INVALID' will be logged to console.
`
#### Browser
html
`javascript
// WAValidator is exposed as a global (window.WAValidator)
var valid = WAValidator.validate('1KFzzGtDdnq5hrwxXGjwVnKzRbvf8WVxck', 'bitcoin');
if(valid)
alert('This is a valid address');
else
alert('Address INVALID');// This should show a pop up with text 'This is a valid address'.
``