Skip to content

CHANGELOG.md

Latest commit

 

History

History
154 lines (129 loc) · 7.85 KB

CHANGELOG.md

File metadata and controls

154 lines (129 loc) · 7.85 KB

Changelog

Changelog information can be found in each release's git tag and can be viewed with git tag -ln100 "v*". Changelog info is also documented on the GitHub releases page. See DEVELOPMENT_CYCLE.md for more details.

Unreleased

3.0.0

  • Added descriptor command for generating descriptors
  • Added wallet subcommand config for saving and reusing wallet configuration
  • Added non-persisted async payjoin support
  • Added completions command to generate shell completions
  • Added wallets command to list all saved wallets configs
  • Refactor sync kyoto client to be borrowed/referenced
  • Updated cont_integration and audit workflows
  • Updated --pretty to be used in any position
  • Updated documentation to include installation prerequisite
  • Updated dependencies bdk_electrum to v0.23.2, bdk_kyoto to v0.15.4, bdk_redb to v0.1.1, clap to v4.6, clap_complete to v4.6, env_logger to v0.11.10, thiserror to v2.0.18, tracing to v0.1.44, toml to v1.1.0, reqwest to v0.13.2, url to v2.5.8 and other transitive dependencies
  • Replaced coveralls with codecov for coverage reporting
  • Fixed config test to use any client
  • Locked payjoin version to 1.0.0-rc.1
  • Fix duplicate wallet creation in non-persistent path
  • Removed remaining MSRV mentions in documentation

2.0.0

  • Removed MSRV and bumped Rust Edition to 2024
  • Added --pretty flag for formatting outputs in human-readable form
  • Updated bdk_wallet to 2.1.0, bdk_bitcoind_rpc to 0.21.0, bdk_esplora to 0.22.1, bdk_kyoto to 0.13.1
  • Updated tracing-subscriber to 0.3.20
  • Added tr script type to compile command to support creating taproot descriptors
  • Added redb as an alternative persistence to sqlite
  • Removed connection requirement for sending transactions in bdk_kyoto
  • Added just command runner for common commands and regtest bitcoind
  • Renamed BuilderError to KyotoBuilderError and added KyotoUpdateError
  • Updated bdk_electrum to 0.23.0
  • Added just example for starting, connecting and funding a wallet in regtest

1.0.0

  • Changed the MSRV to 1.75.0 and bumped the rust edition to 2021
  • Changed electrum client to use bdk_electrum, sqlite feature to use bdk_wallet/rusqlite
  • Updated repl to use shlex instead of regex, rustyline and fd-lock
  • Updated bdk_wallet to 1.0.0
  • Updated bdk_bitcoind_rpc to 0.18.0, bdk_electrum to 0.21.0, bdk_esplora to 0.20.1, bdk-reserves to 0.29.0
  • Updated electrsd to v31.0
  • Updated clap to v4.5
  • Added cbf (compact block filter) feature using bdk-kyoto
  • Replaced regtest-bitcoin feature with rpc
  • Added custom error enum
  • Set repl and sqlite as the default features
  • Set default fee rate to FeeRate::BROADCAST_MIN
  • Enabled replace-by-fee by default
  • Replaced ExtendedPrivateKey with Xpriv
  • Replaced list_transactions with transactions
  • Replaced allow_shringking with drain_to methods
  • Replaced Wallet<D> with PersistedWallet<D>
  • Replaced descriptor CLI parameter with ext-descriptor and change with int-descriptor
  • Dropped support for sled
  • Dropped key-value-db feature
  • Dropped esplora-ureq, esplora-reqwest, regtest-bitcoin, regtest-electrum, regtest-node and reserves features

0.27.1

  • Added hardware signers through the use of HWI.
  • Bumped rustc stable to 1.65.
  • Bumped electrsd version to v0.22.*.

0.26.0

  • Check that a PSBT is signed before broadcast, else throw a useful error message to user.
  • Miniscript Translation capability to an AliasMap in wasm, to enhance the paly ground interface.
  • cli-app framework from structop to clap.
  • Temporarily disable compact_filters until bdk v1.0.0 launch.

0.6.0

  • Add distinct key-value-db and sqlite-db features, keep default as key-value-db
  • Reorganize existing codes in separate modules. Change crate type from lib to bin.
  • Rewrite relevant doc comments as structopt help document.
  • Update bdk and bdk-reserves to v0.22.0.
  • Change default database to sqlite.
  • Change the esplora-reqwest feature to always use async mode
  • Change rpc --skip-blocks option to --start-time which specifies time initial sync will start scanning from.
  • Add new bdk-cli node <command> [<args>] to control the backend node deployed by regtest-* features.
  • Add an integration testing framework in src/tests/integration.rs. This framework uses the regtest-* feature to run automated testing with bdk-cli.
  • Add possible values for network option to improve help message, and fix typo in doc.
  • Add a module wasm containing objects to use bdk-cli from web assembly

0.5.0

  • Re-license to dual MIT and Apache 2.0 and update project name to "Bitcoin Dev Kit"
  • Update to bdk and bdk-reserves to 0.18.0
  • Add 'verify' feature flag which enables transaction verification against consensus rules during sync.
  • Add experimental regtest-* features to automatically deploy local regtest nodes (bitcoind, and electrs) while running cli commands.
  • Put cached wallet data in separate directories: ~/.bdk-bitcoin/<wallet_name>
  • New MSRV set to 1.56

0.4.0

  • Replace wallet bump_fee command --send_all with new --shrink option
  • Add 'reserve' feature to enable proof of reserve
  • If no wallet name is provided, derive one from the descriptor instead of using "main"
  • Add optional cookie authentication for rpc backend

0.3.0

  • Add RPC backend support, after bdk v0.12.0 release
  • Update default feature to not include electrum
  • Upgrade to bdk v0.12.x
  • Add top level command "Compile" which compiles a miniscript policy to an output descriptor
  • Add CompactFilterOpts to WalletOpts to enable compact-filter blockchain configuration
  • Add verbose option to WalletOpts to display PSBTs and transaction details also in JSON format
  • Require at most one blockchain client feature be enabled at a time
  • Change default esplora server URL to https://blockstream.info/testnet/api/ to match default testnet network

0.2.0

  • Add support for wasm
  • Upgrade bdk to 0.4.0 and bdk-macros to 0.3.0
  • A wallet without a Blockchain is used when handling offline wallet sub-commands
  • Add top level commands "wallet", "key", and "repl"
  • Add "key" sub-commands to "generate" and "restore" a master private key
  • Add "key" sub-command to "derive" an extended public key from a master private key
  • "repl" command now has an "exit" sub-command
  • "wallet" sub-commands and options must be proceeded by "wallet" command
  • "repl" command loop now includes both "wallet" and "key" sub-commands

0.1.0

  • Add CONTRIBUTING.md
  • Add CI and code coverage Discord badges to the README
  • Add CI and code coverage github actions workflows
  • Add scheduled audit check in CI
  • Add CHANGELOG.md
  • If an invalid network name return an error instead of defaulting to testnet

0.1.0-beta.1