add clear verify queue rpc

nervosnetwork · Sep 2, 2024 · 3f993ab · 3f993ab
1 parent dee03e8
commit 3f993ab
Show file tree

Hide file tree

Showing 3 changed files with 80 additions and 0 deletions.
diff --git a/rpc/README.md b/rpc/README.md
@@ -109,6 +109,7 @@ The crate `ckb-rpc`'s minimum supported rustc version is 1.71.1.
         * [Method `remove_transaction`](#pool-remove_transaction)
         * [Method `tx_pool_info`](#pool-tx_pool_info)
         * [Method `clear_tx_pool`](#pool-clear_tx_pool)
+        * [Method `clear_tx_verify_queue`](#pool-clear_tx_verify_queue)
         * [Method `get_raw_tx_pool`](#pool-get_raw_tx_pool)
         * [Method `get_pool_tx_detail_info`](#pool-get_pool_tx_detail_info)
         * [Method `tx_pool_ready`](#pool-tx_pool_ready)
@@ -4748,6 +4749,37 @@ Response
 }
 ```
 
+<a id="pool-clear_tx_verify_queue"></a>
+#### Method `clear_tx_verify_queue`
+* `clear_tx_verify_queue()`
+
+* result: `null`
+
+Removes all transactions from the verification queue.
+
+###### Examples
+
+Request
+
+```json
+{
+  "id": 42,
+  "jsonrpc": "2.0",
+  "method": "clear_tx_verify_queue",
+  "params": []
+}
+```
+
+Response
+
+```json
+{
+  "id": 42,
+  "jsonrpc": "2.0",
+  "result": null
+}
+```
+
 <a id="pool-get_raw_tx_pool"></a>
 #### Method `get_raw_tx_pool`
 * `get_raw_tx_pool(verbose)`

diff --git a/rpc/src/module/pool.rs b/rpc/src/module/pool.rs
@@ -322,6 +322,33 @@ pub trait PoolRpc {
     #[rpc(name = "clear_tx_pool")]
     fn clear_tx_pool(&self) -> Result<()>;
 
+    /// Removes all transactions from the verification queue.
+    ///
+    /// ## Examples
+    ///
+    /// Request
+    ///
+    /// ```json
+    /// {
+    ///   "id": 42,
+    ///   "jsonrpc": "2.0",
+    ///   "method": "clear_tx_verify_queue",
+    ///   "params": []
+    /// }
+    /// ```
+    ///
+    /// Response
+    ///
+    /// ```json
+    /// {
+    ///   "id": 42,
+    ///   "jsonrpc": "2.0",
+    ///   "result": null
+    /// }
+    /// ```
+    #[rpc(name = "clear_tx_verify_queue")]
+    fn clear_tx_verify_queue(&self) -> Result<()>;
+
     /// Returns all transaction ids in tx pool as a json array of string transaction ids.
     /// ## Params
     ///
@@ -662,6 +689,15 @@ impl PoolRpc for PoolRpcImpl {
         Ok(())
     }
 
+    fn clear_tx_verify_queue(&self) -> Result<()> {
+        let tx_pool = self.shared.tx_pool_controller();
+        tx_pool
+            .clear_verify_queue()
+            .map_err(|err| RPCError::custom(RPCError::Invalid, err.to_string()))?;
+
+        Ok(())
+    }
+
     fn get_raw_tx_pool(&self, verbose: Option<bool>) -> Result<RawTxPool> {
         let tx_pool = self.shared.tx_pool_controller();
 

diff --git a/tx-pool/src/service.rs b/tx-pool/src/service.rs
@@ -110,6 +110,7 @@ pub(crate) enum Message {
     GetTransactionWithStatus(Request<Byte32, GetTransactionWithStatusResult>),
     NewUncle(Notify<UncleBlockView>),
     ClearPool(Request<Arc<Snapshot>, ()>),
+    ClearVerifyQueue(Request<(), ()>),
     GetAllEntryInfo(Request<(), TxPoolEntryInfo>),
     GetAllIds(Request<(), TxPoolIds>),
     SavePool(Request<(), ()>),
@@ -322,6 +323,11 @@ impl TxPoolController {
         send_message!(self, ClearPool, new_snapshot)
     }
 
+    /// Clears the tx-verify-queue.
+    pub fn clear_verify_queue(&self) -> Result<(), AnyError> {
+        send_message!(self, ClearVerifyQueue, ())
+    }
+
     /// TODO(doc): @zhangsoledad
     pub fn get_all_entry_info(&self) -> Result<TxPoolEntryInfo, AnyError> {
         send_message!(self, GetAllEntryInfo, ())
@@ -914,6 +920,12 @@ async fn process(mut service: TxPoolService, message: Message) {
                 error!("Responder sending clear_pool failed {:?}", e)
             };
         }
+        Message::ClearVerifyQueue(Request { responder, .. }) => {
+            service.verify_queue.write().await.clear();
+            if let Err(e) = responder.send(()) {
+                error!("Responder sending clear_verify_queue failed {:?}", e)
+            };
+        }
         Message::GetPoolTxDetails(Request {
             responder,
             arguments: tx_hash,