Skip to content

Commit e11d137

Browse files
committed
Add comments clarifying that syncing methods shouldn't be used for RPC
1 parent d18167f commit e11d137

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
@@ -387,6 +387,8 @@ impl ChainSource {
387387
}
388388
}
389389

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

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

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

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

0 commit comments

Comments
 (0)