Skip to content

Commit

Permalink
chore: upgraded the OpenZeppelin examples to the latest version
Browse files Browse the repository at this point in the history
chore: bump dependencies
  • Loading branch information
naddison36 committed Oct 5, 2022
1 parent 73fa92f commit 794c7ef
Show file tree
Hide file tree
Showing 7 changed files with 7,474 additions and 4,169 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A visualisation tool for [Solidity](https://solidity.readthedocs.io/) contracts
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.
2. Contract storage layout diagrams.

UML class diagram of Open Zeppelin's ERC20 token contracts generated from [version 2.5.1](https://github.com/OpenZeppelin/openzeppelin-solidity/tree/v2.5.1/contracts/token/ERC20)
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)
![Open Zeppelin ERC20](./examples/OpenZeppelinERC20.svg)

See more contract diagrams [here](./examples/README.md).
Expand Down Expand Up @@ -184,10 +184,10 @@ To generate a diagram of all contracts in a single Solidity file, the output fil
sol2uml class path/to/contracts/root/folder/solidity/file.sol -f png -o ./someFile.png
```

To generate a diagram of all Solidity files under the `contracts` and `node_modules/openzeppelin-solidity` folders. The output will be `contracts.svg` and `contracts.png` files in the working folder.
To generate a diagram of all Solidity files under the `contracts` and `node_modules/@openzeppelin` folders. The output will be `contracts.svg` and `contracts.png` files in the working folder.

```bash
sol2uml class ./contracts,node_modules/openzeppelin-solidity -f all -v
sol2uml class ./contracts,node_modules/@openzeppelin -f all -v
```

To generate a diagram of all Solidity files under the working folder ignoring and files under the `solparse`, `@solidity-parser` and `ethlint` folders, which will be under the `node_modules` folder.
Expand Down
7,702 changes: 5,310 additions & 2,392 deletions examples/OpenZeppelinAll.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
688 changes: 519 additions & 169 deletions examples/OpenZeppelinERC20.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 2 additions & 11 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,7 @@ This uses the verified Solidity code loaded to Etherscan https://etherscan.io/ad
## Open Zeppelin ERC20 Tokens

![Open Zeppelin ERC20](./OpenZeppelinERC20.svg)
Generated from version [2.3.0 contracts/token/ERC20](https://github.com/OpenZeppelin/openzeppelin-solidity/tree/v2.3.0/contracts/token/ERC20)

## Open Zeppelin Base Contract

![Open Zeppelin Base Contract](./OzToken.svg)
Generated from version [2.5.1 contracts](https://github.com/OpenZeppelin/openzeppelin-solidity/tree/v2.5.1/contracts) with

```
sol2uml -b OzToken
```
Generated from version [4.7.3 contracts/token/ERC20](https://github.com/OpenZeppelin/openzeppelin-contracts/tree/v4.7.3/contracts/token/ERC20)

## mStable mUSD on Polygon

Expand All @@ -46,7 +37,7 @@ sol2uml -n bsc 0xB07c1C479b2Fdeb9f9B2d02300C13b328BF86d65
## Open Zeppelin All

![Open Zeppelin ERC20](./OpenZeppelinAll.svg)
Generated from version [2.5.1 contracts](https://github.com/OpenZeppelin/openzeppelin-solidity/tree/v2.5.1/contracts)
Generated from version [4.7.3 contracts](https://github.com/OpenZeppelin/openzeppelin-contracts/tree/v4.7.3/contracts)

## MakerDAO's SAI Token

Expand Down
Empty file modified lib/sol2uml.js
100755 → 100644
Empty file.
Loading

0 comments on commit 794c7ef

Please sign in to comment.