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

* add sync-api mode to comment * clarify comment
scs · Nov 28, 2023 · bec07d4 · bec07d4
1 parent 9a622ce
commit bec07d4
Showing 1 changed file with 10 additions and 4 deletions.
diff --git a/src/api/rpc_api/author.rs b/src/api/rpc_api/author.rs
@@ -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>,
@@ -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,
@@ -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>,
@@ -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,
@@ -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,
@@ -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,