Add functions to test persistence by 110CodingP · Pull Request #2012 · bitcoindevkit/bdk

110CodingP · 2025-08-12T19:25:20Z

Description

Added basic tests to the testenv for testing custom persistence backends. Partially solves bdk_wallet#14 and might help with bdk_wallet#234.

Notes to the reviewers

An alternative approach could be to create a struct whose methods are these tests but the current approach seems better since these tests are meant to be used as unit tests. For the same reason redundant functions to check persistence of individual fields of the ChangeSets are provided.

Changelog notice

Added
   - `miniscript` feature to testenv which depends on `bdk_chain/miniscript` .
    - functions to testenv to check `ChangeSet`s are persisted and merged `ChangeSet`s are loaded properly ,gated by the `miniscript` and `std` feature flags.
    - tests to `file_store` and `chain` based on utilities added to `testenv`.
 Changed
   - default feature of testenv to also activate `miniscript` feature.

Todo

Add docs
Add tests to bdk_chain based on testenv utilities

Checklists

All Submissions:

I followed the contribution guidelines

New Features:

I've added tests for the new feature
I've added docs for the new feature

ValuedMammal · 2025-08-20T14:42:18Z

I tried re-running CI to no avail, maybe try force pushing.

evanlinjin · 2025-08-29T05:34:58Z

Great idea. ConceptACK

crates/testenv/src/persist_test_utils.rs

110CodingP · 2025-09-14T18:56:51Z

In 10c42dc I added a miniscript feature to testenv but I am not sure if this is the correct approach. Earlier I was including the miniscript feature of bdk_chain by default but that doesn't work since miniscript requires either std or no-std but cargo doesn't allow specifying the feature of a dependency of a dependency. Adding miniscript as a separate dependency also does not work since we require bdk_chain/miniscript. But the current solution is also not satisfactory since miniscript feature requires the std feature!

ValuedMammal · 2025-09-20T13:47:40Z

In 10c42dc I added a miniscript feature to testenv but I am not sure if this is the correct approach. Earlier I was including the miniscript feature of bdk_chain by default but that doesn't work since miniscript requires either std or no-std but cargo doesn't allow specifying the feature of a dependency of a dependency. Adding miniscript as a separate dependency also does not work since we require bdk_chain/miniscript. But the current solution is also not satisfactory since miniscript feature requires the std feature!

We could have the testenv default feature enable bdk_chain/default, which in turn enables miniscript/std. I'm not aware of anyone needing a miniscript/no-std feature for the testenv crate.

110CodingP · 2025-09-22T17:07:28Z

Should the miniscript feature introduced be removed? I was thinking if some users might not want bdk_chain/miniscript feature to be enabled?

110CodingP · 2025-09-24T08:24:51Z

miniscript feature still depends on std feature of testenv since ig it would be confusing otherwise like when miniscript is enabled but not std even though miniscript would activate bdk_chain/std. Made miniscript a default feature too. Sorry if I am overthinking 😅 .

crates/testenv/Cargo.toml

notmandatory · 2025-09-24T20:07:02Z

~~Since this is currently based on the master branch should we re-assign this to the 3.0 milestone and then do a new PR to back port it to 2.2?~~ Nevermind, this is for the bdk crate so my question doesn't apply.

notmandatory

Looks good! I made a couple comments and it needs a rebase and then I think it's ready to go.

notmandatory · 2026-02-17T21:39:16Z

crates/chain/tests/test_rusqlite_impl.rs

+            let db_tx = db.transaction()?;
+            tx_graph::ChangeSet::<ConfirmationBlockTime>::init_sqlite_tables(&db_tx)?;
+            let changeset = tx_graph::ChangeSet::<ConfirmationBlockTime>::from_sqlite(&db_tx)?;
+            db_tx.commit()?;
+            Ok(changeset)


Can this be extracted into a function rather than being duplicated?

notmandatory · 2026-02-17T21:39:35Z

crates/chain/tests/test_rusqlite_impl.rs

+            let db_tx = db.transaction()?;
+            changeset.persist_to_sqlite(&db_tx)?;
+            Ok(db_tx.commit()?)


Same question as above.

Done in 6f09bde.

notmandatory · 2026-02-17T21:48:34Z

crates/testenv/src/persist_test_utils.rs

+        last_evicted: [(tx1.compute_txid(), 1755416660)].into(),
+    };
+
+    // persist and load


⛏️ Docs should follow the rust style guidelines with first line starts with a capital letter and ends with a period.

https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html

Sorry for the delay. Done in 70a3662.

oleonardolima · 2026-03-19T21:53:07Z

I moved this to chain-0.24.0 milestone for visibility, @110CodingP let us know when it's ready for another round of review.

