Skip to content

Break CBF wallet chain source reference cycle #23

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

Merged
febyeji merged 1 commit into from
May 28, 2026
Merged

Break CBF wallet chain source reference cycle #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 17 additions & 7 deletions src/chain/cbf.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
use std::collections::{HashMap, HashSet, VecDeque};
use std::net::SocketAddr;
use std::sync::atomic::{AtomicU32, Ordering};
use std::sync::{Arc, Mutex, RwLock};
use std::sync::{Arc, Mutex, RwLock, Weak};
use std::time::{Duration, Instant, SystemTime, UNIX_EPOCH};

use bdk_chain::indexer::keychain_txout::KeychainTxOutIndex;
Expand Down Expand Up @@ -115,7 +115,7 @@ pub(super) struct CbfChainSource {
/// Node configuration (network, storage path, etc.).
config: Arc<Config>,
/// On-chain wallet reference for deriving chain_state checkpoints on restart.
onchain_wallet: Mutex<Option<Arc<Wallet>>>,
onchain_wallet: Mutex<Option<Weak<Wallet>>>,
/// Logger instance.
logger: Arc<Logger>,
/// Shared node metrics (sync timestamps, etc.).
Expand Down Expand Up @@ -194,7 +194,7 @@ impl CbfChainSource {
///
/// Delegates to [`Self::build_cbf_node_static`], passing all needed fields.
fn build_cbf_node(&self) -> (CbfNode, Client) {
let wallet = self.onchain_wallet.lock().expect("lock").clone();
let wallet = self.onchain_wallet.lock().expect("lock").as_ref().and_then(Weak::upgrade);
Self::build_cbf_node_static(
&self.peers,
&self.sync_config,
Expand Down Expand Up @@ -281,8 +281,9 @@ impl CbfChainSource {
return;
}

// Store the wallet reference for future restarts.
*self.onchain_wallet.lock().expect("lock") = Some(Arc::clone(&onchain_wallet));
// Store a weak wallet reference for future restarts without creating a
// Wallet -> ChainSource -> Wallet reference cycle.
*self.onchain_wallet.lock().expect("lock") = Some(Arc::downgrade(&onchain_wallet));

let (node, client) = self.build_cbf_node();

Expand All @@ -304,7 +305,7 @@ impl CbfChainSource {
let restart_peers = self.peers.clone();
let restart_sync_config = self.sync_config.clone();
let restart_config = Arc::clone(&self.config);
let restart_wallet = Arc::clone(&onchain_wallet);
let restart_wallet = Arc::downgrade(&onchain_wallet);

runtime.spawn_background_task(async move {
let mut current_node = node;
Expand Down Expand Up @@ -373,11 +374,19 @@ impl CbfChainSource {
event_handle.abort();

// Rebuild the node from scratch.
let Some(wallet) = restart_wallet.upgrade() else {
log_info!(
restart_logger,
"CBF restart aborted: on-chain wallet was dropped."
);
*restart_status.lock().expect("lock") = CbfRuntimeStatus::Stopped;
break;
};
let (new_node, new_client) = Self::build_cbf_node_static(
&restart_peers,
&restart_sync_config,
&restart_config,
Some(&restart_wallet),
Some(&wallet),
&restart_logger,
);
let Client {
Expand Down Expand Up @@ -423,6 +432,7 @@ impl CbfChainSource {
CbfRuntimeStatus::Stopped => {},
}
*status = CbfRuntimeStatus::Stopped;
*self.onchain_wallet.lock().expect("lock") = None;
}

async fn process_info_messages(mut info_rx: mpsc::Receiver<Info>, logger: Arc<Logger>) {
Expand Down
Loading