sol2uml 2.5.13 → 2.5.15

package/README.md

@@ -6,6 +6,8 @@
 A visualisation tool for [Solidity](https://solidity.readthedocs.io/) contracts featuring:
 1. [Unified Modeling Language (UML)](https://en.wikipedia.org/wiki/Unified_Modeling_Language) [class diagram](https://en.wikipedia.org/wiki/Class_diagram) generator for Solidity contracts.
 2. Contract storage layout diagrams.
+3. Flatten Solidity files on Etherscan-like explorers to a local file.
+4. Diff contracts on Etherscan-like explorers.
 
 UML class diagram of Open Zeppelin's ERC20 token contracts generated from [version 4.7.3](https://github.com/OpenZeppelin/openzeppelin-contracts/tree/v4.7.3/contracts/token/ERC20)
 ![Open Zeppelin ERC20](./examples/OpenZeppelinERC20.svg)
@@ -54,7 +56,7 @@ Options:
   -sf, --subfolders <value>                       number of subfolders that will be recursively searched for Solidity files. (default: all)
   -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
+  -i, --ignoreFilesOrFolders <names>              comma-separated list of files or folders to ignore
   -n, --network <network>                         Ethereum network which maps to a blockchain explorer (choices: "mainnet", "goerli", "sepolia", "polygon", "arbitrum", "avalanche", "bsc", "crono", "fantom", "moonbeam", "optimism", "gnosis", "celo", "base", default: "mainnet", env: ETH_NETWORK)
   -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)
   -k, --apiKey <key>                              Blockchain explorer API key. eg Etherscan, Arbiscan, Optimism, BscScan, CronoScan, FTMScan, PolygonScan or SnowTrace API key (env: SCAN_API_KEY)
@@ -104,7 +106,7 @@ Arguments:
                                         sol2uml 0x79fEbF6B9F76853EDBcBc913e6aAE8232cFB9De9
 
 Options:
-  -b, --baseContractNames <value>  only output contracts connected to these comma separated base contract names
+  -b, --baseContractNames <names>  only output contracts connected to these comma separated base contract names
   -d, --depth <value>              depth of connected classes to the base contracts. 1 will only show directly connected contracts, interfaces, libraries, structs and enums. (default: all)
   -c, --clusterFolders             cluster contracts into source folders (default: false)
   -hv, --hideVariables             hide variables from contracts, interfaces, structs and enums (default: false)
@@ -149,9 +151,11 @@ Options:
   -s, --storage <address>         The address of the contract with the storage values. This will be different from the contract with the code if a proxy contract is used. This is not needed if `fileFolderAddress` is an address and the contract is not proxied.
   -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")
+  -sn, --slotNames <names>        Comma-separated list of slot names when accessed by assembly. The names can be a string, which will be hashed to a slot, or a 32 bytes hexadecimal string with a 0x prefix.
+  -st, --slotTypes <types>        Comma-separated list of types for the slots listed in the `slotNames` option. eg address,uint256,bool. If all types are the same, a single type can be used. eg address (default: ["bytes32"])
   -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)
+  -hv, --hideValues               Hide storage slot value column. (default: false)
   -h, --help                      display help for command
 ```
 
@@ -181,7 +185,7 @@ Options:
 ```
 Usage: sol2uml diff [options] <addressA> <addressB or comma-separated folders>
 
-Compare verified Solidity code to another verified contract, a local file or local source files.
+Compare verified contract code on Etherscan-like explorers to another verified contract, a local file or multiple local files.
 
 The results show the comparison of contract A to B.
 The green sections are additions to contract B that are not in contract A.

package/lib/converterClasses2Storage.d.ts

