[ci] Add github actions and use latest proptest

.github/workflows/test.yml

@@ -0,0 +1,56 @@
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+
+# Make sure CI fails on all warnings, including Clippy lints
+env:
+    RUSTFLAGS: "-Dwarnings"
+    RUSTDOCFLAGS: "-Dwarnings"
+
+jobs:
+  fmt:
+    name: Rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt
+      - run: cargo fmt --all -- --check
+
+  clippy_check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy
+      - uses: Swatinem/rust-cache@v2
+      - run: cargo clippy --all-targets --all-features --tests
+
+  build-msrv:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/[email protected]
+        # don't want dev-dependencies for MSRV check
+      - run: sed -i 's/\[dev-dependencies]/[ignore-this-warning-fren]/g' Cargo.toml
+      - run: cargo build --release
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - run: cargo test --release
+
+  doc-build:
+     name: doc-build
+     runs-on: ubuntu-latest
+     steps:
+       - uses: actions/checkout@v4
+       - uses: dtolnay/rust-toolchain@stable
+       - run:  cargo doc --no-deps

Cargo.toml

@@ -15,11 +15,12 @@ readme = "README.md"
 [dependencies]
 # No dependencies! Please do not add any please!
 
-[dev-dependencies]
-rand = "0.7"
-proptest = "0.10"
-bitcoin = "0.30"
 
 [features]
 default = ["std"]
 std = []
+
+[dev-dependencies]
+rand = "0.8"
+proptest = "1.4"
+bitcoin = "0.30"

README.md

@@ -3,6 +3,9 @@
 `bdk_coin_select` is a tool to help you select inputs for making Bitcoin (ticker: BTC) transactions.
 It's got zero dependencies so you can paste it into your project without concern.
 
+> ⚠ This work is only ready to use by those who expect (potentially catastrophic) bugs and will have
+> the time to investigate them and contribute back to this crate.
+
 ## Constructing the `CoinSelector`
 
 The main structure is [`CoinSelector`](crate::CoinSelector). To construct it, we specify a list of

src/coin_selector.rs

@@ -625,9 +625,9 @@ impl Candidate {
     }
 }
 
-/// A structure that represents the weight costs of a drain (a.k.a. change) output.
+/// Represents the weight costs of a drain (a.k.a. change) output.
 ///
-/// This structure can also represent multiple outputs.
+/// May also represent multiple outputs.
 #[derive(Default, Debug, Clone, Copy, Hash, PartialEq, Eq)]
 pub struct DrainWeights {
     /// The weight of including this drain output.
@@ -659,9 +659,8 @@ impl DrainWeights {
 /// A drain (A.K.A. change) output.
 /// Technically it could represent multiple outputs.
 ///
-/// These are usually created by a [`change_policy`].
-///
-/// [`change_policy`]: crate::change_policy
+/// This is returned from [`CoinSelector::drain`]. Note if `drain` returns a drain where `is_none()`
+/// returns true then **no change should be added** to the transaction.
 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)]
 pub struct Drain {
     /// Weight of adding drain output and spending the drain output.

tests/bnb.rs

@@ -8,11 +8,11 @@ use proptest::{prelude::*, proptest, test_runner::*};
 
 fn test_wv(mut rng: impl RngCore) -> impl Iterator<Item = Candidate> {
     core::iter::repeat_with(move || {
-        let value = rng.gen_range(0, 1_000);
+        let value = rng.gen_range(0..1_000);
         let mut candidate = Candidate {
             value,
             weight: 100,
-            input_count: rng.gen_range(1, 2),
+            input_count: rng.gen_range(1..2),
             is_segwit: rng.gen_bool(0.5),
         };
         // HACK: set is_segwit = true for all these tests because you can't actually lower bound

tests/changeless.rs

@@ -9,11 +9,11 @@ use rand::{prelude::IteratorRandom, Rng, RngCore};
 
 fn test_wv(mut rng: impl RngCore) -> impl Iterator<Item = Candidate> {
     core::iter::repeat_with(move || {
-        let value = rng.gen_range(0, 1_000);
+        let value = rng.gen_range(0..1_000);
         Candidate {
             value,
-            weight: rng.gen_range(0, 100),
-            input_count: rng.gen_range(1, 2),
+            weight: rng.gen_range(0..100),
+            input_count: rng.gen_range(1..2),
             is_segwit: rng.gen_bool(0.5),
         }
     })

tests/common.rs

@@ -207,9 +207,9 @@ impl StrategyParams {
 pub fn gen_candidates(n: usize) -> Vec<Candidate> {
     let mut rng = TestRng::deterministic_rng(RngAlgorithm::ChaCha);
     core::iter::repeat_with(move || {
-        let value = rng.gen_range(1, 500_001);
-        let weight = rng.gen_range(1, 2001);
-        let input_count = rng.gen_range(1, 3);
+        let value = rng.gen_range(1..500_001);
+        let weight = rng.gen_range(1..2001);
+        let input_count = rng.gen_range(1..3);
         let is_segwit = rng.gen_bool(0.01);
 
         Candidate {

tests/waste.rs

@@ -460,11 +460,11 @@ proptest! {
 
 fn test_wv(mut rng: impl RngCore) -> impl Iterator<Item = Candidate> {
     core::iter::repeat_with(move || {
-        let value = rng.gen_range(0, 1_000);
+        let value = rng.gen_range(0..1_000);
         Candidate {
             value,
-            weight: rng.gen_range(0, 100),
-            input_count: rng.gen_range(1, 2),
+            weight: rng.gen_range(0..100),
+            input_count: rng.gen_range(1..2),
             is_segwit: rng.gen_bool(0.5),
         }
     })