Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Add WebRTC private to public example #208

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: Add WebRTC private to public example #208

wants to merge 2 commits into from

Conversation

Nkovaturient
Copy link

@Nkovaturient Nkovaturient commented Mar 1, 2025 •
edited
Loading

feat: Implement WebRTC Private-to-Public Peer Communication

Description

This PR introduces a WebRTC private-to-public implementation where a Node.js peer acts as a listener, and a browser peer dials it using WebRTC-Direct. This eliminates the need for a circuit relay.

Changes:

Public Peer (Node.js):

  • Listens on /ip4/public-ip/tcp/4001/webrtc-direct.
  • Logs available multiaddrs on startup.

Private Peer (Browser):

  • Dials the public peer manually using WebRTC-Direct.
  • Handles messaging using /chat/1.0.0.
  • Improved Connection Handling:
  • Displays status messages on success/failure.
  • Ensures proper setup for WebRTC communication.
  • Fixes : Add WebRTC private to public example #204

Notes & Open Questions

  • Should we add automatic reconnection if the WebRTC connection drops?
  • when adding listener for 'webrtc-direct' it returns, how to fix?
address: {
          listen: ['/ip4/<public-ip>/tcp/4001/webrtc-direct'] 
        },

node .\index.js
Failed to create node: no valid addresses were provided for transports [@libp2p/webrtc-direct]
  • ig the issue is in public-peer listening addr not being configured properly
  • I have setup inbound connections to listen to this port 4001, yet no avail

Checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation if necessary (this includes comments as well)
  • I have added tests that prove my fix is effective or that my feature works

@Nkovaturient Nkovaturient changed the title Add WebRTC private to public example feat: Add WebRTC private to public example Mar 1, 2025
@silkroadnomad
Copy link

silkroadnomad commented Mar 11, 2025 •
edited
Loading

@Nkovaturient that looks great to me. Btw. Maybe you know how to make a browser-to-browser webrtc-direct example without a relay node by simple creating an SDP (e.g. via STUN) of browser A and then transferring the SDP file or scan a SDP QR code to browser B which then can simply connect to browser A without circuit-relay!

There's an example on how to do that (without libp2p) in the webrtc.org examples, it would be amazing to have this working for libp2p and ipfs too!

Like that, people could create ad-hoc libp2p networks on the streets or nature when no wifi or internet is available, e.g. via bluetooth without the need of a public relay. This might be also of help in countries which might ip-block all public libp2p relays and still exchange / replicate their data when meeting in person or via any social media.

@Nkovaturient
Copy link
Author

Nkovaturient commented Mar 14, 2025 •
edited
Loading

hey @silkroadnomad , since we have a webrtc-pvt-to-pvt example that utilises a circuit-relay reservation for peer/IP discovery as of now, we can start to endeavor by changing it to WebRTC-Direct SDP Exchange via QR Code where

Instead of a signaling server (relay node), candidates are transferred via QR Code. Browser B adds ICE candidates and establishes the WebRTC P2P connection.

that will be cool, indeed!

@Nkovaturient
Copy link
Author

also, using a STUN server is a centralized method for public IP discovery?

  • STUN only helps peers determine their external IP & NAT type (it does not relay data).
  • If both peers are publicly reachable, WebRTC-Direct can work without a relay.
  • If behind restrictive NATs, additional techniques (TURN, manual ICE exchange) are needed.

@silkroadnomad
Copy link

silkroadnomad commented Mar 14, 2025 •
edited
Loading

That's all true. But in case of a Bluetooth network (and no other network in the jungle) between two phones, SDP without circuit-relay-v2 would be a great substitute. (In case e.g. the bluetooth api in Chrome can do what I am proposing)

@Nkovaturient
Copy link
Author

Nkovaturient commented Mar 14, 2025 •
edited
Loading

That's all true. But in case of a Bluetooth network (and no other network in the jungle) between two phones, SDP without circuit-relay-v2 would be a great substitute. (In case e.g. the bluetooth api in Chrome can do what I am proposing)

well, agree ! https://blog.libp2p.io/libp2p-webrtc-browser-to-server/

@Nkovaturient Nkovaturient mentioned this pull request Mar 15, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add WebRTC private to public example
2 participants
@Nkovaturient @silkroadnomad