Skip to content

feat(example_wallet_rpc): enhance logging with structured JSON output #216

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

feat(example_wallet_rpc): enhance logging with structured JSON output #216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
06f038f
feat(example_wallet_rpc): enhance logging with structured JSON output
SharanRP Mar 31, 2025
4028fb6
fix(example_wallet_rpc): reorder imports and clean up whitespace in m…
SharanRP Mar 31, 2025
bb9f328
signing the commit
SharanRP Mar 31, 2025
570ff59
style: remove trailing whitespace in main.rs
SharanRP Apr 2, 2025
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
5 changes: 5 additions & 0 deletions examples/example_wallet_rpc/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ name = "example_wallet_rpc"
version = "0.1.0"
edition = "2021"

[[bin]]
name = "example_wallet_rpc"
path = "src/main.rs"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
Expand All @@ -12,3 +16,4 @@ bdk_bitcoind_rpc = { version = "0.18" }
anyhow = "1"
clap = { version = "4.5.17", features = ["derive", "env"] }
ctrlc = "2.0.1"
serde_json = "1.0"
84 changes: 53 additions & 31 deletions examples/example_wallet_rpc/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ use bdk_wallet::{
KeychainKind, Wallet,
};
use clap::{self, Parser};
use serde_json::json;
use std::{path::PathBuf, sync::mpsc::sync_channel, thread::spawn, time::Instant};

const DB_MAGIC: &str = "bdk-rpc-wallet-example";
Expand Down Expand Up @@ -81,8 +82,11 @@ fn main() -> anyhow::Result<()> {

let rpc_client = args.client()?;
println!(
"Connected to Bitcoin Core RPC at {:?}",
rpc_client.get_blockchain_info().unwrap()
"{}",
serde_json::to_string_pretty(&json!({
"event": "connection",
"blockchain_info": rpc_client.get_blockchain_info().unwrap()
}))?
);

let start_load_wallet = Instant::now();
Expand All @@ -105,19 +109,19 @@ fn main() -> anyhow::Result<()> {
.create_wallet(&mut db)?,
},
};
println!(
"Loaded wallet in {}s",
start_load_wallet.elapsed().as_secs_f32()
);

let balance = wallet.balance();
println!("Wallet balance before syncing: {}", balance.total());

let wallet_tip = wallet.latest_checkpoint();
println!(
"Wallet tip: {} at height {}",
wallet_tip.hash(),
wallet_tip.height()
"{}",
serde_json::to_string_pretty(&json!({
"event": "wallet_loaded",
"duration_seconds": start_load_wallet.elapsed().as_secs_f32(),
"initial_balance": balance.total(),
"tip": {
"hash": wallet_tip.hash().to_string(),
"height": wallet_tip.height()
}
}))?
);

let (sender, receiver) = sync_channel::<Emission>(21);
Expand All @@ -143,7 +147,13 @@ fn main() -> anyhow::Result<()> {
for emission in receiver {
match emission {
Emission::SigTerm => {
println!("Sigterm received, exiting...");
println!(
"{}",
serde_json::to_string_pretty(&json!({
"event": "sigterm",
"message": "Sigterm received, exiting..."
}))?
);
break;
}
Emission::Block(block_emission) => {
Expand All @@ -156,39 +166,51 @@ fn main() -> anyhow::Result<()> {
wallet.persist(&mut db)?;
let elapsed = start_apply_block.elapsed().as_secs_f32();
println!(
"Applied block {} at height {} in {}s",
hash, height, elapsed
"{}",
serde_json::to_string_pretty(&json!({
"event": "block_applied",
"block": {
"hash": hash.to_string(),
"height": height
},
"duration_seconds": elapsed
}))?
);
}
Emission::Mempool(mempool_emission) => {
let start_apply_mempool = Instant::now();
wallet.apply_unconfirmed_txs(mempool_emission);
wallet.persist(&mut db)?;
println!(
"Applied unconfirmed transactions in {}s",
start_apply_mempool.elapsed().as_secs_f32()
"{}",
serde_json::to_string_pretty(&json!({
"event": "mempool_applied",
"duration_seconds": start_apply_mempool.elapsed().as_secs_f32()
}))?
);
break;
}
}
}

let wallet_tip_end = wallet.latest_checkpoint();
let balance = wallet.balance();
println!(
"Synced {} blocks in {}s",
blocks_received,
start_load_wallet.elapsed().as_secs_f32(),
);
println!(
"Wallet tip is '{}:{}'",
wallet_tip_end.height(),
wallet_tip_end.hash()
);
println!("Wallet balance is {}", balance.total());
println!(
"Wallet has {} transactions and {} utxos",
wallet.transactions().count(),
wallet.list_unspent().count()
"{}",
serde_json::to_string_pretty(&json!({
"event": "sync_complete",
"blocks_processed": blocks_received,
"total_duration_seconds": start_load_wallet.elapsed().as_secs_f32(),
"final_state": {
"tip": {
"height": wallet_tip_end.height(),
"hash": wallet_tip_end.hash().to_string()
},
"balance": balance.total(),
"transaction_count": wallet.transactions().count(),
"utxo_count": wallet.list_unspent().count()
}
}))?
);

Ok(())
Expand Down