Wallet address validator for Bitcoin and other Altcoins.
npm install @swyftx/api-crypto-address-validatorForked from ognus/wallet-address-validator which was forked from ryanralph/altcoin-address.
Did you know? This package is under active development by Swyftx. Swyftx allows you to buy and sell Bitcoin, Etherium, Ripple and many more assets using Australian Dollars. Buy Bitcoin in Australia
File size is ~189.4 kB (minifed and gzipped - ~69.7% smaller).
#### Yarn
``bash`
yarn add @swyftx/api-crypto-address-validator
#### NPM
`bash`
npm install @swyftx/api-crypto-address-validator
#### Browser
`html`
#### Minified Packed Frontend
`typescript`
import walletAddressValidatorMinJs from '@swyftx/api-crypto-address-validator/dist/wallet-address-validator.min.js'
##### validate (address [, currency = 'bitcoin'[, networkType = 'prod' [, addressType = ['all']]])
###### 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.'legacy'
* addressType - Optional. Specifies what version of the address should be validated. Defaults to , but can be changed on a per asset basis.
> Returns true if the address (string) is a valid wallet address for the crypto currency specified, see below for supported currencies.
* 0x/zrx '0x' or 'zrx'
* Aave/lend or 'lend'
* AdEx/adx or 'adx'
* aelf/ELF or 'ELF'
* Aeternity/ae or 'ae'
* Algorand/algo or 'algo'
* Aragon/ant or 'ant'
* Ardor/ardr or 'ardr'
* Augur/rep or 'rep'
* AuroraCoin/aur or 'aur'
* Australian Dollars/aud or 'aud'
* Bancor/bnt or 'bnt'
* Bankex/bkx or 'bkx'
* BasicAttentionToken/bat or 'bat'
* BeaverCoin/bvc or 'bvc'
* BinanceCoin/bnb or 'bnb'
* BioCoin/bio or 'bio'
* Bitcoin/btc or 'btc'
* Bitcoin Diamond/bcd or 'bcd'
* BitcoinCash/bcc or 'bcc'
* BitcoinCash/bch or 'bch'
* BitcoinGold/btg or 'btg'
* BitcoinPrivate/btcp or 'btcp'
* BitcoinZ/btcz or 'btcz'
* Bitquence/bqx or 'bqx'
* Bitshares/bts or 'bts'
* BitTorrent/btt or 'btt'
* Blockstack/stx or 'stx'
* Callisto/clo or 'clo'
* Cardano/ada or 'ada'
* Chainlink/link or 'link'
* Civic/cvc or 'cvc'
* Cosmos/atom or 'atom'
* Dash/dash or 'dash'
* Decentraland/MANA or 'MANA'
* Decred/dcr or 'dcr'
* Dent/dent or 'dent'
* DigiByte/dgb or 'dgb'
* District0x/dnt or 'dnt'
* DogeCoin/doge or 'doge'
* Enigma/eng or 'eng'
* Enjin Coin/enj or 'enj'
* EOS/eos or 'eos'
* Ethereum/eth or 'eth'
* EthereumClassic/etc or 'etc'
* EtherZero/etz or 'etz'
* ETHOS/ethos or 'ethos'
* Expanse/exp or 'exp'
* FreiCoin/frc or 'frc'
* FunFair/fun or 'fun'
* GameCredits/game or 'game'
* GarliCoin/grlc or 'grlc'
* Gnosis/gno or 'gno'
* Golem/gnt or 'gnt'
* Golem/gnt or 'gnt'
* Hedera Hashgraph/hbar or 'hbar'
* Holo/HOT or 'HOT'
* Horizen/zen or 'zen'
* Hush/hush or 'hush'
* ICON/icx or 'icx'
* iExec RLC/RLC or 'RLC'
* iExec RLC/rlc or 'rlc'
* Internet of Services/IOST or 'IOST'
* Iota/iota or 'iota'
* Komodo/kmd or 'kmd'
* Lisk/lsk or 'lsk'
* LiteCoin/ltc or 'ltc'
* Matchpool/gup or 'gup'
* MegaCoin/mec or 'mec'
* Melon/mln or 'mln'
* Metal/mtl or 'mtl'
* Monacao/mco or 'mco'
* MonaCoin/mona or 'mona'
* Monero/xmr or 'xmr'
* NameCoin/nmc or 'nmc'
* Nano/nano or 'nano'
* NEM/xem or 'xem'
* Neo/neo or 'neo'
* NeoGas/gas or 'gas'
* Nexus/nxs or 'nxs'
* Numeraire/nmr or 'nmr'
* Odyssey/ocn or 'ocn'
* OmiseGO/omg or 'omg'
* Ontology/ont or 'ont'
* Ontology Gas/ong or 'ong'
* Paxos Standard Token/pax or 'pax'
* PeerCoin/ppc or 'ppc'
* PIVX/pivx or 'pivx'
* Polymath/poly or 'poly'
* Populous/ppt or 'ppt'
* PowerLedger/powr or 'powr'
* PrimeCoin/xpm or 'xpm'
* ProtoShares/pts or 'pts'
* Pundi X/npxs or 'npxs'
* Qtum/qtum or 'qtum'
* RaiBlocks/xrb or 'xrb'
* Ravencoin/rvn or 'rvn'
* RipioCreditNetwork/rcn or 'rcn'
* Ripple/xrp or 'xrp'
* Salt/salt or 'salt'
* Siacoin/sc or 'sc'
* SnowGem/sng or 'sng'
* SolarCoin/slr or 'slr'
* Status/snt or 'snt'
* STEEM/steem or 'steem'
* Stellar Lumens/xlm or 'xlm'
* Storj/storj or 'storj'
* Storm/storm or 'storm'
* Stratis/strat or 'strat'
* Substratum/sub or 'sub'
* Swarm City/swt or 'swt'
* Syscoin/sys or 'sys'
* TenX/pay or 'pay'
* Tether/usdt or 'usdt'
* Tezos/XTZ or 'XTZ'
* THETA/theta or 'theta'
* Tron/trx or 'trx'
* TrueUSD/tusd or 'tusd'
* USD Coin/usdc or 'usdc'
* VeChain/vet or 'vet'
* Verge/xvg or 'xvg'
* VertCoin/vtc or 'vtc'
* Viberate/vib or 'vib'
* VoteCoin/vot or 'vot'
* WaltonChain/wtc or 'wtc'
* Waves/waves or 'waves'
* Wings/wings or 'wings'
* ZCash/zec or 'zec'
* ZClassic/zcl or 'zcl'
* ZenCash/zen or 'zen'
* Zilliqa/zil or 'zil'
#### Node
`javascript
const WAValidator = require('@swyftx/api-crypto-address-validator')
const 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
const WAValidator = require('@swyftx/api-crypto-address-validator')
const 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.
`
#### Browser
`html`
`javascript
// WAValidator is exposed as a global (window.WAValidator)
const 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'.
``