libp2p / libp2p/js-libp2p-examples

Add WebRTC private to public example

Open
#204 3 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help wanted
Dominant language
No language data
Stars
105
Forks
63
PR merge metrics
No merged PRs in 30d

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing WebRTC private-to-private example and reviewing how it uses Circuit Relay to exchange SDP messages. Then trace the @libp2p/webrtc 5.1.0 WebRTC-Direct listener support in Node.js and add the corresponding browser-to-Node example. Done means a browser can dial the Node.js listener without a relay.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
networking
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.