sol2uml 2.5.15 → 2.5.17

package/README.md

@@ -57,7 +57,7 @@ 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", "goerli", "sepolia", "polygon", "arbitrum", "avalanche", "bsc", "crono", "fantom", "moonbeam", "optimism", "gnosis", "celo", "base", default: "mainnet", env: ETH_NETWORK)
+  -n, --network <network>                         Ethereum network which maps to a blockchain explorer (choices: "mainnet", "goerli", "sepolia", "polygon", "arbitrum", "avalanche", "bsc", "crono", "fantom", "moonbeam", "optimism", "gnosis", "celo", "scroll", "base", default: "mainnet", 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 or SnowTrace API key (env: SCAN_API_KEY)
   -bc, --backColor <color>                        Canvas background color. "none" will use a transparent canvas. (default: "white")

package/lib/diffContracts.js

@@ -28,7 +28,7 @@ const compareVerified2Local = async (addressA, aEtherscanParser, fileOrBaseFolde
     if (!options.summary) {
         (0, exports.displayFileDiffs)(files, options);
     }
-    const aFileDesc = `"${options.aFile}" file for the `;
+    const aFileDesc = options.aFile ? `"${options.aFile}" file with the ` : '';
     console.log(`Compared the ${aFileDesc}"${contractNameA}" contract with address ${addressA} on ${options.network}`);
     if (local) {
         console.log(`to local file "${fileOrBaseFolders}"\n`);
@@ -49,7 +49,7 @@ const compareFlattenContracts = async (addressA, addressB, aEtherscanParser, bEt
         await (0, writerFiles_1.writeSourceCode)(codeB, addressB);
     }
     if (options.bFile || options.aFile) {
-        console.log(`Compared the "${options.aFile}" file for the "${contractNameA}" contract with address ${addressA} on ${options.network}`);
+        console.log(`Compared the "${options.aFile}" file with the "${contractNameA}" contract with address ${addressA} on ${options.network}`);
         console.log(`to the "${options.bFile || options.aFile}" file for the "${contractNameB}" contract with address ${addressB} on ${options.bNetwork || options.network}\n`);
     }
     else {

package/lib/parserEtherscan.d.ts

@@ -4,7 +4,7 @@ export interface Remapping {
     from: RegExp;
     to: string;
 }
-export declare const networks: readonly ["mainnet", "goerli", "sepolia", "polygon", "arbitrum", "avalanche", "bsc", "crono", "fantom", "moonbeam", "optimism", "gnosis", "celo", "base"];
+export declare const networks: readonly ["mainnet", "goerli", "sepolia", "polygon", "arbitrum", "avalanche", "bsc", "crono", "fantom", "moonbeam", "optimism", "gnosis", "celo", "scroll", "base"];
 export type Network = (typeof networks)[number];
 export declare class EtherscanParser {
     protected apikey: string;

package/lib/parserEtherscan.js

@@ -26,6 +26,7 @@ exports.networks = [
     'optimism',
     'gnosis',
     'celo',
+    'scroll',
     'base',
 ];
 class EtherscanParser {
@@ -78,6 +79,10 @@ class EtherscanParser {
             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';

package/lib/slotValues.js

@@ -9,6 +9,7 @@ const axios_1 = __importDefault(require("axios"));
 const umlClass_1 = require("./umlClass");
 const utils_1 = require("ethers/lib/utils");
 const SlotValueCache_1 = require("./SlotValueCache");
+const ethers_1 = require("ethers");
 const debug = require('debug')('sol2uml');
 /**
  * Adds the slot values to the variables in the storage section.
@@ -211,12 +212,20 @@ const getSlotValues = async (url, contractAddress, slotKeys, blockTag = 'latest'
         const block = blockTag === 'latest'
             ? blockTag
             : (0, utils_1.hexValue)(bignumber_1.BigNumber.from(blockTag));
-        // get cached values and missing slot keys from from cache
+        // get cached values and missing slot keys from the cache
         const { cachedValues, missingKeys } = SlotValueCache_1.SlotValueCache.readSlotValues(slotKeys);
         // If all values are in the cache then just return the cached values
         if (missingKeys.length === 0) {
             return cachedValues;
         }
+        // Check we are pointing to the correct chain by checking the contract has code
+        const provider = new ethers_1.ethers.providers.JsonRpcProvider(url);
+        const code = await provider.getCode(contractAddress, block);
+        if (!code || code === '0x') {
+            const msg = `Address ${contractAddress} has no code. Check your "-u, --url" option or "NODE_URL" environment variable is pointing to the correct node.\nurl: ${url}`;
+            console.error(msg);
+            throw Error(msg);
+        }
         debug(`About to get ${slotKeys.length} storage values for ${contractAddress} at block ${blockTag} from slot ${missingKeys[0].toString()}`);
         // Get the values for the missing slot keys
         const payload = missingKeys.map((key) => ({

package/lib/sol2uml.js

@@ -2,7 +2,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
-const ethers_1 = require("ethers");
 const path_1 = require("path");
 const converterClasses2Dot_1 = require("./converterClasses2Dot");
 const converterClasses2Storage_1 = require("./converterClasses2Storage");
@@ -16,6 +15,7 @@ const slotValues_1 = require("./slotValues");
 const regEx_1 = require("./utils/regEx");
 const validators_1 = require("./utils/validators");
 const writerFiles_1 = require("./writerFiles");
+const block_1 = require("./utils/block");
 const clc = require('cli-color');
 const program = new commander_1.Command();
 const debugControl = require('debug');
@@ -171,12 +171,7 @@ WARNING: sol2uml does not use the Solidity compiler so may differ with solc. A k
                 }
                 storageAddress = fileFolderAddress;
             }
-            let block = combinedOptions.block;
-            if (block === 'latest') {
-                const provider = new ethers_1.ethers.providers.JsonRpcProvider(combinedOptions.url);
-                block = await provider.getBlockNumber();
-                debug(`Latest block is ${block}. All storage slot values will be from this block.`);
-            }
+            let block = await (0, block_1.getBlock)(combinedOptions);
             // Get slot values for each storage section
             for (const storageSection of storageSections) {
                 await (0, slotValues_1.addSlotValues)(combinedOptions.url, storageAddress, storageSection, arrayItems, block);

package/lib/utils/block.d.ts

@@ -0,0 +1,5 @@
+export declare const getBlock: (options: {
+    block: string;
+    url: string;
+    network: string;
+}) => Promise<number>;

package/lib/utils/block.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBlock = void 0;
+const ethers_1 = require("ethers");
+const debug = require('debug')('sol2uml');
+const getBlock = async (options) => {
+    if (options.block === 'latest') {
+        try {
+            const provider = new ethers_1.ethers.providers.JsonRpcProvider(options.url);
+            const block = await provider.getBlockNumber();
+            debug(`Latest block is ${block}. All storage slot values will be from this block.`);
+            return block;
+        }
+        catch (err) {
+            const defaultMessage = options.url === 'http://localhost:8545'
+                ? 'This is the default url. Use the `-u, --url` option or `NODE_URL` environment variable to set the url of your blockchain node.'
+                : `Check your --url option or NODE_URL environment variable is pointing to the correct node for the "${options.network}" blockchain.`;
+            throw Error(`Failed to connect to blockchain node with url ${options.url}.\n${defaultMessage}`);
+        }
+    }
+    try {
+        return parseInt(options.block);
+    }
+    catch (err) {
+        throw Error(`Invalid block number: ${options.block}`);
+    }
+};
+exports.getBlock = getBlock;
+//# sourceMappingURL=block.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sol2uml",
-  "version": "2.5.15",
+  "version": "2.5.17",
   "description": "Solidity contract visualisation tool.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -24,10 +24,10 @@
   "dependencies": {
     "@aduh95/viz.js": "^3.7.0",
     "@solidity-parser/parser": "^0.16.1",
-    "axios": "^1.3.4",
+    "axios": "^1.6.0",
     "axios-debug-log": "^1.0.0",
     "cli-color": "^2.0.3",
-    "commander": "^11.0.0",
+    "commander": "^11.1.0",
     "convert-svg-to-png": "^0.6.4",
     "debug": "^4.3.4",
     "diff-match-patch": "^1.0.5",
@@ -37,14 +37,14 @@
   },
   "devDependencies": {
     "@openzeppelin/contracts": "^4.9.3",
-    "@types/diff-match-patch": "^1.0.32",
-    "@types/jest": "^29.5.3",
-    "@types/klaw": "^3.0.3",
-    "jest": "^29.6.2",
-    "prettier": "^3.0.1",
+    "@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.1.6"
+    "typescript": "^5.2.2"
   },
   "files": [
     "lib/*.js",