Added the following functions to test if persistence of `bdk_chain` is happening correctly. - `persist_txgraph_changeset` - `persist_indexer_changeset` - `persist_local_chain_changeset` - `persist_last_seen`, `persist_last_evicted`, `persist_first_seen` - `persist_txouts` - `persist_txs` - `persist_anchors` - `persist_last_revealed` - `persist_spk_cache` Even though the first three tests cover every part of the `ChangeSet`s , the other tests are retained so as to help in unit testing.

110CodingP · 2026-04-01T12:51:20Z

Since we use v13 of miniscript now, I finally added a miniscript feature to testenv and made it a default feature. The test-utils are now gated by miniscript and std features of testenv.

notmandatory · 2026-04-01T15:30:12Z

This PR will be important to have if we still want to do #1980 to help test persistence implementations.

github-project-automation bot added this to BDK Chain Aug 12, 2025

LagginTimes assigned 110CodingP Aug 13, 2025

110CodingP force-pushed the add_persist_test_utils branch 3 times, most recently from 8f06dc6 to 247d478 Compare August 15, 2025 11:53

110CodingP marked this pull request as ready for review August 15, 2025 13:13

notmandatory mentioned this pull request Aug 18, 2025

refactor!: Implement generics for CheckPoint, LocalChain, and spk_client types #1582

Merged

3 tasks

notmandatory moved this to Needs Review in BDK Chain Aug 19, 2025

110CodingP force-pushed the add_persist_test_utils branch from 247d478 to 83b54a6 Compare August 19, 2025 05:33

110CodingP force-pushed the add_persist_test_utils branch from 83b54a6 to 51d148e Compare August 20, 2025 15:44

ValuedMammal added this to BDK Wallet Aug 21, 2025

ValuedMammal moved this to Needs Review in BDK Wallet Aug 21, 2025

ValuedMammal added this to the Wallet 2.2.0 milestone Aug 21, 2025

oleonardolima added new feature New feature or request tests labels Aug 29, 2025

oleonardolima reviewed Sep 12, 2025

View reviewed changes

110CodingP force-pushed the add_persist_test_utils branch 2 times, most recently from f2623db to b77a114 Compare September 14, 2025 18:14

110CodingP force-pushed the add_persist_test_utils branch 2 times, most recently from 1eee95b to fd9429c Compare September 24, 2025 08:22

ValuedMammal reviewed Sep 24, 2025

View reviewed changes

crates/testenv/Cargo.toml Show resolved Hide resolved

ValuedMammal removed this from BDK Wallet Sep 25, 2025

ValuedMammal removed this from the Wallet 2.2.0 milestone Oct 1, 2025

ValuedMammal added this to the Wallet 3.0.0 milestone Oct 1, 2025

notmandatory requested changes Feb 17, 2026

View reviewed changes

oleonardolima modified the milestones: Wallet 3.0.0, Chain 0.24.0 Mar 19, 2026

110CodingP force-pushed the add_persist_test_utils branch from c4b6873 to d56cea9 Compare April 1, 2026 11:41

110CodingP requested review from evanlinjin, luisschwab, nymius and tvpeter as code owners April 1, 2026 11:41

110CodingP force-pushed the add_persist_test_utils branch 2 times, most recently from 392160f to 6d1738b Compare April 1, 2026 12:19

110CodingP added 2 commits April 1, 2026 18:11

test: use test utils to test file_store and sqlite

6f09bde

110CodingP force-pushed the add_persist_test_utils branch from 6d1738b to 6f09bde Compare April 1, 2026 12:41

Conversation

110CodingP commented Aug 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Notes to the reviewers

Changelog notice

Todo

Checklists

All Submissions:

New Features:

Uh oh!

ValuedMammal commented Aug 20, 2025

Uh oh!

evanlinjin commented Aug 29, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

110CodingP commented Sep 14, 2025

Uh oh!

ValuedMammal commented Sep 20, 2025

Uh oh!

110CodingP commented Sep 22, 2025

Uh oh!

110CodingP commented Sep 24, 2025

Uh oh!

Uh oh!

notmandatory commented Sep 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

notmandatory left a comment

Choose a reason for hiding this comment

Uh oh!

notmandatory Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

notmandatory Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

110CodingP Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

notmandatory Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

110CodingP Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

oleonardolima commented Mar 19, 2026

Uh oh!

110CodingP commented Apr 1, 2026

Uh oh!

notmandatory commented Apr 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

110CodingP commented Aug 12, 2025 •

edited

Loading

notmandatory commented Sep 24, 2025 •

edited

Loading

110CodingP Apr 1, 2026 •

edited

Loading