multichain-address-validator 0.0.1 → 0.7.1

package/package.json

@@ -1,6 +1,7 @@
 {
     "name": "multichain-address-validator",
     "description": "Multichain address validator for Bitcoin and other blockchains.",
+    "version": "0.7.1",
     "keywords": [
         "0x",
         "zrx",
@@ -315,8 +316,7 @@
         "ZenCash",
         "zen"
     ],
-    "version": "0.0.1",
-    "author": "Chris <chris.tsim@gmail.com>",
+    "author": "Chris <28301107+christsim@users.noreply.github.com>",
     "homepage": "https://github.com/christsim/multichain-address-validator",
     "license": "MIT",
     "repository": {
@@ -326,14 +326,13 @@
     "main": "dist/multichain-address-validator.js",
     "type": "module",
     "engines": {
-        "node": ">=16.0.0"
+        "node": ">=18.0.0"
     },
     "engineStrict": true,
     "scripts": {
         "build": "tsc",
-        "bundle": "tsx config/esbuild.ts",
         "test": "mocha --import=tsx test/**.test.ts",
-        "start": "npm run build && npm run bundle && npm test"
+        "start": "npm run build && npm test"
     },
     "dependencies": {
         "@noble/hashes": "^1.4.0",
@@ -345,7 +344,6 @@
     },
     "devDependencies": {
         "chai": "^4.4.1",
-        "esbuild": "^0.23.0",
         "mocha": "^10.2.0",
         "tsx": "^4.16.2",
         "typescript": "^5.5.4"

package/src/chain-validators.ts

@@ -1,4 +1,5 @@
-import {Chain, NetworkType, Validator} from './types.js'
+import type {Chain, Validator} from './types.js'
+import { NetworkType } from './types.js'
 
 import {
     AlgorandValidator,
@@ -7,7 +8,9 @@ import {
     CardanoValidator,
     EOSValidator,
     ETHValidator,
+    HederaValidator,
     MoneroValidator,
+    MoveValidator,
     NanoValidator,
     NemValidator,
     PolkadotValidator,
@@ -30,6 +33,7 @@ type ChainValidators = Record<string, {
 
 const chainValidators: ChainValidators = {
     algorand: {validator: AlgorandValidator},
+    aptos: {validator: MoveValidator},
     bitcoin: {
         alternatives: ['btc', 'omni'],
         validator: {
@@ -71,9 +75,25 @@ const chainValidators: ChainValidators = {
     },
     eos: {validator: EOSValidator},
     ethereum: {
-        alternatives: ['eth', 'erc20', 'flare', 'avalanche', 'avalanche-c', 'bsc', 'bnb', 'binance'],
+        alternatives: [
+            'arbitrum',
+            'avalanche',
+            'avalanche-c',
+            'base',
+            'binance',
+            'bnb',
+            'bsc',
+            'eth',
+            'erc20',
+            'flare',
+            'sonic',
+        ],
         validator: ETHValidator
     },
+    hedera: {
+        alternatives: ['hbar'],
+        validator: HederaValidator
+    },
     litecoin: {
         alternatives: ['ltc'],
         validator: {
@@ -105,6 +125,7 @@ const chainValidators: ChainValidators = {
         alternatives: ['spl'],
         validator: SolanaValidator,
     },
+    sui: {validator: MoveValidator},
     tron: {
         alternatives: ['trc20'],
         validator: TronValidator(),

package/src/multichain-address-validator.ts

@@ -1,11 +1,13 @@
-import {Address, Chain} from './types.js'
+import {Address, Chain, NetworkType} from './types.js'
 import {getValidatorForChain} from './chain-validators.js'
 
 export function validate(address: Address, chain: Chain) {
     const validator = getValidatorForChain(chain)
-    if (validator) {
-        return validator.isValidAddress(address);
+    if (!validator) {
+        throw new Error(`Missing validator for chain: ${chain}`);
     }
 
-    throw new Error(`Missing validator for chain: ${chain}`);
+    return validator.isValidAddress(address);
 }
+
+export type { Address, Chain, NetworkType }

package/src/validators/hedera_validator.ts

@@ -0,0 +1,10 @@
+import type {Address} from '../types.js'
+import {getAddress} from '../helpers.js'
+
+export default {
+    isValidAddress(address: Address) {
+        // Regex to validate the format "shard.realm.account"
+        const regex = /^\d+\.\d+\.\d+$/;
+        return regex.test(getAddress(address));
+    }
+};

package/src/validators/index.ts

@@ -4,7 +4,9 @@ export {default as BTCValidator} from "./bitcoin_validator.js"
 export {default as CardanoValidator} from "./cardano_validator.js"
 export {default as EOSValidator} from "./eos_validator.js"
 export {default as ETHValidator} from "./ethereum_validator.js"
+export {default as HederaValidator} from "./hedera_validator.js"
 export {default as MoneroValidator} from "./monero_validator.js"
+export {default as MoveValidator} from "./move_validator.js"
 export {default as NemValidator} from "./nem_validator.js"
 export {default as NanoValidator} from "./nano_validator.js"
 export {default as PolkadotValidator} from "./polkadot_validator.js"

package/src/validators/move_validator.ts

@@ -0,0 +1,11 @@
+import type { Address} from '../types.js'
+import {getAddress} from '../helpers.js'
+
+const regexp = new RegExp('^0x[0-9a-fA-F]{64}$');
+
+export default {
+    isValidAddress(address: Address) {
+        const addr = getAddress(address)
+        return regexp.test(addr)
+    },
+};

package/src/validators/ripple_validator.ts

@@ -22,8 +22,12 @@ export default {
         return validAddress && this.verifyMemo(destinationTag)
     },
 
-    verifyMemo(destinationTag: string | null) {
-        return !destinationTag || /[0-9]+/.test(destinationTag)
+    verifyMemo(destinationTag: string | null): boolean {
+        if (!destinationTag) return true; // Optional
+
+        const tagNumber = Number(destinationTag);
+        // A destination tag is a 32-bit unsigned integer.
+        return /^[0-9]+$/.test(destinationTag) && tagNumber >= 0 && tagNumber <= 4294967295;
     },
 
     verifyChecksum: function (address: string) {

package/src/validators/xlm_validator.ts

@@ -18,13 +18,21 @@ function swap16(number: number) {
 }
 
 export default {
-    isValidAddress(address: Address) {
+    isValidAddress: function (address: Address) {
         const addr = getAddress(address)
-        if (regexp.test(addr)) {
-            return this.verifyChecksum(addr);
-        }
+        const destinationTag = (address as any).destinationTag
+
+        const validAddress = regexp.test(addr) && this.verifyChecksum(addr);
+
+        return validAddress && this.verifyMemo(destinationTag)
+    },
+
+    verifyMemo(memo: string | null): boolean {
+        if (!memo) return true; // Optional
 
-        return false;
+        // Ensure it's a valid UTF-8 string and does not exceed 28 bytes
+        const encoder = new TextEncoder();
+        return encoder.encode(memo).length <= 28;
     },
 
     verifyChecksum: function (address: string) {

package/test/addresses/addresses.ts

@@ -1,26 +1,32 @@
 import algorand from './algorand.json'
+import aptos from './aptos.json'
 import bch from './bch.json'
 import bchTestnet from './bch-testnet.json'
 import btc from './btc.json'
 import btcTestnet from './btc-testnet.json'
 import cardano from './cardano.json'
 import doge from './doge.json'
+import dogeTestnet from './doge-testnet.json'
 import eos from './eos.json'
 import evm from './evm.json'
+import hbar from './hbar.json'
 import ltc from './ltc.json'
 import ltcTestnet from './ltc-testnet.json'
 import monero from './monero.json'
+import moneroTestnet from './monero-testnet.json'
 import nem from './nem.json'
 import nano from './nano.json'
 import polkadot from './polkadot.json'
 import ripple from './ripple.json'
 import sia from './sia.json'
 import solana from './solana.json'
+import sui from './sui.json'
 import tezos from './tezos.json'
 import tron from './tron.json'
 import xlm from './xlm.json'
 
 export default {
+    aptos,
     algorand,
     bch,
     'bch-testnet': bchTestnet,
@@ -28,16 +34,20 @@ export default {
     'btc-testnet': btcTestnet,
     cardano,
     doge,
+    'doge-testnet': dogeTestnet,
     eos,
     evm,
+    hbar,
     ltc,
     'ltc-testnet': ltcTestnet,
     monero,
+    'monero-testnet': moneroTestnet,
     nem,
     nano,
     polkadot,
     ripple,
     sia,
+    sui,
     solana,
     tezos,
     tron,

package/test/addresses/aptos.json

@@ -0,0 +1,6 @@
+[
+    "0xaabf25b0c115130a4ad88bfa08627c5a103b7851e90869c23fadaf0512dd5133",
+    "0xdce6ab89a1d26c99491a70fd4a2536d065925114deee916a1ae7d35007f4dedf",
+    "0xd05448f15a03f25b2816c4538b72bd54752ba7522d4831a4c9ea5a613becb47a",
+    "0x39f521d22f611a4dec2f790fef2e4f8d1f96550509e85beccf8acec52c1a7219"
+]

package/test/addresses/bch.json

@@ -1,11 +1,6 @@
 [
     "12KYrjTdVGjFMtaxERSk3gphreJ5US8aUP",
     "12QeMLzSrB8XH8FvEzPMVoRxVAzTr5XM2y",
-    "12QeMLzSrB8XH8FvEzPMVoRxVAzTr5XM2y",
-    "12QeMLzSrB8XH8FvEzPMVoRxVAzTr5XM2y",
-    "12QeMLzSrB8XH8FvEzPMVoRxVAzTr5XM2y",
-    "12QeMLzSrB8XH8FvEzPMVoRxVAzTr5XM2y",
-    "12QeMLzSrB8XH8FvEzPMVoRxVAzTr5XM2y",
     "1oNLrsHnBcR6dpaBpwz3LSwutbUNkNSjs",
     "3NJZLcZEEYBpxYEUGewU4knsQRn1WM5Fkt",
     "bitcoincash:qq4v32mtagxac29my6gwj6fd4tmqg8rysu23dax807"

package/test/addresses/btc-testnet.json

@@ -1,6 +1,11 @@
 [
     "mzBc4XEFSdzCDcTxAgf6EZXgsZWpztRhef",
     "GSa5espVLNseXEfKt46zEdS6jrPkmFghBU",
+    "mptPo5AvLzJXi4T82vR6g82fT5uJ6HsQCu",
+    "mzBc4XEFSdzCDcTxAgf6EZXgsZWpztRhef",
+    "2MxKEf2su6FGAUfCEAHreGFQvEYrfYNHvL7",
+    "tb1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3q0sl5k7",
+    "GSa5espVLNseXEfKt46zEdS6jrPkmFghBU",
     "tb1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3q0sl5k7",
     "tb1qqqqqp399et2xygdj5xreqhjjvcmzhxw4aywxecjdzew6hylgvsesrxh6hy"
 ]

package/test/addresses/btc.json

@@ -1,14 +1,14 @@
 [
     "12KYrjTdVGjFMtaxERSk3gphreJ5US8aUP",
     "12QeMLzSrB8XH8FvEzPMVoRxVAzTr5XM2y",
-    "12QeMLzSrB8XH8FvEzPMVoRxVAzTr5XM2y",
-    "12QeMLzSrB8XH8FvEzPMVoRxVAzTr5XM2y",
-    "12QeMLzSrB8XH8FvEzPMVoRxVAzTr5XM2y",
-    "12QeMLzSrB8XH8FvEzPMVoRxVAzTr5XM2y",
-    "12QeMLzSrB8XH8FvEzPMVoRxVAzTr5XM2y",
     "15uwigGExiNQxTNr1QSZYPXJMp9Px2YnVU",
     "3FyVFsEyyBPzHjD3qUEgX7Jsn4tcHNZFkn",
     "38mKdURe1zcQyrFqRLzR8PRao3iLGEPVsU",
     "BC1QW508D6QEJXTDG4Y5R3ZARVARY0C5XW7KV8F3T4",
+    "1oNLrsHnBcR6dpaBpwz3LSwutbUNkNSjs",
+    "1HVDCg2KrPBH1Mg5SK9fGjAR9KVqyMMdBC",
+    "1SQHtwR5oJRKLfiWQ2APsAd9miUc4k2ez",
+    "116CGDLddrZhMrTwhCVJXtXQpxygTT1kHd",
+    "3NJZLcZEEYBpxYEUGewU4knsQRn1WM5Fkt",
     "bc1q2t63ewm3mvh0ztmnmezxm7s0tefknenxlrlwrk"
 ]

package/test/addresses/doge-testnet.json

@@ -0,0 +1,3 @@
+[
+    "2MxKEf2su6FGAUfCEAHreGFQvEYrfYNHvL7"
+]

package/test/addresses/doge.json

@@ -2,6 +2,5 @@
     "DPpJVPpvPNP6i6tMj4rTycAGh8wReTqaSU",
     "DNzLUN6MyYVS5zf4Xc2yK69V3dXs6Mxia5",
     "DPS6iZj7roHquvwRYXNBua9QtKPzigUUhM",
-    "DPS6iZj7roHquvwRYXNBua9QtKPzigUUhM",
     "A7JjzK9k9x5b2MkkQzqt91WZsuu7wTu6iS"
 ]

package/test/addresses/evm.json

@@ -10,7 +10,6 @@
     "0xfB6916095ca1df60bB79Ce92cE3Ea74c37c5d359",
     "0xdbF03B407c01E7cD3CBea99509d93f8DDDC8C6FB",
     "0xD1220A0cf47c7B9Be7A2E6BA89F429762e7b9aDb",
-
     "0xE37c0D48d68da5c5b14E5c1a9f1CFE802776D9FF",
     "0xa00354276d2fC74ee91e37D085d35748613f4748",
     "0xAff4d6793F584a473348EbA058deb8caad77a288",

package/test/addresses/hbar.json

@@ -0,0 +1,11 @@
+[
+    "0.0.12345",
+    "0.0.987654321",
+    "0.1.54321",
+    "1.0.123",
+    "2.3.45678",
+    "0.2.789",
+    "0.2.789",
+    "0.0.1",
+    "10.5.987"
+]

package/test/addresses/monero-testnet.json

@@ -0,0 +1,5 @@
+[
+    "A2be3UvzMtkJtxRYgcCbQt2y7Rp2eLVGqNTWfZeankrWimSMM4y7uMP6B9oAZaHsXTj8KFSerkSkkVRuEuEca9QM8VhxCNU",
+    "9uXRFi4PZMqhsnthBF6bGdfVnBSZtfKkR7Td8qPM7jUKZeTfR1tLhCoTLqYNE12xuiQg3aWGiLw83bWsqwTRLaM4Jk47xYM",
+    "9tFTaQM39JXhULZsHauPHhjFrjcGSGXoijEPYoRgAky9Veck2mFp3EifQ2tKHmEHuuUoFfgYRNR2bVaborz5oi8JA8xkqjY"
+]

package/test/addresses/ripple.json

@@ -3,6 +3,10 @@
     "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
     "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
     "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
+    {
+        "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
+        "destinationTag": 4294967295
+    },
     "rDTXLQ7ZKZVKz33zJbHjgVShjsBnqMBhmN",
     {
         "address": "rDTXLQ7ZKZVKz33zJbHjgVShjsBnqMBhmN",

package/test/addresses/sia.json

@@ -1,5 +1,4 @@
 [
-    "a9b01c85163638682b170d82de02b8bb99ba86092e9ab1b0d25111284fe618e93456915820f1",
     "a9b01c85163638682b170d82de02b8bb99ba86092e9ab1b0d25111284fe618e93456915820f1",
     "ab0c327982abfcc6055a6c9551589167d8a73501aca8769f106371fbc937ad100c955c3b7ba9",
     "ffe1308c044ade30392a0cdc1fd5a4dbe94f9616a95faf888ed36123d9e711557aa497530373"

package/test/addresses/sui.json

@@ -0,0 +1,6 @@
+[
+    "0xaabf25b0c115130a4ad88bfa08627c5a103b7851e90869c23fadaf0512dd5133",
+    "0xdce6ab89a1d26c99491a70fd4a2536d065925114deee916a1ae7d35007f4dedf",
+    "0xd05448f15a03f25b2816c4538b72bd54752ba7522d4831a4c9ea5a613becb47a",
+    "0x39f521d22f611a4dec2f790fef2e4f8d1f96550509e85beccf8acec52c1a7219"
+]

package/test/addresses/xlm.json

@@ -8,5 +8,9 @@
     "GAJHORKJKDDEPYCD6URDFODV7CVLJ5AAOJKR6PG2VQOLWFQOF3X7XLOG",
     "GACXQEAXYBEZLBMQ2XETOBRO4P66FZAJENDHOQRYPUIXZIIXLKMZEXBJ",
     "GDD3XRXU3G4DXHVRUDH7LJM4CD4PDZTVP4QHOO4Q6DELKXUATR657OZV",
-    "GDTYVCTAUQVPKEDZIBWEJGKBQHB4UGGXI2SXXUEW7LXMD4B7MK37CWLJ"
+    "GDTYVCTAUQVPKEDZIBWEJGKBQHB4UGGXI2SXXUEW7LXMD4B7MK37CWLJ",
+    {
+        "address": "GDTYVCTAUQVPKEDZIBWEJGKBQHB4UGGXI2SXXUEW7LXMD4B7MK37CWLJ",
+        "destinationTag": "3fdsfsdfasdfdsfgasdgfdsfgas"
+    }
 ]