Release 3.0.0

Release 3.0.0

This is version 3.0.0 of the BDK language bindings! This release uses the following Rust dependencies:

• bdk_wallet 3.0.0
• bdk_electrum 0.24.0
• bdk_esplora 0.22.2
• bdk_kyoto 0.17.0
• bitcoin 0.32.8
• uniffi 0.30.0

Breaking

• The DescriptorSecretKey::new constructor does not produce an extended key with an automatic wildcard anymore #853
• Descriptor and DescriptorSecretKey constructors now require a NetworkKind #986

Added

• Expose miniscript has_wildcard and sanity_check methods on Descriptor type #945
• Expose new_wsh_sortedmulti and new_pk methods on Descriptor type #949
• Expose new_sh_sortedmulti, new_sh_wsh_sortedmulti, new_pkh, new_wpkh, new_sh_wpkh methods on Descriptor type #973
• Expose wallet event helpers Wallet::apply_unconfirmed_txs_events and Wallet::apply_evicted_txs_events #971
• Expose wallet scan/sync helpers Wallet::start_full_scan_at, Wallet::start_sync_with_revealed_spks_at, and Wallet::checkpoints #971
• Expose locked outpoint wallet APIs and locked outpoint persistence in ChangeSet #971
• Expose transaction builder controls for sighash, transaction ordering, and adding foreign UTXOs with explicit sequence values #971
• Expose Persister::get_pre_v1_wallet_keychains for pre-v1 SQLite wallet migration support #971
• Expose NetworkKind type #986
• New WildcardType enum #853
• New DescriptorPublicKey::add_wildcard method, which adds an unhardened wildcard to the derivation path of the descriptor #853
• New DescriptorSecretKey::add_wildcard(wildcard_type: WildcardType) method, which adds a wildcard to the derivation path of the descriptor #853
• Exposed new_sh, new_wsh,new_bare and new_sh_wsh methods on Descriptor type #988
• Add optional timeout and retry parameters to the Electrum client constructor #1010

Auto-Generated Release Notes

Added

• Electrum params (3.0) by @reez in #1011

Fixed

• Bump miniscript to 12.3.7 patch by @thunderbiscuit in #1014

Needs Label Review

• Validate add_foreign_utxo inputs at method boundary by @reez in #944
• Update cargo.lock by @thunderbiscuit in #947
• Bump Rust to 1.90.0 by @thunderbiscuit in #948
• Post release fixes by @thunderbiscuit in #954
• feat: Expose miniscript has_wildcard and sanity_check by @ItoroD in #945
• test: Add test for descriptor types. by @ItoroD in #943
• Upgrade the Android build scripts and workflow by @thunderbiscuit in #952
• Update bdk_kyoto to 0.15.4 by @rustaceanrob in #953
• Fix iOS deployment target for bdk-swift by @maltsevoff in #958
• Update link for android api docs by @thunderbiscuit in #963
• Cleanup of unused workflows and bump of Android plugin by @thunderbiscuit in #966
• Enable building Rust API docs by @thunderbiscuit in #951
• feat: Add new_wsh_sortedmulti and new_pk by @ItoroD in #949
• feat: Add miniscript key descriptor methods by @ItoroD in #973
• Add reminder to bump the cargo.toml version before building docs by @thunderbiscuit in #972
• Expose validate_domain config in electrum constructor by @newtonick in #975
• Use FeeRate type in TxDetails fee_rate field by @thunderbiscuit in #933
• ci: run swift tests on macos-15 by @reez in #976
• chore: bump bdk_wallet 3.0.0 and bdk_kyoto 0.16.0 by @reez in #978
• test: ignore live mutinynet tx_builder tests by @reez in #980
• feat(kyoto): Add peer_info method for IPv4/6 peer connections by @rustaceanrob in #979
• Add test for Esplora client on Regtest by @thunderbiscuit in #967
• test: add offline wallet smoke tests by @j-kon in #974
• test: remove noisy print statements by @j-kon in #982
• Add small Kyoto integration test by @thunderbiscuit in #965
• refactor: use types::KeychainKind where appropriate by @thunderbiscuit in #985
• docs: fix readme section on local android build by @thunderbiscuit in #984
• 3.0 by @reez in #971
• Update Cargo.lock file by @thunderbiscuit in #989
• Expose the NetworkKind type by @thunderbiscuit in #986
• chore: remove trailing whitespace by @reez in #990
• ci: check pr diff whitespace by @reez in #991
• Require explicit wildcard derivation for descriptor key types by @thunderbiscuit in #853
• feat: Add descriptor miniscript constructor method by @ItoroD in #988
• Changelog by @reez in #992

