sol2uml 2.1.6 → 2.1.7

package/README.md

@@ -97,6 +97,7 @@ Options:
   -hv, --hideVariables             hide variables from contracts, interfaces, structs and enums (default: false)
   -hf, --hideFunctions             hide functions from contracts, interfaces and libraries (default: false)
   -hp, --hidePrivates              hide private and internal attributes and operators (default: false)
+  -hc, --hideConstants             hide file level constants (default: false)
   -he, --hideEnums                 hide enum types (default: false)
   -hs, --hideStructs               hide data structures (default: false)
   -hl, --hideLibraries             hide libraries (default: false)

package/lib/converterAST2Classes.js

@@ -48,7 +48,7 @@ function convertAST2UmlClasses(node, relativePath, filesystem = false) {
                 umlClasses.push(umlClass);
             }
             else if (childNode.type === 'StructDefinition') {
-                debug(`Adding struct ${childNode.name}`);
+                debug(`Adding file level struct ${childNode.name}`);
                 let umlClass = new umlClass_1.UmlClass({
                     name: childNode.name,
                     stereotype: umlClass_1.ClassStereotype.Struct,
@@ -62,7 +62,7 @@ function convertAST2UmlClasses(node, relativePath, filesystem = false) {
                 umlClasses.push(umlClass);
             }
             else if (childNode.type === 'EnumDefinition') {
-                debug(`Adding enum ${childNode.name}`);
+                debug(`Adding file level enum ${childNode.name}`);
                 let umlClass = new umlClass_1.UmlClass({
                     name: childNode.name,
                     stereotype: umlClass_1.ClassStereotype.Enum,
@@ -123,7 +123,36 @@ function convertAST2UmlClasses(node, relativePath, filesystem = false) {
                     imports.push(newImport);
                 }
             }
-            // TODO add file level constants
+            else if (childNode.type === 'FileLevelConstant') {
+                debug(`Adding file level constant ${childNode.name}`);
+                const [type, attributeType] = parseTypeName(childNode.typeName);
+                const umlClass = new umlClass_1.UmlClass({
+                    name: childNode.name,
+                    stereotype: umlClass_1.ClassStereotype.Constant,
+                    absolutePath: filesystem
+                        ? path.resolve(relativePath) // resolve the absolute path
+                        : relativePath,
+                    relativePath,
+                    attributes: [
+                        {
+                            name: childNode.name,
+                            type,
+                            attributeType,
+                        },
+                    ],
+                });
+                if (childNode?.initialValue?.type === 'NumberLiteral') {
+                    umlClass.constants.push({
+                        name: childNode.name,
+                        value: parseInt(childNode.initialValue.number),
+                    });
+                }
+                // TODO handle expressions. eg N_COINS * 2
+                umlClasses.push(umlClass);
+            }
+            else if (childNode.type !== 'PragmaDirective') {
+                debug(`node type "${childNode.type}" not parsed in ${relativePath}`);
+            }
         });
     }
     else {
@@ -347,13 +376,22 @@ function addAssociations(nodes, umlClass) {
                     ], umlClass);
                     // Array of user defined types
                 }
-                else if (node.typeName.type == 'ArrayTypeName' &&
-                    node.typeName.baseTypeName.type === 'UserDefinedTypeName') {
-                    const { umlClassName } = parseClassName(node.typeName.baseTypeName.namePath);
-                    umlClass.addAssociation({
-                        referenceType,
-                        targetUmlClassName: umlClassName,
-                    });
+                else if (node.typeName.type == 'ArrayTypeName') {
+                    if (node.typeName.baseTypeName.type ===
+                        'UserDefinedTypeName') {
+                        const { umlClassName } = parseClassName(node.typeName.baseTypeName.namePath);
+                        umlClass.addAssociation({
+                            referenceType,
+                            targetUmlClassName: umlClassName,
+                        });
+                    }
+                    else if (node.typeName.length?.type === 'Identifier') {
+                        const { umlClassName } = parseClassName(node.typeName.length.name);
+                        umlClass.addAssociation({
+                            referenceType,
+                            targetUmlClassName: umlClassName,
+                        });
+                    }
                 }
                 break;
             case 'UserDefinedTypeName':

package/lib/converterClass2Dot.d.ts

@@ -1,5 +1,6 @@
 import { UmlClass } from './umlClass';
 export interface ClassOptions {
+    hideConstants?: boolean;
     hideVariables?: boolean;
     hideFunctions?: boolean;
     hideStructs?: boolean;

package/lib/converterClass2Dot.js

@@ -14,7 +14,9 @@ const convertClass2Dot = (umlClass, options = {}) => {
             umlClass.stereotype === umlClass_1.ClassStereotype.Abstract) ||
         (options.hideStructs &&
             umlClass.stereotype === umlClass_1.ClassStereotype.Struct) ||
-        (options.hideEnums && umlClass.stereotype === umlClass_1.ClassStereotype.Enum)) {
+        (options.hideEnums && umlClass.stereotype === umlClass_1.ClassStereotype.Enum) ||
+        (options.hideConstants &&
+            umlClass.stereotype === umlClass_1.ClassStereotype.Constant)) {
         return '';
     }
     let dotString = `\n${umlClass.id} [label="{${dotClassTitle(umlClass, options)}`;
@@ -51,6 +53,9 @@ const dotClassTitle = (umlClass, options = {}) => {
         case umlClass_1.ClassStereotype.Enum:
             stereoName = 'Enum';
             break;
+        case umlClass_1.ClassStereotype.Constant:
+            stereoName = 'Constant';
+            break;
         default:
             // Contract or undefined stereotype will just return the UmlClass name
             return `${umlClass.name}${relativePath}`;
@@ -61,9 +66,10 @@ const dotAttributeVisibilities = (umlClass, options = {}) => {
     if (umlClass.attributes.length === 0)
         return '';
     let dotString = '| ';
-    // if a struct or enum then no visibility group
+    // if a struct, enum or constant then no visibility group
     if (umlClass.stereotype === umlClass_1.ClassStereotype.Struct ||
-        umlClass.stereotype === umlClass_1.ClassStereotype.Enum) {
+        umlClass.stereotype === umlClass_1.ClassStereotype.Enum ||
+        umlClass.stereotype === umlClass_1.ClassStereotype.Constant) {
         return dotString + dotAttributes(umlClass.attributes, undefined, false);
     }
     // For each visibility group

package/lib/converterClasses2Dot.js

@@ -90,7 +90,7 @@ function addAssociationsToDot(umlClasses, classOptions = {}) {
 exports.addAssociationsToDot = addAssociationsToDot;
 function addAssociationToDot(sourceUmlClass, targetUmlClass, association, classOptions = {}) {
     // do not include library or interface associations if hidden
-    // Or associations to Structs or Enums if they are hidden
+    // Or associations to Structs, Enums or Constants if they are hidden
     if ((classOptions.hideLibraries &&
         (sourceUmlClass.stereotype === umlClass_1.ClassStereotype.Library ||
             targetUmlClass.stereotype === umlClass_1.ClassStereotype.Library)) ||
@@ -103,7 +103,9 @@ function addAssociationToDot(sourceUmlClass, targetUmlClass, association, classO
         (classOptions.hideStructs &&
             targetUmlClass.stereotype === umlClass_1.ClassStereotype.Struct) ||
         (classOptions.hideEnums &&
-            targetUmlClass.stereotype === umlClass_1.ClassStereotype.Enum)) {
+            targetUmlClass.stereotype === umlClass_1.ClassStereotype.Enum) ||
+        (classOptions.hideConstants &&
+            targetUmlClass.stereotype === umlClass_1.ClassStereotype.Constant)) {
         return '';
     }
     let dotString = `\n${sourceUmlClass.id} -> ${targetUmlClass.id} [`;

package/lib/converterClasses2Storage.js

@@ -177,25 +177,29 @@ const parseReferenceStorage = (attribute, umlClass, otherClasses, storages) => {
             attributeType: baseAttributeType,
         };
         const { size: arrayItemSize } = (0, exports.calcStorageByteSize)(baseAttribute, umlClass, otherClasses);
-        const firstVariable = {
+        const arraySlotSize = arrayItemSize > 16
+            ? 32 * Math.ceil(arrayItemSize / 32)
+            : arrayItemSize;
+        const variables = [];
+        variables[0] = {
             id: variableId++,
             fromSlot: 0,
-            toSlot: Math.floor((arrayItemSize - 1) / 32),
+            toSlot: Math.floor((arraySlotSize - 1) / 32),
             byteSize: arrayItemSize,
             byteOffset: 0,
             type: baseType,
             dynamic,
             noValue: false,
         };
-        const variables = [firstVariable];
         if (arrayLength > 1) {
+            // For fixed length arrays. Dynamic arrays will have undefined arrayLength
             for (let i = 1; i < arrayLength; i++) {
                 variables.push({
                     id: variableId++,
-                    fromSlot: Math.floor((i * arrayItemSize) / 32),
-                    toSlot: Math.floor(((i + 1) * arrayItemSize - 1) / 32),
+                    fromSlot: Math.floor((i * arraySlotSize) / 32),
+                    toSlot: Math.floor(((i + 1) * arraySlotSize - 1) / 32),
                     byteSize: arrayItemSize,
-                    byteOffset: (i * arrayItemSize) % 32,
+                    byteOffset: (i * arraySlotSize) % 32,
                     type: baseType,
                     dynamic,
                     noValue: false,
@@ -205,7 +209,7 @@ const parseReferenceStorage = (attribute, umlClass, otherClasses, storages) => {
         // recursively add storage
         if (baseAttributeType !== umlClass_1.AttributeType.Elementary) {
             const referenceStorage = (0, exports.parseReferenceStorage)(baseAttribute, umlClass, otherClasses, storages);
-            firstVariable.referenceStorageId = referenceStorage?.id;
+            variables[0].referenceStorageId = referenceStorage?.id;
         }
         const newStorage = {
             id: storageId++,

package/lib/sol2uml.js

@@ -60,6 +60,7 @@ If an Ethereum address with a 0x prefix is passed, the verified source code from
     .option('-hv, --hideVariables', 'hide variables from contracts, interfaces, structs and enums', false)
     .option('-hf, --hideFunctions', 'hide functions from contracts, interfaces and libraries', false)
     .option('-hp, --hidePrivates', 'hide private and internal attributes and operators', false)
+    .option('-hc, --hideConstants', 'hide file level constants', false)
     .option('-he, --hideEnums', 'hide enum types', false)
     .option('-hs, --hideStructs', 'hide data structures', false)
     .option('-hl, --hideLibraries', 'hide libraries', false)

package/lib/umlClass.d.ts

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

package/lib/umlClass.js

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

package/package.json

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