sol2uml 2.5.7 → 2.5.9

package/README.md

@@ -151,6 +151,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")
+  -hx, --hideExpand <variables>   Comma-separated list of storage variables to not expand. That's arrays, structs, strings or bytes.
   -hv, --hideValue                Hide storage slot value column. (default: false)
   -h, --help                      display help for command
 ```
@@ -196,8 +197,8 @@ Options:
   -l, --lineBuffer <value>   Minimum number of lines before and after changes (default: 4)
   -af --aFile <value>        Contract A source code filename without the .sol extension (default: compares all source files)
   -bf --bFile <value>        Contract B source code filename without the .sol extension (default: aFile if specified)
-  -bn, --bNetwork <network>  Ethereum network which maps to a blockchain explorer for contract B if on a different blockchain to contract A. Contract A uses the `network` option (default: value of `network` option) (choices: "mainnet", "goerli", "sepolia", "polygon",
-                             "arbitrum", "avalanche", "bsc", "crono", "fantom", "moonbeam", "optimism", "gnosis", "celo")
+  -bn, --bNetwork <network>  Ethereum network which maps to a blockchain explorer for contract B if on a different blockchain to contract A. Contract A uses the `network` option (default: value of `network` option) (choices: "mainnet",
+                             "goerli", "sepolia", "polygon", "arbitrum", "avalanche", "bsc", "crono", "fantom", "moonbeam", "optimism", "gnosis", "celo")
   -be, --bExplorerUrl <url>  Override the `bNetwork` option with custom blockchain explorer API URL for contract B if on a different blockchain to contract A. Contract A uses the `explorerUrl` (default: value of `explorerUrl` option)
   -bk, --bApiKey <key>       Blockchain explorer API key for contract B if on a different blockchain to contract A. Contract A uses the `apiKey` option (default: value of `apiKey` option)
   -s, --summary              Only show a summary of the file differences. (default: false)

package/lib/converterAST2Classes.js

@@ -665,7 +665,7 @@ function parseParameters(params) {
 function parseContractKind(kind) {
     switch (kind) {
         case 'contract':
-            return umlClass_1.ClassStereotype.None;
+            return umlClass_1.ClassStereotype.Contract;
         case 'interface':
             return umlClass_1.ClassStereotype.Interface;
         case 'library':

package/lib/converterClasses2Storage.d.ts

@@ -44,7 +44,7 @@ export interface StorageSection {
  * @param contractFilename relative path of the contract in the file system
  * @return storageSections array of storageSection objects
  */
-export declare const convertClasses2StorageSections: (contractName: string, umlClasses: UmlClass[], arrayItems: number, contractFilename?: string) => StorageSection[];
+export declare const convertClasses2StorageSections: (contractName: string, umlClasses: UmlClass[], arrayItems: number, contractFilename?: string, noExpandVariables?: string[]) => StorageSection[];
 /**
  * Recursively adds new storage sections under a class attribute.
  * also returns the allowed enum values
@@ -57,7 +57,7 @@ export declare const convertClasses2StorageSections: (contractName: string, umlC
  * @return storageSection new storage section that was added or undefined if none was added.
  * @return enumValues array of allowed enum values. undefined if attribute is not an enum
  */
-export declare const parseStorageSectionFromAttribute: (attribute: Attribute, umlClass: UmlClass, otherClasses: readonly UmlClass[], storageSections: StorageSection[], mapping: boolean, arrayItems: number) => {
+export declare const parseStorageSectionFromAttribute: (attribute: Attribute, umlClass: UmlClass, otherClasses: readonly UmlClass[], storageSections: StorageSection[], mapping: boolean, arrayItems: number, noExpandVariables: string[]) => {
     storageSection: StorageSection;
     enumValues?: string[];
 };

package/lib/converterClasses2Storage.js

@@ -29,7 +29,7 @@ let variableId = 1;
  * @param contractFilename relative path of the contract in the file system
  * @return storageSections array of storageSection objects
  */
-const convertClasses2StorageSections = (contractName, umlClasses, arrayItems, contractFilename) => {
+const convertClasses2StorageSections = (contractName, umlClasses, arrayItems, contractFilename, noExpandVariables = []) => {
     // Find the base UML Class from the base contract name
     const umlClass = umlClasses.find(({ name, relativePath }) => {
         if (!contractFilename) {
@@ -48,7 +48,7 @@ const convertClasses2StorageSections = (contractName, umlClasses, arrayItems, co
     }
     debug(`Found contract "${contractName}" in ${umlClass.absolutePath}`);
     const storageSections = [];
-    const variables = parseVariables(umlClass, umlClasses, [], storageSections, [], false, arrayItems);
+    const variables = parseVariables(umlClass, umlClasses, [], storageSections, [], false, arrayItems, noExpandVariables);
     // Add new storage section to the beginning of the array
     storageSections.unshift({
         id: storageId++,
@@ -72,7 +72,7 @@ exports.convertClasses2StorageSections = convertClasses2StorageSections;
  * @param arrayItems the number of items to display at the start and end of an array
  * @return variables array of storage variables in the `umlClass`
  */
-const parseVariables = (umlClass, umlClasses, variables, storageSections, inheritedContracts, mapping, arrayItems) => {
+const parseVariables = (umlClass, umlClasses, variables, storageSections, inheritedContracts, mapping, arrayItems, noExpandVariables) => {
     // Add storage slots from inherited contracts first.
     // Get immediate parent contracts that the class inherits from
     const parentContracts = umlClass.getParentContracts();
@@ -87,7 +87,7 @@ const parseVariables = (umlClass, umlClasses, variables, storageSections, inheri
             throw Error(`Failed to find inherited contract "${parent.targetUmlClassName}" of "${umlClass.absolutePath}"`);
         }
         // recursively parse inherited contract
-        parseVariables(parentClass, umlClasses, variables, storageSections, inheritedContracts, mapping, arrayItems);
+        parseVariables(parentClass, umlClasses, variables, storageSections, inheritedContracts, mapping, arrayItems, noExpandVariables);
     });
     // Parse storage for each attribute
     umlClass.attributes.forEach((attribute) => {
@@ -96,7 +96,9 @@ const parseVariables = (umlClass, umlClasses, variables, storageSections, inheri
             return;
         const { size: byteSize, dynamic } = (0, exports.calcStorageByteSize)(attribute, umlClass, umlClasses);
         // parse any dependent storage sections or enums
-        const references = (0, exports.parseStorageSectionFromAttribute)(attribute, umlClass, umlClasses, storageSections, mapping || attribute.attributeType === umlClass_1.AttributeType.Mapping, arrayItems);
+        const references = noExpandVariables.includes(attribute.name)
+            ? undefined
+            : (0, exports.parseStorageSectionFromAttribute)(attribute, umlClass, umlClasses, storageSections, mapping || attribute.attributeType === umlClass_1.AttributeType.Mapping, arrayItems, noExpandVariables);
         // should this new variable get the slot value
         const displayValue = calcDisplayValue(attribute.attributeType, dynamic, mapping, references?.storageSection?.type);
         const getValue = calcGetValue(attribute.attributeType, mapping);
@@ -179,7 +181,7 @@ const adjustSlots = (storageSection, slotOffset, storageSections) => {
  * @return storageSection new storage section that was added or undefined if none was added.
  * @return enumValues array of allowed enum values. undefined if attribute is not an enum
  */
-const parseStorageSectionFromAttribute = (attribute, umlClass, otherClasses, storageSections, mapping, arrayItems) => {
+const parseStorageSectionFromAttribute = (attribute, umlClass, otherClasses, storageSections, mapping, arrayItems, noExpandVariables) => {
     if (attribute.attributeType === umlClass_1.AttributeType.Array) {
         // storage is dynamic if the attribute type ends in []
         const result = attribute.type.match(/\[([\w$.]*)]$/);
@@ -216,7 +218,7 @@ const parseStorageSectionFromAttribute = (attribute, umlClass, otherClasses, sto
         let references;
         if (baseAttributeType !== umlClass_1.AttributeType.Elementary) {
             // recursively add storage section for Array and UserDefined types
-            references = (0, exports.parseStorageSectionFromAttribute)(baseAttribute, umlClass, otherClasses, storageSections, mapping, arrayItems);
+            references = (0, exports.parseStorageSectionFromAttribute)(baseAttribute, umlClass, otherClasses, storageSections, mapping, arrayItems, noExpandVariables);
         }
         const displayValue = calcDisplayValue(baseAttribute.attributeType, dynamicBase, mapping, references?.storageSection?.type);
         const getValue = calcGetValue(attribute.attributeType, mapping);
@@ -247,7 +249,7 @@ const parseStorageSectionFromAttribute = (attribute, umlClass, otherClasses, sto
                     variable.type !== '----' // ignore any filler variables
                 ) {
                     // recursively add storage section for Array and UserDefined types
-                    references = (0, exports.parseStorageSectionFromAttribute)(baseAttribute, umlClass, otherClasses, storageSections, mapping, arrayItems);
+                    references = (0, exports.parseStorageSectionFromAttribute)(baseAttribute, umlClass, otherClasses, storageSections, mapping, arrayItems, noExpandVariables);
                     variable.referenceSectionId = references?.storageSection?.id;
                     variable.enumValues = references?.enumValues;
                 }
@@ -269,7 +271,7 @@ const parseStorageSectionFromAttribute = (attribute, umlClass, otherClasses, sto
         // Is the user defined type linked to another Contract, Struct or Enum?
         const typeClass = findTypeClass(attribute.type, attribute, umlClass, otherClasses);
         if (typeClass.stereotype === umlClass_1.ClassStereotype.Struct) {
-            const variables = parseVariables(typeClass, otherClasses, [], storageSections, [], mapping, arrayItems);
+            const variables = parseVariables(typeClass, otherClasses, [], storageSections, [], mapping, arrayItems, noExpandVariables);
             const storageSection = {
                 id: storageId++,
                 name: attribute.type,
@@ -298,7 +300,7 @@ const parseStorageSectionFromAttribute = (attribute, umlClass, otherClasses, sto
             // Find UserDefined type can be a contract, struct or enum
             const typeClass = findTypeClass(result[1], attribute, umlClass, otherClasses);
             if (typeClass.stereotype === umlClass_1.ClassStereotype.Struct) {
-                let variables = parseVariables(typeClass, otherClasses, [], storageSections, [], true, arrayItems);
+                let variables = parseVariables(typeClass, otherClasses, [], storageSections, [], true, arrayItems, noExpandVariables);
                 const storageSection = {
                     id: storageId++,
                     name: typeClass.name,
@@ -520,7 +522,7 @@ const calcStorageByteSize = (attribute, umlClass, otherClasses) => {
                     dynamic: false,
                 };
             default:
-                return { size: 32, dynamic: false };
+                return { size: 20, dynamic: false };
         }
     }
     if (attribute.attributeType === umlClass_1.AttributeType.Elementary) {

package/lib/sol2uml.js

@@ -29,7 +29,7 @@ Can also flatten or compare verified source files on Etherscan-like explorers.`)
     .choices(['svg', 'png', 'dot', 'all'])
     .default('svg'))
     .option('-o, --outputFileName <value>', 'output file name')
