Skip to content

Commit 344e5e5

Browse files
committed
Add comments clarifying that syncing methods shouldn't be used for RPC
1 parent 3a20407 commit 344e5e5

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

src/chain/mod.rs

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -388,6 +388,8 @@ impl ChainSource {
388388
}
389389
}
390390

391+
// Synchronize the onchain wallet via transaction-based protocols (i.e., Esplora, Electrum,
392+
// etc.)
391393
pub(crate) async fn sync_onchain_wallet(&self) -> Result<(), Error> {
392394
match self {
393395
Self::Esplora {
@@ -503,10 +505,16 @@ impl ChainSource {
503505

504506
res
505507
},
506-
Self::BitcoindRpc { .. } => todo!(),
508+
Self::BitcoindRpc { .. } => {
509+
// In BitcoindRpc mode we sync lightning and onchain wallet in one go by via
510+
// `ChainPoller`. So nothing to do here.
511+
unreachable!("Onchain wallet will be synced via chain polling")
512+
},
507513
}
508514
}
509515

516+
// Synchronize the Lightning wallet via transaction-based protocols (i.e., Esplora, Electrum,
517+
// etc.)
510518
pub(crate) async fn sync_lightning_wallet(
511519
&self, channel_manager: Arc<ChannelManager>, chain_monitor: Arc<ChainMonitor>,
512520
output_sweeper: Arc<Sweeper>,
@@ -596,7 +604,11 @@ impl ChainSource {
596604

597605
res
598606
},
599-
Self::BitcoindRpc { .. } => todo!(),
607+
Self::BitcoindRpc { .. } => {
608+
// In BitcoindRpc mode we sync lightning and onchain wallet in one go by via
609+
// `ChainPoller`. So nothing to do here.
610+
unreachable!("Lightning wallet will be synced via chain polling")
611+
},
600612
}
601613
}
602614

0 commit comments

Comments
 (0)