feature: update `bdk-cli` to use `bdk_wallet` v1 #174

tvpeter · 2025-02-03T12:32:19Z

Description

This PR update bdk-cli to use bdk_wallet v1

Issue: #172 (comment)

Notes to the reviewers

replaced list_transactions with transactions
set enable_rbf to be true by default
update creating and serializing Psbts
update new_wallet to return PersistedWallet<Connection>
default fee_rate to use FeeRate::BROADCAST_MIN
update zeroize to version 1.8.1 from <1.4.0
update bdk-reserves from 0.27.1 to 0.29.0
replace bdk/electrum with bdk_electrum for the electrum feature
add bdk_esplora for the bdk/use-esplora-ureq and bdk/use-esplora-reqwest features
add bdk_bitcoind_rpc lib to replace bdk/rpc feature
add hwi library to replace bdk/hardware-signer feature

Changelog notice

set enable_rbf to be true by default
update using PartiallySignedTransaction to Psbt
default fee_rate to use FeeRate::BROADCAST_MIN
update zeroize to version 1.8.1 from <1.4.0
update bdk-reserves from 0.27.1 to 0.29.0
replace bdk/electrum with bdk_electrum for the electrum feature
replace bdk/use-esplora-ureq and bdk/use-esplora-reqwest with bdk_esplora lib
replace bdk/rpc with bdk_bitcoind_rpc lib
replace bdk/hardware-signer with hwi lib

Checklists

All Submissions:

I've signed all my commits
I followed the contribution guidelines
I ran cargo fmt and cargo clippy before committing

Bugfixes:

This pull request breaks the existing API
I'm linking the issue being fixed by this PR

add bdk_wallet to Cargo.toml * the bdk crate is still in using because of the error enum, which will be removed after feedback [Ticket: X]

-update imports from bdk to use bdk_wallet - set `enable_rbf` command option to be `true` by default - add `parse_address` fn to parse address from string - replace `ExtendedPrivateKey` with `Xpriv` from bdk_wallet - update derving address from string to use `assumed_check` [Ticket: X]

- replace `list_transactions` method with `transactions` - format `recipients` to be a vec of `ScriptBuf` and `Amount` - update creating and serializing `Psbt`s - update `fee_rate` method and default to `FeeRate::BROADCAST_MIN` - replace `allow_shrinking` method with `drain_to` method - update `handle_offline_wallet_subcommands` to use `PersistedWallet<D>` instead of `Wallet<D>` [Ticket: X]

- update imports from bdk to bdk_wallet - fix compilation warnings [Ticket: X]

- add `parse_address` method - remove `key-value-db` feature as it uses `sled` - update `open_database` fn to return rusqlite::Connection - update `new_wallet` fn to return `PersistedWallet<Connection>` [Ticket: X]

- Replace `bdk` with `bdk_wallet` v1 in Cargo.toml - replace removed features in bdk features/mods with crates [Ticket: X]

-add error enum for handling errors [Ticket: X]

- replace bdk::error with custom error enum - update imports and handling of errors [Ticket: X]

- update deps imports - refactor reserves feature [Ticket: X]

- replace `bitcoincore_rpc` client with `electrsd::Node` client - update rpc commands - update `electrsd` to v0.31.0 [Ticket: X]

-update error enum - update creating a new_backend [Ticket: X]

notmandatory · 2025-02-18T05:21:11Z

I've been doing some cleanup on your branch, sorry it's squashed all into one commit, see here: https://github.com/notmandatory/bdk-cli/tree/feat/bdk-wallet-v1-update

It works for electrum, esplora, sqlite, and repl mode, but not completely tested. I remove rpc and cbf for now, and cleaned up the features so they can all be enabled together, the recommended way for rust. Do you mind if I push my branch into your PR so you can continue working on it to add rpc and cbf back in. It will overwrite your last commit.

notmandatory · 2025-02-18T05:23:19Z

I also removed the hwi support and proof of reserves. Both of these still need updating for 1.0 so we can leave them out of this PR.

I'd also like to re-think what sort of testing we need, the old tests I commented out. And re-think what we want to do for the github CI.

tvpeter · 2025-02-18T05:33:48Z

Do you mind if I push my branch into your PR so you can continue working on it to add rpc and cbf back in. It will overwrite your last commit.

I don’t mind; you can go ahead and push. Thank you so much.

-update all online wallet subcommands [Ticket: X]

- fix repl

- add ci test for features - add "compiler" feature to bdk_wallet dependency - remove duplicate fn in utils.rs - replace "possible_values" with "value_parser" as it is deprecated in clap 4.5 [Ticket: X]

- remove unavailable features in code_coverage workflow - add more features for the cont_integration workflow - update local compilation test script [Ticket: X]

benalleng · 2025-02-24T14:56:53Z

src/commands.rs

+// #[cfg(test)]
+// mod test {


Will all of the tests here ultimately need to be updated in a follow-up PR?

For now, the emphasis is not to test inputs but to test that features are building correctly, which has been included in the ci directory

