From: Steve Myers Date: Thu, 5 Aug 2021 06:35:12 +0000 (-0700) Subject: Update CHANGELOG X-Git-Tag: v0.3.0~28 X-Git-Url: http://internal-gitweb-vhost/script/%22https:/database/struct.CommandStringError.html?a=commitdiff_plain;h=f7f29dd2ab0a425bddd822d2d41d4dc638b1c302;p=bdk-cli Update CHANGELOG --- diff --git a/CHANGELOG.md b/CHANGELOG.md index df1ad9e..0376876 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,64 +6,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] -### Project - -#### Added -- `CliSubCommand::Compile` enum variant and `handle_compile_subcommand()` function - -#### Changed -- Make repl and electrum default features +- Update repl feature to not include electrum - Upgrade to `bdk` v0.7.x - -### `bdk-cli` bin - -#### Added -- New top level command "Compile" which compiles a miniscript policy to an output descriptor -- `CompactFilterOpts` to `WalletOpts` to enable compact-filter blockchain configuration - -#### Changed -- Remove unwraps while handling CLI commands +- 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 also in JSON format +- Require at most one blockchain client feature be enabled at a time ## [0.2.0] -### Project - -#### Added - Add support for `wasm` -- `CliOpts` struct and `CliSubCommand` enum representing top level cli options and commands -- `KeySubCommand` enum -- `handle_key_subcommand` function - -#### Changed - Upgrade `bdk` to `0.4.0` and `bdk-macros` to `0.3.0` -- Renamed `WalletOpt` struct to `WalletOpts` -- `WalletSubCommand` enum split into `OfflineWalletSubCommand` and `OnlineWalletSubCommand` -- Split `handle_wallet_subcommand` into two functions, `handle_offline_wallet_subcommand` and `handle_online_wallet_subcommand` - A wallet without a `Blockchain` is used when handling offline wallet sub-commands - -### `bdk-cli` bin - -#### Added -- Top level commands "wallet", "key", and "repl" -- "key" sub-commands to "generate" and "restore" a master private key -- "key" sub-command to "derive" an extended public key from a master private key +- 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 - -#### Changed - "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] -### Project -#### Added - 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 - -#### Changed - If an invalid network name return an error instead of defaulting to `testnet` ## [0.1.0-beta.1] diff --git a/README.md b/README.md index 53e121b..1855ed0 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ is an example of how to enable the `esplora` blockchain client feature instead o RUST_LOG=debug cargo run --no-default-features --features repl,esplora -- wallet --descriptor "wpkh(tpubEBr4i6yk5nf5DAaJpsi9N2pPYBeJ7fZ5Z9rmN4977iYLCGco1VyjB9tvvuvYtfZzjD5A8igzgw3HeWeeKFmanHYqksqZXYXGsw5zjnj7KM9/*)" sync ``` -If no blockchain client features are enabled then online wallet commands are disabled. +If no blockchain client feature is enabled then online wallet commands are disabled. ### From crates.io You can the install the binaries for the latest tag of `bdk-cli` directly from [crates.io](https://crates.io/crates/bdk-cli) like so: diff --git a/src/bdk_cli.rs b/src/bdk_cli.rs index e6d8b8c..88d4bef 100644 --- a/src/bdk_cli.rs +++ b/src/bdk_cli.rs @@ -114,7 +114,7 @@ where feature = "electrum", any(feature = "esplora", feature = "compact_filters") ))] - compile_error!("Only one blockchain client feature can be enabled at a time. The 'electrum' feature can not be enabled with 'esplora' or 'compact_filters'."); + compile_error!("Only one blockchain client feature can be enabled at a time."); #[cfg(feature = "electrum")] let config = AnyBlockchainConfig::Electrum(ElectrumBlockchainConfig { @@ -128,7 +128,7 @@ where feature = "esplora", any(feature = "electrum", feature = "compact_filters") ))] - compile_error!("Only one blockchain client feature can be enabled at a time. The 'esplora' feature can not be enabled with 'electrum' or 'compact_filters'."); + compile_error!("Only one blockchain client feature can be enabled at a time."); #[cfg(feature = "esplora")] let config = AnyBlockchainConfig::Esplora(EsploraBlockchainConfig { @@ -140,7 +140,7 @@ where feature = "compact_filters", any(feature = "electrum", feature = "esplora") ))] - compile_error!("Only one blockchain client feature can be enabled at a time. The 'esplora' feature can not be enabled with 'electrum' or 'compact_filters'."); + compile_error!("Only one blockchain client feature can be enabled at a time."); #[cfg(feature = "compact_filters")] let config = {