Skip to content

Latest commit

 

History

History
29 lines (26 loc) · 997 Bytes

README.md

File metadata and controls

29 lines (26 loc) · 997 Bytes
Raw

Perpetuals

Generate UML diagram for solidity files

using sol2uml

   npx sol2uml ./contracts/(define file location)

using surya to get uml

   npx surya graph contracts/file location/*.sol | dot -Tpng > ImageName.png
   # example for matching engine folder 
   # npx surya graph contracts/matching-engine/*.sol  | dot -Tpng > MatchingEngine.png
   # For file 
   # npx surya graph contracts/matching-engine/MatchingEngineCore.sol | dot -Tpng > MatchingEngineCore.png

using solgraph to determine function calls and event emits

   npx solgraph ./contracts/file location > contractname.dot
   dot -Tpng contractname.dot -o contractname.png

   # example for matching engine 
   # npx solgraph ./contracts/matching-engine/MatchingEngineCore.sol > MatchingEngine.dot
   # dot -Tpng MatchingEngine.dot -o MyContract.png

Generate documentation

   npx hardhat docgen