sol2uml 2.5.21 → 2.5.22

package/README.md

@@ -57,9 +57,9 @@ Options:
   -f, --outputFormat <value>                      output file format. (choices: "svg", "png", "dot", "all", default: "svg")
   -o, --outputFileName <value>                    output file name
   -i, --ignoreFilesOrFolders <names>              comma-separated list of files or folders to ignore
-  -n, --network <network>                         Ethereum network which maps to a blockchain explorer (choices: "mainnet", "holesky", "sepolia", "polygon", "arbitrum", "avalanche", "bsc", "crono", "fantom", "moonbeam", "optimism", "gnosis", "celo", "scroll", "base", "sonic", default: "mainnet", env: ETH_NETWORK)
+  -n, --network <network>                         Name or chain id of the blockchain explorer. A name like `ethereum` or `base` will map to a chain id, eg 1 or 8453. Alternatively, use an integer of the chain id. Supported names: ethereum, sepolia, holesky, hoodi, arbitrum, optimism, polygon, avalanche, base, bsc, crono, fantom, sonic, gnosis, moonbeam, celo, scroll, linea, blast, berachain, zksync (default: "ethereum", env: ETH_NETWORK)
   -e, --explorerUrl <url>                         Override the `network` option with a custom blockchain explorer API URL. eg Polygon Mumbai testnet https://api-testnet.polygonscan.com/api (env: EXPLORER_URL)
-  -k, --apiKey <key>                              Blockchain explorer API key. eg Etherscan, Arbiscan, Optimism, BscScan, CronoScan, FTMScan, PolygonScan, SonicScan or SnowTrace API key (env: SCAN_API_KEY)
+  -k, --apiKey <key>                              Blockchain explorer API key. (env: SCAN_API_KEY)
   -bc, --backColor <color>                        Canvas background color. "none" will use a transparent canvas. (default: "white")
   -sc, --shapeColor <color>                       Basic drawing color for graphics, not text (default: "black")
   -fc, --fillColor <color>                        Color used to fill the background of a node (default: "gray95")
@@ -81,7 +81,7 @@ Commands:
                                                   3. File imports are commented out.
                                                   4. "SPDX-License-Identifier" is renamed to "SPDX--License-Identifier".
                                                   5. Contract dependencies are analysed so the files are merged in an order that will compile.
-  diff [options] <addressA> <fileFoldersAddress>  Compare verified Solidity code to another verified contract, a local file or local source files.
+  diff [options] <addressA> <fileFoldersAddress>  Compare verified contract code on Etherscan-like explorers to another verified contract, a local file or multiple local files.
   
                                                   The results show the comparison of contract A to B.
                                                   The green sections are additions to contract B that are not in contract A.
@@ -106,7 +106,7 @@ Arguments:
                                         sol2uml 0x79fEbF6B9F76853EDBcBc913e6aAE8232cFB9De9
 
 Options:
-  -b, --baseContractNames <names>  only output contracts connected to these comma separated base contract names
+  -b, --baseContractNames <names>  only output contracts connected to these comma-separated base contract names
   -d, --depth <value>              depth of connected classes to the base contracts. 1 will only show directly connected contracts, interfaces, libraries, structs and enums. (default: all)
   -c, --clusterFolders             cluster contracts into source folders (default: false)
   -hv, --hideVariables             hide variables from contracts, interfaces, structs and enums (default: false)
@@ -139,8 +139,8 @@ WARNING: sol2uml does not use the Solidity compiler so may differ with solc. A k
 Arguments:
   fileFolderAddress               file name, folder(s) or contract address.
                                   When a folder is used, all *.sol files in that folder and all sub folders are used.
-                                  A comma-separated list of files and folders can also be used. For example
-                                        sol2uml contracts,node_modules/openzeppelin-solidity
+                                  A comma-separated list of files and folders can also be used. For example,
+                                        sol2uml contracts,node_modules/@openzeppelin
                                   If an Ethereum address with a 0x prefix is passed, the verified source code from Etherscan will be used. For example
                                         sol2uml 0x79fEbF6B9F76853EDBcBc913e6aAE8232cFB9De9
 
@@ -203,13 +203,12 @@ Options:
   -s, --summary              Only show a summary of the file differences (default: false)
   -af --aFile <value>        Limit code compare to contract A source file with the full path and extension as displayed in the file summary (default: compares all source files)
   -bf --bFile <value>        Contract B source file with the full path and extension as displayed in the file summary. Used if aFile is specified and the source file has been renamed (default: aFile if specified)
