sol2uml 2.5.0 → 2.5.1

package/README.md

@@ -14,7 +14,7 @@ See more contract diagrams [here](./examples/README.md).
 Storage layout diagram of USDC's [verified source code](https://etherscan.io/address/0xa2327a938febf5fec13bacfb16ae10ecbc4cbdcf#code) on Etherscan.
 ![USDC](./examples/storage/usdcData.svg)
 
-See an explanation of how storage diagrams work with lots of examples [here](./examples/storage/README.md).
+See an explanation of how storage diagrams work with lots of examples [here](./examples/storage/README.md#example-storage-diagrams).
 
 # Install
 
@@ -137,6 +137,7 @@ Options:
   -u, --url <url>                 URL of the Ethereum node to get storage values if the `data` option is used. (default: "http://localhost:8545", env: NODE_URL)
   -bn, --block <number>           Block number to get the contract storage values from. (default: "latest")
   -a, --array <number>            Number of slots to display at the start and end of arrays. (default: "2")
+  -hv, --hideValue                Hide storage slot value column.
   -h, --help                      display help for command
 ```
 

package/lib/converterClasses2Storage.js

@@ -267,7 +267,7 @@ const parseStorageSectionFromAttribute = (attribute, umlClass, otherClasses, sto
     }
     if (attribute.attributeType === umlClass_1.AttributeType.UserDefined) {
         // Is the user defined type linked to another Contract, Struct or Enum?
-        const typeClass = findTypeClass(attribute.type, attribute, otherClasses);
+        const typeClass = findTypeClass(attribute.type, attribute, umlClass, otherClasses);
         if (typeClass.stereotype === umlClass_1.ClassStereotype.Struct) {
             const variables = parseVariables(typeClass, otherClasses, [], storageSections, [], mapping, arrayItems);
             const storageSection = {
@@ -296,7 +296,7 @@ const parseStorageSectionFromAttribute = (attribute, umlClass, otherClasses, sto
         // If mapping of user defined type
         if (result !== null && result[1] && !(0, exports.isElementary)(result[1])) {
             // Find UserDefined type can be a contract, struct or enum
-            const typeClass = findTypeClass(result[1], attribute, otherClasses);
+            const typeClass = findTypeClass(result[1], attribute, umlClass, otherClasses);
             if (typeClass.stereotype === umlClass_1.ClassStereotype.Struct) {
                 let variables = parseVariables(typeClass, otherClasses, [], storageSections, [], true, arrayItems);
                 const storageSection = {
@@ -380,12 +380,17 @@ const addArrayVariables = (arrayLength, arrayItems, variables) => {
  * Finds an attribute's user defined type that can be a Contract, Struct or Enum
  * @param userType User defined type that is being looked for. This can be the base type of an attribute.
  * @param attribute the attribute in the class that is user defined. This is just used for logging purposes
+ * @param umlClass the attribute is part of.
  * @param otherClasses
  */
-const findTypeClass = (userType, attribute, otherClasses) => {
+const findTypeClass = (userType, attribute, umlClass, otherClasses) => {
     // Find associated UserDefined type
-    // TODO this just matches on name and doesn't take into account imports
-    const typeClass = otherClasses.find(({ name }) => name === userType || name === userType.split('.')[1]);
+    const types = userType.split('.');
+    const association = {
+        referenceType: umlClass_1.ReferenceType.Memory,
+        targetUmlClassName: types.length === 1 ? types[0] : types[1],
+    };
+    const typeClass = (0, associations_1.findAssociatedClass)(association, umlClass, otherClasses);
     if (!typeClass) {
         throw Error(`Failed to find user defined type "${userType}" in attribute "${attribute.name}" of type "${attribute.attributeType}""`);
     }
