docs(wallet): add sync to bdk_wallet examples

Author: tvpeter

examples/example_wallet_electrum/src/main.rs

@@ -44,7 +44,7 @@ fn main() -> Result<(), anyhow::Error> {
     let balance = wallet.balance();
     println!("Wallet balance before syncing: {}", balance.total());
 
-    print!("Syncing...");
+    println!("=== Performing Full Sync ===");
     let client = BdkElectrumClient::new(electrum_client::Client::new(ELECTRUM_URL)?);
 
     // Populate the electrum client's transaction cache so it doesn't redownload transaction we
@@ -71,7 +71,12 @@ fn main() -> Result<(), anyhow::Error> {
     wallet.persist(&mut db)?;
 
     let balance = wallet.balance();
-    println!("Wallet balance after syncing: {}", balance.total());
+    println!("Wallet balance after full sync: {}", balance.total());
+    println!(
+        "Wallet has {} transactions and {} utxos after full sync",
+        wallet.transactions().count(),
+        wallet.list_unspent().count()
+    );
 
     if balance.total() < SEND_AMOUNT {
         println!(
@@ -92,5 +97,29 @@ fn main() -> Result<(), anyhow::Error> {
     client.transaction_broadcast(&tx)?;
     println!("Tx broadcasted! Txid: {}", tx.compute_txid());
 
+    println!("=== Performing Partial Sync ===");
+    std::io::stdout().flush().expect("must flush");
+    let sync_request =
+        wallet
+            .start_sync_with_revealed_spks()
+            .inspect(|sync_item, sync_progress| {
+                let progress_percent =
+                    (100 * sync_progress.consumed()) as f32 / sync_progress.total() as f32;
+                eprintln!("[ SCANNING {:03.0}%] {}", progress_percent, sync_item)
+            });
+
+    client.populate_tx_cache(wallet.tx_graph().full_txs().map(|tx_node| tx_node.tx));
+
+    let sync_update = client.sync(sync_request, BATCH_SIZE, false)?;
+    wallet.apply_update(sync_update)?;
+
+    let balance_after_sync = wallet.balance();
+    println!("Wallet balance after sync: {}", balance_after_sync.total());
+    println!(
+        "Wallet has {} transactions and {} utxos after partial sync",
+        wallet.transactions().count(),
+        wallet.list_unspent().count()
+    );
+
     Ok(())
 }

examples/example_wallet_esplora_async/src/main.rs

@@ -42,7 +42,7 @@ async fn main() -> Result<(), anyhow::Error> {
     let balance = wallet.balance();
     println!("Wallet balance before syncing: {}", balance.total());
 
-    print!("Syncing...");
+    println!("=== Performing Full Sync ===");
     let client = esplora_client::Builder::new(ESPLORA_URL).build_async()?;
 
     let request = wallet.start_full_scan().inspect({
@@ -66,7 +66,12 @@ async fn main() -> Result<(), anyhow::Error> {
     println!();
 
     let balance = wallet.balance();
-    println!("Wallet balance after syncing: {}", balance.total());
+    println!("Wallet balance after full sync: {}", balance.total());
+    println!(
+        "Wallet has {} transactions and {} utxos after full sync",
+        wallet.transactions().count(),
+        wallet.list_unspent().count()
+    );
 
     if balance.total() < SEND_AMOUNT {
         println!(
@@ -87,5 +92,28 @@ async fn main() -> Result<(), anyhow::Error> {
     client.broadcast(&tx).await?;
     println!("Tx broadcasted! Txid: {}", tx.compute_txid());
 
+    println!("=== Performing Partial Sync ===");
+    std::io::stdout().flush().expect("must flush");
+    let sync_request = wallet
+        .start_sync_with_revealed_spks()
+        .inspect(|item, progress| {
+            let progress_percent = (100 * progress.consumed()) as f32 / progress.total() as f32;
+            println!("[ SCANNING {:03.0}% ] {}", progress_percent, item);
+        });
+
+    let sync_update = client
+        .sync(sync_request, PARALLEL_REQUESTS)
+        .await
+        .map_err(|e| *e)?;
+    wallet.apply_update(sync_update)?;
+
+    let balance_after_sync = wallet.balance();
+    println!("Wallet balance after sync: {}", balance_after_sync.total());
+    println!(
+        "Wallet has {} transactions and {} utxos after partial sync",
+        wallet.transactions().count(),
+        wallet.list_unspent().count()
+    );
+
     Ok(())
 }