sol2uml 2.1.4 → 2.1.5

package/README.md

@@ -119,12 +119,13 @@ Arguments:
   fileFolderAddress        file name, base folder or contract address
 
 Options:
-  -c, --contract <name>    Contract name in local Solidity files. Not needed when using an address as the first argument as the contract name can be derived from Etherscan.
-  -d, --data               Gets the values in the storage slots from an Ethereum node. (default: false)
-  -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")
-  -h, --help               display help for command
+  -c, --contract <name>           Contract name in the local Solidity files. Not needed when using an address as the first argument as the contract name can be derived from Etherscan.
+  -cf, --contractFile <filename>  Filename the contract is located in. This can include the relative path to the desired file.
+  -d, --data                      Gets the values in the storage slots from an Ethereum node. (default: false)
+  -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")
+  -h, --help                      display help for command
 ```
 
 ### Flatten usage

package/lib/converterClasses2Storage.d.ts

@@ -36,7 +36,7 @@ export interface Storage {
  * @param storage is mutated with the storage values
  */
 export declare const addStorageValues: (url: string, contractAddress: string, storage: Storage, blockTag: string) => Promise<void>;
-export declare const convertClasses2Storages: (contractName: string, umlClasses: UmlClass[]) => Storage[];
+export declare const convertClasses2Storages: (contractName: string, umlClasses: UmlClass[], contractFilename?: string) => Storage[];
 export declare const parseReferenceStorage: (attribute: Attribute, umlClass: UmlClass, otherClasses: UmlClass[], storages: Storage[]) => Storage | undefined;
 export declare const calcStorageByteSize: (attribute: Attribute, umlClass: UmlClass, otherClasses: UmlClass[]) => {
     size: number;

package/lib/converterClasses2Storage.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.findDimensionLength = exports.offsetStorageSlots = exports.calcSlotKey = exports.isElementary = exports.calcStorageByteSize = exports.parseReferenceStorage = exports.convertClasses2Storages = exports.addStorageValues = exports.StorageType = void 0;
 const umlClass_1 = require("./umlClass");
@@ -6,6 +9,8 @@ const associations_1 = require("./associations");
 const slotValues_1 = require("./slotValues");
 const utils_1 = require("ethers/lib/utils");
 const ethers_1 = require("ethers");
+const path_1 = __importDefault(require("path"));
+const debug = require('debug')('sol2uml');
 var StorageType;
 (function (StorageType) {
     StorageType["Contract"] = "Contract";
@@ -29,14 +34,23 @@ const addStorageValues = async (url, contractAddress, storage, blockTag) => {
     });
 };
 exports.addStorageValues = addStorageValues;
-const convertClasses2Storages = (contractName, umlClasses) => {
+const convertClasses2Storages = (contractName, umlClasses, contractFilename) => {
     // Find the base UML Class from the base contract name
-    const umlClass = umlClasses.find(({ name }) => {
-        return name === contractName;
+    const umlClass = umlClasses.find(({ name, relativePath }) => {
+        if (!contractFilename) {
+            return name === contractName;
+        }
+        return (name === contractName &&
+            (relativePath == contractFilename ||
+                path_1.default.basename(relativePath) === contractFilename));
     });
     if (!umlClass) {
-        throw Error(`Failed to find contract with name "${contractName}"`);
+        const contractFilenameError = contractFilename
+            ? ` in filename "${contractFilename}"`
+            : '';
+        throw Error(`Failed to find contract with name "${contractName}"${contractFilenameError}`);
     }
+    debug(`Found contract "${contractName}" in ${umlClass.absolutePath}`);
     const storages = [];
     const variables = parseVariables(umlClass, umlClasses, [], storages, []);
     storages.unshift({

package/lib/sol2uml.js

@@ -95,7 +95,8 @@ program
 
 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.`)
     .argument('<fileFolderAddress>', 'file name, base folder or contract address')
-    .option('-c, --contract <name>', 'Contract name in local Solidity files. Not needed when using an address as the first argument as the contract name can be derived from Etherscan.')
+    .option('-c, --contract <name>', 'Contract name in the local Solidity files. Not needed when using an address as the first argument as the contract name can be derived from Etherscan.')
+    .option('-cf, --contractFile <filename>', 'Filename the contract is located in. This can include the relative path to the desired file.')
     .option('-d, --data', 'Gets the values in the storage slots from an Ethereum node.', false)
     .option('-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.')
     .addOption(new commander_1.Option('-u, --url <url>', 'URL of the Ethereum node to get storage values if the `data` option is used.')
@@ -110,7 +111,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 storages = (0, converterClasses2Storage_1.convertClasses2Storages)(contractName, umlClasses);
+        const storages = (0, converterClasses2Storage_1.convertClasses2Storages)(contractName, umlClasses, combinedOptions.contractFile);
         if ((0, regEx_1.isAddress)(fileFolderAddress)) {
             // The first storage is the contract
             storages[0].address = fileFolderAddress;
@@ -125,7 +126,7 @@ WARNING: sol2uml does not use the Solidity compiler so may differ with solc. A k
             }
             else {
                 if (!(0, regEx_1.isAddress)(fileFolderAddress)) {
-                    throw Error(`Can not get storage slot values if first param is not an address and the \`address\` option is not used.`);
+                    throw Error(`Can not get storage slot values if first param is not an address and the \`--storage\` option is not used.`);
                 }
                 storageAddress = fileFolderAddress;
             }

package/package.json

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