@@ -9,8 +9,9 @@ export declare enum StorageSectionType {
 }
 export interface Variable {
     id: number;
-    fromSlot: number;
-    toSlot: number;
+    fromSlot?: number;
+    toSlot?: number;
+    offset?: string;
     byteSize: number;
     byteOffset: number;
     type: string;
@@ -45,6 +46,10 @@ export interface StorageSection {
  * @return storageSections array of storageSection objects
  */
 export declare const convertClasses2StorageSections: (contractName: string, umlClasses: UmlClass[], arrayItems: number, contractFilename?: string, noExpandVariables?: string[]) => StorageSection[];
+export declare const optionStorageVariables: (contractName: string, slotNames?: {
+    name: string;
+    offset: string;
+}[], slotTypes?: string[]) => Variable[];
 /**
  * Recursively adds new storage sections under a class attribute.
  * also returns the allowed enum values

package/lib/converterClasses2Storage.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addDynamicVariables = exports.findDimensionLength = exports.calcSectionOffset = exports.isElementary = exports.calcStorageByteSize = exports.parseStorageSectionFromAttribute = exports.convertClasses2StorageSections = exports.StorageSectionType = void 0;
+exports.addDynamicVariables = exports.findDimensionLength = exports.calcSectionOffset = exports.isElementary = exports.calcStorageByteSize = exports.parseStorageSectionFromAttribute = exports.optionStorageVariables = exports.convertClasses2StorageSections = exports.StorageSectionType = void 0;
 const umlClass_1 = require("./umlClass");
 const associations_1 = require("./associations");
 const utils_1 = require("ethers/lib/utils");
@@ -61,6 +61,53 @@ const convertClasses2StorageSections = (contractName, umlClasses, arrayItems, co
     return storageSections;
 };
 exports.convertClasses2StorageSections = convertClasses2StorageSections;
+const optionStorageVariables = (contractName, slotNames, slotTypes) => {
+    // If no slot names
+    if (!slotNames?.length) {
+        return [];
+    }
+    // The slotTypes default should mean this never happens
+    if (!slotTypes.length) {
+        throw Error(`The slotTypes option must be used with the slotNames option`);
+    }
+    if (slotNames.length > 1 && slotTypes.length === 1) {
+        slotTypes = Array(slotNames.length).fill(slotTypes[0]);
+        // slotTypes = slotTypes.fill(slotTypes[0], 1, slotNames.length - 1)
+    }
+    const variables = [];
+    slotNames.forEach((slotName, i) => {
+        const { size: byteSize, dynamic } = calcElementaryTypeSize(slotTypes[i]);
+        variables.push({
+            id: variableId++,
+            fromSlot: undefined,
+            toSlot: undefined,
+            offset: slotName.offset,
+            byteSize,
+            byteOffset: 0,
+            type: slotTypes[i],
+            attributeType: umlClass_1.AttributeType.Elementary,
+            dynamic,
+            getValue: true,
+            displayValue: true,
+            name: slotName.name,
+            contractName,
+            referenceSectionId: undefined,
+            enumValues: undefined,
+        });
+    });
+    // Sort variables by offset hash
+    const sortedVariables = variables.sort((a, b) => {
+        if (a.offset < b.offset) {
+            return -1;
+        }
+        if (a.offset > b.offset) {
+            return 1;
+        }
+        return 0;
+    });
+    return sortedVariables;
+};
+exports.optionStorageVariables = optionStorageVariables;
 /**
  * Recursively parse the storage variables for a given contract or struct.
  * @param umlClass contract or file level struct
@@ -526,37 +573,40 @@ const calcStorageByteSize = (attribute, umlClass, otherClasses) => {
         }
     }
     if (attribute.attributeType === umlClass_1.AttributeType.Elementary) {
-        switch (attribute.type) {
-            case 'bool':
-                return { size: 1, dynamic: false };
-            case 'address':
-                return { size: 20, dynamic: false };
-            case 'string':
-            case 'bytes':
-                return { size: 32, dynamic: true };
-            case 'uint':
-            case 'int':
-            case 'ufixed':
-            case 'fixed':
-                return { size: 32, dynamic: false };
-            default:
-                const result = attribute.type.match(/[u]*(int|fixed|bytes)([0-9]+)/);
-                if (result === null || !result[2]) {
-                    throw Error(`Failed size elementary type "${attribute.type}"`);
-                }
-                // If bytes
-                if (result[1] === 'bytes') {
-                    return { size: parseInt(result[2]), dynamic: false };
-                }
-                // TODO need to handle fixed types when they are supported
-                // If an int
-                const bitSize = parseInt(result[2]);
-                return { size: bitSize / 8, dynamic: false };
-        }
+        return calcElementaryTypeSize(attribute.type);
     }
     throw new Error(`Failed to calc bytes size of attribute with name "${attribute.name}" and type ${attribute.type}`);
 };
 exports.calcStorageByteSize = calcStorageByteSize;
+const calcElementaryTypeSize = (type) => {
+    switch (type) {
+        case 'bool':
+            return { size: 1, dynamic: false };
+        case 'address':
+            return { size: 20, dynamic: false };
+        case 'string':
+        case 'bytes':
+            return { size: 32, dynamic: true };
+        case 'uint':
+        case 'int':
+        case 'ufixed':
+        case 'fixed':
+            return { size: 32, dynamic: false };
+        default:
+            const result = type.match(/[u]*(int|fixed|bytes)([0-9]+)/);
+            if (result === null || !result[2]) {
+                throw Error(`Failed size elementary type "${type}"`);
+            }
+            // If bytes
+            if (result[1] === 'bytes') {
+                return { size: parseInt(result[2]), dynamic: false };
+            }
+            // TODO need to handle fixed types when they are supported
+            // If an int
+            const bitSize = parseInt(result[2]);
+            return { size: bitSize / 8, dynamic: false };
+    }
+};
 const isElementary = (type) => {
     switch (type) {
         case 'bool':

package/lib/converterStorage2Dot.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertStorage2Dot = exports.convertStorages2Dot = void 0;
 const converterClasses2Storage_1 = require("./converterClasses2Storage");
 const umlClass_1 = require("./umlClass");
+const formatters_1 = require("./utils/formatters");
 const debug = require('debug')('sol2uml');
 const convertStorages2Dot = (storageSections, options) => {
     let dotString = `
@@ -46,7 +47,10 @@ function convertStorage2Dot(storageSection, dotString, options) {
             : `{ slot${dataLine}`;
     startingVariables.forEach((variable, i) => {
         const dataLine = options.data && displayData[i] ? linePad : '';
-        if (variable.fromSlot === variable.toSlot) {
+        if (variable.offset) {
+            dotString += ` | ${(0, formatters_1.shortBytes32)(variable.offset)}${dataLine}`;
+        }
+        else if (variable.fromSlot === variable.toSlot) {
             dotString += ` | ${variable.fromSlot}${dataLine}`;
         }
         else {
@@ -73,7 +77,8 @@ function convertStorage2Dot(storageSection, dotString, options) {
     // For each slot
     startingVariables.forEach((variable) => {
         // Get all the storage variables in this slot
-        const slotVariables = storageSection.variables.filter((s) => s.fromSlot === variable.fromSlot);
+        const slotVariables = storageSection.variables.filter((s) => (!s.offset && s.fromSlot === variable.fromSlot) ||
+            (s.offset && s.offset === variable.offset));
         const usedBytes = slotVariables.reduce((acc, s) => acc + s.byteSize, 0);
         if (usedBytes < 32) {
             // Create an unallocated variable for display purposes

package/lib/parserGeneral.d.ts

@@ -5,7 +5,7 @@ export interface ParserOptions {
     network?: Network;
     explorerUrl?: string;
     subfolders?: string;
-    ignoreFilesOrFolders?: string;
+    ignoreFilesOrFolders?: string[];
 }
 /**
  * Parses Solidity source code from a local filesystem or verified code on Etherscan

package/lib/parserGeneral.js

@@ -27,10 +27,7 @@ const parserUmlClasses = async (fileFolderAddress, options) => {
             process.exit(1);
         }
         const filesFolders = fileFolderAddress.split(',');
-        let ignoreFilesFolders = options.ignoreFilesOrFolders
-            ? options.ignoreFilesOrFolders.split(',')
-            : [];
-        result.umlClasses = await (0, parserFiles_1.parseUmlClassesFromFiles)(filesFolders, ignoreFilesFolders, subfolders);
+        result.umlClasses = await (0, parserFiles_1.parseUmlClassesFromFiles)(filesFolders, options.ignoreFilesOrFolders || [], subfolders);
     }
     return result;
 };

package/lib/slotValues.js

@@ -28,13 +28,18 @@ const addSlotValues = async (url, contractAddress, storageSection, arrayItems, b
     // for each variable, add all the slots used by the variable.
     const slots = [];
     valueVariables.forEach((variable) => {
-        for (let i = 0; variable.fromSlot + i <= variable.toSlot; i++) {
-            if (variable.attributeType === umlClass_1.AttributeType.Array &&
-                i >= arrayItems &&
-                i < variable.toSlot - arrayItems) {
-                continue;
+        if (variable.offset) {
+            slots.push(bignumber_1.BigNumber.from(variable.offset));
+        }
+        else {
+            for (let i = 0; variable.fromSlot + i <= variable.toSlot; i++) {
+                if (variable.attributeType === umlClass_1.AttributeType.Array &&
+                    i >= arrayItems &&
+                    i < variable.toSlot - arrayItems) {
+                    continue;
+                }
+                slots.push(variable.fromSlot + i);
             }
-            slots.push(variable.fromSlot + i);
         }
     });
     // remove duplicate slot numbers
@@ -54,7 +59,17 @@ const addSlotValues = async (url, contractAddress, storageSection, arrayItems, b
         const fromSlot = uniqueFromSlots[i];
         // For each variable in the storage section
         for (const variable of storageSection.variables) {
-            if (variable.getValue && variable.fromSlot === fromSlot) {
+            if (variable.getValue &&
+                variable.offset &&
+                bignumber_1.BigNumber.from(variable.offset).eq(fromSlot)) {
+                debug(`Set slot value ${value} for section "${storageSection.name}", var type ${variable.type}, slot ${variable.offset}`);
+                variable.slotValue = value;
+                // parse variable value from slot data
+                if (variable.displayValue) {
+                    variable.parsedValue = (0, exports.parseValue)(variable);
+                }
+            }
+            else if (variable.getValue && variable.fromSlot === fromSlot) {
                 debug(`Set slot value ${value} for section "${storageSection.name}", var type ${variable.type}, slot ${variable.fromSlot} offset ${storageSection.offset}`);
                 variable.slotValue = value;
                 // parse variable value from slot data
@@ -63,7 +78,8 @@ const addSlotValues = async (url, contractAddress, storageSection, arrayItems, b
                 }
             }
             // if variable is past the slot that has the value
-            else if (bignumber_1.BigNumber.from(variable.toSlot).gt(fromSlot)) {
+            else if (variable.toSlot &&
+                bignumber_1.BigNumber.from(variable.toSlot).gt(fromSlot)) {
                 break;
             }
         }

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 <names>', 'comma-separated list of files or folders to ignore', validators_1.validateNames)
     .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 <names>', 'only output contracts connected to these comma-separated base contract names', validators_1.validateNames)
     .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)
@@ -91,19 +91,18 @@ program
         if (options.squash && options.hideContracts) {
             throw Error('Can not hide contracts when squashing contracts.');
         }
-        const baseContractNames = options.baseContractNames?.split(',');
-        if (baseContractNames) {
-            contractName = baseContractNames[0];
+        if (options.baseContractNames) {
+            contractName = options.baseContractNames[0];
         }
         // Filter out any class stereotypes that are to be hidden
         let filteredUmlClasses = (0, filterClasses_1.filterHiddenClasses)(umlClasses, options);
         // squash contracts
         if (options.squash) {
-            filteredUmlClasses = (0, squashClasses_1.squashUmlClasses)(filteredUmlClasses, baseContractNames || [contractName]);
+            filteredUmlClasses = (0, squashClasses_1.squashUmlClasses)(filteredUmlClasses, options.baseContractNames || [contractName]);
         }
-        if (baseContractNames || options.squash) {
+        if (options.baseContractNames || options.squash) {
             // Find all the classes connected to the base classes after they have been squashed
-            filteredUmlClasses = (0, filterClasses_1.classesConnectedToBaseContracts)(filteredUmlClasses, baseContractNames || [contractName], options.depth);
+            filteredUmlClasses = (0, filterClasses_1.classesConnectedToBaseContracts)(filteredUmlClasses, options.baseContractNames || [contractName], options.depth);
         }
         // Convert UML classes to Graphviz dot format.
         const dotString = (0, converterClasses2Dot_1.convertUmlClasses2Dot)(filteredUmlClasses, combinedOptions.clusterFolders, combinedOptions);
@@ -131,9 +130,11 @@ WARNING: sol2uml does not use the Solidity compiler so may differ with solc. A k
     .env('NODE_URL')
     .default('http://localhost:8545'))
     .option('-bn, --block <number>', 'Block number to get the contract storage values from.', 'latest')
+    .option('-sn, --slotNames <names>', 'Comma-separated list of slot names when accessed by assembly. The names can be a string, which will be hashed to a slot, or a 32 bytes hexadecimal string with a 0x prefix.', validators_1.validateSlotNames)
+    .option('-st, --slotTypes <types>', 'Comma-separated list of types for the slots listed in the `slotNames` option. eg address,uint256,bool. If all types are the same, a single type can be used. eg address', validators_1.validateTypes, ['bytes32'])
     .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)
+    .option('-hx, --hideExpand <variables>', "Comma-separated list of storage variables to not expand. That's arrays, structs, strings or bytes.", validators_1.validateNames)
+    .option('-hv, --hideValues', 'Hide storage slot value column.', false)
     .action(async (fileFolderAddress, options, command) => {
     try {
         const combinedOptions = {
@@ -148,6 +149,11 @@ WARNING: sol2uml does not use the Solidity compiler so may differ with solc. A k
         contractName = combinedOptions.contract || contractName;
         const arrayItems = parseInt(combinedOptions.array);
         const storageSections = (0, converterClasses2Storage_1.convertClasses2StorageSections)(contractName, umlClasses, arrayItems, combinedOptions.contractFile, options.hideExpand);
+        const optionVariables = (0, converterClasses2Storage_1.optionStorageVariables)(contractName, options.slotNames, options.slotTypes);
+        storageSections[0].variables = [
+            ...storageSections[0].variables,
+            ...optionVariables,
+        ];
         if ((0, regEx_1.isAddress)(fileFolderAddress)) {
             // The first storage is the contract
             storageSections[0].address = fileFolderAddress;
@@ -219,7 +225,7 @@ In order for the merged code to compile, the following is done:
 program
     .command('diff')
     .usage('[options] <addressA> <addressB or comma-separated folders>')
-    .description(`Compare verified Solidity code to another verified contract, a local file or local source files.
+    .description(`Compare verified contract code on Etherscan-like explorers to another verified contract, a local file or multiple local files.
 
 The results show the comparison of contract A to B.
 The ${clc.green('green')} sections are additions to contract B that are not in contract A.

package/lib/utils/formatters.d.ts

@@ -0,0 +1 @@
+export declare const shortBytes32: (bytes32: string) => string;

package/lib/utils/formatters.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shortBytes32 = void 0;
+const shortBytes32 = (bytes32) => {
+    if (!bytes32)
+        return '';
+    if (typeof bytes32 !== 'string' || bytes32.length !== 66)
+        return bytes32;
+    return bytes32.slice(0, 5) + '..' + bytes32.slice(-3);
+};
+exports.shortBytes32 = shortBytes32;
+//# sourceMappingURL=formatters.js.map

package/lib/utils/regEx.d.ts

@@ -1,5 +1,6 @@
 export declare const ethereumAddress: RegExp;
 export declare const ethereumAddresses: RegExp;
+export declare const bytes32: 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,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseSolidityVersion = exports.isAddress = exports.commaSeparatedList = exports.ethereumAddresses = exports.ethereumAddress = void 0;
+exports.parseSolidityVersion = exports.isAddress = exports.commaSeparatedList = exports.bytes32 = 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},?)+$/;
+exports.bytes32 = /^0x([A-Fa-f0-9]{64})$/;
 // comma-separated list of names with no whitespace
 exports.commaSeparatedList = /^[^,\s]+(,[^,\s]+)*$/;
 const isAddress = (input) => {

package/lib/utils/validators.d.ts

@@ -1,3 +1,8 @@
 export declare const validateAddress: (address: string) => string;
-export declare const validateVariables: (variables: string) => string[];
+export declare const validateNames: (variables: string) => string[];
 export declare const validateLineBuffer: (lineBufferParam: string) => number;
+export declare const validateSlotNames: (slotNames: string) => {
+    name: string;
+    offset: string;
+}[];
+export declare const validateTypes: (typesString: string) => string[];

package/lib/utils/validators.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateLineBuffer = exports.validateVariables = exports.validateAddress = void 0;
+exports.validateTypes = exports.validateSlotNames = exports.validateLineBuffer = exports.validateNames = exports.validateAddress = void 0;
 const regEx_1 = require("./regEx");
 const commander_1 = require("commander");
 const utils_1 = require("ethers/lib/utils");
+const converterClasses2Storage_1 = require("../converterClasses2Storage");
+const debug = require('debug')('sol2uml');
 const validateAddress = (address) => {
     try {
         if (typeof address === 'string' && address?.match(regEx_1.ethereumAddress))
@@ -13,16 +15,17 @@ const validateAddress = (address) => {
     throw new commander_1.InvalidArgumentError(`Address must be in hexadecimal format with a 0x prefix.`);
 };
 exports.validateAddress = validateAddress;
-const validateVariables = (variables) => {
+// Splits a comma-separated list of names.
+const validateNames = (variables) => {
     try {
         if (typeof variables === 'string' &&
             variables.match(regEx_1.commaSeparatedList))
             return variables.split(',');
     }
     catch (err) { }
-    throw new commander_1.InvalidArgumentError(`Must be a comma-separate list of storage variable names with no white spaces.`);
+    throw new commander_1.InvalidArgumentError(`Must be a comma-separate list of names with no white spaces.`);
 };
-exports.validateVariables = validateVariables;
+exports.validateNames = validateNames;
 const validateLineBuffer = (lineBufferParam) => {
     try {
         const lineBuffer = parseInt(lineBufferParam, 10);
@@ -33,4 +36,44 @@ const validateLineBuffer = (lineBufferParam) => {
     throw new commander_1.InvalidOptionArgumentError(`Must be a zero or a positive integer.`);
 };
 exports.validateLineBuffer = validateLineBuffer;
+const validateSlotNames = (slotNames) => {
+    try {
+        const slots = slotNames.split(',');
+        const results = slots.map((slot) => {
+            if (slot.match(regEx_1.bytes32)) {
+                return {
+                    name: undefined,
+                    offset: slot,
+                };
+            }
+            const offset = (0, utils_1.keccak256)((0, utils_1.toUtf8Bytes)(slot));
+            debug(`Slot name "${slot}" has hash "${offset}"`);
+            return {
+                name: slot,
+                offset,
+            };
+        });
+        console.log(results.length);
+        return results;
+    }
+    catch (err) { }
+    throw new commander_1.InvalidOptionArgumentError(`Must be a comma-separate list of slots with no white spaces.`);
+};
+exports.validateSlotNames = validateSlotNames;
+const validateTypes = (typesString) => {
+    try {
+        if (typeof typesString === 'string') {
+            const types = typesString.split(',');
+            types.forEach((type) => {
+                if (!(0, converterClasses2Storage_1.isElementary)(type)) {
+                    throw Error(`"${type}" is not an elementary type`);
+                }
+            });
+            return types;
+        }
+    }
+    catch (err) { }
+    throw new commander_1.InvalidArgumentError(`Slot type must be an elementary type which includes dynamic and fixed size arrays. eg address, address[], uint256, int256[2], bytes32, string, bool`);
+};
+exports.validateTypes = validateTypes;
 //# sourceMappingURL=validators.js.map

package/package.json

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