Skip to content

Conversation

@VolodymyrBg
Copy link
Contributor

@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
Contributor 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
Contributor Author

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

@EnriqueL8
Copy link
Contributor

No worries, could you squash please :)

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update index.md

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>
@VolodymyrBg
Copy link
Contributor Author

@EnriqueL8 Done

@VolodymyrBg VolodymyrBg requested a review from EnriqueL8 March 17, 2025 18:46
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.

Sorry for spotting this later in the review

@codecov
Copy link

codecov bot commented Mar 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.95%. Comparing base (ec71bca) to head (058c585).
Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1661   +/-   ##
=======================================
  Coverage   99.95%   99.95%           
=======================================
  Files         339      339           
  Lines       29782    29782           
=======================================
  Hits        29770    29770           
  Misses          8        8           
  Partials        4        4           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@VolodymyrBg VolodymyrBg requested a review from EnriqueL8 March 18, 2025 16:44
@VolodymyrBg
Copy link
Contributor Author

@EnriqueL8 Hope now it's ok

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>
@VolodymyrBg VolodymyrBg requested a review from EnriqueL8 March 19, 2025 17:10
@VolodymyrBg
Copy link
Contributor Author

@EnriqueL8 dONE

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>

Update smart_contracts_async_flow.svg

Signed-off-by: VolodymyrBg <aqdrgg19@gmail.com>
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.

Awesome thanks @VolodymyrBg!

@EnriqueL8 EnriqueL8 merged commit 7b7dbb0 into hyperledger:main Mar 21, 2025
19 checks passed
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