Adding alternative way to specify currency: by symbol. Changing API, by moving testnet as separate param.

ognus · ognus · commit ce124815fb77 · 2015-05-28T18:04:20.000+12:00
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -11,6 +11,7 @@ module.exports = function(grunt) {
                         'bower_components/jssha/src/sha256.js',
                         'src/base58.js',
                         'src/crypto_utils.js',
+                        'src/currencies.js',
                         'src/wallet_address_validator.js'
                     ]
                 }
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@ Simple wallet address validator for validating Bitcoin and other altcoins addres
 
 Forked from [ryanralph/altcoin-address](https://github.com/ryanralph/altcoin-address).
 
-I forked it to remove all Node.js dependencies (crypro, Buffer etc.) to make it usable in the browser as well. I didn't use browserify to achieve smaller footprint, **file size is 3.9 kB (minifed and gzipped)**.
+I forked it to remove all Node.js dependencies (crypro, Buffer etc.) to make it usable in the browser as well. I didn't use browserify to achieve smaller footprint, **file size is 4.0 kB (minifed and gzipped)**.
 
 ## Installation
 
@@ -25,37 +25,43 @@ bower install wallet-address-validator
 
 ## API
 
-### validate (address [, currency])
+##### validate (address [, currency = 'bitcoin'[, networkType = 'prod']])
 
-> returns true if the address (string) is a valid wallet address for the crypto currency specified, see below for supported currencies.
->
-> if no options are specified it defaults to bitcoin
+###### 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. 
 
-### getAddressType (address)
+> Returns true if the address (string) is a valid wallet address for the crypto currency specified, see below for supported currencies.
 
-> returns address type (as 2 character hex string) if valid base58 address, otherwise null
+##### 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'`
-* Litecoin/LTC, `'litecoin'`
-* Peercoin/PPCoin/PPC, `'peercoin'`
-* Dogecoin/DOGE, `'dogecoin'`
-* BeaverCoin/BVC, `'beavercoin'`
-* Freicoin/FRC, `'freicoin'`
-* Protoshares/PTS, `'protoshares'`
-* Megacoin/MEC, `'megacoin'`
-* Primecoin/XPM, `'primecoin'`
-* Auroracoin/AUR, `'auroracoin'`
-* Namecoin/NMC, `'namecoin'`
+* Bitcoin/BTC, `'bitcoin'` or `'BTC'`
+* 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
 ```javascript
 var WAValidator = require('wallet-address-validator');
 
-var valid = WAValidator.validate('1KFzzGtDdnq5hrwxXGjwVnKzRbvf8WVxck', 'bitcoin');
+var valid = WAValidator.validate('1KFzzGtDdnq5hrwxXGjwVnKzRbvf8WVxck', 'BTC');
 if(valid)
 	console.log('This is a valid address');
 else
@@ -67,7 +73,7 @@ else
 ```javascript
 var WAValidator = require('wallet-address-validator');
 
-var valid = WAValidator.validate('1KFzzGtDdnq5hrwxXGjwVnKzRbvf8WVxck', 'litecoinTestnet');
+var valid = WAValidator.validate('1KFzzGtDdnq5hrwxXGjwVnKzRbvf8WVxck', 'litecoin', 'testnet');
 if(valid)
       console.log('This is a valid address');
 else
diff --git a/bower.json b/bower.json
@@ -1,15 +1,18 @@
 {
   "name": "wallet-address-validator",
   "description": "Wallet address validator for Bitcoin and other Altcoins.",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "keywords": [
     "bitcoin",
     "litecoin",
     "dogecoin",
     "altcoin",
     "address",
     "wallet",
-    "validator"
+    "validator",
+    "javascript",
+    "browser",
+    "nodejs"
   ],
   "license": "MIT",
   "homepage": "https://github.com/ognus/wallet-address-validator",
diff --git a/dist/wallet-address-validator.min.js b/dist/wallet-address-validator.min.js
diff --git a/package.json b/package.json
@@ -8,9 +8,12 @@
     "altcoin",
     "address",
     "wallet",
-    "validator"
+    "validator",
+    "javascript",
+    "browser",
+    "nodejs"
   ],
-  "version": "0.0.1",
+  "version": "0.1.0",
   "author": "Tomek Kolasa <tomek@kolasa.me>",
   "homepage": "https://github.com/ognus/wallet-address-validator",
   "license": "MIT",
diff --git a/src/currencies.js b/src/currencies.js
@@ -0,0 +1,72 @@
+(function (isNode) {
+    // defines P2PKH and P2SH address types for standard (prod) and testnet networks
+    var CURRENCIES = [{
+            name: 'bitcoin',
+            symbol: 'btc',
+            addressTypes: {prod: ['00', '05'], testnet: ['6f', 'c4']}
+        },{
+            name: 'litecoin',
+            symbol: 'ltc',
+            addressTypes: {prod: ['30', '05'], testnet: ['6f', 'c4']}
+        },{
+            name: 'peercoin',
+            symbol: 'ppc',
+            addressTypes: {prod: ['37', '75'], testnet: ['6f', 'c4']}
+        },{
+            name: 'dogecoin',
+            symbol: 'doge',
+            addressTypes: {prod: ['1e', '16'], testnet: ['71', 'c4']}
+        },{
+            name: 'beavercoin',
+            symbol: 'bvc',
+            addressTypes: {prod: ['19', '05'], testnet: ['6f', 'c4']}
+        },{
+            name: 'freicoin',
+            symbol: 'frc',
+            addressTypes: {prod: ['00', '05'], testnet: ['6f', 'c4']}
+        },{
+            name: 'protoshares',
+            symbol: 'pts',
+            addressTypes: {prod: ['38', '05'], testnet: ['6f', 'c4']}
+        },{
+            name: 'megacoin',
+            symbol: 'mec',
+            addressTypes: {prod: ['32', '05'], testnet: ['6f', 'c4']}
+        },{
+            name: 'primecoin',
+            symbol: 'xpm',
+            addressTypes: {prod: ['17', '53'], testnet: ['6f', 'c4']}
+        },{
+            name: 'auroracoin',
+            symbol: 'aur',
+            addressTypes: {prod: ['17', '05'], testnet: ['6f', 'c4']}
+        },{
+            name: 'namecoin',
+            symbol: 'nmc',
+            addressTypes: {prod: ['34'], testnet: []}
+        }];
+
+
+    var currencies = {
+        getByNameOrSymbol: function (currencyNameOrSymbol) {
+            var nameOrSymbol = currencyNameOrSymbol.toLowerCase();
+            for (var i = 0; i < CURRENCIES.length; i++) {
+                var currency = CURRENCIES[i];
+                if(currency.name === nameOrSymbol || currency.symbol === nameOrSymbol) {
+                    return currency;
+                }
+            }
+            return null;
+        }
+    };
+
+    // export currencies module
+    if(isNode) {
+        module.exports = currencies;
+    } else {
+        if(typeof window.WAValidator === 'undefined'){
+           window.WAValidator = {__imports: {}};
+        }
+        window.WAValidator.__imports.currencies = currencies;
+    }
+})(typeof module !== 'undefined' && typeof module.exports !== 'undefined');
diff --git a/src/wallet_address_validator.js b/src/wallet_address_validator.js
@@ -1,63 +1,19 @@
 (function (isNode) {
-    var base58, cryptoUtils;
+    var base58, cryptoUtils, currencies;
 
     if(isNode) {
         base58 = require('./base58');
         cryptoUtils = require('./crypto_utils');
+        currencies = require('./currencies');
     } else {
         var imports = window.WAValidator.__imports;
         base58 = imports.base58;
         cryptoUtils = imports.cryptoUtils;
+        currencies = imports.currencies;
     }
 
-    var DEFAULT_CURRENCY = 'bitcoin',
-        ADDRESS_TYPE = {
-            P2PKH: {
-                bitcoin: '00',      //  0 Decimal 1 prefix
-                bitcoinTestnet: '6f',   //111 Decimal mn prefix
-                litecoin: '30',         // 48 Decimal L prefix
-                litecoinTestnet: '6f',  //111 Decimal mn prefix
-                peercoin: '37',         // 55 Decimal P prefix
-                peercoinTestnet: '6f',  //111 Decimal mn prefix
-                dogecoin: '1e',         // 30 Decimal D prefix
-                dogecoinTestnet: '71',  //113 Decimal n prefix
-                beavercoin: '19',       // 25 Decimal B prefix
-                beavercoinTestnet: '6f',    //111 Decimal mn prefix
-                freicoin: '00',         //  0 Decimal 1 prefix
-                freicoinTestnet: '6f',  //111 Decimal mn prefix
-                protoshares: '38',      // 56 Decimal P prefix
-                protosharesTestnet: '6f', //111 Decimal mn prefix
-                megacoin: '32',     // 50 Decimal M prefix
-                megacoinTestnet: '6f',  //111 Decimal mn prefix
-                primecoin: '17',        // 23 Decimal A prefix
-                primecoinTestnet: '6f', //111 Decimal mn prefix
-                auroracoin: '17',       // 23 Decimal A prefix
-                auroracoinTestnet: '6f',    //111 Decimal mn prefix
-                namecoin: '34'
-            },
-            P2SH: {
-                bitcoin: '05',      //  5 Decimal 3 prefix
-                bitcoinTestnet: 'c4',   //196 Decimal 2 prefix
-                litecoin: '05',     //  5 Decimal 3 prefix
-                litecoinTestnet: 'c4',  //196 Decimal 2 prefix
-                peercoin: '75',     //117 Decimal p prefix
-                peercoinTestnet: 'c4',  //196 Decimal 2 prefix
-                dogecoin: '16',     //22 Decimal 9A prefix
-                dogecoinTestnet: 'c4',  //196 Decimal 2 prefix
-                beavercoin: '05',       //  5 Decimal 3 prefix
-                beavercoinTestnet: 'c4',    //196 Decimal 2 prefix
-                freicoin: '05',     //  5 Decimal 3 prefix
-                freicoinTestnet: 'c4',  //196 Decimal 2 prefix
-                protoshares: '05',      //  5 Decimal 3 prefix
-                protosharesTestnet: 'c4',//196 Decimal 2 prefix
-                megacoin: '05',     //  5 Decimal 3 prefix
-                megacoinTestnet: 'c4',  //196 Decimal 2 prefix
-                primecoin: '53',        // 83 Decimal a prefix
-                primecoinTestnet: 'c4',  //196 Decimal 2 prefix
-                auroracoin: '05',       // 83 Decimal a prefix
-                auroracoinTestnet: 'c4' //196 Decimal 2 prefix
-            }
-        };
+    var DEFAULT_CURRENCY_NAME = 'bitcoin',
+        DEFAULT_NETWORK_TYPE = 'prod';
 
     var WAValidator = {
         getAddressType: function (address) {
@@ -83,13 +39,21 @@
             return checksum === goodChecksum ? cryptoUtils.toHex(decoded.slice(0, 1)) : null;
         },
 
-        validate: function (address, currency) {
-            currency = currency || DEFAULT_CURRENCY;
-            var addressType = this.getAddressType(address);
-            var correctP2PKH = addressType === ADDRESS_TYPE.P2PKH[currency];
-            var correctP2SH = addressType === ADDRESS_TYPE.P2SH[currency];
-            return correctP2PKH || correctP2SH
-                
+        validate: function (address, currencyNameOrSymbol, networkType) {
+            currencyNameOrSymbol = currencyNameOrSymbol || DEFAULT_CURRENCY_NAME;
+            networkType = networkType || DEFAULT_NETWORK_TYPE;
+
+            var correctAddressTypes,
+                currency = currencies.getByNameOrSymbol(currencyNameOrSymbol),
+                addressType = this.getAddressType(address);
+            
+            if(networkType === 'prod' || networkType === 'testnet'){
+                correctAddressTypes = currency.addressTypes[networkType]
+            } else {
+                correctAddressTypes = currency.addressTypes.prod.concat(currency.addressTypes.testnet);
+            }
+
+            return correctAddressTypes.indexOf(addressType) >= 0;
         }
     };
 
diff --git a/test/wallet_address_validator.js b/test/wallet_address_validator.js

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ module.exports = function(grunt) {`
`11`	`11`	`'bower_components/jssha/src/sha256.js',`
`12`	`12`	`'src/base58.js',`
`13`	`13`	`'src/crypto_utils.js',`
	`14`	`+ 'src/currencies.js',`
`14`	`15`	`'src/wallet_address_validator.js'`
`15`	`16`	`]`
`16`	`17`	`}`