Multicoin address validator for Bitcoin and other Altcoins.
npm install @lamassu/multicoin-address-validator
Forked from christsim/altcoin-address.
File size is ~17 kB (minifed and gzipped).
npm install multicoin-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.
* chainType - Optional. Specify the chainType, eg 'ethereum'. If the given currency is not found but the chainType is, the validator for that chainType will be used, thus allowing unspecified tokens to be validated.> Returns true if the address (string) is a valid wallet address for the crypto currency specified, see below for supported currencies.
$3
* 0x/zrx
'0x' or 'zrx'
* Aave Coin/aave or 'aave'
* Algorand/algo or 'algo'
* Apecoin/ape or 'ape'
* API3/api3 or 'api3'
* Aptos/apt or 'apt'
* Aragon/ant or 'ant'
* Arbitrum/arb or 'arb'
* Arbitrum/arb or 'arb'
* Augur/rep or 'rep'
* AugurV2/repv2 or 'repv2'
* AuroraCoin/aur or 'aur'
* Avalanche/avax or 'avax'
* Axie Infinity/axs or 'axs'
* Bancor/bnt or 'bnt'
* Band Protocol/band or 'band'
* Bankex/bkx or 'bkx'
* Basic Attention Token/bat or 'bat'
* BeaverCoin/bvc or 'bvc'
* Berachain/bera or 'bera'
* Biconomy/bico or 'bico'
* Binance/bnb or 'bnb'
* BinanceSmartChain/bnb or 'bnb'
* BioCoin/bio or 'bio'
* Bitcoin/btc or 'btc'
* Bitcoin SV/bsv or 'bsv'
* BitcoinCash/bch or 'bch'
* BitcoinGold/btg or 'btg'
* BitcoinPrivate/btcp or 'btcp'
* BitcoinZ/btcz or 'btcz'
* BlockTrade/btt or 'btt'
* Blur/blur or 'blur'
* Bonk/bonk or 'bonk'
* BTU Protocol/btu or 'btu'
* Callisto/clo or 'clo'
* Cardano/ada or 'ada'
* Celo/celo or 'celo'
* Chainlink/link or 'link'
* Chiliz/chz or 'chz'
* Civic/cvc or 'cvc'
* Compound/comp or 'comp'
* Cred/lba or 'lba'
* Crypto.com Coin/cro or 'cro'
* Curve DAO/crv or 'crv'
* CUSD/cusd or 'cusd'
* Dash/dash or 'dash'
* Decentraland/mana or 'mana'
* Decred/dcr or 'dcr'
* DigiByte/dgb or 'dgb'
* District0x/dnt or 'dnt'
* DogeCoin/doge or 'doge'
* Enjin Coin/enj or 'enj'
* EOS/eos or 'eos'
* Ethereum/eth or 'eth'
* Ethereum Name Service/ens or 'ens'
* EthereumClassic/etc or 'etc'
* EthereumPow/ethw or 'ethw'
* EtherZero/etz or 'etz'
* Expanse/exp or 'exp'
* Fetch.ai/fet or 'fet'
* FirmaChain/fct or 'fct'
* Flare/flr or 'flr'
* FreiCoin/frc or 'frc'
* GameCredits/game or 'game'
* GarliCoin/grlc or 'grlc'
* Gnosis/gno or 'gno'
* Golem/glm or 'glm'
* Golem (GNT)/gnt or 'gnt'
* Hashflow/hft or 'hft'
* Hedera/hbar or 'hbar'
* HedgeTrade/hedg or 'hedg'
* Hush/hush or 'hush'
* HyperSpace/xsc or 'xsc'
* iExec RLC/rlc or 'rlc'
* Illuvium/ilv or 'ilv'
* Immutable/imx or 'imx'
* Injective/inj or 'inj'
* Komodo/kmd or 'kmd'
* LBRY Credits/lbc or 'lbc'
* Lido DAO Token/ldo or 'ldo'
* LiteCoin/ltc or 'ltc'
* loki/loki or 'loki'
* Loom Network/loom or 'loom'
* Magic/magic or 'magic'
* Maker/mkr or 'mkr'
* Marlin/pond or 'pond'
* Mask Network/mask or 'mask'
* Matchpool/gup or 'gup'
* Matic/matic or 'matic'
* MegaCoin/mec or 'mec'
* Melon/mln or 'mln'
* Metal/mtl or 'mtl'
* Monero/xmr or 'xmr'
* Multi-collateral DAI/dai or 'dai'
* NameCoin/nmc or 'nmc'
* Nano/nano or 'nano'
* Nem/xem or 'xem'
* Neo/neo or 'neo'
* NeoGas/gas or 'gas'
* Numeraire/nmr or 'nmr'
* Ocean Protocol/ocean or 'ocean'
* Odyssey/ocn or 'ocn'
* OmiseGO/omg or 'omg'
* Onyx Protocol/xcn or 'xcn'
* Optimism/op or 'op'
* Origin Protocol/ogn or 'ogn'
* Paxos/pax or 'pax'
* PayPal USD/pyusd or 'pyusd'
* PeerCoin/ppc or 'ppc'
* PIVX/pivx or 'pivx'
* Polkadot/dot or 'dot'
* Polymath/poly or 'poly'
* PrimeCoin/xpm or 'xpm'
* ProtoShares/pts or 'pts'
* Qtum/qtum or 'qtum'
* Quant/qnt or 'qnt'
* Quantum Resistant Ledger/qrl or 'qrl'
* RaiBlocks/xrb or 'xrb'
* Ripio Credit Network/rcn or 'rcn'
* Ripple/xrp or 'xrp'
* Salt/salt or 'salt'
* Serve/serv or 'serv'
* Siacoin/sc or 'sc'
* Skale/skl or 'skl'
* SnowGem/sng or 'sng'
* Solana/sol or 'sol'
* SolarCoin/slr or 'slr'
* SOLVE/solve or 'solve'
* Sonic/s or 's'
* Spendcoin/spnd or 'spnd'
* Status/snt or 'snt'
* Stellar/xlm or 'xlm'
* Storj/storj or 'storj'
* Storm/storm or 'storm'
* StormX/stmx or 'stmx'
* Story/ip or 'ip'
* SuperVerse/super or 'super'
* Swarm City/swt or 'swt'
* Synthetix Network/snx or 'snx'
* Tap/xtp or 'xtp'
* Tellor/trb or 'trb'
* TEMCO/temco or 'temco'
* TenX/pay or 'pay'
* Tether/usdt or 'usdt'
* Tezos/xtz or 'xtz'
* The Graph/grt or 'grt'
* The Sandbox/sand or 'sand'
* Tron/trx or 'trx'
* TrueUSD/tusd or 'tusd'
* Unifi Protocol DAO/unfi or 'unfi'
* Uniswap Coin/uni or 'uni'
* USD Coin/usdc or 'usdc'
* VeChain/vet or 'vet'
* VertCoin/vtc or 'vtc'
* Viberate/vib or 'vib'
* VoteCoin/vot or 'vot'
* Vulcan Forged PYR/pyr or 'pyr'
* Waves/waves or 'waves'
* Wings/wings or 'wings'
* Yearn.finance/yfi or 'yfi'
* ZCash/zec or 'zec'
* ZClassic/zcl or 'zcl'
* ZenCash/zen or 'zen'$3
#### Node
javascript
var WAValidator = require('multicoin-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('multicoin-address-validator');var valid = WAValidator.validate('0xdbF03B407c01E7cD3CBea99509d93f8DDDC8C6FB', 'UNKNOWN TOKEN', {chainType: 'ethereum'});
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('multicoin-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('multicoin-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('multicoin-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'.
``