grants-and-bounties icon indicating copy to clipboard operation
grants-and-bounties copied to clipboard

Published 20 hours ago • verified publisher icon ton-society

Sandbox UML plugin

Open elsvv opened this issue 1 year ago • 5 comments

Summary

The plugin should support generating UML sequence diagram from Sandbox SendMessageResult object. A diagram should represent consequence transactions between contracts, display tx's op (in a human-readable form) and a message value, distinguish different contract types. These diagrams can be logged to the stdout

image

or saved as a png picture.

png-scheme

Context

When it comes to developing a complex smart contract system with many different actors, it is almost impossible to do without an adequate graphical representation. Among other things, graphical schemes can be useful not only at the design stage, but also during testing and debugging of contracts. In particular, such diagrams can provide useful insights regarding gas consumption or debugging of complex transaction chains. @ton/sandbox provides excellent testing and debugging capabilities. Its flexible API also allows you to develop a utility for automatic generation of visual schemes.

References

  • https://plantuml.com/sequence-diagram PlantUML Sequence Diagram is well suited for describing the interaction of TON actors.

Estimate suggested reward

  • Standard TON Footstep NFT
  • $200 in TON equivalent

elsvv avatar Nov 25 '23 21:11 elsvv

Ready for assignment, started the project for my own needs.

elsvv avatar Nov 25 '23 21:11 elsvv

100% need this! Love it.

howardpen9 avatar Nov 26 '23 07:11 howardpen9

This proposal is fantastic! It will definitely streamline our debugging process! We are interested in building this tool 🙌

alan890104 avatar Nov 26 '23 10:11 alan890104

This will help a lot !!

ipromise2324 avatar Nov 26 '23 10:11 ipromise2324

～～

howardpen9 avatar Dec 07 '23 10:12 howardpen9