Merge pull request #82 from naddison36/slot-values

Visualise storage slot values

.github/workflows/nodejs.yml

@@ -23,3 +23,4 @@ jobs:
       env:
         DEBUG: sol2uml
         CI: true
+        NODE_URL: ${{ secrets.NODE_URL }}

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Nick Addison
+Copyright (c) 2022 Nick Addison
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -115,12 +115,16 @@ Visually display a contract's storage slots.
 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.
 
 Arguments:
-  fileFolderAddress           file name, base folder or contract address
+  fileFolderAddress        file name, base folder or contract address
 
 Options:
-  -c, --contractName <value>  Contract name in local Solidity files. Not needed when using an address as the first argument.
-  -h, --help                  display help for command
-
+  -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
 ```
 
 ### Flatten usage