Skip to content

Revert: Set default-features = false for rust-bitcoin and rust-miniscript #897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
notmandatory wants to merge 2 commits into from
Closed

Revert: Set default-features = false for rust-bitcoin and rust-miniscript #897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1de0dee
Revert "Set default-features = false for rust-bitcoin"
notmandatory Mar 16, 2023
9bc8cf9
Mark release 0.27.2 as yanked in changelog
notmandatory Mar 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 2 additions & 9 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [v0.27.2]

### Summary

Disable default-features for rust-bitcoin and rust-miniscript dependencies, and for rust-esplora-client optional dependency.

### Changed

- Set default-features = false for rust-bitcoin and rust-miniscript #882
- Update esplora client dependency to version 0.4 #884
**Yanked**

## [v0.27.1]

Expand Down Expand Up @@ -654,4 +647,4 @@ final transaction is created by calling `finish` on the builder.
[v0.27.0]: https://github.com/bitcoindevkit/bdk/compare/v0.26.0...v0.27.0
[v0.27.1]: https://github.com/bitcoindevkit/bdk/compare/v0.27.0...v0.27.1
[v0.27.2]: https://github.com/bitcoindevkit/bdk/compare/v0.27.1...v0.27.2
[Unreleased]: https://github.com/bitcoindevkit/bdk/compare/v0.27.2...HEAD
[Unreleased]: https://github.com/bitcoindevkit/bdk/compare/v0.27.1...release/0.27
6 changes: 2 additions & 4 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ license = "MIT OR Apache-2.0"
[dependencies]
bdk-macros = "^0.6"
log = "^0.4"
miniscript = { version = "9.0", default-features = false, features = ["serde"] }
Copy link
Copy Markdown
Contributor

@tnull tnull Mar 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mh, rather than outright reverting it, could we maybe leave default-features = false and set miniscript/std in BDK's default feature? This way downstream projects could opt-out of std by setting default-features = false for BDK.

@benthecarman Would this work for you?

Copy link
Copy Markdown
Contributor

@benthecarman benthecarman Mar 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that would work

Copy link
Copy Markdown
Member Author

@notmandatory notmandatory Mar 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should work but will still force any downstream projects that use bdk and have default-features = false to now have to also enable a new std feature. That's the kind of breaking change I want to avoid on a patch release. Ideally I want to defer all breaking changes to the 1.0 release.

Besides Mutiny are there any other downstream projects that need to disable std for bitcoin and miniscript?

bitcoin = { version = "0.29.2", default-features = false, features = ["serde", "base64", "rand"] }
miniscript = { version = "9.0", features = ["serde"] }
bitcoin = { version = "0.29.1", features = ["serde", "base64", "rand"] }
Copy link
Copy Markdown
Contributor

@rajarshimaitra rajarshimaitra Mar 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it intentional to downgrade bitcoin to 0.29.1? I ran some tests with latest version and all seemed to work well with it. Am I missing something..

Copy link
Copy Markdown
Member Author

@notmandatory notmandatory Mar 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was part of the original commit and since I used the git revert command undid the bitcoin 0.29.2 change too. To keep it simple I'd rather not make any other changes in this PR but to revert the original commit (and corresponding changelog entry). Also even if we leave this at 0.29.1 anyone who does a cargo update will still get the latest 0.29.2 version.

serde = { version = "^1.0", features = ["derive"] }
serde_json = { version = "^1.0" }
rand = "^0.8"
Expand Down Expand Up @@ -104,8 +104,6 @@ test-hardware-signer = ["hardware-signer"]
dev-getrandom-wasm = ["getrandom/js"]

[dev-dependencies]
miniscript = { version = "9.0", features = ["std"] }
bitcoin = { version = "0.29.2", features = ["std"] }
lazy_static = "1.4"
env_logger = "0.7"
electrsd = "0.22"
Expand Down