-  -bn, --bNetwork <network>  Ethereum network which maps to a blockchain explorer for contract B if on a different blockchain to contract A. Contract A uses the `network` option (default: value of `network` option) (choices: "mainnet", "holesky", "sepolia", "polygon", "arbitrum", "avalanche", "bsc", "crono", "fantom", "moonbeam", "optimism", "gnosis", "celo", "base")
-  -be, --bExplorerUrl <url>  Override the `bNetwork` option with custom blockchain explorer API URL for contract B if on a different blockchain to contract A. Contract A uses the `explorerUrl` (default: value of `explorerUrl` option)
-  -bk, --bApiKey <key>       Blockchain explorer API key for contract B if on a different blockchain to contract A. Contract A uses the `apiKey` option (default: value of `apiKey` option)
+  -bn, --bNetwork <network>  Ethereum network which maps to a blockchain explorer for contract B if on a different blockchain to contract A. Contract A uses the `network` option (default: value of `network` option) (choices: "ethereum", "sepolia", "holesky", "hoodi", "arbitrum", "optimism", "polygon", "avalanche", "base", "bsc", "crono", "fantom", "sonic", "gnosis", "moonbeam", "celo", "scroll", "linea", "blast", "berachain", "zksync")
   --flatten                  Flatten into a single file before comparing. Only works when comparing two verified contracts, not to local files (default: false)
   --saveFiles                Save the flattened contract code to the filesystem when using the `flatten` option. The file names will be the contract address with a .sol extension (default: false)
   -l, --lineBuffer <value>   Minimum number of lines before and after changes (default: 4)
   -h, --help                 display help for command