New Contributors

• @newtonick made their first contribution in #975
• @j-kon made their first contribution in #974

Full Changelog: v2.3.1...v3.0.0

v2.3.1

This is version 2.3.1 of the BDK language bindings. This release bumps the following Rust dependencies:

Dependency	Version
bdk_kyoto	0.15.4

What's Changed

• Backport Android build/publish workflow and publication plugin changes (#952)
• Update bdk_kyoto to 0.15.4 (panic fix) (#953)
• Set iOS deployment target in bdk-swift xcframework build scripts (#958)

Full Changelog: v2.3.0...v2.3.1

v2.3.0

Release 2.3.0

This is version 2.3.0 of the BDK language bindings. This release uses the following Rust dependencies:

Dependency	Version
bdk_wallet	2.3.0
bdk_electrum	0.23.2
bdk_esplora	0.22.1
bdk_kyoto	0.15.3
rust-bitcoin	0.32.7
uniffi	0.30.0

Added

• Expose Wallet::apply_update_events which returns a WalletEvent type #908
• Expose Psbt::output which returns a list of psbt Output #903
• Other variant added to CBF RecoveryPoint to enable wallet birthdays #920
• Implement Display trait for FeeRate #859
• Expose FeeRate::fee_vb and FeeRate::fee_wu methods #859
• Wallet API: expose TxBuilder::only_witness_utxo and TxBuilder::add_foreign_utxo #928
• Esplora API: expose get_block_by_hash which returns a Block #936
• Esplora API: expose get_tip_hash #930
• Esplora API: expose get_header_by_hash #930
• Esplora API: expose get_address_txs #930
• Esplora API: expose get_tx_no_opt #930
• Esplora API: expose get_txid_at_block_index #930
• Esplora API: expose get_merkle_proof and get_output_status #942
• Electrum API: expose fetch_tx #931
• Electrum API: expose block_header #931
• Electrum API: expose block_headers_pop #931
• Electrum API: expose relay_fee and transaction_get_raw #938
• DerivationPath: expose child, extend, and to_u32_vec #935

Auto-Generated Changes Log

• Fix audit workflow by @thunderbiscuit in #898
• Post Release Fixes by @thunderbiscuit in #900
• fix(kyoto): Spawn dedicated thread for DNS by @rustaceanrob in #902
• deps: uniffi 0.30.0 by @reez in #883
• New stuff on the FeeRate type by @thunderbiscuit in #859
• Fixes to changelog by @thunderbiscuit in #907
• Add development script and commands by @thunderbiscuit in #901
• Bump bdk_kyoto patch release by @rustaceanrob in #910
• feat: Add wallet event by @ItoroD in #908
• feat: Expose psbt output by @ItoroD in #903
• chore: add swift development script and commands by @reez in #914
• fix: Remove unwanted software in android test CI runner by @ItoroD in #918
• feat(kyoto): Add optional new wallet sync height by @rustaceanrob in #920
• fix: Stop removal of large files in android CI by @ItoroD in #922
• feat: expose derived_address helper on Descriptor by @reez in #916
• Bump bdk_wallet dependency to 2.3.0 by @thunderbiscuit in #923
• add lib crate-type to bdk-ffi to be able to reuse it for other bindings like bdk-dart by @kumulynja in #924
• Esplora additions by @reez in #930
• Electrum additions by @reez in #931
• Fix module.modulemap build conflict with other packages by @maltsevoff in #925
• feat(electrum): Add relay_fee and transaction_get_raw by @ItoroD in #938
• chore: Bump ext test lib to 1.3.0 by @ItoroD in #937
• feat: Add method to get block by hash for esplora by @ItoroD in #936
• feat: Add derivation path child and extend methods by @ItoroD in #935
• feat: expose only_witness_utxo and add_foreign_utxo on TxBuilder by @kumulynja in #928
• feat(esplora): Add get_merkle_proof and get_output_status by @ItoroD in #942

New Contributors

• @kumulynja made their first contribution in #924
• @maltsevoff made their first contribution in #925

Full Changelog: v2.2.0...v2.3.0

Release 2.2.0

This release uses the following Rust dependencies:

Dependency	Version
bdk_wallet	2.2.0
bdk_electrum	0.23.2
bdk_esplora	0.22.1
bdk_kyoto	0.15.0
rust-bitcoin	0.32.7
uniffi	0.29.4

Added

• Implement Display for Script #813
• Expose Wallet::create_single constructor on Wallet type #825
• Set lookahead on Wallet::load #829
• Expose Wallet::apply_evicted_txs method #832
• Add Wallet::create_from_two_path_descriptor constructor #847
• next_log and LogLevel are removed from kyoto #849
• Updates Android native libraries to use 16KB page sizes #865
• Expose TxBuilder::exclude_unconfirmed method #870
• Expose TxBuilder::exclude_below_confirmations method #870
• Throw errors rather than panics on faulty Esplora sync/full_scan operations #863
• Expose Wallet::insert_txout #884
• Expose Wallet::nmark_used #882
• Add Wallet::load_single #897
• Expose DerivationPath::master , DerivationPath::is_master , DerivationPath::len , DerivationPath::is_empty #893

Auto-Generated Release Notes

• feat: Add multisig example by @ItoroD in #812
• docs: Add how to run example files to readme by @ItoroD in #817
• Add changelog for 2.0.0 release by @thunderbiscuit in #820
• Make a runtime environment for DNS for Kyoto by @rustaceanrob in #814
• Export Display for Script by @rustaceanrob in #813
• Remove Python by @thunderbiscuit in #815
• Remove nexus-publishing plugin by @thunderbiscuit in #822
• Add Descriptor::desc_type method by @thunderbiscuit in #688
• Bump uniffi to 0.29.4 by @thunderbiscuit in #823
• Remove bdk-jvm libary by @thunderbiscuit in #824
• Set lookahead with Wallet::load by @rustaceanrob in #829
• Apply evicted transactions by @rustaceanrob in #832
• Remove jvm weekly tests by @thunderbiscuit in #833
• chore: update to alpha snapshot by @reez in #830
• chore: bump bdk_wallet to 2.1.0 and clients to latest versions by @thunderbiscuit in #835
• Fix workflow to build api docs for android by @thunderbiscuit in #839
• Test Android library in CI by @thunderbiscuit in #826
• feat: Create trigger workflow trigger for bdk-jvm by @ItoroD in #840
• Fix bdk-jvm trigger by @thunderbiscuit in #841
• Clean up android instrumented tests by @thunderbiscuit in #845
• Expose Wallet::create_from_two_path_descriptor constructor by @thunderbiscuit in #847
• ci: remove kyoto live test sync by @reez in #848
• fix(kyoto): Remove the Debug logs from public API by @rustaceanrob in #849
• Migrate Network type to proc macros (and remove the last of the UDL)! by @thunderbiscuit in #850
• Update Rust compiler to 1.85.1 by @thunderbiscuit in #851
• Expose Wallet::create_single method by @thunderbiscuit in #825
• Remove the live weekly Swift tests by @reez in #854
• Remove uniffi build_foreign_language_testcases tests by @thunderbiscuit in #858
• Small refactors of Cargo.toml file by @thunderbiscuit in #857
• CI Worflow Review + Cleanup by @thunderbiscuit in #856
• Increase page sizes on Android platforms to 16KB by @ReneeVandervelde in #865
• Move Rust tests into their own separate module by @thunderbiscuit in #861
• fix: catch esplora panics and return parsing error by @reez in #863
• feat: Add exclude_unconfirmed to tx_builder by @ItoroD in #870
• CI: Add trigger event for bdk-python library by @mg-twentyone in #868
• Bump bdk_kyoto version by @rustaceanrob in #864
• Bump bdk_wallet to 2.2.0 by @thunderbiscuit in #871
• Update release template by @thunderbiscuit in #873
• Update readme for 2.2.0 release by @thunderbiscuit in #874
• Reduce stack allocation in CBF by @rustaceanrob in #878
• feat: Add Input for PSBT by @ItoroD in #846
• feat: expose Wallet::unmark_used by @reez in #882
• feat: expose insert_txout on Wallet by @reez in #884
• feat: expose staged and take_staged on Wallet by @reez in #885
• Small cleanup of our visibility modifiers by @thunderbiscuit in #876
• refactor: descriptor errors instead of panicking on invalid fingerprints by @reez in #880
• chore: pr template checklist changelog by @reez in #887
• Update cargo.lock file by @thunderbiscuit in #891
• Bump bdk_kyoto patch release by @rustaceanrob in #894
• fix: surface electrum error when server returns invalid genesis hash by @reez in #881
• Refactor DerivationPath to use tuple by @thunderbiscuit in #895
• Add DerivationPath helper methods by @ItoroD in #893
• chore: add upstream doc links to pr template by @reez in #896
• Enable loading of single-descriptor wallets by @thunderbiscuit in #897

New Contributors

• @ReneeVandervelde made their first contribution in #865
• @mg-twentyone made their first contribution in #868

Full Changelog: v2.0.0...v2.2.0

v2.0.0

This release brings bdk-ffi to it's 2.0.0 version!

The release uses the following Rust dependencies:

• bdk_wallet 2.0.0
• bdk_electrum 0.23.0
• bdk_esplora 0.22.0
• bdk_kyoto 0.13.1
• uniffi 0.29.1
• rust-bitcoin 0.32.6

Added

• PSBT file operations: read and write PSBT files #800
• New Psbt::from_unsigned_tx constructor #802
• New Psbt::spend_utxo method #798
• Arbitrary persistence for wallet #771
• Wallet changeset primitives #756
• Display implementation for Transaction #799
• Descriptor::max_weight_to_satisfy method #794
• Expose Wallet::public_descriptor #786
• Expose Wallet::tx_details #778
• Expose Wallet::latest_checkpoint #761
• TxGraphChangeSet::first_seen and last_evicted fields #782
• from_string constructors for hash types #784
• Transaction::wtxid method #773
• Kyoto: average feerate and connect functionality #797

Changed

• Use Amount type in TxOut instead of u64 #781
• Update to latest bdk_kyoto with API changes #772
• Add lookahead as optional argument to wallet methods
  #770

Fixed

• Export public types from Script #763
• Change object to record for struct with fields #738

v1.2.0

This release brings in a new experimental compact block filters client!

The release uses the following Rust dependencies:
- bdk_wallet 1.2.0
- bdk_electrum 0.21.0
- bdk_esplora 0.20.1
- bdk_kyoto 0.8.0
- uniffi 0.29.1
- rust-bitcoin 0.32.5

Added

- New CBF client (Kyoto) [#591], [#716]
- Add optional `proxy` parameter to Esplora client constructor [#711]
- Add optional `socks5` parameter to Electrum client constructor [#711]
- Add `ElectrumClient::ping` method [#689]
- New API docs for a lot of types
- Add `Wallet::apply_unconfirmed_txs` method [#704]
- Add `UnconfirmedTx` type [#704]

Changed

- The `Amount::from_sat` constructor renamed its `sat` argument to `satoshi` [#708]

v1.1.0

This is our first 1.0 stable release!

Dependencies

This release uses the following Rust dependencies:

Library	Version
bdk_wallet	1.1.0
bdk_electrum	0.21.0
bdk_esplora	0.20.1
rust-bitcoin	0.32.5
uniffi	0.29.0

Changelog

Added

• Expose ElectrumClient::block_headers_subscribe method #664
• Expose EsploraClient::get_block_hash method #665
• Expose EsploraClient::get_tx_status method #666
• Expose EsploraClient::get_tx_info method #666
• Support for Testnet 4 #674
• Add AddressData and WitnessProgram types from rust bitcoin #671
• Expose Address::to_address_data method #671

Changed

• More complete LocalOutput type #667

Automated Release Notes

• Update download-artifact action to v4 by @thunderbiscuit in #659
• Steps 28/29/30 of release process by @reez in #656
• Print satoshi amounts in all tests by @thunderbiscuit in #661
• Add get_block_hash to esplora by @reez in #665
• Add get_tx_status and get_tx_info to Esplora by @reez in #666
• Fix LiveTransactionTest JVM test name by @thunderbiscuit in #670
• Add more fields to LocalOutput by @reez in #667
• feat: add to_address_data to address type by @reez in #671
• Upgrade to bdk_wallet 1.1.0 and bdk_electrum to 0.21.0 by @thunderbiscuit in #672
• Remove bitcoin ffi by @thunderbiscuit in #674
• Upgrade to uniffi 0.29.0 by @thunderbiscuit in #677
• Use macros where possible by @thunderbiscuit in #678
• feat: expose ElectrumClient::block_headers_subscribe method by @thunderbiscuit in #664
• General fixes by @thunderbiscuit in #682
• Prepare 1.1.0-rc.1 by @thunderbiscuit in #683

Full Changelog: v1.0.0-beta.7...v1.1.0

Release 1.1.0-rc.1

This is our first 1.0 release candidate! Please consider helping us test it and provide feedback if you have any.

Dependencies

This release uses the following Rust dependencies:

Library	Version
bdk_wallet	1.1.0
bdk_electrum	0.21.0
bdk_esplora	0.20.1
rust-bitcoin	0.32.5
uniffi	0.29.0

Changelog

Added

• Expose ElectrumClient::block_headers_subscribe method #664
• Expose EsploraClient::get_block_hash method #665
• Expose EsploraClient::get_tx_status method #666
• Expose EsploraClient::get_tx_info method #666
• Support for Testnet 4 #674
• Add AddressData and WitnessProgram types from rust bitcoin #671
• Expose Address::to_address_data method #671

Changed

• More complete LocalOutput type #667

Automated Release Notes

• Update download-artifact action to v4 by @thunderbiscuit in #659
• Steps 28/29/30 of release process by @reez in #656
• Print satoshi amounts in all tests by @thunderbiscuit in #661
• Add get_block_hash to esplora by @reez in #665
• Add get_tx_status and get_tx_info to Esplora by @reez in #666
• Fix LiveTransactionTest JVM test name by @thunderbiscuit in #670
• Add more fields to LocalOutput by @reez in #667
• feat: add to_address_data to address type by @reez in #671
• Upgrade to bdk_wallet 1.1.0 and bdk_electrum to 0.21.0 by @thunderbiscuit in #672
• Remove bitcoin ffi by @thunderbiscuit in #674
• Upgrade to uniffi 0.29.0 by @thunderbiscuit in #677
• Use macros where possible by @thunderbiscuit in #678
• feat: expose ElectrumClient::block_headers_subscribe method by @thunderbiscuit in #664
• General fixes by @thunderbiscuit in #682
• Prepare 1.1.0-rc.1 by @thunderbiscuit in #683

Full Changelog: v1.0.0-beta.7...v1.1.0-rc.1

Release 0.32.1

This is a patch release that bumps the Rust bdk library to 0.30.2.

See https://github.com/bitcoindevkit/bdk/releases/tag/v0.30.2 for details!

v1.0.0-beta.7

This release updates the bdk-ffi libraries to the final bdk_wallet 1.0.0 release, and related libraries (Esplora, Electrum, etc.), as well as adds new methods and types.

Added:

• ElectrumClient::server_features #641
• ServerFeaturesRes struct #641
• ElectrumClient::estimate_fee #641
• EsploraClient::get_fee_estimates #648
• New optional argument sign_options on Wallet::sign and Wallet::finalize_psbt #650

Changed:

• The full_scan and sync methods on the Electrum and Esplora clients now take a renamed request argument #642
• ElectrumClient::broadcast was renamed ElectrumClient::transaction_broadcast to mirror the Rust API #642

What's Changed

• chore: use macos-14 image in publish-jvm.yaml by @reez in #643
• Step 28/29/30 in Release by @reez in #645
• Add ADR document on errors by @thunderbiscuit in #513
• Add ElectrumClient::server_features method by @thunderbiscuit in #641
• Small fixes to Electrum and Esplora APIs by @thunderbiscuit in #642
• deps: bump bdk to 1.0.0 by @reez in #647
• Update CI actions to Node.js 20 by @thunderbiscuit in #517
• Add get_fee_estimates to EsploraClient by @reez in #648
• Add sign_options argument to Wallet::sign and Wallet::finalize_psbt methods by @thunderbiscuit in #650
• Prepare language bindings libraries for beta 7 release by @reez in #653
• Add dokka setup for Kotlin API docs by @thunderbiscuit in #655
• Update libraries to official release versions by @reez in #654

Full Changelog: v1.0.0-beta.6...v1.0.0-beta.7