Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sandbox UML plugin #380

Open
elsvv opened this issue Nov 25, 2023 · 5 comments
Open

Sandbox UML plugin #380

elsvv opened this issue Nov 25, 2023 · 5 comments
Assignees
Labels
Approved This proposal is approved by the committee Developer Tool Related to tools or utilities used by developers

Comments

@elsvv
Copy link

elsvv commented Nov 25, 2023

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

Estimate suggested reward

  • Standard TON Footstep NFT
  • $200 in TON equivalent
@elsvv elsvv added the Developer Tool Related to tools or utilities used by developers label Nov 25, 2023
@elsvv
Copy link
Author

elsvv commented Nov 25, 2023

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

@howardpen9
Copy link

100% need this! Love it.

@alan890104
Copy link

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

@ipromise2324
Copy link

This will help a lot !!

@delovoyhomie delovoyhomie added the Approved This proposal is approved by the committee label Nov 28, 2023
@howardpen9
Copy link

~~

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved This proposal is approved by the committee Developer Tool Related to tools or utilities used by developers
Projects
None yet
Development

No branches or pull requests

5 participants