docs(wallet): add `sync` operation to `bdk_wallet` examples #274

tvpeter · 2025-06-30T16:52:27Z

Description

This PR adds sync operation to bdk_wallet examples for electrum and esplora clients.

Fixes #253

Checklists

All Submissions:

I've signed all my commits
I followed the contribution guidelines
I ran just p before pushing

coveralls · 2025-06-30T16:57:12Z

Pull Request Test Coverage Report for Build 16763241238

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 84.888%

Totals
Change from base Build 16730629587:	0.0%
Covered Lines:	6651
Relevant Lines:	7835

💛 - Coveralls

oleonardolima

cACK 8e1a6ef

I left a few comments that I think are applicable. Also, I was unable to test the electrum example locally (I guess it's a local problem on my end).

I think it's a good opportunity to also add a forced eviction, and show that to the user. WDYT?

Any reason to not add the sync usage to blocking esplora example ?

examples/example_wallet_electrum/src/main.rs

tvpeter · 2025-07-02T02:27:08Z

I think it's a good opportunity to also add a forced eviction, and show that to the user. WDYT?

Alright, I will do that.

Any reason to not add the sync usage to blocking esplora example ?

No reason, I will also add that.

Thank you for the review. I will make updates.

tvpeter · 2025-07-04T11:31:30Z

I think it's a good opportunity to also add a forced eviction, and show that to the user. WDYT?

Alright, I will do that.

I have added the eviction logic that identifies transactions that were unconfirmed before a partial sync but are no longer canonical after the sync.

Any reason to not add the sync usage to blocking esplora example ?

No reason, I will also add that.

I have also added the sync to the esplora blocking example.

Another thing I considered was reducing the output of the full scan by a multiple of say 5 or 10 as it is getting lengthy.

examples/example_wallet_esplora_blocking/src/main.rs

notmandatory · 2025-07-30T20:30:55Z

I pushed a new commit to fix a couple things I found while testing:

for electrum, esplora examples they all now use sqlite+testnet and print mempool.space URLs for created txids
for esplore examples I get the fee rate estimate from explora rather than using the default 1 sat/vb
for the RPC example I added a justfile to help testing with regtest bitcoind

notmandatory

tACK ce0a17e

examples/example_wallet_rpc/justfile

examples/example_wallet_esplora_async/src/main.rs

oleonardolima · 2025-08-01T14:18:14Z

I'm not sure why, but now that it's using testnet instead of signet, I keep getting timeout errors and the RBF fails because the transaction is already mined in within that timeframe.

- add partial syncing to electrum, esplora_async and esplora_blocking examples - add applying evicted txns to wallet in electrum, esplora_async and esplora_blocking examples

notmandatory · 2025-08-02T23:04:11Z

I'm not sure why, but now that it's using testnet instead of signet, I keep getting timeout errors and the RBF fails because the transaction is already mined in within that timeframe.

I switched it to use mempool.space and testnet4 which seem to be more reliable. It's also easier to get testnet4 coins from mempool.space since all you need to do is login with your GitHub account. And I cleaned up the just file for RPC to use the stop command, good suggestion @oleonardolima.

tvpeter · 2025-08-03T18:23:22Z

@ValuedMammal following your comments on the issue here, I have removed the step that call the Wallet::apply_evicted_txs to evict txs.

Thank you.

notmandatory

ACK bb4d79b

oleonardolima

partial tACK bb4d79b

I've test for all examples, both esplora and electrum works just fine.

I found a problem in the wallet_rpc one, I've left it as a comment.

examples/example_wallet_rpc/src/main.rs

… mempool.space For electrum, esplora examples print mempool.space tx URLs and add delay before RBF. For rpc example also add justfile to help testing with regtest bitcoind.

oleonardolima

tACK 11bfc2f

github-project-automation bot added this to BDK Wallet Jun 30, 2025

tvpeter changed the title ~~docs(wallet): add sync operation to bdk_wallet examples for electrum and esplora~~ docs(wallet): add sync operation to bdk_wallet examples Jun 30, 2025

notmandatory assigned tvpeter Jul 1, 2025

notmandatory added the documentation Improvements or additions to documentation label Jul 1, 2025

notmandatory moved this to Needs Review in BDK Wallet Jul 1, 2025

notmandatory added this to the Wallet 2.1.0 milestone Jul 1, 2025

oleonardolima reviewed Jul 1, 2025

View reviewed changes

examples/example_wallet_electrum/src/main.rs Show resolved Hide resolved

examples/example_wallet_electrum/src/main.rs Outdated Show resolved Hide resolved

examples/example_wallet_electrum/src/main.rs Outdated Show resolved Hide resolved

tvpeter force-pushed the doc/wallet-sync-example branch 3 times, most recently from 98cb6b9 to 4130f46 Compare July 4, 2025 11:15

tvpeter requested a review from oleonardolima July 4, 2025 11:37

tvpeter force-pushed the doc/wallet-sync-example branch from 4130f46 to 50dacbf Compare July 9, 2025 14:54

oleonardolima reviewed Jul 22, 2025

View reviewed changes

examples/example_wallet_esplora_blocking/src/main.rs Show resolved Hide resolved

tvpeter force-pushed the doc/wallet-sync-example branch 2 times, most recently from 5cf1d52 to cd29221 Compare July 29, 2025 10:17

notmandatory approved these changes Jul 30, 2025

View reviewed changes

oleonardolima reviewed Aug 1, 2025

View reviewed changes

examples/example_wallet_rpc/justfile Outdated Show resolved Hide resolved

examples/example_wallet_rpc/justfile Outdated Show resolved Hide resolved

examples/example_wallet_rpc/justfile Show resolved Hide resolved

oleonardolima reviewed Aug 1, 2025

View reviewed changes

examples/example_wallet_esplora_async/src/main.rs Outdated Show resolved Hide resolved

tvpeter added 3 commits August 1, 2025 17:43

docs(wallet): add sync to bdk_wallet examples

67ee040

- add partial syncing to electrum, esplora_async and esplora_blocking examples - add applying evicted txns to wallet in electrum, esplora_async and esplora_blocking examples

docs(wallet): fix clippy warnings

fabd2d9

docs(wallet): add bumping tx to examples

5d2d25f

tvpeter force-pushed the doc/wallet-sync-example branch 4 times, most recently from 75178be to ae7af35 Compare August 1, 2025 17:27

notmandatory force-pushed the doc/wallet-sync-example branch 2 times, most recently from f31ae60 to 10f56f5 Compare August 2, 2025 23:03

tvpeter force-pushed the doc/wallet-sync-example branch from 10f56f5 to ade903d Compare August 3, 2025 18:17

notmandatory force-pushed the doc/wallet-sync-example branch from ade903d to bb4d79b Compare August 4, 2025 17:54

notmandatory approved these changes Aug 4, 2025

View reviewed changes

oleonardolima reviewed Aug 5, 2025

View reviewed changes

examples/example_wallet_rpc/src/main.rs Outdated Show resolved Hide resolved

docs(wallet): for electrum, esplora examples use sqlite+testnet4, and…

11bfc2f

… mempool.space For electrum, esplora examples print mempool.space tx URLs and add delay before RBF. For rpc example also add justfile to help testing with regtest bitcoind.

notmandatory force-pushed the doc/wallet-sync-example branch from bb4d79b to 11bfc2f Compare August 5, 2025 23:02

oleonardolima approved these changes Aug 5, 2025

View reviewed changes

notmandatory merged commit d0a0abc into bitcoindevkit:master Aug 6, 2025
20 checks passed

github-project-automation bot moved this from Needs Review to Done in BDK Wallet Aug 6, 2025

docs(wallet): add sync operation to bdk_wallet examples #274

docs(wallet): add sync operation to bdk_wallet examples #274

Conversation

tvpeter commented Jun 30, 2025

Description

Checklists

All Submissions:

Uh oh!

coveralls commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 16763241238

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

Uh oh!

oleonardolima left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tvpeter commented Jul 2, 2025

Uh oh!

tvpeter commented Jul 4, 2025

Uh oh!

Uh oh!

notmandatory commented Jul 30, 2025

Uh oh!

notmandatory left a comment • 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

oleonardolima commented Aug 1, 2025

Uh oh!

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

Uh oh!

Uh oh!

tvpeter commented Aug 3, 2025

Uh oh!

notmandatory left a comment

Choose a reason for hiding this comment

Uh oh!

oleonardolima left a comment • 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!

Uh oh!

oleonardolima left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

docs(wallet): add `sync` operation to `bdk_wallet` examples #274

docs(wallet): add `sync` operation to `bdk_wallet` examples #274

coveralls commented Jun 30, 2025 •

edited

Loading

notmandatory left a comment •

edited

Loading

notmandatory commented Aug 2, 2025 •

edited

Loading

oleonardolima left a comment •

edited

Loading