iroh Files

⚠️ Breaking Changes

• iroh

  • changed
    • edition is now set to edition2024

    • The relay wire protocol changed: All relayed messages now contain at least an additional ECN byte.

      They might be accidentally compatible when GSO is not enabled, but they're likely not.

      This means this version of iroh can't connect to older relays or older clients on newer relays.

      • ClientToRelayMsg::SendPacket was removed in favor of ClientToRelayMsg::Datagrams
      • RelayToClientMsg::ReceivedPacket was removed in favor of RelayToClientMsg::Datagrams
      • FrameType has changed variants:
        • SendPacket and RecvPacket were removed
        • ClientToRelayDatagram and ClientToRelayDatagramBatch were added
        • RelayToClientDatagram and RelayToClientDatagramBatch were added
          • The default relay URLs have changed. We are still maintaining relay URLs for version 0.90.0, those will be phased out next release.
          • Updated n0-watcher from version 0.2 to 0.3
      • Migration guide for users:
        • endpoint.node_addr().initialized().await? -> endpoint.node_addr().initialized().await (no ? needed anymore) and similarly for endpoint.home_relay() and other uses of Watchers.
        • endpoint.node_addr().get()? -> endpoint.node_addr().get() and similarly for endpoint.home_relay() and other uses of Watchers.
        • If all you have is a &impl Watcher but you need the current value, then you can't call Watcher::get anymore, as that now takes a &mut self instead of &self. You can work around this by .clone()ing to an intermediate watcher:watcher_ref.get() -> watcher_ref.clone().get()
        • removed
          • Removed iroh::discovery::pkarr::dht::Builder::initial_publish_delay
          • Removed iroh::endpoint::Builder::relay_conn_protocol. It's now always websockets
          • Removed the iroh::RelayProtocol re-export (the type was removed in iroh-relay)

• iroh-relay

  • removed
    • Removed iroh_relay::client::SendMessage and iroh_relay::client::ReceivedMessage in favor of ClientToRelayMsg and RelayToClientMsg respectively.
    • Removed ClientBuilder::is_prober
    • Removed ClientBuilder::protocol
    • Removed http::Protocol type
    • Removed relay_accepts and websocket_accepts metrics
  • changed
    • impl Stream for Client now produces RelayToClientMsg instead of ReceivedMessage
    • Client now impl Sink<ClientToRelayMsg> instead of impl Sink<SendMessage>
    • Moved protos::relay::FrameType to protos::common::FrameType and adjusted frame types to those of the current set of protocols
    • Renamed frames_rx_ratelimited_total metric to bytes_rx_ratelimited_total, which now tracks bytes not frames

⛰️ Features

• (iroh) Update to new relay servers (#3412) - (f3e4307)
• (iroh,iroh-relay) [breaking] Use stride instead of custom split protocol, send ECN bits (#3389) - (f3fd988)
• (iroh-relay) [breaking] Implement new handshake protocol, refactor frame types (#3331) - (3a1592a)
• [breaking] Update to edition 2024 and update deps to latest (#3386) - (e2cfde7)
• Add the timeout duration to the relay dial error (#3406) - (db36c65)

🐛 Bug Fixes

• (iroh) Use std Mutex instead of tokio Mutex (#3374) - (eb383a6)
• (iroh) Track path validity for all paths and replace BestAddr with PathValidity (#3400) - (a3187ca)
• (iroh) Re-batch received relay datagram batches in case they exceed max_receive_segments (#3414) - (a8485ad)
• (iroh) Only clear last_call_me_maybe when the best addr became invalid (#3415) - (bcb60d4)
• (iroh-relay) Fix proptests, make Datagrams::segment_size be an Option<NonZeroU16> (#3404) - (75fd57c)
• Fix dht publishing at startup (#3397) - (dd1d692)
• Better tracing spans (#3399) - (f8f7f95)
• Add missing use<> for wasm_browser (#3411) - (91c2e63)
• Wait for at least one ipv6 and ipv4 qad report (#3413) - (b755db4)

🚜 Refactor

• (iroh,iroh-relay) Remove legacy relay path, make websocket connections default (#3384) - (0776687)

📚 Documentation

• (iroh) Use iroh::Watcher reexport in docs (#3375) - (9c023bf)

🧪 Testing

• (iroh) Make endpoint_relay_connect_loop not flaky (#3402) - (8426241)

⚙️ Miscellaneous Tasks

• (iroh) Update n0-watcher (#3405) - (2ce6a73)
• (iroh) Update portmapper (#3410) - (ee08341)