Documenting Solidity with diagrams
summary
An npm command‑line tool generates visual diagrams of Solidity code: class/hierarchy, squash diagrams that collapse inherited functions, and storage slot layout diagrams that parse slot types and values (requires an RPC URL and can read verified source from Etherscan). It also offers a diff against Etherscan to compare deployed verified contracts to local files, a flatten command for merged verified sources, outputs SVGs, handles proxies by pointing to the proxy address, and does not support mappings.
AI-written summary · about
chapters (11)
- 0:00Solidity docs with diagrams
- 1:08Solidity to UML tool features
- 2:56Class diagrams from Solidity
- 4:00Inheritance hierarchy diagrams
- 5:44Squash diagrams for contracts
- 7:30Custom squash diagram depth
- 8:33Storage diagrams for data
- 10:16Remote storage diagrams
- 11:23Automate diagram generation
- 11:43Verify contracts with diff
- 12:24Q&A
related talks
39mDiagrams as Code 2.0
34mDiagram as Code - Decoding Architectural Diagrams
15mDraw me a software or the art of diagrams that stick in the mind
46mSave a Dev, Write Documentation!
50mDesign Patterns for Software Diagramming
47mDocumentation Is Fine, Don't Worry
49mReverse-engineering Architecture Diagrams
38mCan we visualize software complexity?
