Skip to content

Commit

Permalink
amends
Browse files Browse the repository at this point in the history
  • Loading branch information
ValuedMammal committed Jan 17, 2025
1 parent e862ef0 commit 99afde8
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 15 deletions.
10 changes: 4 additions & 6 deletions .github/workflows/cont_integration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,10 @@ jobs:
- name: Pin dependencies for MSRV
if: matrix.rust.version == '1.63.0'
run: ./ci/pin-msrv.sh
- name: Test chain
if: matrix.rust.version != '1.63.0'
run: cargo test -p bdk_chain ${{ matrix.features }}
- name: Test lib
- name: Test library
run: cargo test -p bdk_bitcoind_rpc ${{ matrix.features }} -- --test-threads=2
- run: cargo test -p bdk_core ${{ matrix.features }}
- run: cargo test -p bdk_chain ${{ matrix.features }}
- run: cargo test -p bdk_esplora ${{ matrix.features }} -- --test-threads=2
- run: cargo test -p bdk_file_store ${{ matrix.features }}
- run: cargo test -p bdk_testenv ${{ matrix.features }} -- --test-threads=2
Expand Down Expand Up @@ -112,7 +110,7 @@ jobs:
uses: dtolnay/rust-toolchain@v1
with:
toolchain: ${{ needs.prepare.outputs.rust_version }}
# targets: "thumbv6m-none-eabi"
# target: "thumbv6m-none-eabi"
- name: Rust Cache
uses: Swatinem/rust-cache@v2.7.5
- name: Check bdk_chain
Expand Down Expand Up @@ -189,7 +187,7 @@ jobs:

build-examples:
needs: prepare
name: Build Examples
name: Build & Test Examples
runs-on: ubuntu-latest
strategy:
matrix:
Expand Down
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,26 @@ 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)
The bdk core library maintains an MSRV of 1.63.0. This includes `bdk_core`, `bdk_chain`, and `bdk_wallet`.
The BDK core library maintains a MSRV of 1.63.0. This includes `bdk_core`, `bdk_chain`, and `bdk_wallet`.

The MSRV of `bdk_electrum` and `bdk_esplora` is 1.75.0

Our policy regarding MSRV is:

1. We guarantee that a crate or library builds on a particular version of Rust
2. We do not guarantee that the MSRV will stay consistent between minor versions
3. We make no guarantees with respect to the MSRV of example crates, crates designed for testing and development, or deprecated or experimental projects.
The MSRV of `bdk_electrum` is 1.75.0.

To build with the MSRV you will need to pin dependencies as follows:

```shell
cargo update -p zstd-sys --precise "2.0.8+zstd.1.5.5"
cargo update -p time --precise "0.3.20"
cargo update -p home --precise "0.5.5"
cargo update -p proptest --precise "1.2.0"
cargo update -p url --precise "2.5.0"
cargo update -p cc --precise "1.0.105"
cargo update -p tokio --precise "1.38.1"
cargo update -p tokio-util --precise "0.7.11"
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"
```

## License

Expand Down
2 changes: 2 additions & 0 deletions ci/pin-msrv.sh
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@ cargo update -p tokio --precise "1.38.1"
cargo update -p tokio-util --precise "0.7.11"
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"
2 changes: 1 addition & 1 deletion crates/chain/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ rusqlite = { version = "0.31.0", features = ["bundled"], optional = true }
rand = "0.8"
proptest = "1.2.0"
bdk_testenv = { path = "../testenv", default-features = false }
criterion = { version = "0.5" }
criterion = { version = "0.2" }

[features]
default = ["std", "miniscript"]
Expand Down
8 changes: 8 additions & 0 deletions crates/electrum/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
1 change: 1 addition & 0 deletions crates/testenv/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
name = "bdk_testenv"
version = "0.11.1"
edition = "2021"
rust-version = "1.63"
homepage = "https://bitcoindevkit.org"
repository = "https://github.com/bitcoindevkit/bdk"
documentation = "https://docs.rs/bdk_testenv"
Expand Down

0 comments on commit 99afde8

Please sign in to comment.