build: move build complexity to justfile

Keep build logic as agnostic as possible to whatever CI task runner is
used. Let the CI job focus on performance, like caching artifacts.

With that goal in mind, the CI job has been refactored to a handful
of jobs which each call a just recipe. Consistent caching have been
added to each job which shows a nice improvement in speed for the job
overall. The justfile has been refactored with the logic that previously
lived in the CI yaml. This makes it easier to maintain as well as run
locally when developing. A few un-used recipes have been cleaned up as
well.

A rust-toolchain.toml file was added to help developers stay on a more
recent version of "stable", that way we can use some of the newer
features like the v3 resolver and see less of "works on my machine". CI
will most likely not use the file however, since it usually needs to
test more complex things like MSRV.

Author: nyonson

.github/workflows/ci.yml

@@ -1,69 +1,69 @@
-name: Build & Test
+# A few guiding principles.
+# 
+# * Always use actions-rust-lang/setup-rust-toolchain for its built-in caching.
+# * Complexity lives in the justfile, this runner is as light as possible.
+ 
+name: CI
 
+# Run on direct commits to master, including merges, and any pull requests against master.
 on:
   push:
     branches:
       - master
   pull_request:
+    branches:
+      - master
 
 jobs:
-  build:
+  # Quick canary of code as well as potential issues with upcoming toolchains.
+  check:
     strategy:
       matrix:
-        platform: [ubuntu-latest, macos-latest, windows-latest]
         toolchain: [stable, beta, nightly]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: extractions/setup-just@v3
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: ${{ matrix.toolchain }}
+          components: clippy,rustfmt
+      - run: just check
+  test:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:
-      - uses: actions/checkout@v3
-      - name: Update Toolchain
-        run: |
-          rustup default ${{ matrix.toolchain }}
-          rustup component add --toolchain ${{ matrix.toolchain }} rustfmt
-          rustup component add --toolchain ${{ matrix.toolchain }} clippy
-          rustup update ${{ matrix.toolchain }}
-      - name: Lint all targets
-        run: cargo clippy --all-targets
-      - name: Format
-        run: cargo fmt -- --check
-      - name: Build with defeault features
-        run: cargo build --verbose
-      - name: Check release build on Rust ${{ matrix.toolchain }}
-        run: cargo check --release --verbose --color always
-      - name: Unit test
-        run: cargo test --verbose --lib
-      - name: Doc test
-        run: cargo test --verbose --doc
-  # Check that library code can be compiled with MSRV (1.63.0).
+      - uses: actions/checkout@v4
+      - uses: extractions/setup-just@v3
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      - run: just test
+  features:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: extractions/setup-just@v3
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      - run: just test-features
   msrv:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      # Modify build tools just for MSRV testing. This avoids us having
-      # to bump our MSRV just for tooling. Tooling doesn't effect consumers so not a risk.
-      - name: Prepare environment for MSRV toolchain
-        run: |
-          # Remove resolver = "3" line for MSRV compatibility. We use V3 to
-          # generate an MSRV-compliant lockfile, but this isn't necessary to
-          # check if library code is MSRV compliant. Any resolver can go
-          # and grab the versions specified in the committed lockfile.
-          #
-          # The V3 resolver is standard in rust 1.85.
-          sed -i '/resolver = "3"/d' Cargo.toml
-      - name: Install MSRV toolchain
-        run: |
-          rustup toolchain install 1.63.0
-          rustup default 1.63.0
-      - name: Build with MSRV compiler
-        run: cargo build --verbose
-  signet:
+      - uses: actions/checkout@v4
+      - uses: extractions/setup-just@v3
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      - run: just test-msrv
+  sync:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - name: Sync signet
-        run: cargo test --verbose signet_syncs
-  bitcoind:
+      - uses: actions/checkout@v4
+      - uses: extractions/setup-just@v3
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      - run: just test-sync
+  integration:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - name: Integration test
-        run: cargo test -- --test-threads 1 --skip signet_syncs --nocapture
+      - uses: actions/checkout@v4
+      - uses: extractions/setup-just@v3
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      - run: just test-integration

Cargo.lock

@@ -9,8 +9,6 @@ repository = "https://github.com/rustaceanrob/kyoto"
 readme = "README.md"
 keywords = ["bitcoin", "cryptography", "network", "peer-to-peer"]
 categories = ["cryptography::cryptocurrencies"]
-# MSRV-aware resolver which is the default in edition2024.
-resolver = "3"
 rust-version = "1.63.0"
 
 [dependencies]
@@ -69,3 +67,6 @@ path = "example/rescan.rs"
 name = "managed"
 path = "example/managed.rs"
 required-features = ["filter-control"]
+
+[lints.rust]
+warnings = "deny"

Cargo.toml

@@ -7,7 +7,7 @@
   <p>
     <a href="https://crates.io/crates/kyoto-cbf"><img alt="Crate Info" src="https://img.shields.io/crates/v/kyoto-cbf.svg"/></a>
     <a href="https://github.com/rustaceanrob/kyoto/blob/master/LICENSE"><img alt="MIT or Apache-2.0 Licensed" src="https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg"/></a>
