crypto-wallet-address-validator
Simple wallet address validator for validating Bitcoin and other altcoins addresses in Node.js and browser.
Forked from ivands/crypto-address-validator
I forked it to include the new Litecoin address prefix format and to add bitcoin cash support, file size is 4.0 kB (minifed and gzipped).
Installation
Node
npm install crypto-wallet-address-validator
Browser
Using bower
bower install crypto-wallet-address-validator
API
validate (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
'prod'
(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)
Parameters
- address - Wallet address.
Returns address type (as 2 character hex string) if valid base58 address, otherwise null.
Supported crypto currencies
- Bitcoin/BTC,
'bitcoin'
or'BTC'
- Bcash/BCH,
'bcash'
or'BCH'
- Litecoin/LTC,
'litecoin'
or'LTC'
- Peercoin/PPCoin/PPC,
'peercoin'
or'PPC'
- Dogecoin/DOGE,
'dogecoin'
or'DOGE'
- BeaverCoin/BVC,
'beavercoin'
or'BVC'
- Freicoin/FRC,
'freicoin'
or'FRC'
- Protoshares/PTS,
'protoshares'
or'PTS'
- Megacoin/MEC,
'megacoin'
or'MEC'
- Primecoin/XPM,
'primecoin'
or'XPM'
- Auroracoin/AUR,
'auroracoin'
or'AUR'
- Namecoin/NMC,
'namecoin'
or'NMC'
Usage example
Node
var WAValidator = ; var valid = WAValidator;ifvalid console;else console; // This will log 'This is a valid address' to the console.
var WAValidator = ; var valid = WAValidator;ifvalid console;else console; // As this is a invalid litecoin address 'Address INVALID' will be logged to console.
Browser
// WAValidator is exposed as a global (window.WAValidator)var valid = WAValidator;ifvalid ;else ; // This should show a pop up with text 'This is a valid address'.