However, if you notice any outputs that seem incorrect or if you want specific features or sections tested, please indicate them here.

- re-enable `rpc` feature

-add more error types to error enum - update the handlers file to replace Generic error arm [Ticket: X]

Also when doing an rpc sync, re-sync the prior 200 blocks to handle any possible reorg scenarios.

notmandatory · 2025-03-13T01:59:03Z

Code looks good but I wasn't able to do a round trip test of receiving and sending back bitcoin to a signet faucet using the new rpc feature. I was able to:

sync against local signet bitcoind
get a new_address
receive signet coins from https://signet25.bublina.eu.org/ to my address
see the unconfirmed balance change while the mempool tx was being RBF'ed by the faucet
see the confirmed balance and verify it with https://mempool.space/signet
create and sign a tx that send sSATs back to the signet faucet

I was not able to broadcast this signed TX however. I don't know why, I get the error "PsbtError: invalid magic". Were you able to successfully receive and send coins back to a signet or testnet wallet?

tvpeter · 2025-03-13T07:39:02Z

Code looks good but I wasn't able to do a round trip test of receiving and sending back bitcoin to a signet faucet using the new rpc feature. I was able to:

sync against local signet bitcoind

get a new_address

receive signet coins from https://signet25.bublina.eu.org/ to my address

see the unconfirmed balance change while the mempool tx was being RBF'ed by the faucet

see the confirmed balance and verify it with https://mempool.space/signet

create and sign a tx that send sSATs back to the signet faucet

I was not able to broadcast this signed TX however. I don't know why, I get the error "PsbtError: invalid magic". Were you able to successfully receive and send coins back to a signet or testnet wallet?

I haven’t tested signing and broadcasting on either signet or testnet yet, as I have primarily been working on regtest. I will test on them now to see the outcome.

- fix the returned data after signing or finalizing `psbt` [Ticket: X]

tvpeter · 2025-03-14T03:51:34Z

Code looks good but I wasn't able to do a round trip test of receiving and sending back bitcoin to a signet faucet using the new rpc feature. I was able to:

sync against local signet bitcoind

get a new_address

receive signet coins from https://signet25.bublina.eu.org/ to my address

see the unconfirmed balance change while the mempool tx was being RBF'ed by the faucet

see the confirmed balance and verify it with https://mempool.space/signet

create and sign a tx that send sSATs back to the signet faucet

I was not able to broadcast this signed TX however. I don't know why, I get the error "PsbtError: invalid magic". Were you able to successfully receive and send coins back to a signet or testnet wallet?

The error occurred because the returned PSBT data after signing or finalizing was the original unsigned PSBT instead of the signed PSBT. I have fixed the bug and can now broadcast signed transactions. Apologies for not catching it at my end.

notmandatory

ACK e0bd147

I retested and verified sign and broadcast with rpc is working. Thanks for hanging in there and getting this first big step done!

tvpeter added 5 commits February 3, 2025 12:37

refactor: add bdk_wallet

890cb45

add bdk_wallet to Cargo.toml * the bdk crate is still in using because of the error enum, which will be removed after feedback [Ticket: X]

refactor: update imports from bdk to bdk_wallet

91f5918

- update imports from bdk to bdk_wallet - fix compilation warnings [Ticket: X]

refactor: update imports from bdk to bd_wallet

b56c023

- add `parse_address` method - remove `key-value-db` feature as it uses `sled` - update `open_database` fn to return rusqlite::Connection - update `new_wallet` fn to return `PersistedWallet<Connection>` [Ticket: X]

notmandatory assigned tvpeter Feb 3, 2025

notmandatory added the enhancement New feature or request label Feb 3, 2025

tvpeter added 2 commits February 6, 2025 12:50

feat!: replace bdk with bdk_wallet & update deps

6f263bf

- Replace `bdk` with `bdk_wallet` v1 in Cargo.toml - replace removed features in bdk features/mods with crates [Ticket: X]

feat: add custom error enum

b8d2357

-add error enum for handling errors [Ticket: X]

tvpeter force-pushed the feat/bdk-wallet-v1-update branch from 6653428 to c7bd335 Compare February 6, 2025 12:45

refactor: replace bdk::error with custom error

50233dd

- replace bdk::error with custom error enum - update imports and handling of errors [Ticket: X]

tvpeter force-pushed the feat/bdk-wallet-v1-update branch from c7bd335 to 50233dd Compare February 6, 2025 14:04

tvpeter added 2 commits February 8, 2025 15:23

refactor: update imports and reserves feature

cb4450b

- update deps imports - refactor reserves feature [Ticket: X]

refactor: update nodes.rs file

58f07a1

- replace `bitcoincore_rpc` client with `electrsd::Node` client - update rpc commands - update `electrsd` to v0.31.0 [Ticket: X]

tvpeter force-pushed the feat/bdk-wallet-v1-update branch from 4bf989c to 58f07a1 Compare February 12, 2025 00:17

refactor: update creating_backend fn

440bd36

-update error enum - update creating a new_backend [Ticket: X]