+
 ```
 
 ## UML Class diagram examples

package/lib/associations.js

@@ -13,16 +13,23 @@ const findAssociatedClass = (association, sourceUmlClass, umlClasses, searchedAb
     // If a link was found
     if (umlClass)
         return umlClass;
-    // Could not find association so now need to recursively look at imports of imports
-    // add to already recursively processed files to avoid getting stuck in circular imports
-    searchedAbsolutePaths.push(sourceUmlClass.absolutePath);
-    const importedType = findChainedImport(association, sourceUmlClass, umlClasses, searchedAbsolutePaths);
-    if (importedType)
-        return importedType;
-    // Still could not find association so now need to recursively look for inherited types
-    const inheritedType = findInheritedType(association, sourceUmlClass, umlClasses);
-    if (inheritedType)
-        return inheritedType;
+    // // Could not find association so now need to recursively look at imports of imports
+    // // add to already recursively processed files to avoid getting stuck in circular imports
+    // searchedAbsolutePaths.push(sourceUmlClass.absolutePath)
+    // const importedType = findChainedImport(
+    //     association,
+    //     sourceUmlClass,
+    //     umlClasses,
+    //     searchedAbsolutePaths,
+    // )
+    // if (importedType) return importedType
+    // // Still could not find association so now need to recursively look for inherited types
+    // const inheritedType = findInheritedType(
+    //     association,
+    //     sourceUmlClass,
+    //     umlClasses,
+    // )
+    // if (inheritedType) return inheritedType
     return undefined;
 };
 exports.findAssociatedClass = findAssociatedClass;
@@ -109,39 +116,62 @@ const findInheritedType = (association, sourceUmlClass, umlClasses) => {
     }
     return undefined;
 };
-const findChainedImport = (association, sourceUmlClass, umlClasses, searchedRelativePaths) => {
-    // Get all valid imports. That is, imports that do not explicitly import contracts or interfaces
-    // or explicitly import the source class
-    const imports = sourceUmlClass.imports.filter((i) => i.classNames.length === 0 ||
-        i.classNames.some((cn) => (association.targetUmlClassName === cn.className &&
-            !cn.alias) ||
-            association.targetUmlClassName === cn.alias));
-    // For each import
-    for (const importDetail of imports) {
-        // Find a class with the same absolute path as the import so we can get the new imports
-        const newSourceUmlClass = umlClasses.find((c) => c.absolutePath === importDetail.absolutePath);
-        if (!newSourceUmlClass) {
-            // Could not find a class in the import file so just move onto the next loop
-            continue;
-        }
-        // Avoid circular imports
-        if (searchedRelativePaths.includes(newSourceUmlClass.absolutePath)) {
-            // Have already recursively looked for imports of imports in this file
-            continue;
-        }
-        // find class linked to the association without aliased imports
-        const umlClass = (0, exports.findAssociatedClass)(association, newSourceUmlClass, umlClasses, searchedRelativePaths);
-        if (umlClass)
-            return umlClass;
-        // find all aliased imports
-        const aliasedImports = importDetail.classNames.filter((cn) => cn.alias);
-        // For each aliased import
-        for (const aliasedImport of aliasedImports) {
-            const umlClass = (0, exports.findAssociatedClass)({ ...association, targetUmlClassName: aliasedImport.className }, newSourceUmlClass, umlClasses, searchedRelativePaths);
-            if (umlClass)
-                return umlClass;
-        }
-    }
-    return undefined;
-};
+// const findChainedImport = (
+//     association: Association,
+//     sourceUmlClass: UmlClass,
+//     umlClasses: readonly UmlClass[],
+//     searchedRelativePaths: string[],
+// ): UmlClass | undefined => {
+//     // Get all valid imports. That is, imports that do not explicitly import contracts or interfaces
+//     // or explicitly import the source class
+//     const imports = sourceUmlClass.imports.filter(
+//         (i) =>
+//             i.classNames.length === 0 ||
+//             i.classNames.some(
+//                 (cn) =>
+//                     (association.targetUmlClassName === cn.className &&
+//                         !cn.alias) ||
+//                     association.targetUmlClassName === cn.alias,
+//             ),
+//     )
+//     // For each import
+//     for (const importDetail of imports) {
+//         // Find a class with the same absolute path as the import so we can get the new imports
+//         const newSourceUmlClass = umlClasses.find(
+//             (c) => c.absolutePath === importDetail.absolutePath,
+//         )
+//         if (!newSourceUmlClass) {
+//             // Could not find a class in the import file so just move onto the next loop
+//             continue
+//         }
+//         // Avoid circular imports
+//         if (searchedRelativePaths.includes(newSourceUmlClass.absolutePath)) {
+//             // Have already recursively looked for imports of imports in this file
+//             continue
+//         }
+//
+//         // find class linked to the association without aliased imports
+//         const umlClass = findAssociatedClass(
+//             association,
+//             newSourceUmlClass,
+//             umlClasses,
+//             searchedRelativePaths,
+//         )
+//         if (umlClass) return umlClass
+//
+//         // find all aliased imports
+//         const aliasedImports = importDetail.classNames.filter((cn) => cn.alias)
+//         // For each aliased import
+//         for (const aliasedImport of aliasedImports) {
+//             const umlClass = findAssociatedClass(
+//                 { ...association, targetUmlClassName: aliasedImport.className },
+//                 newSourceUmlClass,
+//                 umlClasses,
+//                 searchedRelativePaths,
+//             )
+//             if (umlClass) return umlClass
+//         }
+//     }
+//     return undefined
+// }
 //# sourceMappingURL=associations.js.map

package/lib/converterAST2Classes.js

@@ -15,15 +15,26 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.renameFile = exports.convertAST2UmlClasses = void 0;
+exports.renameFile = void 0;
+exports.convertAST2UmlClasses = convertAST2UmlClasses;
 const path = __importStar(require("path"));
 const path_1 = require("path");
 const umlClass_1 = require("./umlClass");
@@ -48,7 +59,7 @@ function convertAST2UmlClasses(node, relativePath, remappings, filesystem = fals
                     name: childNode.name,
                     absolutePath: filesystem
                         ? path.resolve(relativePath) // resolve the absolute path
-                        : relativePath,
+                        : relativePath, // from Etherscan so don't resolve
                     relativePath,
                 });
                 umlClasses.push(umlClass);
@@ -62,7 +73,7 @@ function convertAST2UmlClasses(node, relativePath, remappings, filesystem = fals
                     stereotype: umlClass_1.ClassStereotype.Struct,
                     absolutePath: filesystem
                         ? path.resolve(relativePath) // resolve the absolute path
-                        : relativePath,
+                        : relativePath, // from Etherscan so don't resolve
                     relativePath,
                 });
                 parseStructDefinition(childNode, umlClass);
@@ -76,7 +87,7 @@ function convertAST2UmlClasses(node, relativePath, remappings, filesystem = fals
                     stereotype: umlClass_1.ClassStereotype.Enum,
                     absolutePath: filesystem
                         ? path.resolve(relativePath) // resolve the absolute path
-                        : relativePath,
+                        : relativePath, // from Etherscan so don't resolve
                     relativePath,
                 });
                 debug(`Added enum ${umlClass.name}`);
@@ -143,7 +154,7 @@ function convertAST2UmlClasses(node, relativePath, remappings, filesystem = fals
                     stereotype: umlClass_1.ClassStereotype.Constant,
                     absolutePath: filesystem
                         ? path.resolve(relativePath) // resolve the absolute path
-                        : relativePath,
+                        : relativePath, // from Etherscan so don't resolve
                     relativePath,
                     attributes: [
                         {
@@ -181,7 +192,7 @@ function convertAST2UmlClasses(node, relativePath, remappings, filesystem = fals
             stereotype: umlClass_1.ClassStereotype.Import,
             absolutePath: filesystem
                 ? path.resolve(relativePath) // resolve the absolute path
-                : relativePath,
+                : relativePath, // from Etherscan so don't resolve
             relativePath,
         });
         importUmlClass.imports = imports;
@@ -189,7 +200,6 @@ function convertAST2UmlClasses(node, relativePath, remappings, filesystem = fals
     }
     return umlClasses;
 }
-exports.convertAST2UmlClasses = convertAST2UmlClasses;
 /**
  * Parse struct definition for UML attributes and associations.
  * @param node defined in ASTNode as `StructDefinition`

package/lib/converterClasses2Dot.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addAssociationsToDot = exports.convertUmlClasses2Dot = void 0;
+exports.convertUmlClasses2Dot = convertUmlClasses2Dot;
+exports.addAssociationsToDot = addAssociationsToDot;
 const path_1 = require("path");
 const converterClass2Dot_1 = require("./converterClass2Dot");
 const umlClass_1 = require("./umlClass");
@@ -49,7 +50,6 @@ label="${codeFolder}"`;
     debug(dotString);
     return dotString;
 }
