feat: add hideValue option

fix: handle types with dot splitting contract name and type
chore: add Uniswap V3 pool example with hideValue option

README.md

@@ -137,6 +137,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")
+  -hv, --hideValue                Hide storage slot value column.
   -h, --help                      display help for command
 ```
 

examples/storage/README.md

@@ -263,3 +263,12 @@ sol2uml storage 0xc63a48d85CCE7C3bD4d18db9c0972a4D223e4193 -bn 16000000 -d -s 0x
 
 ![Staking Tokens BPT](./StakedTokenBPTData.svg)
 
+## Uniswap ETH/USDC Pool
+
+The `value` column with the slot values in hexadecimal format can be hidden with the `-hv, --hideValue` option.
+
+```
+sol2uml  storage -d -hv 0x8ad599c3A0ff1De082011EFDDc58f1908eb6e6D8 -o ./examples/storage/UniswapV3PoolData.svg
+```
+
+![Uniswap ETH/USDC Pool Data](./UniswapV3PoolData.svg)

lib/converterStorage2Dot.d.ts

@@ -5,7 +5,9 @@ export declare const convertStorages2Dot: (storageSections: readonly StorageSect
     shapeColor: string;
     fillColor: string;
     textColor: string;
+    hideValues?: boolean;
 }) => string;
 export declare function convertStorage2Dot(storageSection: StorageSection, dotString: string, options: {
     data: boolean;
+    hideValues?: boolean;
 }): string;

src/ts/converterClasses2Storage.ts

@@ -591,9 +591,10 @@ const findTypeClass = (
     otherClasses: readonly UmlClass[]
 ): UmlClass => {
     // Find associated UserDefined type
+    const types = userType.split('.')
     const association = {
         referenceType: ReferenceType.Memory,
-        targetUmlClassName: userType,
+        targetUmlClassName: types.length === 1 ? types[0] : types[1],
     }
     const typeClass = findAssociatedClass(association, umlClass, otherClasses)
     if (!typeClass) {

src/ts/converterStorage2Dot.ts

@@ -15,6 +15,7 @@ export const convertStorages2Dot = (
         shapeColor: string
         fillColor: string
         textColor: string
+        hideValues?: boolean
     }
 ): string => {
     let dotString: string = `
@@ -50,7 +51,7 @@ node [shape=record, style=filled, color="${options.shapeColor}", fillcolor="${op
 export function convertStorage2Dot(
     storageSection: StorageSection,
     dotString: string,
-    options: { data: boolean }
+    options: { data: boolean; hideValues?: boolean }
 ): string {
     // write storage header with name and optional address
     dotString += `\n${storageSection.id} [label="${storageSection.name} \\<\\<${
@@ -88,7 +89,7 @@ export function convertStorage2Dot(
     })
 
     // write slot values if available
-    if (options.data) {
+    if (options.data && !options.hideValues) {
         dotString += `} | {value${dataLine}`
         startingVariables.forEach((variable, i) => {
             if (displayData[i]) {

src/ts/sol2uml.ts

@@ -283,6 +283,7 @@ WARNING: sol2uml does not use the Solidity compiler so may differ with solc. A k
         'Number of slots to display at the start and end of arrays.',
         '2'
     )
+    .option('-hv, --hideValue', 'Hide storage slot value column.', false)
     .action(async (fileFolderAddress, options, command) => {
         try {
             const combinedOptions = {