-    .option('-i, --ignoreFilesOrFolders <filesOrFolders>', 'comma separated list of files or folders to ignore')
+    .option('-i, --ignoreFilesOrFolders <filesOrFolders>', 'comma-separated list of files or folders to ignore')
     .addOption(new commander_1.Option('-n, --network <network>', 'Ethereum network which maps to a blockchain explorer')
     .choices(parserEtherscan_1.networks)
     .default('mainnet')
@@ -56,7 +56,7 @@ program
     .usage('[options] <fileFolderAddress>')
     .description('Generates a UML class diagram from Solidity source code.')
     .argument('fileFolderAddress', argumentText)
-    .option('-b, --baseContractNames <value>', 'only output contracts connected to these comma separated base contract names')
+    .option('-b, --baseContractNames <value>', 'only output contracts connected to these comma-separated base contract names')
     .addOption(new commander_1.Option('-d, --depth <value>', 'depth of connected classes to the base contracts. 1 will only show directly connected contracts, interfaces, libraries, structs and enums.').default('100', 'all'))
     .option('-c, --clusterFolders', 'cluster contracts into source folders', false)
     .option('-hv, --hideVariables', 'hide variables from contracts, interfaces, structs and enums', false)
@@ -132,6 +132,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('-hx, --hideExpand <variables>', "Comma-separated list of storage variables to not expand. That's arrays, structs, strings or bytes.", validators_1.validateVariables)
     .option('-hv, --hideValue', 'Hide storage slot value column.', false)
     .action(async (fileFolderAddress, options, command) => {
     try {
@@ -146,7 +147,7 @@ WARNING: sol2uml does not use the Solidity compiler so may differ with solc. A k
         let { umlClasses, contractName } = await (0, parserGeneral_1.parserUmlClasses)(fileFolderAddress, combinedOptions);
         contractName = combinedOptions.contract || contractName;
         const arrayItems = parseInt(combinedOptions.array);
-        const storageSections = (0, converterClasses2Storage_1.convertClasses2StorageSections)(contractName, umlClasses, arrayItems, combinedOptions.contractFile);
+        const storageSections = (0, converterClasses2Storage_1.convertClasses2StorageSections)(contractName, umlClasses, arrayItems, combinedOptions.contractFile, options.hideExpand);
         if ((0, regEx_1.isAddress)(fileFolderAddress)) {
             // The first storage is the contract
             storageSections[0].address = fileFolderAddress;
@@ -232,7 +233,7 @@ The line numbers are from contract B. There are no line numbers for the red sect
     .addOption(new commander_1.Option('-bn, --bNetwork <network>', 'Ethereum network which maps to a blockchain explorer for contract B if on a different blockchain to contract A. Contract A uses the `network` option (default: value of `network` option)').choices(parserEtherscan_1.networks))
     .option('-be, --bExplorerUrl <url>', 'Override the `bNetwork` option with custom blockchain explorer API URL for contract B if on a different blockchain to contract A. Contract A uses the `explorerUrl` (default: value of `explorerUrl` option)')
     .option('-bk, --bApiKey <key>', 'Blockchain explorer API key for contract B if on a different blockchain to contract A. Contract A uses the `apiKey` option (default: value of `apiKey` option)')
-    .option('-s, --summary', 'Only show a summary of the file differences.', false)
+    .option('-s, --summary', 'Only show a summary of the file differences', false)
     .option('--flatten', 'Flatten into a single file before comparing', false)
     .option('--saveFiles', 'Save the flattened contract code to the filesystem when using the `flatten` option. The file names will be the contract address with a .sol extension', false)
     .action(async (addressA, addressB, options, command) => {

package/lib/utils/regEx.d.ts

@@ -1,4 +1,5 @@
 export declare const ethereumAddress: RegExp;
 export declare const ethereumAddresses: RegExp;
+export declare const commaSeparatedList: RegExp;
 export declare const isAddress: (input: string) => boolean;
 export declare const parseSolidityVersion: (compilerVersion: string) => string;

package/lib/utils/regEx.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseSolidityVersion = exports.isAddress = exports.ethereumAddresses = exports.ethereumAddress = void 0;
+exports.parseSolidityVersion = exports.isAddress = exports.commaSeparatedList = exports.ethereumAddresses = exports.ethereumAddress = void 0;
 exports.ethereumAddress = /^0x([A-Fa-f0-9]{40})$/;
 // comma-separated list of addresses with no whitespace
 exports.ethereumAddresses = /^(0x[A-Fa-f0-9]{40},?)+$/;
+// comma-separated list of names with no whitespace
+exports.commaSeparatedList = /^[^,\s]+(,[^,\s]+)*$/;
 const isAddress = (input) => {
     return input.match(/^0x([A-Fa-f0-9]{40})$/) !== null;
 };

package/lib/utils/validators.d.ts

@@ -1,3 +1,3 @@
 export declare const validateAddress: (address: string) => string;
-export declare const validateAddresses: (addresses: string) => string[];
+export declare const validateVariables: (variables: string) => string[];
 export declare const validateLineBuffer: (lineBufferParam: string) => number;

package/lib/utils/validators.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateLineBuffer = exports.validateAddresses = exports.validateAddress = void 0;
+exports.validateLineBuffer = exports.validateVariables = exports.validateAddress = void 0;
 const regEx_1 = require("./regEx");
 const commander_1 = require("commander");
 const utils_1 = require("ethers/lib/utils");
@@ -13,29 +13,24 @@ const validateAddress = (address) => {
     throw new commander_1.InvalidArgumentError(`Address must be in hexadecimal format with a 0x prefix.`);
 };
 exports.validateAddress = validateAddress;
-const validateAddresses = (addresses) => {
+const validateVariables = (variables) => {
     try {
-        const addressArray = convertAddresses(addresses);
-        if (addressArray)
-            return addressArray;
+        if (typeof variables === 'string' &&
+            variables.match(regEx_1.commaSeparatedList))
+            return variables.split(',');
     }
     catch (err) { }
-    throw new commander_1.InvalidArgumentError(`Must be an address or an array of addresses in hexadecimal format with a 0x prefix.
-If running for multiple addresses, the comma-separated list of addresses must not have white spaces.`);
-};
-exports.validateAddresses = validateAddresses;
-const convertAddresses = (addresses) => {
-    if (typeof addresses === 'string' && addresses?.match(regEx_1.ethereumAddress))
-        return [(0, utils_1.getAddress)(addresses).toLowerCase()];
-    if (typeof addresses === 'string' && addresses?.match(regEx_1.ethereumAddresses))
-        return addresses.split(',').map((a) => (0, utils_1.getAddress)(a).toLowerCase());
-    return undefined;
+    throw new commander_1.InvalidArgumentError(`Must be a comma-separate list of storage variable names with no white spaces.`);
 };
+exports.validateVariables = validateVariables;
 const validateLineBuffer = (lineBufferParam) => {
-    const lineBuffer = parseInt(lineBufferParam);
-    if (isNaN(lineBuffer))
-        throw Error(`Invalid line buffer "${lineBuffer}". Must be a number`);
-    return lineBuffer;
+    try {
+        const lineBuffer = parseInt(lineBufferParam, 10);
+        if (lineBuffer >= 0)
+            return lineBuffer;
+    }
+    catch (err) { }
+    throw new commander_1.InvalidOptionArgumentError(`Must be a zero or a positive integer.`);
 };
 exports.validateLineBuffer = validateLineBuffer;
 //# sourceMappingURL=validators.js.map

package/package.json

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