sol2uml 2.5.6 → 2.5.7

package/README.md

@@ -189,15 +189,21 @@ The red sections are removals from contract A that are not in contract B.
 The line numbers are from contract B. There are no line numbers for the red sections as they are not in contract B.
 
 Arguments:
-  addressA                  Contract address in hexadecimal format with a 0x prefix of the first contract.
-  addressB                  Contract address in hexadecimal format with a 0x prefix of the second contract.
+  addressA                   Contract address in hexadecimal format with a 0x prefix of the first contract
+  addressB                   Contract address in hexadecimal format with a 0x prefix of the second contract
 
 Options:
-  -l, --lineBuffer <value>  Minimum number of lines before and after changes (default: "4")
-  --aFile <value>           Contract A source code filename without the .sol extension. (default: compares all source files)
-  --bFile <value>           Contract B source code filename without the .sol extension. (default: aFile if specified)
-  -s, --saveFiles           Save the flattened contract code to the filesystem. The file names will be the contract address with a .sol extension. (default: false)
-  -h, --help                display help for command
+  -l, --lineBuffer <value>   Minimum number of lines before and after changes (default: 4)
+  -af --aFile <value>        Contract A source code filename without the .sol extension (default: compares all source files)
+  -bf --bFile <value>        Contract B source code filename without the .sol extension (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", "goerli", "sepolia", "polygon",
+                             "arbitrum", "avalanche", "bsc", "crono", "fantom", "moonbeam", "optimism", "gnosis", "celo")
+  -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)
+  -s, --summary              Only show a summary of the file differences. (default: false)
+  --flatten                  Flatten into a single file before comparing (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)
+  -h, --help                 display help for command
 ```
 
 ## UML Class diagram examples

package/lib/converterClasses2Storage.js

@@ -18,7 +18,7 @@ var StorageSectionType;
     StorageSectionType["Array"] = "Array";
     StorageSectionType["Bytes"] = "Bytes";
     StorageSectionType["String"] = "String";
-})(StorageSectionType = exports.StorageSectionType || (exports.StorageSectionType = {}));
+})(StorageSectionType || (exports.StorageSectionType = StorageSectionType = {}));
 let storageId = 1;
 let variableId = 1;
 /**

package/lib/diffContracts.d.ts

@@ -0,0 +1,35 @@
+import { EtherscanParser } from './parserEtherscan';
+interface DiffOptions {
+    network: string;
+    lineBuffer: number;
+}
+interface FlattenAndDiffOptions extends DiffOptions {
+    aFile?: string;
+    bFile?: string;
+    saveFiles?: boolean;
+}
+interface DiffFiles {
+    filename?: string;
+    aCode?: string;
+    bCode?: string;
+    result: 'added' | 'removed' | 'match' | 'changed';
+}
+interface CompareContracts {
+    files: DiffFiles[];
+    contractNameA: string;
+    contractNameB: string;
+}
+export declare const compareContracts: (addressA: string, addressB: string, etherscanParserA: EtherscanParser, etherscanParserB: EtherscanParser, options: DiffOptions) => Promise<CompareContracts>;
+export declare const displayContractNames: (addressA: string, addressB: string, contractNameA: string, contractNameB: string, options: {
+    network: string;
+    bNetwork?: string;
+}) => void;
+export declare const displayFileDiffSummary: (fileDiffs: DiffFiles[]) => void;
+export declare const displayFileDiffs: (fileDiffs: DiffFiles[], options?: {
+    lineBuffer?: number;
+}) => void;
+export declare const flattenAndDiff: (addressA: string, addressB: string, aEtherscanParser: EtherscanParser, bEtherscanParser: EtherscanParser, options: FlattenAndDiffOptions) => Promise<{
+    contractNameA: string;
+    contractNameB: string;
+}>;
+export {};

package/lib/diffContracts.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.flattenAndDiff = exports.displayFileDiffs = exports.displayFileDiffSummary = exports.displayContractNames = exports.compareContracts = void 0;
+const regEx_1 = require("./utils/regEx");
+const clc = require('cli-color');
+const writerFiles_1 = require("./writerFiles");
+const diff_1 = require("./utils/diff");
+const compareContracts = async (addressA, addressB, etherscanParserA, etherscanParserB, options) => {
+    const files = [];
+    const { files: aFiles, contractName: contractNameA } = await etherscanParserA.getSourceCode(addressA);
+    const { files: bFiles, contractName: contractNameB } = await etherscanParserB.getSourceCode(addressB);
+    if (aFiles.length === 1 && bFiles.length === 1) {
+        if ((0, regEx_1.isAddress)(aFiles[0].filename))
+            files.push({
+                filename: `${aFiles[0].filename} to ${bFiles[0].filename}`,
+                aCode: aFiles[0].code,
+                bCode: bFiles[0].code,
+                result: aFiles[0].code === bFiles[0].code ? 'match' : 'changed',
+            });
+        return {
+            files,
+            contractNameA,
+            contractNameB,
+        };
+    }
+    // For each file in the A contract
+    for (const aFile of aFiles) {
+        // Look for A contract filename in B contract
+        const bFile = bFiles.find((bFile) => bFile.filename === aFile.filename);
+        if (bFile) {
+            // The A contract filename exists in the B contract
+            if (aFile.code !== bFile.code) {
+                // console.log(`${aFile.filename}  ${clc.red('different')}:`)
+                files.push({
+                    filename: aFile.filename,
+                    aCode: aFile.code,
+                    bCode: bFile.code,
+                    result: 'changed',
+                });
+            }
+            else {
+                files.push({
+                    filename: aFile.filename,
+                    aCode: aFile.code,
+                    bCode: bFile.code,
+                    result: 'match',
+                });
+            }
+        }
+        else {
+            // The A contract filename does not exist in the B contract
+            files.push({
+                filename: aFile.filename,
+                aCode: aFile.code,
+                result: 'removed',
+            });
+        }
+    }
+    // For each file in the B contract
+    for (const bFile of bFiles) {
+        // Look for B contract filename in A contract
+        const aFile = aFiles.find((aFile) => aFile.filename === bFile.filename);
+        if (!aFile) {
+            // The B contract filename does not exist in the A contract
+            files.push({
+                filename: bFile.filename,
+                bCode: bFile.code,
+                result: 'added',
+            });
+        }
+    }
+    // Sort by filename
+    return {
+        files: files.sort((a, b) => a.filename.localeCompare(b.filename)),
+        contractNameA,
+        contractNameB,
+    };
+};
+exports.compareContracts = compareContracts;
+const displayContractNames = (addressA, addressB, contractNameA, contractNameB, options) => {
+    console.log(`Contract A: ${addressA} ${contractNameA} on ${options.network}`);
+    console.log(`Contract B: ${addressB} ${contractNameB} on ${options.bNetwork || options.network}\n`);
+};
+exports.displayContractNames = displayContractNames;
+const displayFileDiffSummary = (fileDiffs) => {
+    for (const file of fileDiffs) {
+        switch (file.result) {
+            case 'match':
+                console.log(`${file.result.padEnd(7)} ${file.filename}`);
+                break;
+            case 'added':
+                console.log(`${clc.green(file.result.padEnd(7))} ${file.filename}`);
+                break;
+            case 'changed':
+            case 'removed':
+                console.log(`${clc.red(file.result)} ${file.filename}`);
+                break;
+        }
+    }
+};
+exports.displayFileDiffSummary = displayFileDiffSummary;
+const displayFileDiffs = (fileDiffs, options = {}) => {
+    for (const file of fileDiffs) {
+        switch (file.result) {
+            case 'added':
+                console.log(`Added ${file.filename}`);
+                console.log(clc.green(file.bCode));
+                break;
+            case 'changed':
+                console.log(`Changed ${file.filename}`);
+                (0, diff_1.diffCode)(file.aCode, file.bCode, options.lineBuffer);
+                break;
+            case 'removed':
+                console.log(`Removed ${file.filename}`);
+                console.log(clc.red(file.aCode));
+                break;
+        }
+    }
+};
+exports.displayFileDiffs = displayFileDiffs;
+const flattenAndDiff = async (addressA, addressB, aEtherscanParser, bEtherscanParser, options) => {
+    // Get verified Solidity code from Etherscan and flatten
+    const { solidityCode: codeA, contractName: contractNameA } = await aEtherscanParser.getSolidityCode(addressA, options.aFile);
+    const { solidityCode: codeB, contractName: contractNameB } = await bEtherscanParser.getSolidityCode(addressB, options.bFile || options.aFile);
+    (0, exports.displayContractNames)(addressA, addressB, contractNameA, contractNameB, options);
+    (0, diff_1.diffCode)(codeA, codeB, options.lineBuffer);
+    if (options.saveFiles) {
+        await (0, writerFiles_1.writeSolidity)(codeA, addressA);
+        await (0, writerFiles_1.writeSolidity)(codeB, addressB);
+    }
+    (0, exports.displayContractNames)(addressA, addressB, contractNameA, contractNameB, options);
+    return { contractNameA, contractNameB };
+};
+exports.flattenAndDiff = flattenAndDiff;
+//# sourceMappingURL=diffContracts.js.map

package/lib/parserEtherscan.d.ts

@@ -42,7 +42,7 @@ export declare class EtherscanParser {
      * @oaram filename optional, case-sensitive name of the source file without the .sol
      */
     getSourceCode(contractAddress: string, filename?: string): Promise<{
-        files: readonly {
+        files: {
             code: string;
             filename: string;
         }[];

package/lib/slotValues.js

@@ -63,7 +63,7 @@ const addSlotValues = async (url, contractAddress, storageSection, arrayItems, b
                 }
             }
             // if variable is past the slot that has the value
-            else if (variable.toSlot > fromSlot) {
+            else if (bignumber_1.BigNumber.from(variable.toSlot).gt(fromSlot)) {
                 break;
             }
         }

package/lib/sol2uml.js

@@ -1,20 +1,21 @@
 #! /usr/bin/env node
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const converterClasses2Dot_1 = require("./converterClasses2Dot");
-const parserGeneral_1 = require("./parserGeneral");
-const parserEtherscan_1 = require("./parserEtherscan");
-const filterClasses_1 = require("./filterClasses");
 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");
 const converterStorage2Dot_1 = require("./converterStorage2Dot");
-const regEx_1 = require("./utils/regEx");
-const writerFiles_1 = require("./writerFiles");
-const path_1 = require("path");
+const diffContracts_1 = require("./diffContracts");
+const filterClasses_1 = require("./filterClasses");
+const parserEtherscan_1 = require("./parserEtherscan");
+const parserGeneral_1 = require("./parserGeneral");
 const squashClasses_1 = require("./squashClasses");
-const diff_1 = require("./diff");
 const slotValues_1 = require("./slotValues");
-const ethers_1 = require("ethers");
+const regEx_1 = require("./utils/regEx");
+const validators_1 = require("./utils/validators");
+const writerFiles_1 = require("./writerFiles");
 const clc = require('cli-color');
 const program = new commander_1.Command();
 const debugControl = require('debug');
@@ -33,7 +34,7 @@ Can also flatten or compare verified source files on Etherscan-like explorers.`)
     .choices(parserEtherscan_1.networks)
     .default('mainnet')
     .env('ETH_NETWORK'))
