multichain-address-validator 0.7.6 → 0.7.8

package/dist/cjs/chain-validators.js

@@ -62,6 +62,7 @@ const chainValidators = {
             'EthereumPow',
             'erc20',
             'flare',
+            'optimism',
             'sonic',
             'story',
         ],
@@ -97,9 +98,12 @@ const chainValidators = {
         alternatives: ['xrp'],
         validator: index_js_1.RippleValidator,
     },
-    sia: { validator: index_js_1.SiaValidator },
+    sia: {
+        alternatives: ['SiaCoin'],
+        validator: index_js_1.SiaValidator
+    },
     solana: {
-        alternatives: ['spl'],
+        alternatives: ['sol', 'spl'],
         validator: index_js_1.SolanaValidator,
     },
     sui: { validator: index_js_1.MoveValidator },
@@ -109,7 +113,7 @@ const chainValidators = {
     },
     tezos: { validator: index_js_1.TezosValidator },
     xlm: {
-        alternatives: ['stellar'],
+        alternatives: ['stellar', 'stellarlumens'],
         validator: index_js_1.XLMValidator,
     },
 };

package/dist/cjs/index.d.ts

@@ -1,5 +1,6 @@
 import { Address, Chain, NetworkType } from './types.js';
 export declare function validate(address: Address, chain: Chain): boolean;
+export declare function validateMemo(memo: string, chain: Chain): boolean;
 export type { Address, Chain };
 export { NetworkType };
 declare const _default: {

package/dist/cjs/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NetworkType = void 0;
 exports.validate = validate;
+exports.validateMemo = validateMemo;
 const types_js_1 = require("./types.js");
 Object.defineProperty(exports, "NetworkType", { enumerable: true, get: function () { return types_js_1.NetworkType; } });
 const chain_validators_js_1 = require("./chain-validators.js");
@@ -12,6 +13,13 @@ function validate(address, chain) {
     }
     return validator.isValidAddress(address);
 }
+function validateMemo(memo, chain) {
+    const validator = (0, chain_validators_js_1.getValidatorForChain)(chain);
+    if (!validator) {
+        throw new Error(`Missing validator for chain: ${chain}`);
+    }
+    return validator.isValidMemo?.(memo) ?? true;
+}
 exports.default = {
     validate
 };

package/dist/cjs/types.d.ts

