sol2uml 2.5.24 → 2.5.25

package/README.md

@@ -111,6 +111,7 @@ Options:
   -c, --clusterFolders             cluster contracts into source folders (default: false)
   -hv, --hideVariables             hide variables from contracts, interfaces, structs and enums (default: false)
   -hf, --hideFunctions             hide functions from contracts, interfaces and libraries (default: false)
+  -hy, --hideTypes                 hide types of variables, function arguments and return types (default: false)
   -hp, --hidePrivates              hide private and internal attributes and operators (default: false)
   -hm, --hideModifiers             hide modifier functions from contracts (default: false)
   -ht, --hideEvents                hide events from contracts, interfaces and libraries (default: false)
@@ -122,6 +123,7 @@ Options:
   -hi, --hideInterfaces            hide interfaces (default: false)
   -ha, --hideAbstracts             hide abstract contracts (default: false)
   -hn, --hideFilename              hide relative path and file name (default: false)
+  -hd, --hideDepFunctions          hide function names on dependency arrows (default: false)
   -s, --squash                     squash inherited contracts to the base contract(s) (default: false)
   -hsc, --hideSourceContract       hide the source contract when using squash (default: false)
   -h, --help                       display help for command

package/lib/converterAST2Classes.js

@@ -533,7 +533,24 @@ function parseExpression(expression, umlClass) {
         parseExpression(expression.right, umlClass);
     }
     else if (expression.type === 'FunctionCall') {
-        parseExpression(expression.expression, umlClass);
+        if (expression.expression.type === 'MemberAccess' &&
+            expression.expression.expression?.type === 'Identifier') {
+            // Pattern: ClassName.functionName(args) — explicit library/contract call
+            const memberName = expression.expression.memberName;
+            umlClass.addAssociation({
+                referenceType: umlClass_1.ReferenceType.Memory,
+                targetUmlClassName: expression.expression.expression.name,
+                functionsCalled: [memberName],
+            });
+            umlClass.memberAccessCalls.add(memberName);
+        }
+        else {
+            // Track member access calls inside other FunctionCall patterns (e.g. x.functionName())
+            if (expression.expression.type === 'MemberAccess') {
+                umlClass.memberAccessCalls.add(expression.expression.memberName);
+            }
+            parseExpression(expression.expression, umlClass);
+        }
         expression.arguments.forEach((arg) => {
             parseExpression(arg, umlClass);
         });

package/lib/converterClass2Dot.d.ts

@@ -4,6 +4,7 @@ export interface ClassOptions {
     hideContracts?: boolean;
     hideVariables?: boolean;
     hideFunctions?: boolean;
+    hideTypes?: boolean;
     hideModifiers?: boolean;
     hideEvents?: boolean;
     hideStructs?: boolean;
@@ -14,6 +15,7 @@ export interface ClassOptions {
     hideAbstracts?: boolean;
     hideFilename?: boolean;
     hideSourceContract?: boolean;
+    hideDepFunctions?: boolean;
     backColor?: string;
     shapeColor?: string;
     fillColor?: string;

package/lib/converterClass2Dot.js

@@ -116,7 +116,8 @@ const dotAttributes = (attributes, options, vizGroup, indent = true) => {
         const sourceContract = attribute.sourceContract && !options.hideSourceContract
             ? ` \\<\\<${attribute.sourceContract}\\>\\>`
             : '';
-        dotString += `${indentString}${attribute.name}: ${attribute.type}${sourceContract}\\l`;
+        const type = options.hideTypes ? '' : `: ${attribute.type}`;
+        dotString += `${indentString}${attribute.name}${type}${sourceContract}\\l`;
     });
     return dotString;
 };
@@ -176,8 +177,8 @@ const dotOperators = (umlClass, vizGroup, operators, options) => {
             dotString += dotOperatorStereotype(umlClass, operator.stereotype);
         }
         dotString += operator.name;
-        dotString += dotParameters(operator.parameters);
-        if (operator.returnParameters?.length > 0) {
+        dotString += dotParameters(operator.parameters, false, options.hideTypes);
+        if (operator.returnParameters?.length > 0 && !options.hideTypes) {
             dotString += ': ' + dotParameters(operator.returnParameters, true);
         }
         if (options.hideModifiers === false && operator.modifiers?.length > 0) {
@@ -214,7 +215,10 @@ const dotOperatorStereotype = (umlClass, operatorStereotype) => {
     }
     return dotString + ' ';
 };
-const dotParameters = (parameters, returnParams = false) => {
+const dotParameters = (parameters, returnParams = false, hideTypes = false) => {
+    if (hideTypes && !returnParams) {
+        return '()';
+    }
     if (parameters.length == 1 && !parameters[0].name) {
         if (returnParams) {
             return parameters[0].type;

package/lib/converterClasses2Dot.js

@@ -139,6 +139,39 @@ function addAssociationToDot(sourceUmlClass, targetUmlClass, association, classO
             dotString += 'weight=3, ';
         }
     }
+    // Add function name labels on dependency arrows (not on realization/inheritance)
+    if (!association.realization && !classOptions.hideDepFunctions) {
+        const functionNames = getAssociationFunctionNames(sourceUmlClass, targetUmlClass, association);
+        if (functionNames.length > 0) {
+            const label = functionNames.map((fn) => fn + '\\l').join('');
+            dotString += `label="${label}", fontsize=10, `;
+        }
+    }
     return dotString + ']';
 }
+function getAssociationFunctionNames(sourceUmlClass, targetUmlClass, association) {
+    const names = new Set();
+    // Add explicitly captured function names
+    if (association.functionsCalled) {
+        for (const fn of association.functionsCalled) {
+            names.add(fn);
+        }
+    }
+    // Cross-reference: if no explicit calls, check if source class's member
+    // access calls match any of the target class's operator names.
+    // Applies to libraries (using...for) and interfaces (e.g. IERC20(token).transfer())
+    if (names.size === 0 &&
+        (targetUmlClass.stereotype === umlClass_1.ClassStereotype.Library ||
+            targetUmlClass.stereotype === umlClass_1.ClassStereotype.Interface) &&
+        sourceUmlClass.memberAccessCalls?.size > 0 &&
+        targetUmlClass.operators?.length > 0) {
+        const targetOperatorNames = new Set(targetUmlClass.operators.map((op) => op.name));
+        for (const callName of sourceUmlClass.memberAccessCalls) {
+            if (targetOperatorNames.has(callName)) {
+                names.add(callName);
+            }
+        }
+    }
+    return [...names].sort();
+}
 //# sourceMappingURL=converterClasses2Dot.js.map

package/lib/parserEtherscan.js

@@ -192,14 +192,29 @@ class EtherscanParser {
         const description = `get verified source code for address ${contractAddress} from Etherscan API.`;
         try {
             debug(`About to get Solidity source code for ${contractAddress} from ${this.url}`);
-            const response = await axios_1.default.get(this.url, {
-                params: {
-                    module: 'contract',
-                    action: 'getsourcecode',
-                    address: contractAddress,
-                    apikey: this.apiKey,
-                },
-            });
+            let response;
+            const maxRetries = 3;
+            for (let attempt = 1; attempt <= maxRetries; attempt++) {
+                response = await axios_1.default.get(this.url, {
+                    params: {
+                        module: 'contract',
+                        action: 'getsourcecode',
+                        address: contractAddress,
+                        apikey: this.apiKey,
+                    },
+                });
+                // Retry on rate limit errors
+                if (!Array.isArray(response?.data?.result) &&
+                    typeof response?.data?.result === 'string' &&
+                    response.data.result.includes('rate limit') &&
+                    attempt < maxRetries) {
+                    const delay = attempt * 2000;
+                    debug(`Rate limited on attempt ${attempt}. Retrying in ${delay}ms...`);
+                    await new Promise((resolve) => setTimeout(resolve, delay));
+                    continue;
+                }
+                break;
+            }
             if (!Array.isArray(response?.data?.result)) {
                 throw new Error(`Failed to ${description}. No result array in HTTP data: ${JSON.stringify(response?.data)}`);
             }

package/lib/sol2uml.js

@@ -34,7 +34,7 @@ Can also flatten or compare verified source files on Etherscan-like explorers.`)
     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('-e, --explorerUrl <url>', 'Override the `network` option with a custom blockchain explorer API URL. eg Polygon Amoy testnet https://api-amoy.polygonscan.com/api').env('EXPLORER_URL'))
     .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')
@@ -61,6 +61,7 @@ program
     .option('-c, --clusterFolders', 'cluster contracts into source folders', false)
     .option('-hv, --hideVariables', 'hide variables from contracts, interfaces, structs and enums', false)
     .option('-hf, --hideFunctions', 'hide functions from contracts, interfaces and libraries', false)
+    .option('-hy, --hideTypes', 'hide types of variables, function arguments and return types', false)
     .option('-hp, --hidePrivates', 'hide private and internal attributes and operators', false)
     .option('-hm, --hideModifiers', 'hide modifier functions from contracts', false)
     .option('-ht, --hideEvents', 'hide events from contracts, interfaces and libraries', false)
@@ -72,6 +73,7 @@ program
     .option('-hi, --hideInterfaces', 'hide interfaces', false)
     .option('-ha, --hideAbstracts', 'hide abstract contracts', false)
     .option('-hn, --hideFilename', 'hide relative path and file name', false)
+    .option('-hd, --hideDepFunctions', 'hide function names on dependency arrows', false)
     .option('-s, --squash', 'squash inherited contracts to the base contract(s)', false)
     .option('-hsc, --hideSourceContract', 'hide the source contract when using squash', false)
     .action(async (fileFolderAddress, options, command) => {

package/lib/squashClasses.js

@@ -117,6 +117,12 @@ const recursiveSquash = (squashedClass, inheritedContractNames, baseClass, umlCl
     baseClass.enums.forEach((e) => squashedClass.enums.push(e));
     baseClass.structs.forEach((s) => squashedClass.structs.push(s));
     baseClass.imports.forEach((i) => squashedClass.imports.push(i));
+    // Merge memberAccessCalls for cross-referencing function names on dependency arrows
+    if (baseClass.memberAccessCalls?.size > 0) {
+        for (const call of baseClass.memberAccessCalls) {
+            squashedClass.memberAccessCalls.add(call);
+        }
+    }
     // copy the functions
     baseClass.operators.forEach((f) => squashedClass.operators.push({
         ...f,

package/lib/umlClass.d.ts

@@ -69,6 +69,7 @@ export interface Association {
     parentUmlClassName?: string;
     targetUmlClassName: string;
     realization?: boolean;
+    functionsCalled?: string[];
 }
 export interface Constants {
     name: string;
@@ -108,6 +109,7 @@ export declare class UmlClass implements ClassProperties {
     associations: {
         [name: string]: Association;
     };
+    memberAccessCalls: Set<string>;
     constructor(properties: ClassProperties);
     addAssociation(association: Association): void;
     /**

package/lib/umlClass.js

@@ -52,6 +52,8 @@ class UmlClass {
         this.enums = [];
         this.structs = [];
         this.associations = {};
+        // Tracks all member access function call names for cross-referencing with using...for libraries
+        this.memberAccessCalls = new Set();
         if (!properties || !properties.name) {
             throw TypeError(`Failed to instantiate UML Class with no name property`);
         }
@@ -73,6 +75,20 @@ class UmlClass {
             if (association.referenceType === ReferenceType.Storage) {
                 this.associations[association.targetUmlClassName].referenceType = ReferenceType.Storage;
             }
+            // Merge functionsCalled arrays with deduplication
+            if (association.functionsCalled?.length) {
+                const existing = this.associations[association.targetUmlClassName];
+                if (!existing.functionsCalled) {
+                    existing.functionsCalled = [...association.functionsCalled];
+                }
+                else {
+                    for (const fn of association.functionsCalled) {
+                        if (!existing.functionsCalled.includes(fn)) {
+                            existing.functionsCalled.push(fn);
+                        }
+                    }
+                }
+            }
         }
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sol2uml",
-  "version": "2.5.24",
+  "version": "2.5.25",
   "description": "Solidity contract visualisation tool.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",