libp2p/js-libp2p-examples

Add WebRTC private to public example

Open

#204 opened on Feb 18, 2025

View on GitHubContributor guide
 (3 comments) (3 reactions) (0 assignees) (63 forks)auto 404
good first issuehelp wanted

Repository metrics

Stars
 (106 stars)
PR merge metrics
 (PR metrics pending)

Description

We have an example for WebRTC private to private (e.g. two browser peers behind NATs) where we use a Circuit Relay server to exchange SDP messages to establish a direct connection between the two nodes.

As of @libp2p/webrtc@5.1.0 support has landed for WebRTC-Direct listeners in Node.js, so it would be great to add a private to public example where a Node.js listener is created and a browser dials it without needing a relay.

Contributor guide

Research direction
Review the existing private to private WebRTC example and the @libp2p/webrtc documentation for WebRTC Direct listeners. Create a new example with a Node.js listener and a browser dialer that connects directly without a relay.
Tech stack
javascriptnodejs
Domain
backendnetworking
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65