Skip to content

Latest commit

 

History

History
112 lines (74 loc) · 3.17 KB

README.md

File metadata and controls

112 lines (74 loc) · 3.17 KB
Raw

Example UML Diagrams

Bored Ape Yacht Club NFT

Bored Ape Yacht Club NFT Generated from running

sol2uml 0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D

This uses the verified Solidity code loaded to Etherscan https://etherscan.io/address/0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d#code

Open Zeppelin ERC20 Tokens

Open Zeppelin ERC20 Generated from version 4.7.3 contracts/token/ERC20

mStable mUSD on Polygon

Polygon mUSD Generated from running

sol2uml -n polygon 0xcA9cf48aD534f1efA2B0f6923457F2953df86e0b

Crypto Blades on BSC

BSC Crypto Blades Generated from running

sol2uml -n bsc 0xB07c1C479b2Fdeb9f9B2d02300C13b328BF86d65

Open Zeppelin All

Open Zeppelin ERC20 Generated from version 4.7.3 contracts

Uniswap V3 Router

  • -hp hide private and internal variables and functions
  • -hi hide interfaces
  • -hl hide libraries
  • -he hide enums

Uniswap V3 Router Generated from running

sol2uml -hp -hi -hl -hs -he 0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45

This uses the verified Solidity code loaded to Etherscan https://etherscan.io/address/0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45#code

Uniswap V3 Router Squashed

Same as the previous diagram but the inherited contracts are squashed into a single class diagram with the -s, --squash option.

The last stereotype is the contract the variable or function is implemented in. For example, unwrapWETH9 is implemented in the PeripheryPaymentsWithFeeExtended contract.

Uniswap V3 Router Squashed

Generated from running

sol2uml -s -hp -hi -hl -hs -he 0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45

Uniswap V3 Router Squashed No Source

Adding the -hsc, --hideSourceContract option to the previous diagram removes the stereotype with the source contract the variable or function was implemented in.

Uniswap V3 Router Squashed no source contract

Generated from running

sol2uml -s -hsc -hp -hi -hl -hs -he 0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45

Tether

Tether Generated from running

sol2uml 0xdAC17F958D2ee523a2206206994597C13D831ec7

This uses the verified Solidity code loaded to Etherscan https://etherscan.io/address/0xdac17f958d2ee523a2206206994597c13d831ec7#code

Compound Finance's cDAI

Compound Finance cDAI Generated from running

sol2uml 0xf5dce57282a584d2746faf1593d3121fcac444dc

This uses the verified Solidity code loaded to Etherscan https://etherscan.io/address/0xf5dce57282a584d2746faf1593d3121fcac444dc#code

Compound Finance's cDAI Hide

Same as the previous except enums, stucts and interfaces are hidden. Also, only classes linked to the base CErc20 contract are included.

Compound Finance cDAI Generated from running

sol2uml -b CErc20 -he -hs -hi 0xf5dce57282a584d2746faf1593d3121fcac444dc