Merge pull request nervosnetwork#4124 from EthanYuan/fix-rpc-doc

fix: update the RPC `generate_block` method comments
libraries · Aug 29, 2023 · e90241b · e90241b
2 parents 7db3976 + 5c02c9a
commit e90241b
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 20 deletions.
diff --git a/rpc/README.md b/rpc/README.md
@@ -3182,19 +3182,9 @@ Response
 * `generate_block()`
 * result: [`H256`](#type-h256)
 
-Generate block with block_assembler_config, process the block(with verification)
-
-and broadcast the block.
-
-###### Params
-
-*
-    `block_assembler_script` - specified block assembler script
-
-
-*
-    `block_assembler_message` - specified block assembler message
+Generate block(with verification) and broadcast the block.
 
+Note that if called concurrently, it may return the hash of the same block.
 
 ###### Examples
 

diff --git a/rpc/src/module/test.rs b/rpc/src/module/test.rs
@@ -140,15 +140,9 @@ pub trait IntegrationTestRpc {
     #[rpc(name = "truncate")]
     fn truncate(&self, target_tip_hash: H256) -> Result<()>;
 
-    /// Generate block with block_assembler_config, process the block(with verification)
+    /// Generate block(with verification) and broadcast the block.
     ///
-    /// and broadcast the block.
-    ///
-    /// ## Params
-    ///
-    /// * `block_assembler_script` - specified block assembler script
-    ///
-    /// * `block_assembler_message` - specified block assembler message
+    /// Note that if called concurrently, it may return the hash of the same block.
     ///
     /// ## Examples
     ///