add Nimiq support

Author: Developer

README.md

@@ -71,6 +71,8 @@ npm install wallet-address-validator
 * NEO/NEO, `'NEO'` or `'NEO'`
 * NeoGas/GAS, `'neogas'` or `'GAS'`
 
+* Nimiq/NIM, `'nimiq'` or `'NIM'`
+
 * Peercoin/PPCoin/PPC, `'peercoin'` or `'PPC'`
 * Primecoin/XPM, `'primecoin'` or `'XPM'`
 * Protoshares/PTS, `'protoshares'` or `'PTS'`

package.json

@@ -26,6 +26,7 @@
     "validator",
     "vertcoin",
     "nano",
+    "nimiq",
     "raiblocks",
     "javascript",
     "browser",

src/currencies.js

@@ -3,6 +3,7 @@ var ETHValidator = require('./ethereum_validator');
 var BTCValidator = require('./bitcoin_validator');
 var XMRValidator = require('./monero_validator');
 var NANOValidator = require('./nano_validator');
+var IBANValidator = require('./iban_validator');
 
 // defines P2PKH and P2SH address types for standard (prod) and testnet networks
 var CURRENCIES = [{
@@ -209,6 +210,12 @@ var CURRENCIES = [{
     name: 'raiblocks',
     symbol: 'xrb',
     validator: NANOValidator,
+},{
+    name: 'nimiq',
+    symbol: 'nim',
+    countryCode: 'NQ',
+    length: 36,
+    validator: IBANValidator,
 }];
 
 

src/iban_validator.js

@@ -0,0 +1,32 @@
+function ibanCheck(address) {
+    const num = address.split('').map(function(c) {
+        const code = c.toUpperCase().charCodeAt(0);
+        return code >= 48 && code <= 57 ? c : (code - 55).toString();
+    }).join('');
+    let tmp = '';
+
+    for (let i = 0; i < Math.ceil(num.length / 6); i++) {
+        tmp = (parseInt(tmp + num.substr(i * 6, 6)) % 97).toString();
+    }
+
+    return parseInt(tmp);
+}
+
+module.exports = {
+    isValidAddress: function (address, currency) {
+        currency = currency || {};
+        address = address.replace(/ /g, '');
+
+        if (address.substr(0, 2).toUpperCase() !== currency.countryCode) {
+            return false;
+        }
+        if (address.length !== currency.length) {
+            return false;
+        }
+        if (ibanCheck(address.substr(4) + address.substr(0, 4)) !== 1) {
+            return false;
+        }
+
+        return true;
+    }
+};

test/wallet_address_validator.js

@@ -382,6 +382,17 @@ describe('WAValidator.validate()', function () {
             valid('xrb_1q79ahdr36uqn38p5tp5sqwkn73rnpj1k8obtuetdbjcx37d5gahhd1u9cuh', 'nano');
             valid('nano_1q79ahdr36uqn38p5tp5sqwkn73rnpj1k8obtuetdbjcx37d5gahhd1u9cuh', 'nano');
         });
+
+        it('should return true for correct nimiq addresses', function () {
+            valid('NQ09 QCG8 HG0T NEBP 4DJN 81XV CJU2 9LY8 BVNT', 'nimiq');
+            valid('nq09 qcg8 hg0t nebp 4djn 81xv cju2 9ly8 bvnt', 'nimiq');
+            valid('NQ09QCG8HG0TNEBP4DJN81XVCJU29LY8BVNT', 'nimiq');
+            valid('nq09qcg8hg0tnebp4djn81xvcju29ly8bvnt', 'nimiq');
+            valid('NQ09 QCG8 HG0T NEBP 4DJN 81XV CJU2 9LY8 BVNT', 'NIM');
+            valid('nq09 qcg8 hg0t nebp 4djn 81xv cju2 9ly8 bvnt', 'NIM');
+            valid('NQ09QCG8HG0TNEBP4DJN81XVCJU29LY8BVNT', 'NIM');
+            valid('nq09qcg8hg0tnebp4djn81xvcju29ly8bvnt', 'NIM');
+        });
     });
 
     describe('invalid results', function () {
@@ -595,5 +606,15 @@ describe('WAValidator.validate()', function () {
             invalid('xrb_1111111112111111111111111111111111111111111111111111hifc8npp', 'nano');
             invalid('nano_111111111111111111111111111111111111111111111111111hifc8npp', 'nano');
         });
+
+        it('should return false for incorrect nimiq addresses', function () {
+            commonTests('nimiq');
+            invalid('NQ09 QCG8 HG0T NEBP 4DJN 81XV CJU2 9LY8 BVNX', 'nimiq');
+            invalid('NQ09QCG8HG0TNEBP4DJN81XVCJU29LY8BVNX', 'nimiq');
+            invalid('09 QCG8 HG0T NEBP 4DJN 81XV CJU2 9LY8 BVNT', 'nimiq');
+            invalid('09 qcg8 hg0t nebp 4djn 81xv cju2 9ly8 bvnt', 'nimiq');
+            invalid('09QCG8HG0TNEBP4DJN81XVCJU29LY8BVNT', 'nimiq');
+            invalid('09qcg8hg0tnebp4djn81xvcju29ly8bvnt', 'nimiq');
+        });
     });
 });