-    .addOption(new commander_1.Option('-e, --explorerUrl <url>', 'Override network with custom blockchain explorer API URL. eg Polygon Mumbai testnet https://api-testnet.polygonscan.com/api').env('EXPLORER_URL'))
+    .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 or SnowTrace 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')
@@ -125,7 +126,7 @@ WARNING: sol2uml does not use the Solidity compiler so may differ with solc. A k
     .option('-c, --contract <name>', 'Contract name in the local Solidity files. Not needed when using an address as the first argument as the contract name can be derived from Etherscan.')
     .option('-cf, --contractFile <filename>', 'Filename the contract is located in. This can include the relative path to the desired file.')
     .option('-d, --data', 'Gets the values in the storage slots from an Ethereum node.', false)
-    .option('-s, --storage <address>', 'The address of the contract with the storage values. This will be different from the contract with the code if a proxy contract is used. This is not needed if `fileFolderAddress` is an address and the contract is not proxied.')
+    .option('-s, --storage <address>', 'The address of the contract with the storage values. This will be different from the contract with the code if a proxy contract is used. This is not needed if `fileFolderAddress` is an address and the contract is not proxied.', validators_1.validateAddress)
     .addOption(new commander_1.Option('-u, --url <url>', 'URL of the Ethereum node to get storage values if the `data` option is used.')
     .env('NODE_URL')
     .default('http://localhost:8545'))
