sol2uml 2.2.0 → 2.2.2

package/README.md

@@ -137,9 +137,11 @@ Options:
 Usage: sol2uml flatten <contractAddress> [options]
 
 In order for the merged code to compile, the following is done:
-1. File imports are commented out.
-2. "SPDX-License-Identifier" is renamed to "SPDX--License-Identifier".
-3. Contract dependencies are analysed so the files are merged in an order that will compile.
+1. pragma solidity is set using the compiler of the verified contract.
+2. All pragma solidity lines in the source files are commented out.
+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.
 
 Merges verified source files for a contract from a Blockchain explorer into one local file.
 

package/lib/converterAST2Classes.js

@@ -158,9 +158,23 @@ function convertAST2UmlClasses(node, relativePath, filesystem = false) {
     else {
         throw new Error(`AST node not of type SourceUnit`);
     }
-    umlClasses.forEach((umlClass) => {
-        umlClass.imports = imports;
-    });
+    if (umlClasses.length > 0) {
+        umlClasses.forEach((umlClass) => {
+            umlClass.imports = imports;
+        });
+    }
+    else {
+        const importUmlClass = new umlClass_1.UmlClass({
+            name: 'Import',
+            stereotype: umlClass_1.ClassStereotype.Import,
+            absolutePath: filesystem
+                ? path.resolve(relativePath) // resolve the absolute path
+                : relativePath,
+            relativePath,
+        });
+        importUmlClass.imports = imports;
+        umlClasses = [importUmlClass];
+    }
     return umlClasses;
 }
 exports.convertAST2UmlClasses = convertAST2UmlClasses;

package/lib/converterClass2Dot.js

