Skip to content

Commit

Permalink
Document verison requirements for --no-default-features
Browse files Browse the repository at this point in the history
In an effort to make the crate work with `--no-default-features` ages
ago I accidentally introduced an implicit requirement that the
`bitcoind` binary was the same version as the 'default' we use in
`node/src/versions.rs` and `node/src/client_versions.rs`.

Currently I cannot think of a solution except to document it in the
readme.
  • Loading branch information
tcharding committed Jan 22, 2025
1 parent ecf31ed commit 899189e
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ if let Ok(exe_path) = bitcoind::exe_path() {
Startup options could be configured via the [`Conf`] struct using [`Node::with_conf`] or
[`Node::from_downloaded_with_conf`]

*WARNING* In order to get `--no-default-features` to work we hack-ishly default to the latest
supported version of Core. This means that the `bitcoind` binary _must_ be the latest version or
units test will/may fail.

## Features

* Waits until bitcoind daemon becomes ready to accept RPC commands
Expand Down

0 comments on commit 899189e

Please sign in to comment.