feat: added storage options slotNames and slotTypes for assembly acce…

…ssed slots

README.md

@@ -151,6 +151,8 @@ 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, --hideValues               Hide storage slot value column. (default: false)

examples/storage/README.md

@@ -238,6 +238,33 @@ The storage slots for contract `D` in [inheritance/common.sol](../../src/contrac
 sol2uml storage ./src/contracts/inheritance -c D -o examples/storage/inheritanceStorage.svg
 ```
 
+## Assembly Accessed Slots
+
+The `-sn, --slotNames` option lists slots that are accessed by assembly rather than Solidity storage variables.
+The option value is a comma-separate list of slot names.
+The names can be a string, which will be hashed to a slot, or a 32 bytes hexadecimal string with a 0x prefix.
+
+In the below example, `OUSD.governor` is keccak256 hashed to slot `0x7bea13895fa79d2831e0a9e28edede30099005a50d652d8957cf8a607ee6ca4a`.
+
+The `-st, --slotTypes` options allows types to be specified for each of the named slots.
+This is a comma-separated list of types or a single type if all the types are the same.
+
+The following example is Origin's OETH Dripper contract.
+
+The `0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc` slot is the keccak256 hash of "eip1967.proxy.implementation" subtracted by 1.
+This holds the address of the implementation contract `0x2fdfbb2b905484f1445e23a97c97f65fe0e43dec` of the proxy contract `0xc0f42f73b8f01849a2dd99753524d4ba14317eb3`.
+
+![OETH Dripper](../../examples/storage/origin-oeth-dripper.svg)
+
+```
+sol2uml storage 0x2fdfbb2b905484f1445e23a97c97f65fe0e43dec -v \
+  --data --storage 0xc0f42f73b8f01849a2dd99753524d4ba14317eb3 \
+  --slotNames OUSD.governor,OUSD.pending.governor,OUSD.reentry.status,0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc \
+  --slotTypes address,address,bool,address \
+  --hideExpand drip \
+  -o examples/storage/origin-oeth-dripper.svg
+```
+
 ## USDC
 
 The USD Coin (USDC) token deployed to [0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48](https://etherscan.io/address/0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48#code) on mainnet is a proxied contract.

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