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.

Sign up for GitHub

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

Jump to bottom

Rpc-api author: Clarify comments about blocking functions #679

Merged
merged 2 commits into from
Nov 28, 2023
Merged

Rpc-api author: Clarify comments about blocking functions #679

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
019fec0
add sync-api mode to comment
haerdib Nov 28, 2023
5923379
clarify comment
haerdib Nov 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions src/api/rpc_api/author.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ pub trait SubmitAndWatch {

/// Submit an extrinsic an return a Subscription
/// to watch the extrinsic progress.
///
/// This method is blocking if the sync-api feature is activated
async fn submit_and_watch_extrinsic<Address, Call, Signature, SignedExtra>(
&self,
extrinsic: UncheckedExtrinsicV4<Address, Call, Signature, SignedExtra>,
Expand All @@ -99,6 +101,8 @@ pub trait SubmitAndWatch {

/// Submit an encoded, opaque extrinsic an return a Subscription to
/// watch the extrinsic progress.
///
/// This method is blocking if the sync-api feature is activated
async fn submit_and_watch_opaque_extrinsic(
&self,
encoded_extrinsic: &Bytes,
Expand All @@ -123,7 +127,7 @@ pub trait SubmitAndWatch {
/// - extrinsic hash
/// - last known extrinsic (transaction) status
///
/// This method is blocking.
/// This method is blocking if the sync-api feature is activated
async fn submit_and_watch_extrinsic_until<Address, Call, Signature, SignedExtra>(
&self,
extrinsic: UncheckedExtrinsicV4<Address, Call, Signature, SignedExtra>,
Expand Down Expand Up @@ -154,7 +158,7 @@ pub trait SubmitAndWatch {
/// - extrinsic hash
/// - last known extrinsic (transaction) status
///
/// This method is blocking.
/// This method is blocking if the sync-api feature is activated
async fn submit_and_watch_opaque_extrinsic_until(
&self,
encoded_extrinsic: &Bytes,
Expand All @@ -170,7 +174,8 @@ pub trait SubmitAndWatch {
/// - if watched until at least `InBlock`:
/// hash of the block the extrinsic was included in
/// - last known extrinsic (transaction) status
/// This method is blocking.
///
/// This method is blocking if the sync-api feature is activated
async fn submit_and_watch_extrinsic_until_without_events<
Address,
Call,
Expand All @@ -196,7 +201,8 @@ pub trait SubmitAndWatch {
/// - if watched until at least `InBlock`:
/// hash of the block the extrinsic was included in
/// - last known extrinsic (transaction) status
/// This method is blocking.
///
/// This method is blocking if the sync-api feature is activated
async fn submit_and_watch_opaque_extrinsic_until_without_events(
&self,
encoded_extrinsic: &Bytes,
Expand Down
Loading