-
Notifications
You must be signed in to change notification settings - Fork 227
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this 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?
@EnriqueL8 LIKE THIS? |
There was a problem hiding this 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
@EnriqueL8 Corrected. I can squash commits if it's necessary, cause too many of them. Sorry for mess |
No worries, could you squash please :) |
Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update index.md Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]> Update smart_contracts_async_flow.svg Signed-off-by: VolodymyrBg <[email protected]>
@EnriqueL8 Done |
There was a problem hiding this 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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After reviewing the code flow and where the TODO was, this diagram doesn't show the Async behavior of a smart contract invoke. The blockchain connector will return a transaction accepted before it's submitted to the blockchain and the response of the operation being completed is a receipt from the blockchain so two things need changing:
Transaction accepted
from connector to FireFly should just after theSubmit Transaction
Before the emit blockchain events
there is also aRetrieve receipt/confirmation for TX
and thenconfirm tx to FireFly
. At this point the operation is updated.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1661 +/- ##
=======================================
Coverage 99.95% 99.95%
=======================================
Files 339 339
Lines 29780 29780
=======================================
Hits 29768 29768
Misses 8 8
Partials 4 4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Proposed changes
Fixes # <issue_number_here>
Types of changes
Please make sure to follow these points
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.