sol2uml 2.5.13 → 2.5.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -2
- package/lib/sol2uml.js +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
A visualisation tool for [Solidity](https://solidity.readthedocs.io/) contracts featuring:
|
|
7
7
|
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.
|
|
8
8
|
2. Contract storage layout diagrams.
|
|
9
|
+
3. Flatten Solidity files on Etherscan-like explorers to a local file.
|
|
10
|
+
4. Diff contracts on Etherscan-like explorers.
|
|
9
11
|
|
|
10
12
|
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)
|
|
11
13
|

|
|
@@ -151,7 +153,7 @@ Options:
|
|
|
151
153
|
-bn, --block <number> Block number to get the contract storage values from. (default: "latest")
|
|
152
154
|
-a, --array <number> Number of slots to display at the start and end of arrays. (default: "2")
|
|
153
155
|
-hx, --hideExpand <variables> Comma-separated list of storage variables to not expand. That's arrays, structs, strings or bytes.
|
|
154
|
-
-hv, --
|
|
156
|
+
-hv, --hideValues Hide storage slot value column. (default: false)
|
|
155
157
|
-h, --help display help for command
|
|
156
158
|
```
|
|
157
159
|
|
|
@@ -181,7 +183,7 @@ Options:
|
|
|
181
183
|
```
|
|
182
184
|
Usage: sol2uml diff [options] <addressA> <addressB or comma-separated folders>
|
|
183
185
|
|
|
184
|
-
Compare verified
|
|
186
|
+
Compare verified contract code on Etherscan-like explorers to another verified contract, a local file or multiple local files.
|
|
185
187
|
|
|
186
188
|
The results show the comparison of contract A to B.
|
|
187
189
|
The green sections are additions to contract B that are not in contract A.
|
package/lib/sol2uml.js
CHANGED
|
@@ -133,7 +133,7 @@ WARNING: sol2uml does not use the Solidity compiler so may differ with solc. A k
|
|
|
133
133
|
.option('-bn, --block <number>', 'Block number to get the contract storage values from.', 'latest')
|
|
134
134
|
.option('-a, --array <number>', 'Number of slots to display at the start and end of arrays.', '2')
|
|
135
135
|
.option('-hx, --hideExpand <variables>', "Comma-separated list of storage variables to not expand. That's arrays, structs, strings or bytes.", validators_1.validateVariables)
|
|
136
|
-
.option('-hv, --
|
|
136
|
+
.option('-hv, --hideValues', 'Hide storage slot value column.', false)
|
|
137
137
|
.action(async (fileFolderAddress, options, command) => {
|
|
138
138
|
try {
|
|
139
139
|
const combinedOptions = {
|
|
@@ -219,7 +219,7 @@ In order for the merged code to compile, the following is done:
|
|
|
219
219
|
program
|
|
220
220
|
.command('diff')
|
|
221
221
|
.usage('[options] <addressA> <addressB or comma-separated folders>')
|
|
222
|
-
.description(`Compare verified
|
|
222
|
+
.description(`Compare verified contract code on Etherscan-like explorers to another verified contract, a local file or multiple local files.
|
|
223
223
|
|
|
224
224
|
The results show the comparison of contract A to B.
|
|
225
225
|
The ${clc.green('green')} sections are additions to contract B that are not in contract A.
|