sol2uml 2.0.2 → 2.0.5

package/README.md

@@ -20,16 +20,19 @@ The following installation assumes [Node.js](https://nodejs.org/en/download/) ha
 `sol2uml` works with node 14 or above.
 
 To install globally so you can run `sol2uml` from anywhere
+
 ```bash
 npm link sol2uml --only=production
 ```
 
 To upgrade run
+
 ```bash
 npm upgrade sol2uml -g
 ```
 
 To see which version you are using
+
 ```bash
 npm ls sol2uml -g
 ```
@@ -53,7 +56,7 @@ Options:
   -f, --outputFormat <value>                   output file format. (choices: "svg", "png", "dot", "all", default: "svg")
   -o, --outputFileName <value>                 output file name
   -i, --ignoreFilesOrFolders <filesOrFolders>  comma separated list of files or folders to ignore
-  -n, --network <network>                      Ethereum network (choices: "mainnet", "polygon", "bsc", "arbitrum", "ropsten", "kovan", "rinkeby", "goerli", default: "mainnet")
+  -n, --network <network>                      Ethereum network (choices: "mainnet", "polygon", "bsc", "arbitrum", "ropsten", "kovan", "rinkeby", "goerli", "sepolia", default: "mainnet")
   -k, --apiKey <key>                           Etherscan, Polygonscan or BscScan API key
   -v, --verbose                                run with debugging statements (default: false)
   -h, --help                                   display help for command
@@ -109,7 +112,7 @@ Usage: sol2uml storage [options] <fileFolderAddress>
 
 Visually display a contract's storage slots.
 
-WARNING: sol2uml does not use the Solidity compiler so may differ with solc. A known example is storage arrays declared with a constant, immutable or expression will show as only taking one slot but it could be more. Storage arrays declared with an integer work.
+WARNING: sol2uml does not use the Solidity compiler so may differ with solc. A known example is fixed-sized arrays declared with an expression will fail to be sized.
 
 Arguments:
   fileFolderAddress           file name, base folder or contract address
@@ -139,36 +142,43 @@ Options:
 ## UML Class diagram examples
 
 To generate a diagram of all contracts under the contracts folder and its sub folders
+
 ```bash
 sol2uml class ./contracts
 ```
 
 To generate a diagram of EtherDelta's contract from the verified source code on [Etherscan](https://etherscan.io/address/0x8d12A197cB00D4747a1fe03395095ce2A5CC6819#code). The output wil be a svg file `0x8d12A197cB00D4747a1fe03395095ce2A5CC6819.svg` in the working folder.
+
 ```bash
 sol2uml class 0x8d12A197cB00D4747a1fe03395095ce2A5CC6819
 ```
 
 To generate a diagram of EtherDelta's contract from the verified source code on [Etherscan Ropsten](https://ropsten.etherscan.io/address/0xa19833bd291b66aB0E17b9C6d46D2Ec5fEC15190#code). The output wil be a svg file `0xa19833bd291b66aB0E17b9C6d46D2Ec5fEC15190.svg` in the working folder.
+
 ```bash
 sol2uml class 0xa19833bd291b66aB0E17b9C6d46D2Ec5fEC15190 -n ropsten
 ```
 
 To generate all Solidity files under some root folder and output the svg file to a specific location
+
 ```bash
 sol2uml class path/to/contracts/root/folder -o ./outputFile.svg
 ```
 
 To generate a diagram of all contracts in a single Solidity file, the output file in png format to output file `./someFile.png`
+
 ```bash
 sol2uml class path/to/contracts/root/folder/solidity/file.sol -f png -o ./someFile.png
 ```
 
-To generate a diagram of all Solidity files under the `contracts` and `node_modules/openzeppelin-solidity` folders.  The output will be `contracts.svg` and `contracts.png` files in the working folder.
+To generate a diagram of all Solidity files under the `contracts` and `node_modules/openzeppelin-solidity` folders. The output will be `contracts.svg` and `contracts.png` files in the working folder.
+
 ```bash
 sol2uml class ./contracts,node_modules/openzeppelin-solidity -f all -v
 ```
 
 To generate a diagram of all Solidity files under the working folder ignoring and files under the `solparse`, `@solidity-parser` and `ethlint` folders, which will be under the `node_modules` folder.
+
 ```bash
 sol2uml class -i solparse,@solidity-parser,ethlint
 ```
@@ -176,8 +186,9 @@ sol2uml class -i solparse,@solidity-parser,ethlint
 # UML Class Diagram Syntax
 
 Good online resources for learning UML
-* [UML 2 Class Diagramming Guidelines](http://www.agilemodeling.com/style/classDiagram.htm)
-* [Creating class diagrams with UML](https://www.ionos.com/digitalguide/websites/web-development/class-diagrams-with-uml/)
+
+-   [UML 2 Class Diagramming Guidelines](http://www.agilemodeling.com/style/classDiagram.htm)
+-   [Creating class diagrams with UML](https://www.ionos.com/digitalguide/websites/web-development/class-diagrams-with-uml/)
 
 ## Terminology differences
 
@@ -187,33 +198,35 @@ A Solidity variable becomes an attribute in UML and a Solidity function becomes
 
 ### Class stereotypes
 
-* Interface
-* Abstract - if any of the contract's functions are abstract, the class will have an Abstract stereotype. Child contracts of abstract contracts that do not implement all the abstract functions are currently not marked as Abstract.
-* Library
+-   Interface
+-   Abstract - if any of the contract's functions are abstract, the class will have an Abstract stereotype. Child contracts of abstract contracts that do not implement all the abstract functions are currently not marked as Abstract.
+-   Library
 
 ### Operator stereotypes
 
-* event
-* modifier
-* abstract - is there is no function body on a contract, the operator is marked as abstract. Operators on an Interface do not have an abstract stereotype as all operators are abstract.
-* fallback - abstract fallback functions will just have an abstract stereotype.
-* payable - payable fallback functions will just have a fallback stereotype.
+-   event
+-   modifier
+-   abstract - if there is no function body on a contract, the operator is marked as abstract. Operators on an Interface do not have an abstract stereotype as all operators are abstract.
+-   fallback - abstract fallback functions will just have an abstract stereotype.
+-   payable - payable fallback functions will just have a fallback stereotype.
 
 ## UML Associations
 
 Lines:
-- Solid lines for
-    - link the contract types of storage (state) variables. This can be linked to contracts, interfaces, libraries or file level structs and enums.
-    - generalisations of contracts and abstract contracts.
-    - aggregated contract level structs and enums.
-- Dashed lines for
-    - generalisations of interfaces.
-    - types of memory variables.
+
+-   Solid lines for
+    -   link the contract types of storage (state) variables. This can be linked to contracts, interfaces, libraries or file level structs and enums.
+    -   generalisations of contracts and abstract contracts.
+    -   aggregated contract level structs and enums.
+-   Dashed lines for
+    -   generalisations of interfaces.
+    -   types of memory variables.
 
 Heads/Tails:
-- An empty triangle head for generalisations of contracts, interfaces and abstract contracts.
-- An open arrow head for storage or memory variable dependencies
-- A diamond tail for aggregations of contract level structs and enums
+
+-   An empty triangle head for generalisations of contracts, interfaces and abstract contracts.
+-   An open arrow head for storage or memory variable dependencies
+-   A diamond tail for aggregations of contract level structs and enums
 
 ## Storage diagram
 

package/lib/converterAST2Classes.js

@@ -172,6 +172,16 @@ function parseContractDefinition(umlClass, node) {
                     attributeType,
                     compiled: valueStore,
                 });
+                // Is the variable a constant that could be used in declaring fixed sized arrays
+                if (variable.isDeclaredConst) {
+                    if (variable?.expression.type === 'NumberLiteral') {
+                        umlClass.constants.push({
+                            name: variable.name,
+                            value: parseInt(variable.expression.number),
+                        });
+                    }
+                    // TODO handle expressions. eg N_COINS * 2
+                }
             });
             // Recursively parse variables for associations
             umlClass = addAssociations(subNode.variables, umlClass);

package/lib/converterClasses2Storage.js

@@ -170,7 +170,7 @@ const calcStorageByteSize = (attribute, umlClass, otherClasses) => {
     }
     if (attribute.attributeType === umlClass_1.AttributeType.Array) {
         // All array dimensions must be fixed. eg [2][3][8].
-        const result = attribute.type.match(/(\w+)(\[([1-9][0-9]*)\])+$/);
+        const result = attribute.type.match(/(\w+)(\[([\w][\w]*)\])+$/);
         // The above will not match any dynamic array dimensions, eg [],
         // as there needs to be one or more [0-9]+ in the square brackets
         if (result === null) {
@@ -180,9 +180,19 @@ const calcStorageByteSize = (attribute, umlClass, otherClasses) => {
         }
         // All array dimensions are fixes so we now need to multiply all the dimensions
         // to get a total number of array elements
-        const arrayDimensions = attribute.type.match(/\[\d+/g);
+        const arrayDimensions = attribute.type.match(/\[\w+/g);
         const dimensionsStr = arrayDimensions.map((d) => d.slice(1));
-        const dimensions = dimensionsStr.map((d) => parseInt(d));
+        const dimensions = dimensionsStr.map((dimension) => {
+            const dimensionNum = parseInt(dimension);
+            if (!isNaN(dimensionNum))
+                return dimensionNum;
+            // Try and size array dimension from declared constants
+            const constant = umlClass.constants.find((constant) => constant.name === dimension);
+            if (constant) {
+                return constant.value;
+            }
+            throw Error(`Could not size fixed sized array with dimension "${dimension}"`);
+        });
         let elementSize;
         // If a fixed sized array
         if ((0, exports.isElementary)(result[1])) {

package/lib/parserEtherscan.d.ts

@@ -1,6 +1,6 @@
 import { ASTNode } from '@solidity-parser/parser/dist/src/ast-types';
 import { UmlClass } from './umlClass';
-declare const networks: readonly ["mainnet", "ropsten", "kovan", "rinkeby", "goerli", "polygon", "bsc", "arbitrum"];
+declare const networks: readonly ["mainnet", "ropsten", "kovan", "rinkeby", "goerli", "sepolia", "polygon", "bsc", "arbitrum"];
 declare type Network = typeof networks[number];
 export declare class EtherscanParser {
     protected apikey: string;

package/lib/parserEtherscan.js

@@ -13,6 +13,7 @@ const networks = [
     'kovan',
     'rinkeby',
     'goerli',
+    'sepolia',
     'polygon',
     'bsc',
     'arbitrum',

package/lib/slotValues.js

@@ -0,0 +1,21 @@
+// import { providers } from 'ethers'
+// import { BigNumberish } from '@ethersproject/bignumber'
+// import { BlockTag } from '@ethersproject/abstract-provider'
+//
+// export const getStorageValue = async (
+//     contractAddress: string,
+//     slot: BigNumberish,
+//     blockTag: BlockTag = 'latest'
+// ) => {
+//     const provider = new providers.JsonRpcProvider(
+//         'https://eth-mainnet.alchemyapi.io/v2/iRsTnBFfuK96dHeFnEJ0wg56wdzioYPg',
+//         'mainnet'
+//     )
+//     const slotValue = await provider.getStorageAt(
+//         contractAddress,
+//         slot,
+//         blockTag
+//     )
+//     console.log(`Slot ${slot}: ${slotValue}`)
+// }
+//# sourceMappingURL=slotValues.js.map

package/lib/sol2uml.js

@@ -37,6 +37,7 @@ The Solidity code can be pulled from verified source code on Blockchain explorer
     'kovan',
     'rinkeby',
     'goerli',
+    'sepolia',
 ])
     .default('mainnet'))
     .option('-k, --apiKey <key>', 'Etherscan, Polygonscan, BscScan or Arbiscan API key')
@@ -90,7 +91,7 @@ If an Ethereum address with a 0x prefix is passed, the verified source code from
 });
 program
     .command('storage')
-    .description("Visually display a contract's storage slots.\n\nWARNING: sol2uml does not use the Solidity compiler so may differ with solc. A known example is storage arrays declared with a constant, immutable or expression will show as only taking one slot but it could be more. Storage arrays declared with an integer work.")
+    .description("Visually display a contract's storage slots.\n\nWARNING: sol2uml does not use the Solidity compiler so may differ with solc. A known example is fixed-sized arrays declared with an expression will fail to be sized.")
     .argument('<fileFolderAddress>', 'file name, base folder or contract address')
     .option('-c, --contractName <value>', 'Contract name in local Solidity files. Not needed when using an address as the first argument.')
     // .option('-d, --data', 'gets the data in the storage slots')
@@ -100,15 +101,16 @@ program
             ...command.parent._optionValues,
             ...options,
         };
-        const { umlClasses, contractName } = await (0, parserGeneral_1.parserUmlClasses)(fileFolderAddress, combinedOptions);
-        const storageObjects = (0, converterClasses2Storage_1.convertClasses2StorageObjects)(combinedOptions.contractName || contractName, umlClasses);
+        let { umlClasses, contractName } = await (0, parserGeneral_1.parserUmlClasses)(fileFolderAddress, combinedOptions);
+        contractName = combinedOptions.contractName || contractName;
+        const storageObjects = (0, converterClasses2Storage_1.convertClasses2StorageObjects)(contractName, umlClasses);
         if ((0, regEx_1.isAddress)(fileFolderAddress)) {
             // The first object is the contract
             storageObjects[0].address = fileFolderAddress;
         }
         debug(storageObjects);
         const dotString = (0, converterStorage2Dot_1.convertStorage2Dot)(storageObjects);
-        await (0, writerFiles_1.writeOutputFiles)(dotString, fileFolderAddress, combinedOptions.outputFormat, combinedOptions.outputFileName);
+        await (0, writerFiles_1.writeOutputFiles)(dotString, fileFolderAddress, contractName, combinedOptions.outputFormat, combinedOptions.outputFileName);
     }
     catch (err) {
         console.error(`Failed to generate storage diagram ${err}`);

package/lib/umlClass.d.ts

@@ -63,6 +63,10 @@ export interface Association {
     targetUmlClassStereotype?: ClassStereotype;
     realization?: boolean;
 }
+export interface Constants {
+    name: string;
+    value: number;
+}
 export interface ClassProperties {
     name: string;
     absolutePath: string;
@@ -76,6 +80,7 @@ export interface ClassProperties {
     associations?: {
         [name: string]: Association;
     };
+    constants?: Constants[];
 }
 export declare class UmlClass implements ClassProperties {
     static idCounter: number;
@@ -85,6 +90,7 @@ export declare class UmlClass implements ClassProperties {
     relativePath: string;
     imports?: Import[];
     stereotype?: ClassStereotype;
+    constants: Constants[];
     attributes: Attribute[];
     operators: Operator[];
     enums: number[];

package/lib/umlClass.js

@@ -43,6 +43,7 @@ var ReferenceType;
 })(ReferenceType = exports.ReferenceType || (exports.ReferenceType = {}));
 class UmlClass {
     constructor(properties) {
+        this.constants = [];
         this.attributes = [];
         this.operators = [];
         this.enums = [];

package/lib/writerFiles.d.ts

@@ -1,5 +1,5 @@
 export declare type OutputFormats = 'svg' | 'png' | 'dot' | 'all';
-export declare const writeOutputFiles: (dot: string, outputBaseName: string, outputFormat?: OutputFormats, outputFilename?: string) => Promise<void>;
+export declare const writeOutputFiles: (dot: string, fileFolderAddress: string, contractName: string, outputFormat?: OutputFormats, outputFilename?: string) => Promise<void>;
 export declare function convertDot2Svg(dot: string): any;
 export declare function writeSolidity(code: string, filename?: string): void;
 export declare function writeDot(dot: string, filename?: string): void;

package/lib/writerFiles.js

@@ -9,7 +9,7 @@ const path_1 = __importDefault(require("path"));
 const sync_1 = __importDefault(require("@aduh95/viz.js/sync"));
 const { convert } = require('convert-svg-to-png');
 const debug = require('debug')('sol2uml');
-const writeOutputFiles = async (dot, outputBaseName, outputFormat = 'svg', outputFilename) => {
+const writeOutputFiles = async (dot, fileFolderAddress, contractName, outputFormat = 'svg', outputFilename) => {
     if (outputFormat === 'dot' || outputFormat === 'all') {
         writeDot(dot, outputFilename);
         // No need to continue if only generating a dot file
@@ -17,19 +17,24 @@ const writeOutputFiles = async (dot, outputBaseName, outputFormat = 'svg', outpu
             return;
         }
     }
+    // If all output then extension is svg
+    const outputExt = outputFormat === 'all' ? 'svg' : outputFormat;
     if (!outputFilename) {
-        // If all output then extension is svg
-        const outputExt = outputFormat === 'all' ? 'svg' : outputFormat;
-        // if outputBaseName is a folder
+        outputFilename =
+            path_1.default.join(process.cwd(), contractName) + '.' + outputExt;
+    }
+    else {
+        // check if outputFilename is a folder
         try {
-            const folderOrFile = (0, fs_1.lstatSync)(outputBaseName);
+            const folderOrFile = (0, fs_1.lstatSync)(outputFilename);
             if (folderOrFile.isDirectory()) {
-                const parsedDir = path_1.default.parse(process.cwd());
-                outputBaseName = path_1.default.join(process.cwd(), parsedDir.name);
+                outputFilename =
+                    path_1.default.join(process.cwd(), outputFilename, contractName) +
+                        '.' +
+                        outputExt;
             }
         }
-        catch (err) { } // we can ignore errors as it just means outputBaseName is not a folder
-        outputFilename = outputBaseName + '.' + outputExt;
+        catch (err) { } // we can ignore errors as it just means outputFilename does not exist yet
     }
     const svg = convertDot2Svg(dot);
     if (outputFormat === 'svg' || outputFormat === 'all') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sol2uml",
-  "version": "2.0.2",
+  "version": "2.0.5",
   "description": "Unified Modeling Language (UML) class diagram generator for Solidity contracts",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -8,8 +8,8 @@
     "buildSol": "cd ./src/contracts && solc **/*.sol",
     "build": "tsc --build ./tsconfig.json",
     "clean": "tsc --build --clean ./tsconfig.json",
-    "prettier": "prettier --write \"src/**/*.ts\"",
-    "prettier:check": "prettier --check \"src/**/*.ts\"",
+    "prettier": "prettier --write src/**/*.ts **/*.md",
+    "prettier:check": "prettier --check src/**/*.ts  **/*.md",
     "test": "npx jest"
   },
   "preferGlobal": true,