-exports.convertUmlClasses2Dot = convertUmlClasses2Dot;
 let subGraphCount = 0;
 function getSubGraphName(clusterFolders = false) {
     if (clusterFolders) {
@@ -104,7 +104,6 @@ function addAssociationsToDot(umlClasses, classOptions = {}) {
     }
     return dotString;
 }
-exports.addAssociationsToDot = addAssociationsToDot;
 function addAssociationToDot(sourceUmlClass, targetUmlClass, association, classOptions = {}) {
     // do not include library or interface associations if hidden
     // Or associations to Structs, Enums or Constants if they are hidden

package/lib/converterStorage2Dot.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertStorage2Dot = exports.convertStorages2Dot = void 0;
+exports.convertStorages2Dot = void 0;
+exports.convertStorage2Dot = convertStorage2Dot;
 const converterClasses2Storage_1 = require("./converterClasses2Storage");
 const umlClass_1 = require("./umlClass");
 const formatters_1 = require("./utils/formatters");
@@ -113,7 +114,6 @@ function convertStorage2Dot(storageSection, dotString, options) {
     dotString += '}}"]\n';
     return dotString;
 }
-exports.convertStorage2Dot = convertStorage2Dot;
 const dotVariable = (variable, contractName) => {
     const port = variable.referenceSectionId !== undefined ? `<${variable.id}>` : '';
     const contractNamePrefix = variable.contractName !== contractName

package/lib/parserEtherscan.d.ts

@@ -4,13 +4,14 @@ export interface Remapping {
     from: RegExp;
     to: string;
 }
-export declare const networks: readonly ["mainnet", "holesky", "sepolia", "polygon", "arbitrum", "avalanche", "bsc", "crono", "fantom", "moonbeam", "optimism", "gnosis", "celo", "scroll", "base", "sonic"];
+export declare const networks: readonly ["ethereum", "sepolia", "holesky", "hoodi", "arbitrum", "optimism", "polygon", "avalanche", "base", "bsc", "crono", "fantom", "sonic", "gnosis", "moonbeam", "celo", "scroll", "linea", "blast", "berachain", "zksync"];
 export type Network = (typeof networks)[number];
+export declare const setChainId: (network: string) => number;
 export declare class EtherscanParser {
-    protected apikey: string;
+    protected apiKey?: string;
     network: Network;
     readonly url: string;
-    constructor(apikey?: string, network?: Network, url?: string);
+    constructor(apiKey?: string, network?: Network, url?: string);
     /**
      * Parses the verified source code files from Etherscan
      * @param contractAddress Ethereum contract address with a 0x prefix

package/lib/parserEtherscan.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseRemapping = exports.parseRemappings = exports.EtherscanParser = exports.networks = void 0;
+exports.parseRemapping = exports.parseRemappings = exports.EtherscanParser = exports.setChainId = exports.networks = void 0;
 const axios_1 = __importDefault(require("axios"));
 const parser_1 = require("@solidity-parser/parser");
 const converterAST2Classes_1 = require("./converterAST2Classes");
@@ -13,92 +13,89 @@ const path_1 = __importDefault(require("path"));
 require('axios-debug-log');
 const debug = require('debug')('sol2uml');
 exports.networks = [
-    'mainnet',
-    'holesky',
+    'ethereum',
     'sepolia',
-    'polygon',
+    'holesky',
+    'hoodi',
     'arbitrum',
+    'optimism',
+    'polygon',
     'avalanche',
+    'base',
     'bsc',
     'crono',
     'fantom',
-    'moonbeam',
-    'optimism',
+    'sonic',
     'gnosis',
+    'moonbeam',
     'celo',
     'scroll',
-    'base',
-    'sonic',
+    'linea',
+    'blast',
+    'berachain',
+    'zksync',
 ];
+const setChainId = (network) => 
+// If an integer is passed, return it as is
+/^-?(0|[1-9]\d*)$/.test(network)
+    ? parseInt(network)
+    : network === 'sepolia'
+        ? 11155111
+        : network === 'holesky'
+            ? 17000
+            : network === 'hoodi'
+                ? 560048
+                : network === 'arbitrum'
+                    ? 42161
+                    : network === 'optimism'
+                        ? 10
+                        : network === 'polygon'
+                            ? 137
+                            : network === 'avalanche'
+                                ? 43114
+                                : network === 'base'
+                                    ? 8453
+                                    : network === 'bsc'
+                                        ? 56
+                                        : network === 'crono'
+                                            ? 25
+                                            : network === 'fantom'
+                                                ? 250
+                                                : network === 'sonic'
+                                                    ? 146
+                                                    : network === 'gnosis'
+                                                        ? 100
+                                                        : network === 'moonbeam'
+                                                            ? 1284
+                                                            : network === 'celo'
+                                                                ? 42220
+                                                                : network === 'scroll'
+                                                                    ? 534352
+                                                                    : network === 'linea'
+                                                                        ? 59144
+                                                                        : network === 'blast'
+                                                                            ? 81457
+                                                                            : network === 'berachain'
+                                                                                ? 80094
+                                                                                : network === 'zksync'
+                                                                                    ? 324
+                                                                                    : 1;
+exports.setChainId = setChainId;
 class EtherscanParser {
-    constructor(apikey = 'ZAD4UI2RCXCQTP38EXS3UY2MPHFU5H9KB1', network = 'mainnet', url) {
-        this.apikey = apikey;
+    constructor(apiKey, network = 'ethereum', url) {
+        this.apiKey = apiKey;
         this.network = network;
         if (url) {
             this.url = url;
             return;
         }
-        if (!exports.networks.includes(network)) {
-            throw new Error(`Invalid network "${network}". Must be one of ${exports.networks}`);
-        }
-        else if (network === 'mainnet') {
-            this.url = 'https://api.etherscan.io/api';
-        }
-        else if (network === 'polygon') {
-            this.url = 'https://api.polygonscan.com/api';
-            this.apikey = 'AMHGNTV5A7XYGX2M781JB3RC1DZFVRWQEB';
-        }
-        else if (network === 'arbitrum') {
-            this.url = 'https://api.arbiscan.io/api';
-            this.apikey = 'ZGTK2TAGWMAB6IAC12BMK8YYPNCPIM8VDQ';
-        }
-        else if (network === 'avalanche') {
-            this.url = 'https://api.snowtrace.io/api';
-            this.apikey = 'U5FAN98S5XNH5VI83TI4H35R9I4TDCKEJY';
-        }
-        else if (network === 'bsc') {
-            this.url = 'https://api.bscscan.com/api';
-            this.apikey = 'APYH49FXVY9UA3KTDI6F4WP3KPIC86NITN';
-        }
-        else if (network === 'crono') {
-            this.url = 'https://api.cronoscan.com/api';
-            this.apikey = '76A3RG5WHTPMMR66E9SFI2EIDT6MP976W2';
-        }
-        else if (network === 'fantom') {
-            this.url = 'https://api.ftmscan.com/api';
-            this.apikey = '71KRX13XPZMGR3D1Q85W78G2DSZ4JPMAEX';
-        }
-        else if (network === 'optimism') {
-            this.url = `https://api-optimistic.etherscan.io/api`;
-            this.apikey = 'FEXS1HXVA4Y2RNTMEA8V1UTK21S4JWHH9U';
-        }
-        else if (network === 'moonbeam') {
-            this.url = 'https://api-moonbeam.moonscan.io/api';
-            this.apikey = '5EUFXW6TDC16VERF3D9SCWRRU6AEMTBHNJ';
-        }
-        else if (network === 'gnosis') {
-            this.url = 'https://api.gnosisscan.io/api';
-            this.apikey = '2RWGXIWK538EJ8XSP9DE2JUINSCG7UCSJB';
-        }
-        else if (network === 'scroll') {
-            this.url = 'https://api.scrollscan.com/api';
-            this.apikey = '4V37ZJFIN9AURJSU9YG1RP3MSVTPH6D6Z4';
-        }
-        else if (network === 'celo') {
-            this.url = 'https://api.celoscan.io/api';
-            this.apikey = 'JBV78T5KP15W7WKKKD6KC4J8RX2F4PK8AF';
-        }
-        else if (network === 'base') {
-            this.url = 'https://api.basescan.org/api';
-            this.apikey = '9I5HUJHPD4ZNXJ4M8TZJ1HD2QBVP1U3M3J';
-        }
-        else if (network === 'sonic') {
-            this.url = 'https://api.sonicscan.org/api';
-            this.apikey = 'STCM7CPYP341C66C4IVV1IFMWDYRUTI1QY';
-        }
-        else {
-            this.url = `https://api-${network}.etherscan.io/api`;
+        if (!apiKey) {
+            console.error(`The apiKey option must be set when getting verified source code from an Etherscan like explorer`);
+            process.exit(1);
         }
+        const chainId = (0, exports.setChainId)(network);
+        debug(`Chain id ${chainId} for network ${network}`);
+        this.url = `https://api.etherscan.io/v2/api?chainid=${chainId}`;
     }
     /**
      * Parses the verified source code files from Etherscan
@@ -200,7 +197,7 @@ class EtherscanParser {
                     module: 'contract',
                     action: 'getsourcecode',
                     address: contractAddress,
-                    apikey: this.apikey,
+                    apikey: this.apiKey,
                 },
             });
             if (!Array.isArray(response?.data?.result)) {

package/lib/parserFiles.js

@@ -3,7 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isFolder = exports.isFile = exports.readFile = exports.parseSolidityFile = exports.getSolidityFilesFromFolderOrFile = exports.getSolidityFilesFromFolderOrFiles = exports.parseUmlClassesFromFiles = void 0;
+exports.isFolder = exports.isFile = exports.readFile = exports.parseUmlClassesFromFiles = void 0;
+exports.getSolidityFilesFromFolderOrFiles = getSolidityFilesFromFolderOrFiles;
+exports.getSolidityFilesFromFolderOrFile = getSolidityFilesFromFolderOrFile;
+exports.parseSolidityFile = parseSolidityFile;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const klaw_1 = __importDefault(require("klaw"));
@@ -30,7 +33,6 @@ async function getSolidityFilesFromFolderOrFiles(folderOrFilePaths, ignoreFilesO
     }
     return files;
 }
-exports.getSolidityFilesFromFolderOrFiles = getSolidityFilesFromFolderOrFiles;
 function getSolidityFilesFromFolderOrFile(folderOrFilePath, ignoreFilesOrFolders = [], depthLimit = -1) {
     debug(`About to get Solidity files under ${folderOrFilePath}`);
     return new Promise((resolve, reject) => {
@@ -87,7 +89,6 @@ function getSolidityFilesFromFolderOrFile(folderOrFilePath, ignoreFilesOrFolders
         }
     });
 }
-exports.getSolidityFilesFromFolderOrFile = getSolidityFilesFromFolderOrFile;
 function parseSolidityFile(fileName) {
     const solidityCode = (0, exports.readFile)(fileName);
     try {
@@ -99,7 +100,6 @@ function parseSolidityFile(fileName) {
         });
     }
 }
-exports.parseSolidityFile = parseSolidityFile;
 const readFile = (fileName, extension) => {
     try {
         // try to read file with no extension

package/lib/parserGeneral.js

@@ -16,7 +16,7 @@ const parserUmlClasses = async (fileFolderAddress, options) => {
     };
     if ((0, regEx_1.isAddress)(fileFolderAddress)) {
         debug(`argument ${fileFolderAddress} is an Ethereum address so checking Etherscan for the verified source code`);
-        const etherscanApiKey = options.apiKey || 'ZAD4UI2RCXCQTP38EXS3UY2MPHFU5H9KB1';
+        const etherscanApiKey = options.apiKey;
         const etherscanParser = new parserEtherscan_1.EtherscanParser(etherscanApiKey, options.network, options.explorerUrl);
         result = await etherscanParser.getUmlClasses(fileFolderAddress);
     }

package/lib/slotValues.d.ts

@@ -22,7 +22,7 @@ export declare const parseValue: (variable: Variable) => string;
  * @param blockTag block number or `latest`
  * @return slotValues array of 32 byte slot values as hexadecimal strings
  */
-export declare const getSlotValues: (url: string, contractAddress: string, slotKeys: readonly BigNumberish[], blockTag?: BigNumberish | 'latest') => Promise<string[]>;
+export declare const getSlotValues: (url: string, contractAddress: string, slotKeys: readonly BigNumberish[], blockTag?: BigNumberish | "latest") => Promise<string[]>;
 /**
  * Get storage slot values from JSON-RPC API provider.
  * @param url of Ethereum JSON-RPC API provider. eg Infura or Alchemy
@@ -32,7 +32,7 @@ export declare const getSlotValues: (url: string, contractAddress: string, slotK
  * @param blockTag block number or `latest`
  * @return slotValue 32 byte slot value as hexadecimal string
  */
-export declare const getSlotValue: (url: string, contractAddress: string, slotKey: BigNumberish, blockTag: BigNumberish | 'latest') => Promise<string>;
+export declare const getSlotValue: (url: string, contractAddress: string, slotKey: BigNumberish, blockTag: BigNumberish | "latest") => Promise<string>;
 /**
  * Calculates the number of string characters or bytes of a string or bytes type.
  * See the following for how string and bytes are stored in storage slots

package/lib/sol2uml.js

@@ -30,12 +30,12 @@ Can also flatten or compare verified source files on Etherscan-like explorers.`)
     .default('svg'))
     .option('-o, --outputFileName <value>', 'output file name')
     .option('-i, --ignoreFilesOrFolders <names>', 'comma-separated list of files or folders to ignore', validators_1.validateNames)
-    .addOption(new commander_1.Option('-n, --network <network>', 'Ethereum network which maps to a blockchain explorer')
-    .choices(parserEtherscan_1.networks)
-    .default('mainnet')
+    .addOption(new commander_1.Option('-n, --network <network>', 'Name or chain id of the blockchain explorer. A name like `ethereum` or `base` will map to a chain id, eg 1 or 8453. Alternatively, use an integer of the chain id. Supported names: ' +
+    parserEtherscan_1.networks.join(', '))
+    .default('ethereum')
     .env('ETH_NETWORK'))
     .addOption(new commander_1.Option('-e, --explorerUrl <url>', 'Override the `network` option with a custom blockchain explorer API URL. eg Polygon Mumbai testnet https://api-testnet.polygonscan.com/api').env('EXPLORER_URL'))
-    .addOption(new commander_1.Option('-k, --apiKey <key>', 'Blockchain explorer API key. eg Etherscan, Arbiscan, Optimism, BscScan, CronoScan, FTMScan, PolygonScan, SonicScan or SnowTrace API key').env('SCAN_API_KEY'))
+    .addOption(new commander_1.Option('-k, --apiKey <key>', 'Blockchain explorer API key.').env('SCAN_API_KEY'))
     .option('-bc, --backColor <color>', 'Canvas background color. "none" will use a transparent canvas.', 'white')
     .option('-sc, --shapeColor <color>', 'Basic drawing color for graphics, not text', 'black')
     .option('-fc, --fillColor <color>', 'Color used to fill the background of a node', 'gray95')
@@ -235,8 +235,6 @@ The line numbers are from contract B. There are no line numbers for the red sect
     .option('-af --aFile <value>', 'Limit code compare to contract A source file with the full path and extension as displayed in the file summary (default: compares all source files)')
     .option('-bf --bFile <value>', 'Contract B source file with the full path and extension as displayed in the file summary. Used if aFile is specified and the source file has been renamed (default: aFile if specified)')
     .addOption(new commander_1.Option('-bn, --bNetwork <network>', 'Ethereum network which maps to a blockchain explorer for contract B if on a different blockchain to contract A. Contract A uses the `network` option (default: value of `network` option)').choices(parserEtherscan_1.networks))
-    .option('-be, --bExplorerUrl <url>', 'Override the `bNetwork` option with custom blockchain explorer API URL for contract B if on a different blockchain to contract A. Contract A uses the `explorerUrl` (default: value of `explorerUrl` option)')
-    .option('-bk, --bApiKey <key>', 'Blockchain explorer API key for contract B if on a different blockchain to contract A. Contract A uses the `apiKey` option (default: value of `apiKey` option)')
     .option('--flatten', 'Flatten into a single file before comparing. Only works when comparing two verified contracts, not to local files', false)
     .option('--saveFiles', 'Save the flattened contract code to the filesystem when using the `flatten` option. The file names will be the contract address with a .sol extension', false)
     .option('-l, --lineBuffer <value>', 'Minimum number of lines before and after changes (default: 4)', validators_1.validateLineBuffer)
@@ -250,7 +248,7 @@ The line numbers are from contract B. There are no line numbers for the red sect
         const aEtherscanParser = new parserEtherscan_1.EtherscanParser(combinedOptions.apiKey, combinedOptions.network, combinedOptions.explorerUrl);
         if ((0, regEx_1.isAddress)(fileFoldersAddress)) {
             const addressB = fileFoldersAddress;
-            const bEtherscanParser = new parserEtherscan_1.EtherscanParser(combinedOptions.bApiKey || combinedOptions.apiKey, combinedOptions.bNetwork || combinedOptions.network, combinedOptions.bExplorerUrl || combinedOptions.explorerUrl);
+            const bEtherscanParser = new parserEtherscan_1.EtherscanParser(combinedOptions.apiKey, combinedOptions.bNetwork || combinedOptions.network, combinedOptions.explorerUrl);
             // If flattening
             if (options.flatten) {
                 await (0, diffContracts_1.compareFlattenContracts)(addressA, addressB, aEtherscanParser, bEtherscanParser, combinedOptions);

package/lib/squashClasses.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.squashUmlClasses = void 0;
 const umlClass_1 = require("./umlClass");

package/lib/utils/diff.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.diffCode = void 0;
 const diff_match_patch_1 = __importStar(require("diff-match-patch"));

package/lib/writerFiles.js

@@ -3,7 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writePng = exports.writeSVG = exports.writeDot = exports.writeSourceCode = exports.convertDot2Svg = exports.writeOutputFiles = void 0;
+exports.writeOutputFiles = void 0;
+exports.convertDot2Svg = convertDot2Svg;
+exports.writeSourceCode = writeSourceCode;
+exports.writeDot = writeDot;
+exports.writeSVG = writeSVG;
+exports.writePng = writePng;
 const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
 const sync_1 = __importDefault(require("@aduh95/viz.js/sync"));
@@ -63,7 +68,6 @@ function convertDot2Svg(dot) {
         throw new Error(`Failed to parse dot string`, { cause: err });
     }
 }
-exports.convertDot2Svg = convertDot2Svg;
 function writeSourceCode(code, filename = 'source', extension = '.sol') {
     const fileExtension = path_1.default.extname(filename);
     const outputFile = fileExtension === extension ? filename : filename + extension;
@@ -79,7 +83,6 @@ function writeSourceCode(code, filename = 'source', extension = '.sol') {
         }
     });
 }
-exports.writeSourceCode = writeSourceCode;
 function writeDot(dot, filename) {
     const dotFilename = changeFileExtension(filename, 'dot');
     debug(`About to write Dot file to ${dotFilename}`);
@@ -94,7 +97,6 @@ function writeDot(dot, filename) {
         }
     });
 }
-exports.writeDot = writeDot;
 /**
  * Writes an SVG file to the file system.
  * @param svg The SVG input to be written to the file system.
@@ -127,7 +129,6 @@ function writeSVG(svg, svgFilename = 'classDiagram.svg', outputFormats = 'png')
         });
     });
 }
-exports.writeSVG = writeSVG;
 /**
  * Asynchronously writes a PNG file to the file system from an SVG input.
  * @param svg - The SVG input to be converted to a PNG file.
@@ -161,7 +162,6 @@ async function writePng(svg, filename) {
         });
     }
 }
-exports.writePng = writePng;
 // put a new file extension on a filename
 const changeFileExtension = (filename, extension) => {
     const parsedFile = path_1.default.parse(filename);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sol2uml",
-  "version": "2.5.21",
+  "version": "2.5.22",
   "description": "Solidity contract visualisation tool.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -23,28 +23,28 @@
   "license": "MIT",
   "dependencies": {
     "@aduh95/viz.js": "^3.7.0",
-    "@solidity-parser/parser": "^0.16.1",
-    "axios": "^1.6.0",
+    "@solidity-parser/parser": "^0.20.1",
+    "axios": "^1.10.0",
     "axios-debug-log": "^1.0.0",
-    "cli-color": "^2.0.3",
-    "commander": "^11.1.0",
+    "cli-color": "^2.0.4",
+    "commander": "^12.1.0",
     "convert-svg-to-png": "^0.6.4",
-    "debug": "^4.3.4",
+    "debug": "^4.4.1",
     "diff-match-patch": "^1.0.5",
-    "ethers": "^5.7.2",
+    "ethers": "^5.8.0",
     "js-graph-algorithms": "^1.0.18",
     "klaw": "^4.1.0"
   },
   "devDependencies": {
     "@openzeppelin/contracts": "^4.9.3",
-    "@types/diff-match-patch": "^1.0.35",
-    "@types/jest": "^29.5.7",
-    "@types/klaw": "^3.0.5",
-    "jest": "^29.7.0",
-    "prettier": "^3.0.3",
-    "ts-jest": "^29.1.1",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.2.2"
+    "@types/diff-match-patch": "^1.0.36",
+    "@types/jest": "^29.5.14",
+    "@types/klaw": "^3.0.7",
+    "jest": "^30.0.0",
+    "prettier": "^3.5.3",
+    "ts-jest": "^29.4.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3"
   },
   "files": [
     "lib/*.js",