Skip to content

fix!: remove panics in tx_graph persistence fns #13

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
110CodingP merged 1 commit into from
Aug 1, 2025
Merged

fix!: remove panics in tx_graph persistence fns #13

Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions src/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#![warn(missing_docs)]
//! This module contains the crate's error type.
use bdk_chain::bitcoin;
use std::io::Error as IoError;

#[derive(Debug, thiserror::Error)]
Expand Down Expand Up @@ -34,4 +35,8 @@ pub enum StoreError {
/// [`BlockHash`]: <https://docs.rs/bitcoin/latest/bitcoin/struct.BlockHash.html>
#[error("BlockHash deserialization error: {0}")]
BlockHashFromSlice(#[from] bdk_chain::bitcoin::hashes::FromSliceError),
/// Error thrown when tx corresponding to txid is not found while persisting
/// anchors, last_seen, last_evicted or first_seen.
#[error("Tx corresponding to txid is missing")]
TxMissing(bitcoin::Txid),
}
90 changes: 63 additions & 27 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,7 @@ impl Store {
bytes[4..].copy_from_slice(&anchor_block.hash.to_byte_array());
table.insert((txid.to_byte_array(), bytes), &anchor.metadata())?;
} else {
panic!("txn corresponding to anchor must exist");
return Err(StoreError::TxMissing(*txid));
}
}
Ok(())
Expand All @@ -504,7 +504,7 @@ impl Store {
if txs_table.get(txid.to_byte_array())?.is_some() || found {
table.insert(txid.to_byte_array(), *last_seen_time)?;
} else {
panic!("txn must exist before persisting last_seen");
return Err(StoreError::TxMissing(*txid));
}
}
Ok(())
Expand All @@ -527,7 +527,7 @@ impl Store {
if txs_table.get(txid.to_byte_array())?.is_some() || found {
table.insert(txid.to_byte_array(), last_evicted_time)?;
} else {
panic!("txn must exist before persisting last_evicted");
return Err(StoreError::TxMissing(*txid));
}
}
Ok(())
Expand All @@ -550,7 +550,7 @@ impl Store {
if txs_table.get(txid.to_byte_array())?.is_some() || found {
table.insert(txid.to_byte_array(), first_seen_time)?;
} else {
panic!("txn must exist before persisting first_seen");
return Err(StoreError::TxMissing(*txid));
}
}
Ok(())
Expand Down Expand Up @@ -1165,28 +1165,39 @@ mod test {
}

#[test]
#[should_panic]
fn test_last_seen_missing_txn() {
// to hit the branch for the panic case in persist_last_seen
let tmpfile = NamedTempFile::new().unwrap();
let db = create_db(tmpfile.path());
let store = create_test_store(Arc::new(db), "wallet1");

let last_seen: BTreeMap<Txid, u64> =
[(hash!("B"), 100), (hash!("T"), 120), (hash!("C"), 121)].into();
let tx1 = Arc::new(create_one_inp_one_out_tx(
Txid::from_byte_array([0; 32]),
30_000,
));
let tx2 = Arc::new(create_one_inp_one_out_tx(tx1.compute_txid(), 20_000));

let last_seen: BTreeMap<Txid, u64> = [
(hash!("B"), 100),
(tx1.compute_txid(), 120),
(tx2.compute_txid(), 121),
]
.into();

let write_tx = store.db.begin_write().unwrap();
let _ = write_tx.open_table(store.txs_table_defn()).unwrap();
let _ = write_tx.open_table(store.last_seen_defn()).unwrap();
write_tx.commit().unwrap();

let txs: BTreeSet<Arc<Transaction>> = BTreeSet::new();
let txs: BTreeSet<Arc<Transaction>> = [tx1, tx2].into();

let write_tx = store.db.begin_write().unwrap();
let read_tx = store.db.begin_read().unwrap();
store
.persist_last_seen(&write_tx, &read_tx, &last_seen, &txs)
.unwrap();
match store.persist_last_seen(&write_tx, &read_tx, &last_seen, &txs) {
Ok(_) => panic!("should give error since tx missing"),
Err(StoreError::TxMissing(txid)) => assert_eq!(txid, hash!("B")),
Err(_) => panic!("error should only be due to missing tx"),
}
write_tx.commit().unwrap();
}

Expand Down Expand Up @@ -1262,15 +1273,24 @@ mod test {
}