@@ -8,6 +8,7 @@ export type Chain = string | {
 };
 export interface Validator {
     isValidAddress(address: Address): boolean;
+    isValidMemo?(memo: string): boolean;
 }
 export declare enum NetworkType {
     MainNet = "mainnet",

package/dist/cjs/validators/ripple_validator.d.ts

@@ -4,6 +4,7 @@ declare const _default: {
      * ripple address validation
      */
     isValidAddress: (address: Address) => any;
+    isValidMemo(memo: string): boolean;
     verifyMemo(memo?: string): boolean;
     verifyChecksum(address: string): boolean;
 };

package/dist/cjs/validators/ripple_validator.js

@@ -19,6 +19,9 @@ exports.default = {
         const validAddress = regexp.test(addr) && this.verifyChecksum(addr);
         return validAddress && this.verifyMemo(memo);
     },
+    isValidMemo(memo) {
+        return this.verifyMemo(memo);
+    },
     verifyMemo(memo) {
         if (!memo)
             return true; // Optional

package/dist/cjs/validators/solana_validator.js

@@ -5,11 +5,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const base58_validator_js_1 = __importDefault(require("./base58_validator.js"));
 const helpers_js_1 = require("../helpers.js");
+const base58_js_1 = __importDefault(require("../crypto/base58.js"));
 exports.default = {
     isValidAddress: function (address) {
-        return base58_validator_js_1.default.isValidAddress((0, helpers_js_1.getAddress)(address), {
+        const validBase58 = base58_validator_js_1.default.isValidAddress((0, helpers_js_1.getAddress)(address), {
             maxLength: 44,
             minLength: 43,
         });
+        if (!validBase58) {
+            return false;
+        }
+        // solana address must be 32 bytes
+        return base58_js_1.default.decode((0, helpers_js_1.getAddress)(address)).length === 32;
     }
 };

package/dist/cjs/validators/xlm_validator.d.ts

@@ -1,6 +1,7 @@
 import { Address } from '../types.js';
 declare const _default: {
     isValidAddress: (address: Address) => any;
+    isValidMemo(memo: string): boolean;
     verifyMemo(memo?: string): boolean;
     verifyChecksum: (address: string) => boolean;
 };

package/dist/cjs/validators/xlm_validator.js

@@ -23,6 +23,9 @@ exports.default = {
         const validAddress = regexp.test(addr) && this.verifyChecksum(addr);
         return validAddress && this.verifyMemo(memo);
     },
+    isValidMemo(memo) {
+        return this.verifyMemo(memo);
+    },
     verifyMemo(memo) {
         if (!memo)
             return true; // Optional

package/dist/esm/chain-validators.js

@@ -59,6 +59,7 @@ const chainValidators = {
             'EthereumPow',
             'erc20',
             'flare',
+            'optimism',
             'sonic',
             'story',
         ],
@@ -94,9 +95,12 @@ const chainValidators = {
         alternatives: ['xrp'],
         validator: RippleValidator,
     },
-    sia: { validator: SiaValidator },
+    sia: {
+        alternatives: ['SiaCoin'],
+        validator: SiaValidator
+    },
     solana: {
-        alternatives: ['spl'],
+        alternatives: ['sol', 'spl'],
         validator: SolanaValidator,
     },
     sui: { validator: MoveValidator },
@@ -106,7 +110,7 @@ const chainValidators = {
     },
     tezos: { validator: TezosValidator },
     xlm: {
-        alternatives: ['stellar'],
+        alternatives: ['stellar', 'stellarlumens'],
         validator: XLMValidator,
     },
 };

package/dist/esm/index.d.ts

@@ -1,5 +1,6 @@
 import { Address, Chain, NetworkType } from './types.js';
 export declare function validate(address: Address, chain: Chain): boolean;
+export declare function validateMemo(memo: string, chain: Chain): boolean;
 export type { Address, Chain };
 export { NetworkType };
 declare const _default: {

package/dist/esm/index.js

@@ -7,6 +7,13 @@ export function validate(address, chain) {
     }
     return validator.isValidAddress(address);
 }
+export function validateMemo(memo, chain) {
+    const validator = getValidatorForChain(chain);
+    if (!validator) {
+        throw new Error(`Missing validator for chain: ${chain}`);
+    }
+    return validator.isValidMemo?.(memo) ?? true;
+}
 export { NetworkType };
 export default {
     validate

package/dist/esm/types.d.ts

@@ -8,6 +8,7 @@ export type Chain = string | {
 };
 export interface Validator {
     isValidAddress(address: Address): boolean;
+    isValidMemo?(memo: string): boolean;
 }
 export declare enum NetworkType {
     MainNet = "mainnet",

package/dist/esm/validators/ripple_validator.d.ts

@@ -4,6 +4,7 @@ declare const _default: {
      * ripple address validation
      */
     isValidAddress: (address: Address) => any;
+    isValidMemo(memo: string): boolean;
     verifyMemo(memo?: string): boolean;
     verifyChecksum(address: string): boolean;
 };

package/dist/esm/validators/ripple_validator.js

@@ -14,6 +14,9 @@ export default {
         const validAddress = regexp.test(addr) && this.verifyChecksum(addr);
         return validAddress && this.verifyMemo(memo);
     },
+    isValidMemo(memo) {
+        return this.verifyMemo(memo);
+    },
     verifyMemo(memo) {
         if (!memo)
             return true; // Optional

package/dist/esm/validators/solana_validator.js

@@ -1,10 +1,16 @@
 import base58Validator from './base58_validator.js';
 import { getAddress } from '../helpers.js';
+import base58 from '../crypto/base58.js';
 export default {
     isValidAddress: function (address) {
-        return base58Validator.isValidAddress(getAddress(address), {
+        const validBase58 = base58Validator.isValidAddress(getAddress(address), {
             maxLength: 44,
             minLength: 43,
         });
+        if (!validBase58) {
+            return false;
+        }
+        // solana address must be 32 bytes
+        return base58.decode(getAddress(address)).length === 32;
     }
 };

package/dist/esm/validators/xlm_validator.d.ts

@@ -1,6 +1,7 @@
 import { Address } from '../types.js';
 declare const _default: {
     isValidAddress: (address: Address) => any;
+    isValidMemo(memo: string): boolean;
     verifyMemo(memo?: string): boolean;
     verifyChecksum: (address: string) => boolean;
 };

package/dist/esm/validators/xlm_validator.js

@@ -18,6 +18,9 @@ export default {
         const validAddress = regexp.test(addr) && this.verifyChecksum(addr);
         return validAddress && this.verifyMemo(memo);
     },
+    isValidMemo(memo) {
+        return this.verifyMemo(memo);
+    },
     verifyMemo(memo) {
         if (!memo)
             return true; // Optional

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "multichain-address-validator",
     "description": "Multichain address validator for Bitcoin and other blockchains.",
-    "version": "0.7.6",
+    "version": "0.7.8",
     "keywords": [
         "0x",
         "zrx",

package/src/chain-validators.ts

@@ -90,6 +90,7 @@ const chainValidators: ChainValidators = {
             'EthereumPow',
             'erc20',
             'flare',
+            'optimism',
             'sonic',
             'story',
         ],
@@ -125,9 +126,12 @@ const chainValidators: ChainValidators = {
         alternatives: ['xrp'],
         validator: RippleValidator,
     },
-    sia: {validator: SiaValidator},
+    sia: {
+        alternatives: ['SiaCoin'],
+        validator: SiaValidator
+    },
     solana: {
-        alternatives: ['spl'],
+        alternatives: ['sol','spl'],
         validator: SolanaValidator,
     },
     sui: {validator: MoveValidator},
@@ -137,7 +141,7 @@ const chainValidators: ChainValidators = {
     },
     tezos: {validator: TezosValidator},
     xlm: {
-        alternatives: ['stellar'],
+        alternatives: ['stellar', 'stellarlumens'],
         validator: XLMValidator,
     },
 }

package/src/index.ts

@@ -1,7 +1,7 @@
 import {Address, Chain, NetworkType} from './types.js'
 import {getValidatorForChain} from './chain-validators.js'
 
-export function validate(address: Address, chain: Chain) {
+export function validate(address: Address, chain: Chain): boolean {
     const validator = getValidatorForChain(chain)
     if (!validator) {
         throw new Error(`Missing validator for chain: ${chain}`);
@@ -10,6 +10,15 @@ export function validate(address: Address, chain: Chain) {
     return validator.isValidAddress(address);
 }
 
+export function validateMemo(memo: string, chain: Chain): boolean {
+    const validator = getValidatorForChain(chain)
+    if (!validator) {
+        throw new Error(`Missing validator for chain: ${chain}`);
+    }
+
+    return validator.isValidMemo?.(memo) ?? true
+}
+
 export type { Address, Chain }
 export { NetworkType }
 

package/src/types.ts

@@ -10,6 +10,7 @@ export type Chain = string | {
 
 export interface Validator {
     isValidAddress(address: Address): boolean
+    isValidMemo?(memo: string): boolean
 }
 
 export enum NetworkType {

package/src/validators/ripple_validator.ts

@@ -22,6 +22,10 @@ export default {
         return validAddress && this.verifyMemo(memo)
     },
 
+    isValidMemo(memo: string): boolean {
+        return this.verifyMemo(memo)
+    },
+
     verifyMemo(memo?: string): boolean {
         if (!memo) return true; // Optional
 

package/src/validators/solana_validator.ts

@@ -1,12 +1,21 @@
 import base58Validator from './base58_validator.js';
 import {Address} from '../types.js'
 import {getAddress} from '../helpers.js'
+import {Buffer} from 'buffer'
+import base58 from '../crypto/base58.js'
 
 export default {
     isValidAddress: function (address: Address) {
-        return base58Validator.isValidAddress(getAddress(address), {
+        const validBase58 = base58Validator.isValidAddress(getAddress(address), {
             maxLength: 44,
             minLength: 43,
         })
+
+        if (!validBase58) {
+            return false
+        }
+
+        // solana address must be 32 bytes
+        return base58.decode(getAddress(address)).length === 32
     }
 };

package/src/validators/xlm_validator.ts

@@ -27,6 +27,10 @@ export default {
         return validAddress && this.verifyMemo(memo)
     },
 
+    isValidMemo(memo: string): boolean {
+        return this.verifyMemo(memo)
+    },
+
     verifyMemo(memo?: string): boolean {
         if (!memo) return true; // Optional
 

package/test/addresses/addresses.ts

@@ -24,9 +24,8 @@ import sui from './sui.json'
 import tezos from './tezos.json'
 import tron from './tron.json'
 import xlm from './xlm.json'
-import {Address} from '../../src'
 
-export type TestAddress = Address & { invalid?: boolean }
+export type TestAddress = string | { address: string, memo?: string } & { invalid?: boolean, invalidMemo?: boolean }
 
 const testAddresses: Record<string, TestAddress[]> = {
     aptos,

package/test/addresses/btc-testnet.json

@@ -7,5 +7,7 @@
     "tb1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3q0sl5k7",
     "GSa5espVLNseXEfKt46zEdS6jrPkmFghBU",
     "tb1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3q0sl5k7",
-    "tb1qqqqqp399et2xygdj5xreqhjjvcmzhxw4aywxecjdzew6hylgvsesrxh6hy"
+    "tb1qqqqqp399et2xygdj5xreqhjjvcmzhxw4aywxecjdzew6hylgvsesrxh6hy",
+    "mxHzYDeCZD8qzvfVzTqPS65p23inGkRvXT",
+    "2N3ATmqPqnHR243HiwtqpCFwSsNdTiCvmmv"
 ]

package/test/addresses/doge.json

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

package/test/addresses/ltc-testnet.json

@@ -5,5 +5,6 @@
     "QW2SvwjaJU8LD6GSmtm1PHnBG2xPuxwZFy",
     "QjpzxpbLp5pCGsCczMbfh1uhC3P89QZavY",
     "tltc1qu78xur5xnq6fjy83amy0qcjfau8m367defyhms",
-    "mipcBbFg9gMiCh81Kj8tqqdgoZub1ZJRfn"
+    "mipcBbFg9gMiCh81Kj8tqqdgoZub1ZJRfn",
+    "nYNZ81BicMYUDt99dFsMdPo5JjfrMB6T3k"
 ]

package/test/addresses/ltc.json

@@ -3,5 +3,6 @@
     "LTpYZG19YmfvY2bBDYtCKpunVRw7nVgRHW",
     "Lb6wDP2kHGyWC7vrZuZAgV7V4ECyDdH7a6",
     "ltc1qg42tkwuuxefutzxezdkdel39gfstuap288mfea",
-    "ltc1qg42tkwuuxefutzxezdkdel39gfstuap288mfea"
+    "ltc1qg42tkwuuxefutzxezdkdel39gfstuap288mfea",
+    "LLUvRjeoNCa1gRuoVzFAzr3pWdu21JJESa"
 ]

package/test/addresses/ripple.json

@@ -15,6 +15,6 @@
     {
         "address": "rDTXLQ7ZKZVKz33zJbHjgVShjsBnqMBhmN",
         "memo": "non-numeric-memo",
-        "invalid": true
+        "invalidMemo": true
     }
 ]

package/test/addresses/solana.json

@@ -4,5 +4,9 @@
     "HgyXhqapicB8zoyyFQ23oUwwFrBACDyDc7bqUuvnEELM",
     "833XorXTTx5iya5B3Tr6iqEs9GbRuvVfwyLCP2vpdzhq",
     "69UwBV4LPg7hHUS5JXiXyfgVnESmDKe8KJppsLj8pRU",
-    "G4qGCGF4vWGPzYi2pxc2Djvgv3j8NiWaHQMgTVebCX6W"
+    "G4qGCGF4vWGPzYi2pxc2Djvgv3j8NiWaHQMgTVebCX6W",
+    {
+        "address": "3Yu3ULPjVc4QqS349VCs22br9zH9T6MWNnSM9RBimkw",
+        "invalid": true
+    }
 ]

package/test/addresses/xlm.json

@@ -16,6 +16,6 @@
     {
         "address": "GDTYVCTAUQVPKEDZIBWEJGKBQHB4UGGXI2SXXUEW7LXMD4B7MK37CWLJ",
         "memo": "really long memo that exceeds 28 bytes",
-        "invalid": true
+        "invalidMemo": true
     }
 ]

package/test/multichain-address-validator.test.ts

@@ -1,12 +1,15 @@
 import {describe, it} from 'mocha'
 import {expect} from 'chai'
 
-import {validate, Chain, NetworkType} from '../src'
+import {Chain, NetworkType, validate, validateMemo} from '../src'
 // @ts-ignore
 import addresses, {TestAddress} from './addresses/addresses'
 
 function check(address: TestAddress, chain: Chain) {
-    address.invalid
+    if (typeof address === 'string') {
+        return valid(address, chain)
+    }
+    (address.invalid || address.invalidMemo)
         ? invalid(address, chain)
         : valid(address, chain)
 }
@@ -21,6 +24,31 @@ function invalid(address: TestAddress, chain: Chain) {
     expect({address, chain, valid}).to.deep.equal({address, chain, valid: false});
 }
 
+function checkMemo(address: TestAddress, chain: Chain) {
+    if (typeof address === 'string') {
+        return
+    }
+    address.invalidMemo
+        ? invalidMemo(address.memo, chain)
+        : validMemo(address.memo, chain)
+}
+
+function validMemo(memo: string | undefined, chain: Chain) {
+    if (!memo) {
+        return
+    }
+    const valid = validateMemo(memo, chain);
+    expect({memo, chain, valid}).to.deep.equal({memo, chain, valid: true});
+}
+
+function invalidMemo(memo: string | undefined, chain: Chain) {
+    if (!memo) {
+        return
+    }
+    const valid = validateMemo(memo, chain);
+    expect({memo, chain, valid}).to.deep.equal({memo, chain, valid: false});
+}
+
 interface TestCase {
     alternatives: string[],
     testAddresses: keyof typeof addresses,
@@ -73,7 +101,21 @@ const TestCases: Record<string, TestCase> = {
         testAddresses: 'eos',
     },
     'ethereum': {
-        alternatives: ['eth', 'flare', 'avalanche', 'avalanche-c', 'bsc', 'bnb', 'binance', 'sonic', 'berachain', 'story'],
+        alternatives: [
+            'arbitrum',
+            'avalanche',
+            'avalanche-c',
+            'base',
+            'berachain',
+            'binance',
+            'bnb',
+            'bsc',
+            'eth',
+            'flare',
+            'optimism',
+            'sonic',
+            'story',
+        ],
         testAddresses: 'evm',
     },
     'hedera': {
@@ -112,11 +154,11 @@ const TestCases: Record<string, TestCase> = {
         testAddresses: 'ripple'
     },
     'sia': {
-        alternatives: [],
+        alternatives: ['SiaCoin'],
         testAddresses: 'sia',
     },
     'solana': {
-        alternatives: ['spl'],
+        alternatives: ['sol', 'spl'],
         testAddresses: 'solana'
     },
     'sui': {
@@ -134,13 +176,12 @@ const TestCases: Record<string, TestCase> = {
         testAddresses: 'tron',
     },
     'xlm': {
-        alternatives: ['stellar'],
+        alternatives: ['stellar', 'stellarlumens'],
         testAddresses: 'xlm',
     }
 }
 
 describe('multichain address validator', function () {
-
     it('should check valid addresses for chains', function () {
         for (const chain in TestCases) {
             for (const c of [chain, ...TestCases[chain].alternatives]) {
@@ -149,6 +190,7 @@ describe('multichain address validator', function () {
                 }
                 for (const address of addresses[TestCases[chain].testAddresses]) {
                     check(address, c)
+                    checkMemo(address, c)
                 }
 
                 if (TestCases[chain].testnet) {
@@ -156,7 +198,7 @@ describe('multichain address validator', function () {
                         throw new Error(`No test testnet addresses for chain '${chain}'`)
                     }
                     for (const address of addresses[TestCases[chain].testnet.testAddresses]) {
-                        check(address, { chain: c, networkType: NetworkType.TestNet })
+                        checkMemo(address, {chain: c, networkType: NetworkType.TestNet})
                     }
                 }
             }