@@ -6,8 +6,9 @@ const umlClass_1 = require("./umlClass");
 const regEx_1 = require("./utils/regEx");
 const convertClass2Dot = (umlClass, options = {}) => {
     // do not include library, interface, abstracts, struct or enum classes if hidden
-    if ((options.hideLibraries &&
-        umlClass.stereotype === umlClass_1.ClassStereotype.Library) ||
+    if (umlClass.stereotype === umlClass_1.ClassStereotype.Import ||
+        (options.hideLibraries &&
+            umlClass.stereotype === umlClass_1.ClassStereotype.Library) ||
         (options.hideInterfaces &&
             umlClass.stereotype === umlClass_1.ClassStereotype.Interface) ||
         (options.hideAbstracts &&

package/lib/parserEtherscan.d.ts

@@ -42,6 +42,7 @@ export declare class EtherscanParser {
             filename: string;
         }[];
         contractName: string;
+        compilerVersion: string;
     }>;
 }
 export {};

package/lib/parserEtherscan.js

@@ -8,6 +8,8 @@ const axios_1 = __importDefault(require("axios"));
 const parser_1 = require("@solidity-parser/parser");
 const converterAST2Classes_1 = require("./converterAST2Classes");
 const filterClasses_1 = require("./filterClasses");
+const regEx_1 = require("./utils/regEx");
+require('axios-debug-log');
 const debug = require('debug')('sol2uml');
 exports.networks = [
     'mainnet',
@@ -122,7 +124,7 @@ class EtherscanParser {
      * @return Promise string of Solidity code
      */
     async getSolidityCode(contractAddress) {
-        const { files, contractName } = await this.getSourceCode(contractAddress);
+        const { files, contractName, compilerVersion } = await this.getSourceCode(contractAddress);
         // Parse the UmlClasses from the Solidity code in each file
         let umlClasses = [];
         for (const file of files) {
@@ -139,7 +141,9 @@ class EtherscanParser {
         // find any files that didn't have dependencies found
         const nonDependentFiles = files.filter((f) => !dependentFilenames.includes(f.filename));
         const nonDependentFilenames = nonDependentFiles.map((f) => f.filename);
-        let solidityCode = '';
+        debug(`Failed to find dependencies to files: ${nonDependentFilenames}`);
+        const solidityVersion = (0, regEx_1.parseSolidityVersion)(compilerVersion);
+        let solidityCode = `pragma solidity = ${solidityVersion};\n`;
         // output non dependent code before the dependent files just in case sol2uml missed some dependencies
         const filenames = [...nonDependentFilenames, ...dependentFilenames];
         // For each filename
@@ -148,11 +152,13 @@ class EtherscanParser {
             const file = files.find((f) => f.filename === filename);
             if (!file)
                 throw Error(`Failed to find file with filename "${filename}"`);
+            // comment out any pragma solidity lines as its set from the compiler version
+            const removedPragmaSolidity = file.code.replace(/(\s)(pragma\s+solidity.*;)/gm, '$1/* $2 */');
             // comment out any import statements
             // match whitespace before import
             // and characters after import up to ;
             // replace all in file and match across multiple lines
-            const removedImports = file.code.replace(/(\s)(import.*;)/gm, '$1/* $2 */');
+            const removedImports = removedPragmaSolidity.replace(/(\s)(import.*;)/gm, '$1/* $2 */');
             // Rename SPDX-License-Identifier to SPDX--License-Identifier so the merged file will compile
             const removedSPDX = removedImports.replace(/SPDX-/, 'SPDX--');
             solidityCode += removedSPDX;
@@ -239,6 +245,7 @@ class EtherscanParser {
             return {
                 files: results.flat(1),
                 contractName: response.data.result[0].ContractName,
+                compilerVersion: response.data.result[0].CompilerVersion,
             };
         }
         catch (err) {

package/lib/sol2uml.js

@@ -156,9 +156,11 @@ program
     .usage(`<contractAddress> [options]
 
 In order for the merged code to compile, the following is done:
-1. File imports are commented out.
-2. "SPDX-License-Identifier" is renamed to "SPDX--License-Identifier".
-3. Contract dependencies are analysed so the files are merged in an order that will compile.`)
+1. pragma solidity is set using the compiler of the verified contract.
+2. All pragma solidity lines in the source files are commented out.
+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.`)
     .argument('<contractAddress>', 'Contract address in hexadecimal format with a 0x prefix.')
     .action(async (contractAddress, options, command) => {
     try {
@@ -179,7 +181,7 @@ In order for the merged code to compile, the following is done:
     }
 });
 program.on('option:verbose', () => {
-    debugControl.enable('sol2uml');
+    debugControl.enable('sol2uml,axios');
     debug('verbose on');
 });
 const main = async () => {

package/lib/umlClass.d.ts

@@ -13,7 +13,8 @@ export declare enum ClassStereotype {
     Contract = 4,
     Struct = 5,
     Enum = 6,
-    Constant = 7
+    Constant = 7,
+    Import = 8
 }
 export declare enum OperatorStereotype {
     None = 0,

package/lib/umlClass.js

@@ -19,6 +19,7 @@ var ClassStereotype;
     ClassStereotype[ClassStereotype["Struct"] = 5] = "Struct";
     ClassStereotype[ClassStereotype["Enum"] = 6] = "Enum";
     ClassStereotype[ClassStereotype["Constant"] = 7] = "Constant";
+    ClassStereotype[ClassStereotype["Import"] = 8] = "Import";
 })(ClassStereotype = exports.ClassStereotype || (exports.ClassStereotype = {}));
 var OperatorStereotype;
 (function (OperatorStereotype) {

package/lib/utils/regEx.d.ts

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

package/lib/utils/regEx.js

@@ -1,8 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAddress = void 0;
+exports.parseSolidityVersion = exports.isAddress = void 0;
 const isAddress = (input) => {
     return input.match(/^0x([A-Fa-f0-9]{40})$/) !== null;
 };
 exports.isAddress = isAddress;
+const parseSolidityVersion = (compilerVersion) => {
+    const result = compilerVersion.match(`v(\\d+.\\d+.\\d+)`);
+    if (result[1]) {
+        return result[1];
+    }
+    throw Error(`Failed to parse compiler version ${compilerVersion}`);
+};
+exports.parseSolidityVersion = parseSolidityVersion;
 //# sourceMappingURL=regEx.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sol2uml",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "description": "Solidity contract visualisation tool.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -22,6 +22,7 @@
     "@aduh95/viz.js": "^3.7.0",
     "@solidity-parser/parser": "^0.14.3",
     "axios": "^0.27.2",
+    "axios-debug-log": "^0.8.4",
     "commander": "^9.4.0",
     "convert-svg-to-png": "^0.6.4",
     "debug": "^4.3.4",