feat(iroh): add initial scaffolding for WebRTC support #3440

anchalshivank · 2025-08-18T07:04:21Z

Hi team,

I’ve added the basic struct for WebRTC support to get things started.
Kindly guide me if this is a good direction or if there’s anything I should take care of early on.

Also, what signaling server setup would you recommend for Iroh’s WebRTC integration?

Thanks!

matheus23 · 2025-08-18T10:02:49Z

We're discussing this in the iroh discord: https://discord.com/channels/1161119546170687619/1406897550140772393

iroh/src/disco.rs

flub

I've had a quick scroll through and noticed a bunch of printlns and commented out code still. Could you add a note on what the stated of completion of the PR is, what the first round of review should pay attention to?

iroh/src/discovery/repomix-output.xml

anchalshivank · 2025-09-09T10:47:23Z

I've had a quick scroll through and noticed a bunch of printlns and commented out code still. Could you add a note on what the stated of completion of the PR is, what the first round of review should pay attention to?

This PR is still in progress - I’ll clean up the println! statements and remove the commented-out code before finalizing. For the first round of review, I’d like you to mainly focus on whether I am correctly sending the WebRTC offer/ICE candidate from one node to another.

Current flow

Node A is spawned.

Node B connects.

Node B uses discovery to send a ping .
We do share different message types ping, pong , call me may be . I added another message type.
I also need to confirm when shall the webrtc offer be exchanged.

I refactored the message-sending logic so that send_ping now also carries WebRTC ICE candidate information.

Points where I need guidance

Virtual socket: Matheus mentioned we should bind a socket. I’m not fully sure if the current approach is sufficient. I could not get intuition.
Refactoring correctness: Did I refactor the send_ping (and related messages) correctly so that ICE candidates are shared properly?
Transport mode setup: The PR currently focuses only on native WebRTC with a transport mode of WebrtcRelay. Could you check if I set up the transport modes correctly?
Socket binding intuition: In handle::new(), IP transports generate a socket address. For WebRTC, should I also bind it to some sort of socket, or is the transport abstraction enough?
WASM case: In WASM, there’s no real socket. How should I be thinking about this when extending the transport to work in WASM?

For now you can ignore webrtc actor (peer connection state ) as it needs to be changed

anchalshivank · 2025-09-10T04:07:33Z

iroh-base/src/node_addr.rs

    /// Socket addresses where the peer might be reached directly.
    pub direct_addresses: BTreeSet<SocketAddr>,
+    /// Static Webrtc connection information for the node
+    pub webrtc_info: Option<WebRtcInfo>,
+}


My understanding:
NodeAddr is used by the discovery system to locate nodes in the network. For discovery purposes, we only need the node_id to find a node. Once found, WebRTC connections are established through the standard offer/answer exchange process.

My concern:
Since WebRTC connections require dynamic offer/answer negotiation anyway, is it necessary to store static WebRTC information like channel_id and webrtc_info (certificate fingerprints) here?

anchalshivank · 2025-09-10T04:09:38Z

iroh-base/src/webrtc_port.rs

I added this file to uniquely identify the webrtc connection on the node locally. We need to decide if this correct.

anchalshivank · 2025-09-10T04:10:18Z

iroh-base/Cargo.toml

this file can be ignored for now

anchalshivank · 2025-09-10T04:14:52Z

iroh-relay/src/node_info.rs