@@ -471,7 +476,7 @@ const calcStorageByteSize = (attribute, umlClass, otherClasses) => {
     // TODO need to handle User Defined Value Types when they are added to Solidity
     if (attribute.attributeType === umlClass_1.AttributeType.UserDefined) {
         // Is the user defined type linked to another Contract, Struct or Enum?
-        const attributeTypeClass = findTypeClass(attribute.type, attribute, otherClasses);
+        const attributeTypeClass = findTypeClass(attribute.type, attribute, umlClass, otherClasses);
         switch (attributeTypeClass.stereotype) {
             case umlClass_1.ClassStereotype.Enum:
                 return { size: 1, dynamic: false };
@@ -491,7 +496,7 @@ const calcStorageByteSize = (attribute, umlClass, otherClasses) => {
                     else if (structAttribute.attributeType ===
                         umlClass_1.AttributeType.UserDefined) {
                         // UserDefined types can be a struct or enum, so we need to check if it's a struct
-                        const userDefinedClass = findTypeClass(structAttribute.type, structAttribute, otherClasses);
+                        const userDefinedClass = findTypeClass(structAttribute.type, structAttribute, umlClass, otherClasses);
                         // If a struct
                         if (userDefinedClass.stereotype ===
                             umlClass_1.ClassStereotype.Struct) {

package/lib/converterStorage2Dot.d.ts

@@ -5,7 +5,9 @@ export declare const convertStorages2Dot: (storageSections: readonly StorageSect
     shapeColor: string;
     fillColor: string;
     textColor: string;
+    hideValues?: boolean;
 }) => string;
 export declare function convertStorage2Dot(storageSection: StorageSection, dotString: string, options: {
     data: boolean;
+    hideValues?: boolean;
 }): string;

package/lib/converterStorage2Dot.js

@@ -54,7 +54,7 @@ function convertStorage2Dot(storageSection, dotString, options) {
         }
     });
     // write slot values if available
-    if (options.data) {
+    if (options.data && !options.hideValues) {
         dotString += `} | {value${dataLine}`;
         startingVariables.forEach((variable, i) => {
             if (displayData[i]) {

package/lib/sol2uml.js

@@ -133,6 +133,7 @@ WARNING: sol2uml does not use the Solidity compiler so may differ with solc. A k
     .default('http://localhost:8545'))
     .option('-bn, --block <number>', 'Block number to get the contract storage values from.', 'latest')
     .option('-a, --array <number>', 'Number of slots to display at the start and end of arrays.', '2')
+    .option('-hv, --hideValue', 'Hide storage slot value column.', false)
     .action(async (fileFolderAddress, options, command) => {
     try {
         const combinedOptions = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sol2uml",
-  "version": "2.5.0",
+  "version": "2.5.1",
   "description": "Solidity contract visualisation tool.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -20,28 +20,28 @@
   "license": "MIT",
   "dependencies": {
     "@aduh95/viz.js": "^3.7.0",
-    "@solidity-parser/parser": "^0.14.5",
-    "axios": "1.1.3",
+    "@solidity-parser/parser": "^0.15.0",
+    "axios": "^1.3.4",
     "axios-debug-log": "^1.0.0",
     "cli-color": "^2.0.3",
-    "commander": "^9.4.1",
+    "commander": "^10.0.0",
     "convert-svg-to-png": "^0.6.4",
     "debug": "^4.3.4",
     "diff-match-patch": "^1.0.5",
     "ethers": "^5.7.2",
     "js-graph-algorithms": "^1.0.18",
-    "klaw": "^4.0.1"
+    "klaw": "^4.1.0"
   },
   "devDependencies": {
     "@openzeppelin/contracts": "4.8.0",
     "@types/diff-match-patch": "^1.0.32",
     "@types/jest": "^29.4.0",
     "@types/klaw": "^3.0.3",
-    "jest": "^29.4.1",
-    "prettier": "^2.8.3",
+    "jest": "^29.4.3",
+    "prettier": "^2.8.4",
     "ts-jest": "^29.0.5",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.4"
+    "typescript": "^4.9.5"
   },
   "files": [
     "lib/*.js",