@@ -195,7 +196,7 @@ In order for the merged code to compile, the following is done:
 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.\n`)
-    .argument('<contractAddress>', 'Contract address in hexadecimal format with a 0x prefix.')
+    .argument('<contractAddress>', 'Contract address in hexadecimal format with a 0x prefix.', validators_1.validateAddress)
     .action(async (contractAddress, options, command) => {
     try {
         debug(`About to flatten ${contractAddress}`);
@@ -223,12 +224,17 @@ The results show the comparison of contract A to B.
 The ${clc.green('green')} sections are additions to contract B that are not in contract A.
 The ${clc.red('red')} sections are removals from contract A that are not in contract B.
 The line numbers are from contract B. There are no line numbers for the red sections as they are not in contract B.\n`)
-    .argument('<addressA>', 'Contract address in hexadecimal format with a 0x prefix of the first contract.')
-    .argument('<addressB>', 'Contract address in hexadecimal format with a 0x prefix of the second contract.')
-    .addOption(new commander_1.Option('-l, --lineBuffer <value>', 'Minimum number of lines before and after changes').default('4'))
-    .addOption(new commander_1.Option('-af --aFile <value>', 'Contract A source code filename without the .sol extension. (default: compares all source files)'))
-    .addOption(new commander_1.Option('-bf --bFile <value>', 'Contract B source code filename without the .sol extension. (default: aFile if specified)'))
-    .option('-s, --saveFiles', 'Save the flattened contract code to the filesystem. The file names will be the contract address with a .sol extension.', false)
+    .argument('<addressA>', 'Contract address in hexadecimal format with a 0x prefix of the first contract', validators_1.validateAddress)
+    .argument('<addressB>', 'Contract address in hexadecimal format with a 0x prefix of the second contract', validators_1.validateAddress)
+    .option('-l, --lineBuffer <value>', 'Minimum number of lines before and after changes (default: 4)', validators_1.validateLineBuffer)
+    .option('-af --aFile <value>', 'Contract A source code filename without the .sol extension (default: compares all source files)')
+    .option('-bf --bFile <value>', 'Contract B source code filename without the .sol extension (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('-s, --summary', 'Only show a summary of the file differences.', false)
+    .option('--flatten', 'Flatten into a single file before comparing', 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)
     .action(async (addressA, addressB, options, command) => {
     try {
         debug(`About to diff ${addressA} and ${addressB}`);
@@ -236,21 +242,25 @@ The line numbers are from contract B. There are no line numbers for the red sect
             ...command.parent._optionValues,
             ...options,
         };
-        // Diff solidity code
-        const lineBuffer = parseInt(options.lineBuffer);
-        if (isNaN(lineBuffer))
-            throw Error(`Invalid line buffer "${options.lineBuffer}". Must be a number`);
-        const etherscanParser = new parserEtherscan_1.EtherscanParser(combinedOptions.apiKey, combinedOptions.network, combinedOptions.explorerUrl);
-        // Get verified Solidity code from Etherscan and flatten
-        const { solidityCode: codeA, contractName: contractNameA } = await etherscanParser.getSolidityCode(addressA, combinedOptions.aFile);
-        const { solidityCode: codeB, contractName: contractNameB } = await etherscanParser.getSolidityCode(addressB, combinedOptions.bFile || combinedOptions.aFile);
-        console.log(`Difference between`);
-        console.log(`A. ${addressA} ${contractNameA} on ${combinedOptions.network}`);
-        console.log(`B. ${addressB} ${contractNameB} on ${combinedOptions.network}\n`);
-        (0, diff_1.diffCode)(codeA, codeB, lineBuffer);
-        if (options.saveFiles) {
-            await (0, writerFiles_1.writeSolidity)(codeA, addressA);
-            await (0, writerFiles_1.writeSolidity)(codeB, addressB);
+        const aEtherscanParser = new parserEtherscan_1.EtherscanParser(combinedOptions.apiKey, combinedOptions.network, combinedOptions.explorerUrl);
+        const bEtherscanParser = new parserEtherscan_1.EtherscanParser(combinedOptions.bApiKey || combinedOptions.apiKey, combinedOptions.bNetwork || combinedOptions.network, combinedOptions.bExplorerUrl || combinedOptions.explorerUrl);
+        if (options.flatten || options.aFile) {
+            await (0, diffContracts_1.flattenAndDiff)(addressA, addressB, aEtherscanParser, bEtherscanParser, combinedOptions);
+        }
+        else {
+            const { contractNameA, contractNameB, files } = await (0, diffContracts_1.compareContracts)(addressA, addressB, aEtherscanParser, bEtherscanParser, combinedOptions);
+            (0, diffContracts_1.displayContractNames)(addressA, addressB, contractNameA, contractNameB, combinedOptions);
+            (0, diffContracts_1.displayFileDiffSummary)(files);
+            if (!options.summary) {
+                // Just show the summary if all the files are the same
+                const diffFiles = files.filter((f) => f.result !== 'match');
+                if (diffFiles.length === 0)
+                    return;
+                console.log();
+                (0, diffContracts_1.displayFileDiffs)(files, combinedOptions);
+                (0, diffContracts_1.displayContractNames)(addressA, addressB, contractNameA, contractNameB, combinedOptions);
+                (0, diffContracts_1.displayFileDiffSummary)(files);
+            }
         }
     }
     catch (err) {

package/lib/umlClass.js

@@ -8,7 +8,7 @@ var Visibility;
     Visibility[Visibility["External"] = 2] = "External";
     Visibility[Visibility["Internal"] = 3] = "Internal";
     Visibility[Visibility["Private"] = 4] = "Private";
-})(Visibility = exports.Visibility || (exports.Visibility = {}));
+})(Visibility || (exports.Visibility = Visibility = {}));
 var ClassStereotype;
 (function (ClassStereotype) {
     ClassStereotype[ClassStereotype["None"] = 0] = "None";
@@ -20,7 +20,7 @@ var ClassStereotype;
     ClassStereotype[ClassStereotype["Enum"] = 6] = "Enum";
     ClassStereotype[ClassStereotype["Constant"] = 7] = "Constant";
     ClassStereotype[ClassStereotype["Import"] = 8] = "Import";
-})(ClassStereotype = exports.ClassStereotype || (exports.ClassStereotype = {}));
+})(ClassStereotype || (exports.ClassStereotype = ClassStereotype = {}));
 var OperatorStereotype;
 (function (OperatorStereotype) {
     OperatorStereotype[OperatorStereotype["None"] = 0] = "None";
@@ -29,7 +29,7 @@ var OperatorStereotype;
     OperatorStereotype[OperatorStereotype["Payable"] = 3] = "Payable";
     OperatorStereotype[OperatorStereotype["Fallback"] = 4] = "Fallback";
     OperatorStereotype[OperatorStereotype["Abstract"] = 5] = "Abstract";
-})(OperatorStereotype = exports.OperatorStereotype || (exports.OperatorStereotype = {}));
+})(OperatorStereotype || (exports.OperatorStereotype = OperatorStereotype = {}));
 var AttributeType;
 (function (AttributeType) {
     AttributeType[AttributeType["Elementary"] = 0] = "Elementary";
@@ -37,12 +37,12 @@ var AttributeType;
     AttributeType[AttributeType["Function"] = 2] = "Function";
     AttributeType[AttributeType["Array"] = 3] = "Array";
     AttributeType[AttributeType["Mapping"] = 4] = "Mapping";
-})(AttributeType = exports.AttributeType || (exports.AttributeType = {}));
+})(AttributeType || (exports.AttributeType = AttributeType = {}));
 var ReferenceType;
 (function (ReferenceType) {
     ReferenceType[ReferenceType["Memory"] = 0] = "Memory";
     ReferenceType[ReferenceType["Storage"] = 1] = "Storage";
-})(ReferenceType = exports.ReferenceType || (exports.ReferenceType = {}));
+})(ReferenceType || (exports.ReferenceType = ReferenceType = {}));
 class UmlClass {
     constructor(properties) {
         this.imports = [];

package/lib/utils/diff.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Compares code using Google's diff_match_patch and displays the results in the console.
+ * @param codeA
+ * @param codeB
+ * @param lineBuff the number of lines to display before and after each change.
+ */
+export declare const diffCode: (codeA: string, codeB: string, lineBuff: number) => void;

package/lib/utils/diff.js

@@ -1 +1,188 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.diffCode = void 0;
+const diff_match_patch_1 = __importStar(require("diff-match-patch"));
+const clc = require('cli-color');
+const SkippedLinesMarker = `\n---`;
+/**
+ * Compares code using Google's diff_match_patch and displays the results in the console.
+ * @param codeA
+ * @param codeB
+ * @param lineBuff the number of lines to display before and after each change.
+ */
+const diffCode = (codeA, codeB, lineBuff) => {
+    // @ts-ignore
+    const dmp = new diff_match_patch_1.default();
+    const diff = dmp.diff_main(codeA, codeB);
+    dmp.diff_cleanupSemantic(diff);
+    const linesB = countLines(codeB) + 1;
+    diff_pretty(diff, linesB, lineBuff);
+};
+exports.diffCode = diffCode;
+/**
+ * Convert a diff array into human-readable for the console
+ * @param {!Array.<!diff_match_patch.Diff>} diffs Array of diff tuples.
+ * @param lines number of a lines in the second contract B
+ * @param lineBuff number of a lines to output before and after the change
+ */
+const diff_pretty = (diffs, lines, lineBuff = 2) => {
+    const linePad = lines.toString().length;
+    let output = '';
+    let diffIndex = 0;
+    let lineCount = 1;
+    const firstLineNumber = '1'.padStart(linePad) + ' ';
+    for (const diff of diffs) {
+        diffIndex++;
+        const initialLineNumber = diffIndex <= 1 ? firstLineNumber : '';
+        const op = diff[0]; // Operation (insert, delete, equal)
+        const text = diff[1]; // Text of change.
+        switch (op) {
+            case diff_match_patch_1.DIFF_INSERT:
+                // If first diff then we need to add the first line number
+                const linesInserted = addLineNumbers(text, lineCount, linePad);
+                output += initialLineNumber + clc.green(linesInserted);
+                lineCount += countLines(text);
+                break;
+            case diff_match_patch_1.DIFF_DELETE:
+                // zero start line means blank line numbers are used
+                const linesDeleted = addLineNumbers(text, 0, linePad);
+                output += initialLineNumber + clc.red(linesDeleted);
+                break;
+            case diff_match_patch_1.DIFF_EQUAL:
+                const eolPositions = findEOLPositions(text);
+                // If no changes yet
+                if (diffIndex <= 1) {
+                    output += lastLines(text, eolPositions, lineBuff, linePad);
+                }
+                // if no more changes
+                else if (diffIndex === diffs.length) {
+                    output += firstLines(text, eolPositions, lineBuff, lineCount, linePad);
+                }
+                else {
+                    // else the first n lines and last n lines
+                    output += firstAndLastLines(text, eolPositions, lineBuff, lineCount, linePad);
+                }
+                lineCount += eolPositions.length;
+                break;
+        }
+    }
+    output += '\n';
+    console.log(output);
+};
+/**
+ * Used when there is no more changes left
+ */
+const firstLines = (text, eolPositions, lineBuff, lineStart, linePad) => {
+    const lines = text.slice(0, eolPositions[lineBuff]);
+    return addLineNumbers(lines, lineStart, linePad);
+};
+/**
+ * Used before the first change
+ */
+const lastLines = (text, eolPositions, lineBuff, linePad) => {
+    const eolFrom = eolPositions.length - (lineBuff + 1);
+    let lines = text;
+    let lineCount = 1;
+    if (eolFrom >= 0) {
+        lines = eolFrom >= 0 ? text.slice(eolPositions[eolFrom] + 1) : text;
+        lineCount = eolFrom + 2;
+    }
+    const firstLineNumber = lineCount.toString().padStart(linePad) + ' ';
+    return firstLineNumber + addLineNumbers(lines, lineCount, linePad);
+};
+/**
+ * Used between changes to show the lines after the last change and before the next change.
+ * @param text
+ * @param eolPositions
+ * @param lineBuff
+ * @param lineStart
+ * @param linePad
+ */
+const firstAndLastLines = (text, eolPositions, lineBuff, lineStart, linePad) => {
+    if (eolPositions.length <= 2 * lineBuff) {
+        return addLineNumbers(text, lineStart, linePad);
+    }
+    const endFirstLines = eolPositions[lineBuff];
+    const eolFrom = eolPositions.length - (lineBuff + 1);
+    const startLastLines = eolPositions[eolFrom];
+    if (startLastLines <= endFirstLines) {
+        return addLineNumbers(text, lineStart, linePad);
+    }
+    // Lines after the previous change
+    let lines = text.slice(0, endFirstLines);
+    let output = addLineNumbers(lines, lineStart, linePad);
+    output += SkippedLinesMarker;
+    // Lines before the next change
+    lines = text.slice(startLastLines);
+    const lineCount = lineStart + eolFrom;
+    output += addLineNumbers(lines, lineCount, linePad);
+    return output;
+};
+/**
+ * Gets the positions of the end of lines in the string
+ * @param text
+ */
+const findEOLPositions = (text) => {
+    const eolPositions = [];
+    text.split('').forEach((c, i) => {
+        if (c === '\n') {
+            eolPositions.push(i);
+        }
+    });
+    return eolPositions;
+};
+/**
+ * Counts the number of carriage returns in a string
+ * @param text
+ */
+const countLines = (text) => (text.match(/\n/g) || '').length;
+/**
+ * Adds left padded line numbers to each line.
+ * @param text with the lines of code
+ * @param lineStart the line number of the first line in the text. If zero, then no lines numbers are added.
+ * @param linePad the width of the largest number which may not be in the text
+ */
+const addLineNumbers = (text, lineStart, linePad) => {
+    let lineCount = lineStart;
+    let textWithLineNumbers = '';
+    text.split('').forEach((c, i) => {
+        if (c === '\n') {
+            if (lineStart > 0) {
+                textWithLineNumbers += `\n${(++lineCount)
+                    .toString()
+                    .padStart(linePad)} `;
+            }
+            else {
+                textWithLineNumbers += `\n${' '.repeat(linePad)} `;
+            }
+        }
+        else {
+            textWithLineNumbers += c;
+        }
+    });
+    return textWithLineNumbers;
+};
 //# sourceMappingURL=diff.js.map

package/lib/utils/regEx.d.ts

@@ -1,2 +1,4 @@
+export declare const ethereumAddress: RegExp;
+export declare const ethereumAddresses: RegExp;
 export declare const isAddress: (input: string) => boolean;
 export declare const parseSolidityVersion: (compilerVersion: string) => string;

package/lib/utils/regEx.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseSolidityVersion = exports.isAddress = void 0;
+exports.parseSolidityVersion = exports.isAddress = exports.ethereumAddresses = exports.ethereumAddress = void 0;
+exports.ethereumAddress = /^0x([A-Fa-f0-9]{40})$/;
+// comma-separated list of addresses with no whitespace
+exports.ethereumAddresses = /^(0x[A-Fa-f0-9]{40},?)+$/;
 const isAddress = (input) => {
     return input.match(/^0x([A-Fa-f0-9]{40})$/) !== null;
 };

package/lib/utils/validators.d.ts

@@ -0,0 +1,3 @@
+export declare const validateAddress: (address: string) => string;
+export declare const validateAddresses: (addresses: string) => string[];
+export declare const validateLineBuffer: (lineBufferParam: string) => number;

package/lib/utils/validators.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateLineBuffer = exports.validateAddresses = exports.validateAddress = void 0;
+const regEx_1 = require("./regEx");
+const commander_1 = require("commander");
+const utils_1 = require("ethers/lib/utils");
+const validateAddress = (address) => {
+    try {
+        if (typeof address === 'string' && address?.match(regEx_1.ethereumAddress))
+            return (0, utils_1.getAddress)(address);
+    }
+    catch (err) { }
+    throw new commander_1.InvalidArgumentError(`Address must be in hexadecimal format with a 0x prefix.`);
+};
+exports.validateAddress = validateAddress;
+const validateAddresses = (addresses) => {
+    try {
+        const addressArray = convertAddresses(addresses);
+        if (addressArray)
+            return addressArray;
+    }
+    catch (err) { }
+    throw new commander_1.InvalidArgumentError(`Must be an address or an array of addresses in hexadecimal format with a 0x prefix.
+If running for multiple addresses, the comma-separated list of addresses must not have white spaces.`);
+};
+exports.validateAddresses = validateAddresses;
+const convertAddresses = (addresses) => {
+    if (typeof addresses === 'string' && addresses?.match(regEx_1.ethereumAddress))
+        return [(0, utils_1.getAddress)(addresses).toLowerCase()];
+    if (typeof addresses === 'string' && addresses?.match(regEx_1.ethereumAddresses))
+        return addresses.split(',').map((a) => (0, utils_1.getAddress)(a).toLowerCase());
+    return undefined;
+};
+const validateLineBuffer = (lineBufferParam) => {
+    const lineBuffer = parseInt(lineBufferParam);
+    if (isNaN(lineBuffer))
+        throw Error(`Invalid line buffer "${lineBuffer}". Must be a number`);
+    return lineBuffer;
+};
+exports.validateLineBuffer = validateLineBuffer;
+//# sourceMappingURL=validators.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sol2uml",
-  "version": "2.5.6",
+  "version": "2.5.7",
   "description": "Solidity contract visualisation tool.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -23,11 +23,11 @@
   "license": "MIT",
   "dependencies": {
     "@aduh95/viz.js": "^3.7.0",
-    "@solidity-parser/parser": "^0.15.0",
+    "@solidity-parser/parser": "^0.16.1",
     "axios": "^1.3.4",
     "axios-debug-log": "^1.0.0",
     "cli-color": "^2.0.3",
-    "commander": "^10.0.0",
+    "commander": "^11.0.0",
     "convert-svg-to-png": "^0.6.4",
     "debug": "^4.3.4",
     "diff-match-patch": "^1.0.5",
@@ -36,15 +36,15 @@
     "klaw": "^4.1.0"
   },
   "devDependencies": {
-    "@openzeppelin/contracts": "^4.8.2",
+    "@openzeppelin/contracts": "^4.9.3",
     "@types/diff-match-patch": "^1.0.32",
-    "@types/jest": "^29.4.0",
+    "@types/jest": "^29.5.3",
     "@types/klaw": "^3.0.3",
-    "jest": "^29.4.3",
-    "prettier": "^2.8.4",
-    "ts-jest": "^29.0.5",
+    "jest": "^29.6.2",
+    "prettier": "^3.0.1",
+    "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.5"
+    "typescript": "^5.1.6"
   },
   "files": [
     "lib/*.js",