Add EventReport and failed xt check to examples #615
Conversation
haerdib
changed the title
haerdib
changed the title
There was a problem hiding this comment.
Really clean. But I'm still missing the 'little' differences between submit_and_watch_extrinsic_until_without_event and submit_and_watch_extrinsic_until.
submit_and_watch_extrinsic_until_without_eventdoesn't thrown an error when the extrinsic has failed onchain.- how can we get the triggered events when the extrinsic has failed?
| let balance_of_bob = api.get_account_data(&bob).unwrap().unwrap_or_default().free; | ||
| println!("[+] Bob's Free Balance is {balance_of_bob}\n"); | ||
|
|
||
| // First we want to see the events of a failed extrinsic. |
There was a problem hiding this comment.
How do you want to do it?
There was a problem hiding this comment.
Good Input - let me do something about that
There was a problem hiding this comment.
See #617: I think that should be done in a different PR, as it affects the API. What do you think?
Regarding your point of
submit_and_watch_extrinsic_until_without_event doesn't thrown an error when the extrinsic has failed onchain.
What do you propose for this? I think the comments are quite telling already.. so I removed thewithout_eventsfrom the examples. It should not be used if one does not know what one is doing.
There was a problem hiding this comment.
#617 makes sense. Adding the report to the Error gives access to all the information we have collected.
There was a problem hiding this comment.
submit_and_watch_extrinsic_until_without_event doesn't thrown an error when the extrinsic has failed onchain.
What do you propose for this? I think the comments are quite telling already.. so I removed thewithout_eventsfrom the examples. It should not be used if one does not know what one is doing.
Not showing any examples is just a way of forcing the user not to use it. Is that really what we want?
I'm not sure the comments are clear enough. Because we're talking about an error when an extrinsic has failed on the chain, and not an event, the user may think that submit_and_watch_extrinsic_until_without_event informs her when an extrinsic fails on the chain. Without studying the code, they may miss this point.
Maybe add an example check_extrinsic_without_events similar to check_extrinsic_events? We could do it in another issue. Maybe I'm too picky, so it's up to you to decide.
There was a problem hiding this comment.
Created a follow up issue in #627
haerdib
force-pushed
the
bh/improve-examples
branch
from
6b89e24
to
35181d3
Compare
The following has been changed:
Examples
DefaultRuntimeConfiginstead of Polkadot Config and added a little more text.submit_and_watch_extrinsic_until_without_eventtosubmit_and_watch_extrinsic_until. Reasoning:submit_and_watch_extrinsic_until_without_eventsdoes not check if the extrinsic has failed, which might lead to confusion. So I'd suggest to usesubmit_and_watch_extrinsic_untilinstead, which checks for failure if possible, and if not (due to watching not long enough), it acts the very same assubmit_and_watch_extrinsic_until_without_events.event_callbacktosubscribe_events. I believe that's more descriptive.event_error_detailscheck_extrinsic_eventsExtrinsicReportcontains with an descriptiveprintlnmessage. It also checks the returned events.Tests
author_teststo check for:TransactionStatusNoneorSomeas one would expected. I therefore also changed fromsubmit_and_watch_extrinsic_until_without_eventstosubmit_and_watch_extrinsic_until. To still testsubmit_and_watch_extrinsic_until_without_eventsI added two new tests further below.closes #591