multichain-address-validator 0.0.1

package/.editorconfig

@@ -0,0 +1,10 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

package/.travis.yml

@@ -0,0 +1,11 @@
+sudo: required
+addons:
+    chrome: stable
+language: node_js
+node_js:
+    - "16"
+    - "stable"
+before_install:
+    - npm install -g yarn --cache-min 999999999
+install:
+    - yarn

package/.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Mocha Tests",
+            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+            "args": [
+                "-u",
+                "tdd",
+                "--timeout",
+                "999999",
+                "--colors",
+                "${workspaceFolder}/test"
+            ],
+            "internalConsoleOptions": "openOnSessionStart"
+        }
+    ]
+}

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Roman Shtylman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,87 @@
+# multichain address validator
+Simple blockchain address validator for validating Bitcoin and other blockchain addresses **Node.js and browser**.
+
+[![Build Status](https://travis-ci.org/christsim/multicoin-address-validator.svg?branch=master)](https://travis-ci.org/christsim/multicoin-address-validator)
+
+## Installation
+
+### NPM
+```
+npm install multichain-address-validator
+```
+
+### Browser
+```html
+<script src="dist/multichain-address-validator.bundle.min.js"></script>
+```
+
+## API
+
+##### validate (address, chain)
+
+###### Parameters
+* address - blockchain address to validate
+* chain - blockchain name or object with networkType (mainnet or testnet)
+
+> Returns true if the address is a valid wallet address for the blockchain specified or throws if validator could not be found for chain
+
+### Supported blockchains
+
+* Algorand: `algorand`
+* Bitcoin: `bitcoin`, `btc`, `omni`
+* Bitcoin Cash: `bitcoin-cash`, `bitcoincash`, `bitcoin cash`, `bch`
+* Cardano: `cardano`, `ada`
+* Dogecoin: `dogecoin`, `doge`
+* EOS: `eos`
+* Etherum: `ethereum`, `eth`, `erc20`, `flare`, `avalanche`, `avalanche-c`, `bsc`, `bnb`, `binance`
+* Litecoin: `litecoin`, `ltc`
+* Monero: `monero`
+* Nano: `nano`
+* NEM: `nem`
+* Polkadot: `polkadot`
+* Ripple: `ripple', `xrp`
+* Sia: `sia`
+* Solana: `solana`, `spl`
+* Tezos: `tezos`
+* Tron: `tron`, `trc20`
+* XLM: `xlm`, `stellar`
+
+### Usage example
+
+#### Node
+```javascript
+import { validate } from 'multichain-address-validator'
+
+const valid = 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
+import { validate } from 'multichain-address-validator'
+
+const valid = validate('0xdbF03B407c01E7cD3CBea99509d93f8DDDC8C6FB', 'ethereum');
+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
+import { validate } from 'multichain-address-validator'
+
+const valid = validate('1KFzzGtDdnq5hrwxXGjwVnKzRbvf8WVxck', { chain: 'litecoin', networkType: '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.
+```
+

package/config/esbuild.inject.js

@@ -0,0 +1 @@
+export let Buffer = require("buffer").Buffer

package/config/esbuild.ts

@@ -0,0 +1,14 @@
+import * as esbuild from 'esbuild';
+
+const buildResult = esbuild.buildSync({
+    entryPoints: ['src/multichain-address-validator.ts'],
+    outfile: 'dist/multichain-address-validator.bundle.min.js',
+    bundle: true,
+    minify: true,
+    inject: ['./config/esbuild.inject.js'],
+    globalName: 'MCAV',
+    metafile: true,
+})
+
+const metafileInfo = esbuild.analyzeMetafileSync(buildResult.metafile)
+console.log(metafileInfo)

package/dist/chain-validators.d.ts

@@ -0,0 +1,2 @@
+import { Chain, Validator } from './types.js';
+export declare function getValidatorForChain(chain: Chain): Validator | undefined;

package/dist/chain-validators.js

@@ -0,0 +1,98 @@
+import { NetworkType } from './types.js';
+import { AlgorandValidator, BCHValidator, BTCValidator, CardanoValidator, EOSValidator, ETHValidator, MoneroValidator, NanoValidator, NemValidator, PolkadotValidator, RippleValidator, SiaValidator, SolanaValidator, TezosValidator, TronValidator, XLMValidator, } from './validators/index.js';
+const chainValidators = {
+    algorand: { validator: AlgorandValidator },
+    bitcoin: {
+        alternatives: ['btc', 'omni'],
+        validator: {
+            mainnet: BTCValidator({
+                addressTypes: ['00', '05'],
+                bech32Hrp: ['bc'],
+            }),
+            testnet: BTCValidator({
+                addressTypes: ['6f', 'c4', '3c', '26'],
+                bech32Hrp: ['tb'],
+            }),
+        },
+    },
+    'bitcoincash': {
+        alternatives: ['bch', 'bitcoin-cash', 'bitcoin cash'],
+        validator: {
+            mainnet: BCHValidator({
+                addressTypes: ['00', '05'],
+                bech32Hrp: ['bc'],
+                networkType: NetworkType.MainNet,
+            }),
+            testnet: BCHValidator({
+                addressTypes: ['6f', 'c4', '3c', '26'],
+                bech32Hrp: ['tb'],
+                networkType: NetworkType.TestNet,
+            }),
+        }
+    },
+    cardano: {
+        alternatives: ['ada'],
+        validator: CardanoValidator,
+    },
+    doge: {
+        alternatives: ['dogecoin'],
+        validator: {
+            mainnet: BTCValidator({ addressTypes: ['1e', '16'] }),
+            testnet: BTCValidator({ addressTypes: ['71', 'c4'] }),
+        }
+    },
+    eos: { validator: EOSValidator },
+    ethereum: {
+        alternatives: ['eth', 'erc20', 'flare', 'avalanche', 'avalanche-c', 'bsc', 'bnb', 'binance'],
+        validator: ETHValidator
+    },
+    litecoin: {
+        alternatives: ['ltc'],
+        validator: {
+            mainnet: BTCValidator({
+                addressTypes: ['30', '05', '32'],
+                bech32Hrp: ['ltc'],
+            }),
+            testnet: BTCValidator({
+                addressTypes: ['6f', 'c4', '3a'],
+                bech32Hrp: ['tltc']
+            })
+        }
+    },
+    monero: {
+        validator: {
+            mainnet: MoneroValidator(NetworkType.MainNet),
+            testnet: MoneroValidator(NetworkType.TestNet),
+        }
+    },
+    nem: { validator: NemValidator },
+    nano: { validator: NanoValidator },
+    polkadot: { validator: PolkadotValidator },
+    ripple: {
+        alternatives: ['xrp'],
+        validator: RippleValidator,
+    },
+    sia: { validator: SiaValidator },
+    solana: {
+        alternatives: ['spl'],
+        validator: SolanaValidator,
+    },
+    tron: {
+        alternatives: ['trc20'],
+        validator: TronValidator(),
+    },
+    tezos: { validator: TezosValidator },
+    xlm: {
+        alternatives: ['stellar'],
+        validator: XLMValidator,
+    },
+};
+export function getValidatorForChain(chain) {
+    const chainName = chain.chain || chain;
+    const networkType = chain.networkType || NetworkType.MainNet;
+    const key = Object.keys(chainValidators).find(key => key.toUpperCase() === chainName.toUpperCase() || chainValidators[key]
+        ?.alternatives
+        ?.map(alternative => alternative.toUpperCase())
+        ?.includes(chainName.toUpperCase()));
+    return chainValidators[key]?.validator[networkType] || chainValidators[key]?.validator;
+}

package/dist/crypto/base32.d.ts

@@ -0,0 +1,5 @@
+declare const _default: {
+    b32decode: (s: string) => Uint8Array;
+    b32encode: (s: string) => string;
+};
+export default _default;

package/dist/crypto/base32.js

@@ -0,0 +1,64 @@
+const alphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567";
+/**
+* Encode a string to base32
+*/
+const b32encode = function (s) {
+    const parts = [];
+    let quanta = Math.floor((s.length / 5));
+    const leftover = s.length % 5;
+    if (leftover != 0) {
+        for (let i = 0; i < (5 - leftover); i++) {
+            s += '\x00';
+        }
+        quanta += 1;
+    }
+    for (let i = 0; i < quanta; i++) {
+        parts.push(alphabet.charAt(s.charCodeAt(i * 5) >> 3));
+        parts.push(alphabet.charAt(((s.charCodeAt(i * 5) & 0x07) << 2) | (s.charCodeAt(i * 5 + 1) >> 6)));
+        parts.push(alphabet.charAt(((s.charCodeAt(i * 5 + 1) & 0x3F) >> 1)));
+        parts.push(alphabet.charAt(((s.charCodeAt(i * 5 + 1) & 0x01) << 4) | (s.charCodeAt(i * 5 + 2) >> 4)));
+        parts.push(alphabet.charAt(((s.charCodeAt(i * 5 + 2) & 0x0F) << 1) | (s.charCodeAt(i * 5 + 3) >> 7)));
+        parts.push(alphabet.charAt(((s.charCodeAt(i * 5 + 3) & 0x7F) >> 2)));
+        parts.push(alphabet.charAt(((s.charCodeAt(i * 5 + 3) & 0x03) << 3) | (s.charCodeAt(i * 5 + 4) >> 5)));
+        parts.push(alphabet.charAt(((s.charCodeAt(i * 5 + 4) & 0x1F))));
+    }
+    let replace = 0;
+    if (leftover == 1)
+        replace = 6;
+    else if (leftover == 2)
+        replace = 4;
+    else if (leftover == 3)
+        replace = 3;
+    else if (leftover == 4)
+        replace = 1;
+    for (let i = 0; i < replace; i++)
+        parts.pop();
+    for (let i = 0; i < replace; i++)
+        parts.push("=");
+    return parts.join("");
+};
+/**
+* Decode a base32 string.
+* This is made specifically for our use, deals only with proper strings
+*/
+const b32decode = function (s) {
+    const r = new ArrayBuffer(s.length * 5 / 8);
+    const b = new Uint8Array(r);
+    for (let j = 0; j < s.length / 8; j++) {
+        const v = [0, 0, 0, 0, 0, 0, 0, 0];
+        for (let i = 0; i < 8; ++i) {
+            v[i] = alphabet.indexOf(s[j * 8 + i]);
+        }
+        const i = 0;
+        b[j * 5 + 0] = (v[i + 0] << 3) | (v[i + 1] >> 2);
+        b[j * 5 + 1] = ((v[i + 1] & 0x3) << 6) | (v[i + 2] << 1) | (v[i + 3] >> 4);
+        b[j * 5 + 2] = ((v[i + 3] & 0xf) << 4) | (v[i + 4] >> 1);
+        b[j * 5 + 3] = ((v[i + 4] & 0x1) << 7) | (v[i + 5] << 2) | (v[i + 6] >> 3);
+        b[j * 5 + 4] = ((v[i + 6] & 0x7) << 5) | (v[i + 7]);
+    }
+    return b;
+};
+export default {
+    b32decode,
+    b32encode
+};

package/dist/crypto/base58.d.ts

@@ -0,0 +1,4 @@
+declare const _default: {
+    decode: (string: string) => number[];
+};
+export default _default;

package/dist/crypto/base58.js

@@ -0,0 +1,42 @@
+// Base58 encoding/decoding
+// Originally written by Mike Hearn for BitcoinJ
+// Copyright (c) 2011 Google Inc
+// Ported to JavaScript by Stefan Thomas
+// Merged Buffer refactorings from base58-native by Stephen Pair
+// Copyright (c) 2013 BitPay Inc
+const ALPHABET = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz';
+const ALPHABET_MAP = {};
+for (let i = 0; i < ALPHABET.length; ++i) {
+    ALPHABET_MAP[ALPHABET.charAt(i)] = i;
+}
+const BASE = ALPHABET.length;
+export default {
+    decode: function (string) {
+        if (string.length === 0)
+            return [];
+        var i, j, bytes = [0];
+        for (i = 0; i < string.length; ++i) {
+            var c = string[i];
+            if (!(c in ALPHABET_MAP))
+                throw new Error('Non-base58 character');
+            for (j = 0; j < bytes.length; ++j)
+                bytes[j] *= BASE;
+            bytes[0] += ALPHABET_MAP[c];
+            var carry = 0;
+            for (j = 0; j < bytes.length; ++j) {
+                bytes[j] += carry;
+                carry = bytes[j] >> 8;
+                bytes[j] &= 0xff;
+            }
+            while (carry) {
+                bytes.push(carry & 0xff);
+                carry >>= 8;
+            }
+        }
+        // deal with leading zeros
+        for (i = 0; string[i] === '1' && i < string.length - 1; ++i) {
+            bytes.push(0);
+        }
+        return bytes.reverse();
+    }
+};

package/dist/crypto/bech32.d.ts

@@ -0,0 +1,17 @@
+declare namespace _default {
+    export { decode };
+    export { encode };
+    export { encodings };
+    export { verifyChecksum };
+}
+export default _default;
+declare function decode(bechString: any, enc: any): {
+    hrp: any;
+    data: number[];
+};
+declare function encode(hrp: any, data: any, enc: any): string;
+declare namespace encodings {
+    let BECH32: string;
+    let BECH32M: string;
+}
+declare function verifyChecksum(hrp: any, data: any, enc: any): boolean;

package/dist/crypto/bech32.js

@@ -0,0 +1,124 @@
+// Copyright (c) 2017, 2021 Pieter Wuille
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+var CHARSET = 'qpzry9x8gf2tvdw0s3jn54khce6mua7l';
+var GENERATOR = [0x3b6a57b2, 0x26508e6d, 0x1ea119fa, 0x3d4233dd, 0x2a1462b3];
+const encodings = {
+    BECH32: "bech32",
+    BECH32M: "bech32m",
+};
+export default {
+    decode: decode,
+    encode: encode,
+    encodings: encodings,
+    verifyChecksum: verifyChecksum
+};
+function getEncodingConst(enc) {
+    if (enc == encodings.BECH32) {
+        return 1;
+    }
+    else if (enc == encodings.BECH32M) {
+        return 0x2bc830a3;
+    }
+    else {
+        return null;
+    }
+}
+function polymod(values) {
+    var chk = 1;
+    for (var p = 0; p < values.length; ++p) {
+        var top = chk >> 25;
+        chk = (chk & 0x1ffffff) << 5 ^ values[p];
+        for (var i = 0; i < 5; ++i) {
+            if ((top >> i) & 1) {
+                chk ^= GENERATOR[i];
+            }
+        }
+    }
+    return chk;
+}
+function hrpExpand(hrp) {
+    var ret = [];
+    var p;
+    for (p = 0; p < hrp.length; ++p) {
+        ret.push(hrp.charCodeAt(p) >> 5);
+    }
+    ret.push(0);
+    for (p = 0; p < hrp.length; ++p) {
+        ret.push(hrp.charCodeAt(p) & 31);
+    }
+    return ret;
+}
+function verifyChecksum(hrp, data, enc) {
+    return polymod(hrpExpand(hrp).concat(data)) === getEncodingConst(enc);
+}
+function createChecksum(hrp, data, enc) {
+    var values = hrpExpand(hrp).concat(data).concat([0, 0, 0, 0, 0, 0]);
+    var mod = polymod(values) ^ getEncodingConst(enc);
+    var ret = [];
+    for (var p = 0; p < 6; ++p) {
+        ret.push((mod >> 5 * (5 - p)) & 31);
+    }
+    return ret;
+}
+function encode(hrp, data, enc) {
+    var combined = data.concat(createChecksum(hrp, data, enc));
+    var ret = hrp + '1';
+    for (var p = 0; p < combined.length; ++p) {
+        ret += CHARSET.charAt(combined[p]);
+    }
+    return ret;
+}
+function decode(bechString, enc) {
+    var p;
+    var has_lower = false;
+    var has_upper = false;
+    for (p = 0; p < bechString.length; ++p) {
+        if (bechString.charCodeAt(p) < 33 || bechString.charCodeAt(p) > 126) {
+            return null;
+        }
+        if (bechString.charCodeAt(p) >= 97 && bechString.charCodeAt(p) <= 122) {
+            has_lower = true;
+        }
+        if (bechString.charCodeAt(p) >= 65 && bechString.charCodeAt(p) <= 90) {
+            has_upper = true;
+        }
+    }
+    if (has_lower && has_upper) {
+        return null;
+    }
+    bechString = bechString.toLowerCase();
+    var pos = bechString.lastIndexOf('1');
+    if (pos < 1 || pos + 7 > bechString.length || bechString.length > 110) {
+        return null;
+    }
+    var hrp = bechString.substring(0, pos);
+    var data = [];
+    for (p = pos + 1; p < bechString.length; ++p) {
+        var d = CHARSET.indexOf(bechString.charAt(p));
+        if (d === -1) {
+            return null;
+        }
+        data.push(d);
+    }
+    if (!verifyChecksum(hrp, data, enc)) {
+        return null;
+    }
+    return { hrp: hrp, data: data.slice(0, data.length - 6) };
+}

package/dist/crypto/biginteger.d.ts

@@ -0,0 +1,57 @@
+export function BigInteger(n: any, s: any, token: any): BigInteger;
+export class BigInteger {
+    constructor(n: any, s: any, token: any);
+    _d: any;
+    _s: any;
+    toString(base: any): any;
+    add(n: any): any;
+    negate(): BigInteger;
+    abs(): BigInteger;
+    subtract(n: any): any;
+    compareAbs(n: any): any;
+    compare(n: any): any;
+    isUnit(): boolean;
+    multiply(n: any): any;
+    multiplySingleDigit(n: any): any;
+    square(): BigInteger;
+    quotient(n: any): BigInteger;
+    divide: any;
+    remainder(n: any): BigInteger;
+    divRem(n: any): BigInteger[];
+    divRemSmall(n: any): BigInteger[];
+    isEven(): boolean;
+    isOdd(): boolean;
+    sign(): any;
+    isPositive(): boolean;
+    isNegative(): boolean;
+    isZero(): boolean;
+    exp10(n: any): BigInteger;
+    pow(n: any): BigInteger;
+    modPow(exponent: any, modulus: any): BigInteger;
+    log(): number;
+    valueOf(): any;
+    toJSValue(): number;
+    lowVal(): any;
+}
+export namespace BigInteger {
+    export function _construct(n: any, s: any): BigInteger;
+    export { BigInteger_base as base };
+    export { BigInteger_base_log10 as base_log10 };
+    export { ZERO };
+    export { ONE };
+    export { M_ONE };
+    export { ZERO as _0 };
+    export { ONE as _1 };
+    export let small: BigInteger[];
+    export let digits: string[];
+    export let radixRegex: RegExp[];
+    export function parse(s: any, base: any): BigInteger;
+    export { MAX_EXP };
+}
+declare var BigInteger_base: number;
+declare var BigInteger_base_log10: number;
+declare var ZERO: BigInteger;
+declare var ONE: BigInteger;
+declare var M_ONE: BigInteger;
+declare var MAX_EXP: BigInteger;
+export {};