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

docs: update smart contracts async flow diagram #1661

Open
wants to merge 23 commits into
base: main
Choose a base branch
from

Conversation

VolodymyrBg
Copy link

@VolodymyrBg VolodymyrBg commented Mar 13, 2025

Proposed changes

  1. Updated the smart_contracts_async_flow.svg diagram in the custom contracts tutorial to:
  • Add the Blockchain Connector component to accurately represent the architecture
  • Improve the flow visualization with more detailed steps
  • Add color coding for better visual distinction between components
  • Include a note about event subscription options
  • Make the diagram more comprehensive and modern
  1. Removed the TODO comment from the custom_contracts/index.md file

Fixes # <issue_number_here>


Types of changes

  • Bug fix
  • New feature added
  • Documentation Update

Please make sure to follow these points

  • I have read the contributing guidelines.
  • I have performed a self-review of my own code or work.
  • I have commented my code, particularly in hard-to-understand areas.
  • My changes generates no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • My changes have sufficient code coverage (unit, integration, e2e tests).

Screenshots (If Applicable)


Other Information

The previous diagram was simplified and didn't accurately represent the role of the Blockchain Connector or the complete flow of events. This update provides a more accurate and detailed representation of how custom contract interactions work in FireFly, which will help developers better understand the asynchronous nature of blockchain transactions.

@VolodymyrBg VolodymyrBg requested a review from a team as a code owner March 13, 2025 17:22
Copy link
Contributor

@EnriqueL8 EnriqueL8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @VolodymyrBg this is super useful, it seems that the SVG is cut and I can't see the store events flow and emit events to the App, could you please add that?

@VolodymyrBg
Copy link
Author

@EnriqueL8 LIKE THIS?

Copy link
Contributor

@EnriqueL8 EnriqueL8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks , looking better! A few changes needed please

@VolodymyrBg
Copy link
Author

@EnriqueL8 Corrected. I can squash commits if it's necessary, cause too many of them. Sorry for mess

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants