v0.21.0 - Fix, Clean & Polish

[dignifiedquire]

⚠️ Breaking Changes

Protocol Changes

• iroh-relay
  • Clients will dial /relay instead of /derp, this means all 0.21 nodes are only compatible with relays >= 0.20

API Changes

• iroh-cli
  • top level commands
    • author -> authors
    • blob -> blobs
    • doc -> docs
    • tag -> tags
    • sub commands
      • new -> create
  • added metrics_dump_path on the top level CLI parameters, which if set will make sure metrics are collected at regular intervals and written to the provided path in CSV format.
• iroh
  • removed deprecated
    • client::MemIroh use iroh::client::Iroh instead
    • client::QuicIroh use iroh::client::Iroh instead
    • client::MemDocuse iroh::client::docs::Doc instead
    • client::QuicDoc use iroh::client::docs::Doc instead
• iroh-net
  • renamed
    • field: magicsock::metrics::Metrics::update_endpoints -> update_direct_addrs.
  • relay server is now behind the iroh-relay feature flag
  • removed
    • endpoint::Builder::peers_path
  • added
    • endpoint::Builder::known_nodes
• no automatic storage of known peers anymore in iroh-net
• Public interfaces using tokio_util::task::LocalPoolHandle now use our own LocalPool/LocalPoolHandle.

⛰️ Features

• (ci) Publish docker images (#2520) - (c0fa1f4)
• (iroh-cli) [breaking] Realign cli commands with library (#2522) - (4c11c58)
• (iroh-net) Add holepunching events (#2495) - (8685222)
• (iroh-net) [breaking] Remove fs based peers storage (#2510) - (0a8cb8a)
• (iroh-net) Update netdev to 0.30 (#2528) - (214bb0c)
• (iroh-relay) Add more context to iroh-relay errors (#2506) - (04df203)

🐛 Bug Fixes

• (iroh-blobs) Properly handle Drop in local pool during shutdown (#2517) - (b4506b2)
• (iroh-docs) Do not dial invalid peers (#2470) - (7579caa)
• (iroh-metrics) Add the bind addr in errors for bind failures (#2511) - (50a8b5c)

🚜 Refactor

• (iroh) Make use of quic-rpc-derive macros to prettify the rpc declarations (#2508) - (026baaa)
• (iroh-net) [breaking] Move relay implemention in iroh-net behind iroh-relay cfg flag (#2516) - (f37d9f9)
• (iroh-net) Switch to new iroh-relay route /relay instead of /derp (#2489) - (b7b493d)
• (iroh-net) More renaming of endpoint to direct address (#2515) - (0c03f6e)
• (iroh-net) Remove random choice of direct addr (#2509) - (c1c3539)
• [breaking] Metrics (#2464) - (09e9746)

📚 Documentation

• (iroh-net) Fix broken HTTP/3 link (#2485) - (a5a2324)
• (iroh-net) Improve Endpoint::accept docs (#2492) - (79a2768)

🧪 Testing

• (iroh-cli) Improve bao_store_migration test logging (#2483) - (d17ffa3)

⚙️ Miscellaneous Tasks

• (bytes) Bytes v1.6.0 was yanked so upgrade to bytes v1.6.1 (#2503) - (ecfbed3)
• Add a flaky tests failure report to our discord notification (#2496) - (f84c06e)
• Keep GitHub Actions up to date with GitHub's Dependabot (#2498) - (538efbf)

Deprecation

• (iroh) [breaking] Remove deprecated type aliases (#2467) - (0102b05)

---

This discussion was created from the release v0.21.0 - Fix, Clean & Polish.