ci: add lychee

.github/workflows/audit.yml

@@ -1,4 +1,5 @@
 # This runs `cargo audit` on all dependencies (only if Cargo deps changed)
+# <https://github.com/RustSec/rustsec/tree/main/cargo-audit>
 
 name: Audit
 
@@ -27,7 +28,9 @@ jobs:
     - uses: actions/checkout@v4
       with:
         submodules: recursive
+
     - name: Install dependencies
       run: cargo install cargo-audit --locked
+
     - name: Audit
       run: cargo audit

.github/workflows/ci.yml

@@ -123,6 +123,9 @@ jobs:
         wget https://repo.msys2.org/mingw/mingw64/mingw-w64-x86_64-gcc-13.2.0-6-any.pkg.tar.zst https://repo.msys2.org/mingw/mingw64/mingw-w64-x86_64-gcc-libs-13.2.0-6-any.pkg.tar.zst
         pacman -U --noconfirm mingw-w64-x86_64-gcc-13.2.0-6-any.pkg.tar.zst mingw-w64-x86_64-gcc-libs-13.2.0-6-any.pkg.tar.zst
 
+    - name: Install dependencies (All)
+      run: cargo install lychee
+
     - name: Documentation
       run: cargo doc --workspace --all-features --no-deps
 
@@ -135,6 +138,14 @@ jobs:
         cargo test --all-features --workspace
         cargo test --package cuprate-blockchain --no-default-features --features redb --features service
 
+    # Run `lychee` at:
+    # 1. The repo root (excluding `target/`)
+    # 2. Cuprate's cargo documentation
+    - name: Lychee
+      run: |
+        lychee . --exclude target
+        lychee target/doc/cuprate_*
+
     # TODO: upload binaries with `actions/upload-artifact@v3`
     - name: Build
       run: cargo build --all-features --all-targets --workspace

.github/workflows/deny.yml

@@ -1,4 +1,5 @@
 # This runs `cargo deny check` on all dependencies (only if Cargo deps changed)
+# <https://github.com/EmbarkStudios/cargo-deny>
 
 name: Deny
 
@@ -12,7 +13,7 @@ env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  audit:
+  deny:
 
     runs-on: ubuntu-latest
 
@@ -27,7 +28,9 @@ jobs:
     - uses: actions/checkout@v4
       with:
         submodules: recursive
+
     - name: Install dependencies
       run: cargo install cargo-deny --locked
+
     - name: Deny
       run: cargo deny check

consensus/rules/src/blocks.rs

@@ -120,7 +120,7 @@ pub fn check_block_pow(hash: &[u8; 32], difficulty: u128) -> Result<(), BlockErr
 
 /// Returns the penalty free zone
 ///
-/// <https://cuprate.github.io/monero-book/consensus_rules/blocks/weight_limit.html#penalty-free-zone>
+/// <https://monero-book.cuprate.org/consensus_rules/blocks/weights.html#penalty-free-zone>
 pub fn penalty_free_zone(hf: &HardFork) -> usize {
     if hf == &HardFork::V1 {
         PENALTY_FREE_ZONE_1

consensus/rules/src/transactions/contextual_data.rs

@@ -81,7 +81,7 @@ pub struct TxRingMembersInfo {
 /// - The input amounts are *ALL* 0 (RCT)
 /// - The top block hash is the same as when this data was retrieved (the blockchain state is unchanged).
 ///
-/// <https://cuprate.github.io/monero-book/consensus_rules/transactions/decoys.html>
+/// <https://cuprate.github.io/monero-book/consensus_rules/transactions/inputs.html>
 #[derive(Debug, Copy, Clone)]
 pub struct DecoyInfo {
     /// The number of inputs that have enough outputs on the chain to mix with.

lychee.toml

@@ -0,0 +1,26 @@
+# Enable link caching. This can be helpful to avoid checking the same links on
+# multiple runs.
+cache = false
+
+# Verbose program output
+# Accepts log level: "error", "warn", "info", "debug", "trace"
+verbose = "debug"
+
+# Don't show interactive progress bar while checking links.
+no_progress = true
+
+# Exclude URLs and mail addresses from checking (supports regex).
+exclude = ["^file", "docs.rs"]
+
+# Exclude these filesystem paths from getting checked.
+exclude_path = [
+    # Contains local link meant for `lib.rs`.
+    "storage/blockchain/README.md",
+    # Contains local link.
+    "books/protocol/src/consensus_rules/transactions/outputs.md",
+]
+
+# Exclude all private IPs from checking.
+# Equivalent to setting `exclude_private`, `exclude_link_local`, and
+# `exclude_loopback` to true.
+exclude_all_private = true