From f7c9bc5166a508743ad11f116131a6f94d3e8e9e Mon Sep 17 00:00:00 2001 From: valued mammal Date: Fri, 17 Jan 2025 13:12:36 -0500 Subject: [PATCH] docs: update `README.md` with MSRV policy - bdk_electrum: add MSRV section to README.md --- README.md | 11 +++++++++-- crates/electrum/README.md | 8 ++++++++ 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cdc3df72..67a65d40 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,15 @@ Fully working examples of how to use these components are in `/example-crates`: [`bdk_chain`]: https://docs.rs/bdk-chain/ ## Minimum Supported Rust Version (MSRV) -This library should compile with any combination of features with Rust 1.63.0. +The BDK library maintains a MSRV of 1.63.0. This includes the following crates + +- `bdk_core` +- `bdk_chain` +- `bdk_bitcoind_rpc`. +- `bdk_esplora`. +- `bdk_wallet`. + +The MSRV of `bdk_electrum` is 1.75.0. To build with the MSRV you will need to pin dependencies as follows: @@ -80,7 +88,6 @@ cargo update -p indexmap --precise "2.5.0" cargo update -p security-framework-sys --precise "2.11.1" cargo update -p csv --precise "1.3.0" cargo update -p unicode-width --precise "0.1.13" -cargo update -p rustls@0.23.21 --precise "0.23.19" ``` ## License diff --git a/crates/electrum/README.md b/crates/electrum/README.md index 1bafe04e..efe7109c 100644 --- a/crates/electrum/README.md +++ b/crates/electrum/README.md @@ -3,5 +3,13 @@ BDK Electrum extends [`electrum-client`] to update [`bdk_chain`] structures from an Electrum server. +## Minimum Supported Rust Version (MSRV) +This crate has a MSRV of 1.75.0. + +To build with MSRV you will need to pin dependencies as follows: +```shell +cargo update -p home --precise "0.5.9" +``` + [`electrum-client`]: https://docs.rs/electrum-client/ [`bdk_chain`]: https://docs.rs/bdk-chain/ -- 2.49.0