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.

Author: nyonson

.github/workflows/ci.yml

@@ -1,69 +1,62 @@
+# 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: Build & Test
 
+# 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
   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
+      - uses: actions/checkout@v4
+      - uses: extractions/setup-just@v3
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      - run: just test-msrv
   signet:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - name: Sync signet
-        run: cargo test --verbose signet_syncs
+      - uses: actions/checkout@v4
+      - uses: extractions/setup-just@v3
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      - run: just test-sync
   bitcoind:
     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-integrate

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]

Cargo.toml

@@ -1,36 +1,55 @@
-default:
-  just --list
-
-build:
-  cargo build
-
+set ignore-comments
+
+nightly-toolchain := "nightly-2025-04-02"
+  
+# Hidden default lists all available recipies.
+_default:
+  @just --list --list-heading $'KYOTO\n'
+
+# Update Cargo.lock with strategy: msrv, min, or max.
+update-lockfile strategy="msrv":
+  # "Fallback" MSRV resolving (v3) requires stable rust > 1.84. Older
+  # versions have it behind an unstable flag on nightly.
+  #
+  # The minimal-versions feature for the min strategy
+  # is still only on nightly.
+  #
+  # "Maximum" versions, the v2 default, is also available on stable > 1.84
+  # with the --ignore-rust-version flag.
+  @echo "Updating Cargo.lock using {{strategy}} strategy"
+  @if [ "{{strategy}}" = "msrv" ]; then CARGO_RESOLVER_INCOMPATIBLE_RUST_VERSIONS=fallback cargo update --verbose; \
+  elif [ "{{strategy}}" = "min" ]; then cargo +{{nightly-toolchain}} update -Z direct-minimal-versions --verbose; \
+  elif [ "{{strategy}}" = "max" ]; then cargo update --ignore-rust-version --verbose; \
+  else echo "Error: Invalid strategy '{{strategy}}'" && exit 1; fi
+  @echo "Lockfile update complete."
+  
+# 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
 
+# Unit test suite.
 test:
   cargo test --lib
   cargo test --doc
+  cargo test --examples
 
-sync: 
-  cargo test signet_syncs -- --nocapture
-
-integrate: 
-  cargo test -- --test-threads 1 --nocapture --skip signet_syncs
+# 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
 
-example:
-  cargo run --example signet --release
-
-signet:
-  cargo run --example signet --release
+# Run the signet sync integration tests.
+test-sync: 
+  cargo test signet_syncs -- --nocapture
 
-testnet:
-  cargo run --example testnet --release
+# Run integration tests, except signet sync.
+test-integrate: 
+  cargo test --tests -- --test-threads 1 --nocapture --skip signet_syncs
 
-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,5 @@
+[toolchain]
+# >1.84 for stabalized MSRV resolving.
+channel = "1.85.0"
+# Default profile for CI, local installs probably also want to add the rust-analyzer component for IDE support.
+profile = "default"

rust-toolchain.toml

@@ -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};