From: Mshehu5 <musheu@gmail.com>
Date: Sat, 20 Dec 2025 22:53:14 +0000 (+0100)
Subject: refactor: use handle pattern for Kyoto client
X-Git-Url: http://internal-gitweb-vhost/parse/%22https:/struct.EncoderStringWriter.html?a=commitdiff_plain;h=99b71fdaede31dd89aa10f153294bfb3e90d5e6f;p=bdk-cli

refactor: use handle pattern for Kyoto client

Refactor KyotoClient to use a KyotoClientHandle struct instead of
Box<LightClient>. Previously, the Box<LightClient> was consumed
when destructured in sync_kyoto_client, preventing the function
from being called multiple times or borrowed. With the handle
pattern, sync_kyoto_client now takes &mut KyotoClientHandle,
allowing it to be borrowed and reused.

This also allows the node to be started at creation time in
new_blockchain_client rather than during sync, making the client
ready for use immediately after creation.

- Add KyotoClientHandle struct containing requester and
  update_subscriber
- Move node startup and logger spawning to new_blockchain_client
- Update sync_kyoto_client to accept &mut KyotoClientHandle
  instead of consuming Box<LightClient>
---

diff --git a/src/utils.rs b/src/utils.rs
index 73d3453..448675a 100644
--- a/src/utils.rs
+++ b/src/utils.rs
@@ -158,7 +158,15 @@ pub(crate) enum BlockchainClient {
     },
 
     #[cfg(feature = "cbf")]
-    KyotoClient { client: Box<LightClient> },
+    KyotoClient { client: KyotoClientHandle },
+}
+
+/// Handle for the Kyoto client after the node has been started.
+/// Contains only the components needed for sync and broadcast operations.
+#[cfg(feature = "cbf")]
+pub struct KyotoClientHandle {
+    pub requester: bdk_kyoto::Requester,
+    pub update_subscriber: tokio::sync::Mutex<bdk_kyoto::UpdateSubscriber>,
 }
 
 #[cfg(any(
@@ -215,13 +223,32 @@ pub(crate) fn new_blockchain_client(
             let scan_type = Sync;
             let builder = Builder::new(_wallet.network());
 
-            let client = builder
+            let light_client = builder
                 .required_peers(wallet_opts.compactfilter_opts.conn_count)
                 .data_dir(&_datadir)
                 .build_with_wallet(_wallet, scan_type)?;
 
+            let LightClient {
+                requester,
+                info_subscriber,
+                warning_subscriber,
+                update_subscriber,
+                node,
+            } = light_client;
+
+            let subscriber = tracing_subscriber::FmtSubscriber::new();
+            let _ = tracing::subscriber::set_global_default(subscriber);
+
+            tokio::task::spawn(async move { node.run().await });
+            tokio::task::spawn(
+                async move { trace_logger(info_subscriber, warning_subscriber).await },
+            );
+
             BlockchainClient::KyotoClient {
-                client: Box::new(client),
+                client: KyotoClientHandle {
+                    requester,
+                    update_subscriber: tokio::sync::Mutex::new(update_subscriber),
+                },
             }
         }
     };
@@ -318,29 +345,17 @@ pub async fn trace_logger(
 
 // Handle Kyoto Client sync
 #[cfg(feature = "cbf")]
-pub async fn sync_kyoto_client(wallet: &mut Wallet, client: Box<LightClient>) -> Result<(), Error> {
-    let LightClient {
-        requester,
-        info_subscriber,
-        warning_subscriber,
-        mut update_subscriber,
-        node,
-    } = *client;
-
-    let subscriber = tracing_subscriber::FmtSubscriber::new();
-    tracing::subscriber::set_global_default(subscriber)
-        .map_err(|e| Error::Generic(format!("SetGlobalDefault error: {e}")))?;
-
-    tokio::task::spawn(async move { node.run().await });
-    tokio::task::spawn(async move { trace_logger(info_subscriber, warning_subscriber).await });
-
-    if !requester.is_running() {
+pub async fn sync_kyoto_client(
+    wallet: &mut Wallet,
+    handle: &KyotoClientHandle,
+) -> Result<(), Error> {
+    if !handle.requester.is_running() {
         tracing::error!("Kyoto node is not running");
         return Err(Error::Generic("Kyoto node failed to start".to_string()));
     }
     tracing::info!("Kyoto node is running");
 
-    let update = update_subscriber.update().await?;
+    let update = handle.update_subscriber.lock().await.update().await?;
     tracing::info!("Received update: applying to wallet");
     wallet
         .apply_update(update)