Update README, bump version to 0.4.0

Author: martinboehm

README.md

@@ -28,6 +28,15 @@ npm install trezor-address-validator
 
 > Returns true if the address (string) is a valid wallet address for the crypto currency specified, see below for supported currencies.
 
+
+##### getAddressType (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 address type (`'address' | 'p2pkh' | 'p2wpkh' | 'p2wsh' | 'p2sh' | 'p2tr' | 'pw-unknown'`) of the address or `undefined` if the address is invalid.
 ### Supported crypto currencies
 
 * 0x/zrx `'0x'` or `'zrx'`
@@ -57,6 +66,7 @@ npm install trezor-address-validator
 * BeaverCoin/bvc `'BeaverCoin'` or `'bvc'`
 * BetterBetting/betr `'BetterBetting'` or `'betr'`
 * Binance/bnb `'Binance'` or `'bnb'`
+* Binance Smart Chain/bsc `'Binance Smart Chain'` or `'bsc'`
 * Binance USD/busd `'Binance USD'` or `'busd'`
 * BioCoin/bio `'BioCoin'` or `'bio'`
 * Bitcoin/btc `'Bitcoin'` or `'btc'`

dist/wallet-address-validator.js

@@ -13590,12 +13590,8 @@ const addressType = {
     WITNESS_UNKNOWN: 'p2w-unknown',
 };
 
-function numberToHex(number) {
-    var hex = Math.round(number).toString(16)
-    if (hex.length === 1) {
-        hex = '0' + hex
-    }
-    return hex
+function numberToHex(number, sizeInBytes) {
+    return Math.round(number).toString(16).padStart(sizeInBytes * 2, '0');
 }
 
 function isHexChar(c) {
@@ -13663,10 +13659,11 @@ function hexStr2byteArray(str) {
 }
 
 module.exports = {
+    numberToHex,
     toHex: function (arrayOfBytes) {
         var hex = '';
         for (var i = 0; i < arrayOfBytes.length; i++) {
-            hex += numberToHex(arrayOfBytes[i]);
+            hex += numberToHex(arrayOfBytes[i], 1);
         }
         return hex;
     },
@@ -14910,11 +14907,7 @@ var CURRENCIES = [
         name: 'Zilliqa',
         symbol: 'zil',
         validator: ZILValidator
-	}, {
-        name: 'Binance Smart Chain',
-        symbol: 'bsc',
-        validator: ETHValidator,
-    }
+	}
 ];
 
 
@@ -15377,50 +15370,42 @@ module.exports = {
 
 },{"../src/crypto/utils":144}],159:[function(require,module,exports){
 const { addressType } = require('../src/crypto/utils');
-var baseX = require('base-x');
-var crc = require('crc');
-var cryptoUtils = require('./crypto/utils');
+const baseX = require('base-x');
+const crc = require('crc');
+const cryptoUtils = require('./crypto/utils');
 
- var ALPHABET = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567';
+const ALPHABET = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567';
 
- var base32 = baseX(ALPHABET);
-var regexp = new RegExp('^[' + ALPHABET + ']{56}$');
-var ed25519PublicKeyVersionByte = (6 << 3);
+const base32 = baseX(ALPHABET);
+const regexp = new RegExp('^[' + ALPHABET + ']{56}$');
+const ed25519PublicKeyVersionByte = (6 << 3);
 
- function swap16(number) {
-    var lower = number & 0xFF;
-    var upper = (number >> 8) & 0xFF;
+function swap16(number) {
+    const lower = number & 0xFF;
+    const upper = (number >> 8) & 0xFF;
     return (lower << 8) | upper;
 }
 
- function numberToHex(number) {
-    var hex = number.toString(16);
-    if(hex.length % 2 === 1) {
-        hex = '0' + hex;
-    }
-    return hex;
-}
-
- module.exports = {
+module.exports = {
     isValidAddress: function (address) {
         if (regexp.test(address)) {
             return this.verifyChecksum(address);
         }
 
-         return false;
+        return false;
     },
 
      verifyChecksum: function (address) {
-        // based on https://github.com/stellar/js-stellar-base/blob/master/src/strkey.js#L126
-        var bytes = base32.decode(address);
+        // based on https://github.com/stellar/js-stellar-base/blob/master/src/strkey.js
+        const bytes = base32.decode(address);
         if (bytes[0] !== ed25519PublicKeyVersionByte) {
             return false;
         }
 
-         var computedChecksum = numberToHex(swap16(crc.crc16xmodem(bytes.slice(0, -2))));
-        var checksum = cryptoUtils.toHex(bytes.slice(-2));
-
-         return computedChecksum === checksum
+        const payload = bytes.slice(0, -2);
+        const checksum = cryptoUtils.toHex(bytes.slice(-2));
+        const computedChecksum = cryptoUtils.numberToHex(swap16(crc.crc16xmodem(payload)), 2);
+        return computedChecksum === checksum;
     },
 
     getAddressType: function (address, currency, networkType) {

dist/wallet-address-validator.min.js

@@ -35,7 +35,7 @@
     "browser",
     "nodejs"
   ],
-  "version": "0.3.22",
+  "version": "0.4.0",
   "author": "Martin <martin.bohm@satoshilabs.com>",
   "homepage": "https://github.com/trezor/trezor-address-validator",
   "license": "MIT",

package.json

@@ -1193,11 +1193,7 @@ var CURRENCIES = [
         name: 'Zilliqa',
         symbol: 'zil',
         validator: ZILValidator
-	}, {
-        name: 'Binance Smart Chain',
-        symbol: 'bsc',
-        validator: ETHValidator,
-    }
+	}
 ];
 
 

src/currencies.js

@@ -2,7 +2,7 @@ declare module 'trezor-address-validator' {
     export interface Currency {
         name: string,
         symbol: string,
-    };
+    }
     export type AddressType = 'address' | 'p2pkh' | 'p2wpkh' | 'p2wsh' | 'p2sh' | 'p2tr' | 'pw-unknown';
     export function validate(address: string, currencyNameOrSymbol?: string, networkType?: string): boolean;
     export function getAddressType(address: string, currencyNameOrSymbol?: string, networkType?: string): AddressType | undefined;