#[test]
#[should_panic]
fn test_last_evicted_missing_txs() {
// to hit the branch for the panic case in persist_last_evicted
let tmpfile = NamedTempFile::new().unwrap();
let db = create_db(tmpfile.path());
let store = create_test_store(Arc::new(db), "wallet1");

let last_evicted: BTreeMap<Txid, u64> =
[(hash!("B"), 100), (hash!("D"), 120), (hash!("K"), 132)].into();
let tx1 = Arc::new(create_one_inp_one_out_tx(
Txid::from_byte_array([0; 32]),
30_000,
));
let tx2 = Arc::new(create_one_inp_one_out_tx(tx1.compute_txid(), 20_000));

let last_evicted: BTreeMap<Txid, u64> = [
(hash!("B"), 100),
(tx1.compute_txid(), 120),
(tx2.compute_txid(), 132),
]
.into();

let write_tx = store.db.begin_write().unwrap();
let _ = write_tx.open_table(store.txs_table_defn()).unwrap();
Expand All @@ -1279,13 +1299,15 @@ mod test {
.unwrap();
write_tx.commit().unwrap();

let txs: BTreeSet<Arc<Transaction>> = BTreeSet::new();
let txs: BTreeSet<Arc<Transaction>> = [tx1, tx2].into();

let write_tx = store.db.begin_write().unwrap();
let read_tx = store.db.begin_read().unwrap();
store
.persist_last_evicted(&write_tx, &read_tx, &last_evicted, &txs)
.unwrap();
match store.persist_last_evicted(&write_tx, &read_tx, &last_evicted, &txs) {
Ok(_) => panic!("should give error since tx missing"),
Err(StoreError::TxMissing(txid)) => assert_eq!(txid, hash!("B")),
Err(_) => panic!("error should only be due to missing tx"),
}
write_tx.commit().unwrap();
}

Expand Down Expand Up @@ -1357,28 +1379,39 @@ mod test {
}

#[test]
#[should_panic]
fn test_first_seen_missing_tx() {
// to hit the branch for the panic case persist_first_seen
let tmpfile = NamedTempFile::new().unwrap();
let db = create_db(tmpfile.path());
let store = create_test_store(Arc::new(db), "wallet1");

let first_seen: BTreeMap<Txid, u64> =
[(hash!("B"), 100), (hash!("T"), 120), (hash!("C"), 121)].into();
let tx1 = Arc::new(create_one_inp_one_out_tx(
Txid::from_byte_array([0; 32]),
30_000,
));
let tx2 = Arc::new(create_one_inp_one_out_tx(tx1.compute_txid(), 20_000));

let first_seen: BTreeMap<Txid, u64> = [
(hash!("B"), 100),
(tx1.compute_txid(), 120),
(tx2.compute_txid(), 121),
]
.into();

let write_tx = store.db.begin_write().unwrap();
let _ = write_tx.open_table(store.txs_table_defn()).unwrap();
let _ = write_tx.open_table(store.first_seen_table_defn()).unwrap();
write_tx.commit().unwrap();

let txs: BTreeSet<Arc<Transaction>> = BTreeSet::new();
let txs: BTreeSet<Arc<Transaction>> = [tx1, tx2].into();

let write_tx = store.db.begin_write().unwrap();
let read_tx = store.db.begin_read().unwrap();
store
.persist_first_seen(&write_tx, &read_tx, &first_seen, &txs)
.unwrap();
match store.persist_first_seen(&write_tx, &read_tx, &first_seen, &txs) {
Ok(_) => panic!("should give error since tx missing"),
Err(StoreError::TxMissing(txid)) => assert_eq!(txid, hash!("B")),
Err(_) => panic!("error should only be due to missing tx"),
}
write_tx.commit().unwrap();
}

Expand Down Expand Up @@ -1577,7 +1610,6 @@ mod test {
}

#[test]
#[should_panic]
fn test_anchors_missing_tx() {
// to hit the branch for the panic case in persist_anchors
let tmpfile = NamedTempFile::new().unwrap();
Expand All @@ -1602,7 +1634,11 @@ mod test {

let write_tx = store.db.begin_write().unwrap();
let read_tx = store.db.begin_read().unwrap();
let _ = store.persist_anchors(&write_tx, &read_tx, &anchors_missing_txs, &txs);
match store.persist_anchors(&write_tx, &read_tx, &anchors_missing_txs, &txs) {
Ok(_) => panic!("should give error since tx missing"),
Err(StoreError::TxMissing(txid)) => assert_eq!(txid, hash!("B")),
Err(_) => panic!("error should only be due to missing tx"),
}
read_tx.close().unwrap();
write_tx.commit().unwrap();
}
Expand Down
Loading