tvpeter and others added 3 commits February 18, 2025 21:49

refactor: update onlinewalletsubcommands

0be8453

-update all online wallet subcommands [Ticket: X]

refactor: remove rpc, cbf, cleanup features

50a6a60

- fix repl

feat: add ci test for features

a2ad6b3

- add ci test for features - add "compiler" feature to bdk_wallet dependency - remove duplicate fn in utils.rs - replace "possible_values" with "value_parser" as it is deprecated in clap 4.5 [Ticket: X]

tvpeter marked this pull request as ready for review February 21, 2025 03:39

ci: update the CI workflow

8ac2529

- remove unavailable features in code_coverage workflow - add more features for the cont_integration workflow - update local compilation test script [Ticket: X]

benalleng reviewed Feb 24, 2025

View reviewed changes

feat: re-enable rpc feature

8307db0

- re-enable `rpc` feature

tvpeter force-pushed the feat/bdk-wallet-v1-update branch 3 times, most recently from c163b95 to b20683a Compare March 9, 2025 18:56

refactor: fix error handling

cb10873

-add more error types to error enum - update the handlers file to replace Generic error arm [Ticket: X]

tvpeter force-pushed the feat/bdk-wallet-v1-update branch from b20683a to cb10873 Compare March 12, 2025 13:57

notmandatory force-pushed the feat/bdk-wallet-v1-update branch 3 times, most recently from f001a48 to 62ca1c4 Compare March 12, 2025 16:45

ci: update actions checkout and cache to v4, simplify matrix features

92cabb1

notmandatory force-pushed the feat/bdk-wallet-v1-update branch 2 times, most recently from 897f7e5 to 2828cee Compare March 12, 2025 17:11

ci: fix clippy errors

efc5fc5

notmandatory force-pushed the feat/bdk-wallet-v1-update branch from 2828cee to efc5fc5 Compare March 12, 2025 17:19

notmandatory added 2 commits March 12, 2025 12:30

ci: with msrv 1.75 pin minreq to 2.13.2

eb947fc

ci: remove WASM job, fix more clippy errors

4a66557

tvpeter force-pushed the feat/bdk-wallet-v1-update branch from ff99cbd to 4a66557 Compare March 12, 2025 20:30

rpc: print status during full_scan and sync

fb7232f

Also when doing an rpc sync, re-sync the prior 200 blocks to handle any possible reorg scenarios.

fix: signing / finalizing psbt

524562c

- fix the returned data after signing or finalizing `psbt` [Ticket: X]

mehmetefeumit mentioned this pull request Mar 14, 2025

add payjoin support #156

Closed

fix: clippy errors

e0bd147

notmandatory approved these changes Apr 13, 2025

View reviewed changes

notmandatory merged commit 2fa18a0 into bitcoindevkit:master Apr 13, 2025
7 checks passed

tvpeter mentioned this pull request Apr 13, 2025

Re-enable cbf client feature using bdk_kyoto #178

Closed

notmandatory mentioned this pull request May 28, 2025

Update to use bdk_wallet 1.0.0 #172

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feature: update `bdk-cli` to use `bdk_wallet` v1 #174

feature: update `bdk-cli` to use `bdk_wallet` v1 #174

Uh oh!

tvpeter commented Feb 3, 2025 •

edited

Loading

Uh oh!

notmandatory commented Feb 18, 2025 •

edited

Loading

Uh oh!

notmandatory commented Feb 18, 2025

Uh oh!

tvpeter commented Feb 18, 2025

Uh oh!

benalleng Feb 24, 2025

Uh oh!

tvpeter Feb 24, 2025

Uh oh!

tvpeter Feb 24, 2025

Uh oh!

notmandatory commented Mar 13, 2025 •

edited

Loading

Uh oh!

tvpeter commented Mar 13, 2025

Uh oh!

tvpeter commented Mar 14, 2025

Uh oh!

notmandatory left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feature: update bdk-cli to use bdk_wallet v1 #174

feature: update bdk-cli to use bdk_wallet v1 #174

Uh oh!

Conversation

tvpeter commented Feb 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Notes to the reviewers

Changelog notice

Checklists

All Submissions:

Bugfixes:

Uh oh!

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

Uh oh!

Uh oh!

notmandatory commented Feb 18, 2025

Uh oh!

tvpeter commented Feb 18, 2025

Uh oh!

benalleng Feb 24, 2025

Choose a reason for hiding this comment

Uh oh!

tvpeter Feb 24, 2025

Choose a reason for hiding this comment

Uh oh!

tvpeter Feb 24, 2025

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

tvpeter commented Mar 13, 2025

Uh oh!

tvpeter commented Mar 14, 2025

Uh oh!

notmandatory left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feature: update `bdk-cli` to use `bdk_wallet` v1 #174

feature: update `bdk-cli` to use `bdk_wallet` v1 #174

tvpeter commented Feb 3, 2025 •

edited

Loading

notmandatory commented Feb 18, 2025 •

edited

Loading

notmandatory commented Mar 13, 2025 •

edited

Loading