-    <a href="https://github.com/rustaceanrob/kyoto/actions?query=workflow%3A%22Build+%26+Test%22"><img alt="CI Status" src="https://github.com/rustaceanrob/kyoto/workflows/Build%20%26%20Test/badge.svg"></a>
+    <a href="https://github.com/rustaceanrob/kyoto/actions?query=workflow%3A%22Build+%26+Test%22"><img alt="CI Status" src="https://github.com/rustaceanrob/kyoto/workflows/CI/badge.svg"></a>
     <a href="https://docs.rs/kyoto-cbf"><img alt="API Docs" src="https://img.shields.io/badge/docs.rs-kyoto_cbf-green"/></a>
     <a href="https://blog.rust-lang.org/2022/08/11/Rust-1.63.0.html"><img alt="Rustc Version 1.63.0+" src="https://img.shields.io/badge/rustc-1.63.0%2B-lightgrey.svg"/></a>
   </p>
@@ -114,7 +114,7 @@ just test
 To sync with a live Signet node:
 
 ```
-just sync
+just test-sync
 ```
 
 And to run scenarios against your `bitcoind` instance, set a `BITCOIND_EXE` environment variable to the path to `bitcoind`:
@@ -128,10 +128,10 @@ You may want to add this to your bash or zsh profile.
 To run the `bitcoind` tests:
 
 ```
-just integrate
+just test-integration`
 ```
 
-If you do not have `bitcoind` installed, you may simply run `just integrate` and it will be installed for you in the `build` folder.
+If you do not have `bitcoind` installed, you may simply run `just test-integration` and it will be installed for you in the `build` folder.
 
 ## Contributing
 

README.md

@@ -1,36 +1,52 @@
-default:
-  just --list
-
-build:
-  cargo build
-
+set ignore-comments
+  
+# Hidden default lists all available recipies.
+_default:
+  @just --list --list-heading $'KYOTO\n'
+
+# Update Cargo.lock with strategy msrv enforcing policy.
+@update-lockfile:
+  # "Fallback" MSRV resolving (v3) requires stable rust > 1.84. Older
+  # versions have it behind an unstable flag on nightly. Matching the
+  # stable version in rust-toolchain.toml. This recipe is necessary
+  # as long as MSRV < 1.84.0 since setting package.resolver to 3 in
+  # the manifest panics older rust versions.
+  CARGO_RESOLVER_INCOMPATIBLE_RUST_VERSIONS=fallback cargo +1.85.0 update --verbose;
+  
+# Quick check of the code including lints and formatting.
 check:
-   cargo fmt
-   cargo clippy --all-targets
+  cargo fmt -- --check
+  # Turn warnings into errors.
+  cargo clippy --all-targets -- -D warnings
+  cargo check --all-features
 
+# Unit test suite.
 test:
   cargo test --lib
   cargo test --doc
-
-sync: 
+  cargo test --examples
+
+# Test feature flag matrix compatability.
+test-features:
+  # Build and test with all features, no features, and some combinations.
+  cargo test --lib --all-features
+  cargo test --lib --no-default-features
+  cargo test --lib --no-default-features --features database,filter-control 
+
+# Check code with MSRV compiler.
+test-msrv:
+  # Handles creating sandboxed environments to ensure no newer binaries sneak in.
+  cargo install cargo-msrv@0.18.4
+  cargo msrv verify
+
+# Run the network sync integration test.
+test-sync: 
   cargo test signet_syncs -- --nocapture
 
-integrate: 
-  cargo test -- --test-threads 1 --nocapture --skip signet_syncs
-
-example:
-  cargo run --example signet --release
+# Run integration tests, excluding the network sync.
+test-integration: 
+  cargo test --tests -- --test-threads 1 --nocapture --skip signet_syncs
 
-signet:
-  cargo run --example signet --release
-
-testnet:
-  cargo run --example testnet --release
-
-all:
-  cargo fmt 
-  cargo clippy --all-targets
-  cargo test --lib
-  cargo test --doc
-  cargo test -- --test-threads 1 --nocapture --skip signet_syncs
-  cargo run --example signet
+# Run the example: signet, testnet.
+example name="signet":
+  cargo run --example {{name}} --release

justfile

@@ -0,0 +1,4 @@
+[toolchain]
+# >1.84 for stabalized MSRV resolving.
+channel = "1.85.0"
+profile = "default"

rust-toolchain.toml

@@ -697,6 +697,7 @@ impl<H: HeaderStore> Chain<H> {
         if self.is_filters_synced() {
             return Ok(None);
         }
+        #[allow(unused_mut)] // Some trickiness with the filter-control feature
         let mut filter = Filter::new(filter_message.filter, filter_message.block_hash);
         let expected_filter_hash = self.cf_header_chain.hash_at(&filter_message.block_hash);
         // Disallow any filter that we do not have a block hash for

src/chain/chain.rs

@@ -1,3 +1,4 @@
+#[allow(unused_imports)] // Required for some features.
 use std::fmt::Debug;
 
 /// Errors when initializing a SQL-based backend.

src/db/error.rs

@@ -109,8 +109,6 @@ pub type BlockReceiver = tokio::sync::oneshot::Receiver<Result<IndexedBlock, Fet
 use crate::error::FetchBlockError;
 #[cfg(feature = "filter-control")]
 use filters::Filter;
-#[cfg(feature = "filter-control")]
-use std::collections::HashSet;
 
 use std::net::{IpAddr, SocketAddr};
 

src/lib.rs

@@ -145,6 +145,7 @@ pub(crate) enum ClientMessage {
     /// Broadcast a [`crate::Transaction`] with a [`crate::TxBroadcastPolicy`].
     Broadcast(TxBroadcast),
     /// Add more Bitcoin [`ScriptBuf`] to look for.
+    #[allow(dead_code)] // Some trickiness with the filter-control feature
     AddScript(ScriptBuf),
     /// Starting at the configured anchor checkpoint, look for block inclusions with newly added scripts.
     Rescan,