@@ -224,7 +224,7 @@ impl From<NodeAddr> for NodeData {
 /// `UserData` implements [`FromStr`] and [`TryFrom<String>`], so you can
 /// convert `&str` and `String` into `UserData` easily.
 #[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
-pub struct UserData(String);
+pub struct UserData(pub String);


Needs to revert it back. It was a quick fix for compilation erros. #3250

anchalshivank · 2025-09-10T04:15:25Z

iroh/src/magicsock/node_map/node_state.rs

@@ -587,6 +620,7 @@ impl NodeState {
        // direct address paths to contact but no RelayUrl, we still need to send a DISCO
        // ping to the direct address paths so that the other node will learn about us and
        // accepts the connection.
+        println!("----------- 625");


Needs to revert it back. #3250

anchalshivank · 2025-09-10T04:21:36Z

iroh/src/magicsock/node_map/node_state.rs

@@ -115,6 +117,7 @@ pub(super) struct NodeState {
    ///
    /// The fallback/bootstrap path, if non-zero (non-zero for well-behaved clients).
    relay_url: Option<(RelayUrl, PathState)>,
+    webrtc_channel: Option<(ChannelId, PathState)>,


I think this is incorrect. I need more intuition on what node state , what to put it here

anchalshivank · 2025-09-10T04:22:00Z

iroh/src/magicsock/transports/webrtc/actor.rs

We can ignore this file for now

anchalshivank · 2025-09-10T04:22:44Z

iroh/src/magicsock/node_map.rs

@@ -55,6 +56,7 @@ pub(super) struct NodeMap {
 pub(super) struct NodeMapInner {
    by_node_key: HashMap<NodeId, usize>,
    by_ip_port: HashMap<IpPort, usize>,
+    by_webrtc_port: HashMap<WebRtcPort, usize>,


I also need guidance on this part. If this is correct or needs changes

anchalshivank · 2025-09-10T04:23:58Z

iroh/src/endpoint.rs

We can ignore this file for now

anchalshivank · 2025-09-10T04:26:24Z

iroh/src/magicsock.rs

                    }
                }
            }
+            disco::Message::WebRtcIceCandidate(ice) => {
+


When we use this file, we can see the offer being received at this point.

anchalshivank · 2025-09-10T04:33:52Z

iroh/src/magicsock.rs

+        // the packet if grease_quic_bit is set to false.
+        endpoint_config.grease_quic_bit(false);
+
+        let sender = transports.create_sender(msock.clone());
+        let local_addrs_watch = transports.local_addrs_watch();
+        let network_change_sender = transports.create_network_change_sender();
+
+        let endpoint = quinn::Endpoint::new_with_abstract_socket(
+            endpoint_config,
+            Some(server_config),
+            Box::new(MagicUdpSocket {
+                socket: msock.clone(),
+                transports,
+            }),
+            #[cfg(not(wasm_browser))]
+            Arc::new(quinn::TokioRuntime),
+            #[cfg(wasm_browser)]
+            Arc::new(crate::web_runtime::WebRuntime),
+        )
+        .context(CreateQuinnEndpointSnafu)?;
+
+        let network_monitor = netmon::Monitor::new()
+            .await
+            .context(CreateNetmonMonitorSnafu)?;
+
+        let qad_endpoint = endpoint.clone();
+
+        #[cfg(any(test, feature = "test-utils"))]
+        let client_config = if insecure_skip_relay_cert_verify {
+            iroh_relay::client::make_dangerous_client_config()
+        } else {
+            default_quic_client_config()
+        };
+        #[cfg(not(any(test, feature = "test-utils")))]
+        let client_config = default_quic_client_config();
+
+        let net_report_config = net_report::Options::default();
+        #[cfg(not(wasm_browser))]
+        let net_report_config = net_report_config.quic_config(Some(QuicConfig {
+            ep: qad_endpoint,
+            client_config,
+            ipv4: true,
+            ipv6,
+        }));
+
+        #[cfg(any(test, feature = "test-utils"))]
+        let net_report_config =
+            net_report_config.insecure_skip_relay_cert_verify(insecure_skip_relay_cert_verify);
+
+        let net_reporter = net_report::Client::new(
+            #[cfg(not(wasm_browser))]
+            dns_resolver,
+            #[cfg(not(wasm_browser))]
+            Some(ip_mapped_addrs),
+            relay_map.clone(),
+            net_report_config,
+            metrics.net_report.clone(),
+        );
+
+        let (direct_addr_done_tx, direct_addr_done_rx) = mpsc::channel(8);
+        let direct_addr_update_state = DirectAddrUpdateState::new(
+            msock.clone(),
+            #[cfg(not(wasm_browser))]
+            port_mapper,
+            Arc::new(AsyncMutex::new(net_reporter)),
+            relay_map,
+            direct_addr_done_tx,
+        );
+
+        let netmon_watcher = network_monitor.interface_state();
+        let actor = Actor {
+            msg_receiver: actor_receiver,
+            msock: msock.clone(),
+            periodic_re_stun_timer: new_re_stun_timer(false),
+            network_monitor,
+            netmon_watcher,
+            direct_addr_update_state,
+            network_change_sender,
+            direct_addr_done_rx,
+            pending_call_me_maybes: Default::default(),
+            disco_receiver,
+        };
+
+        let actor_token = CancellationToken::new();
+        let token = actor_token.clone();
+        let actor_task = task::spawn(
+            actor
+                .run(token, local_addrs_watch, sender)
+                .instrument(info_span!("actor")),
+        );
+
+        let actor_task = Arc::new(Mutex::new(Some(AbortOnDropHandle::new(actor_task))));
+
+        Ok(Handle {
+            msock,
+            actor_task,
+            endpoint,
+            actor_token,
+        })
+    }


We can ignore this part for now

anchalshivank · 2025-09-10T04:34:23Z

iroh/src/magicsock.rs

+        let network_change_sender = transports.create_network_change_sender();
+
+        let endpoint = quinn::Endpoint::new_with_abstract_socket(
+            endpoint_config,
+            Some(server_config),
+            Box::new(MagicUdpSocket {
+                socket: msock.clone(),
+                transports,
+            }),
+            #[cfg(not(wasm_browser))]
+            Arc::new(quinn::TokioRuntime),
+            #[cfg(wasm_browser)]
+            Arc::new(crate::web_runtime::WebRuntime),
+        )
+        .context(CreateQuinnEndpointSnafu)?;
+
+        let network_monitor = netmon::Monitor::new()
+            .await
+            .context(CreateNetmonMonitorSnafu)?;
+
+        let qad_endpoint = endpoint.clone();
+
+        #[cfg(any(test, feature = "test-utils"))]
+        let client_config = if insecure_skip_relay_cert_verify {
+            iroh_relay::client::make_dangerous_client_config()
+        } else {
+            default_quic_client_config()
+        };
+        #[cfg(not(any(test, feature = "test-utils")))]
+        let client_config = default_quic_client_config();
+
+        let net_report_config = net_report::Options::default();
+        #[cfg(not(wasm_browser))]
+        let net_report_config = net_report_config.quic_config(Some(QuicConfig {
+            ep: qad_endpoint,
+            client_config,
+            ipv4: true,
+            ipv6,
+        }));
+
+        #[cfg(any(test, feature = "test-utils"))]
+        let net_report_config =
+            net_report_config.insecure_skip_relay_cert_verify(insecure_skip_relay_cert_verify);
+
+        let net_reporter = net_report::Client::new(
+            #[cfg(not(wasm_browser))]
+            dns_resolver,
+            #[cfg(not(wasm_browser))]
+            Some(ip_mapped_addrs),
+            relay_map.clone(),
+            net_report_config,
+            metrics.net_report.clone(),
+        );
+
+        let (direct_addr_done_tx, direct_addr_done_rx) = mpsc::channel(8);
+        let direct_addr_update_state = DirectAddrUpdateState::new(
+            msock.clone(),
+            #[cfg(not(wasm_browser))]
+            port_mapper,
+            Arc::new(AsyncMutex::new(net_reporter)),
+            relay_map,
+            direct_addr_done_tx,
+        );
+
+        let netmon_watcher = network_monitor.interface_state();
+        let actor = Actor {
+            msg_receiver: actor_receiver,
+            msock: msock.clone(),
+            periodic_re_stun_timer: new_re_stun_timer(false),
+            network_monitor,
+            netmon_watcher,
+            direct_addr_update_state,
+            network_change_sender,
+            direct_addr_done_rx,
+            pending_call_me_maybes: Default::default(),
+            disco_receiver,
+        };
+
+        let actor_token = CancellationToken::new();
+        let token = actor_token.clone();
+        let actor_task = task::spawn(
+            actor
+                .run(token, local_addrs_watch, sender)
+                .instrument(info_span!("actor")),
+        );
+
+        let actor_task = Arc::new(Mutex::new(Some(AbortOnDropHandle::new(actor_task))));
+
+        Ok(Handle {
+            msock,
+            actor_task,
+            endpoint,
+            actor_token,
+        })
+    }
+
+    /// The underlying [`quinn::Endpoint`]
+    pub fn endpoint(&self) -> &quinn::Endpoint {
+        &self.endpoint
+    }


Also ignore this part

anchalshivank · 2025-09-10T04:35:28Z

iroh/src/disco.rs

@@ -57,8 +56,11 @@ pub enum MessageType {
    Ping = 0x01,
    Pong = 0x02,
    CallMeMaybe = 0x03,
+    WebRtcIceCandidate = 0x06


I think this will also need some refactoring

anchalshivank · 2025-09-10T04:36:50Z

iroh/Cargo.toml

Since I was running the complete stack locally, I had to modify the Cargo.toml. I think we should consider adding Cargo.toml to .gitignore, unless you suggest a better approach.

feat(iroh): add initial scaffolding for WebRTC support

fb83cc8

n0bot bot added this to iroh Aug 18, 2025

github-project-automation bot moved this to 🏗 In progress in iroh Aug 18, 2025

anchalshivank added 3 commits August 19, 2025 16:17

feat(iroh): add basic webrtc implementation

908eef3

Merge branch 'main' into feature/webrtc-wasm-support

676a6b3

feat(webrtc): implement actor and sender

54e9423

matheus23 reviewed Aug 27, 2025

View reviewed changes

iroh/src/disco.rs Outdated Show resolved Hide resolved

feat(webrtc): add webrtc poll_recv, webrtc transport and webrtc sender

257bdb5

anchalshivank requested a review from matheus23 September 2, 2025 15:10

anchalshivank added 5 commits September 4, 2025 02:04

feat(webrtc): add various builder for different transports

3496a19

Merge branch 'main' into feature/webrtc-wasm-support

a559b35

fix(webrtc): fix compile errors

219915a

feat(webrtc): add webrtc initiation in ping action for disco

d4ce636

feat(webrtc): exchange offer via disco

4a358f2

flub reviewed Sep 9, 2025

View reviewed changes

iroh/src/discovery/repomix-output.xml Outdated Show resolved Hide resolved

chore(webrtc): remove repomix.xml

b87d3f8

anchalshivank commented Sep 10, 2025

View reviewed changes

anchalshivank requested a review from flub September 10, 2025 04:37

anchalshivank added 4 commits September 11, 2025 23:53

feat(webrtc): add offer and answer exchange struct

7d4cfbd

feat(webrtc): send answer after receiving offer

dd02f37

feat(webrtc): add ice exchange

b054362

feat(webrtc): send ice-candidates

829a419

feat(iroh): add initial scaffolding for WebRTC support #3440

Are you sure you want to change the base?

feat(iroh): add initial scaffolding for WebRTC support #3440

Uh oh!

Conversation

anchalshivank commented Aug 18, 2025

Uh oh!

matheus23 commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

flub left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

anchalshivank commented Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

matheus23 commented Aug 18, 2025 •

edited

Loading

anchalshivank commented Sep 9, 2025 •

edited

Loading