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

feat: add direct relay-rtc example #260

Merged
merged 8 commits into from
Oct 2, 2023
+11,263 −0
Merged

feat: add direct relay-rtc example #260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f0b204d
add relay-rtc example
weboko Aug 7, 2023
bb06af3
add relay chat example
weboko Aug 29, 2023
bce883a
update readme and texts
weboko Aug 29, 2023
e9118cd
add default node from go-waku prod fleet
weboko Aug 29, 2023
23b6b8c
add ci steps
weboko Aug 29, 2023
87319e9
update readme
weboko Aug 30, 2023
835880c
rename to relay-direct-chat
weboko Aug 30, 2023
2fdd20f
rename to relay-direct-rtc
weboko Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ jobs:
web-chat,
noise-js,
noise-rtc,
relay-direct-rtc
]
runs-on: ubuntu-latest
steps:
Expand Down
1 change: 1 addition & 0 deletions ci/Jenkinsfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ pipeline {
stage('web-chat') { steps { script { buildExample() } } }
stage('noise-js') { steps { script { buildExample() } } }
stage('noise-rtc') { steps { script { buildExample() } } }
stage('relay-direct-rtc') { steps { script { buildExample() } } }
}
}

Expand Down
25 changes: 25 additions & 0 deletions examples/relay-direct-rtc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Direct WebRTC connection for Waku Relay

**Demonstrates**:

- Waku Relay node with direct WebRTC connection
- Pure Javascript/HTML.

This example uses WebRTC transport and Waku Relay to exchange messages.

To test the example run `npm install` and then `npm start`.

The `master` branch's HEAD is deployed at https://examples.waku.org/relay-direct-chat/.

### Steps to run an example:
1. Get a Waku node that implements `/libp2p/circuit/relay/0.2.0/hop` and `/libp2p/circuit/relay/0.2.0/stop`
1.1. Find `go-waku` node or
1.2. Build and then run `go-waku` node with following command: `./build/waku --ws true --relay true --circuit-relay true`
2. Copy node's multiaddr (e.g `/ip4/192.168.0.101/tcp/60001/ws/p2p/16Uiu2HAm9w2xeDWFJm5eeGLZfJdaPtkNatQD1xrzK5EFWSeXdFvu`)
3. In `relay-chat` example's folder run `npm install` and then `npm start`
4. Use `go-waku`'s multiaddr for **Remote node multiaddr** and press dial. Repeat in two more tabs.
5. In `tab2` copy **Local Peer Id** and use as **WebRTC Peer** in `tab1` and press dial.
6. In `tab1` or `tab2` press **Ensure WebRTC Relay connection**
7. In `tab1` press **Drop non WebRTC connections**
8. In `tab1` enter **Nickname** and **Message** and send.
9. See the message in `tab3` which was connected only to `go-waku` node.
Binary file added examples/relay-direct-rtc/favicon.ico
View file
Open in desktop
Binary file not shown.
Binary file added examples/relay-direct-rtc/favicon.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
73 changes: 73 additions & 0 deletions examples/relay-direct-rtc/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta content="width=device-width, initial-scale=1.0" name="viewport" />
<title>Relay direct chat</title>
<link rel="stylesheet" href="./style.css" />
<link rel="apple-touch-icon" href="./favicon.png" />
<link rel="manifest" href="./manifest.json" />
<link rel="icon" href="./favicon.ico" />
</head>

<body>
<div class="content">
<div class="header">
<h3>Status: <span id="status"></span></h3>

<h4><label for="remoteNode">Remote node multiaddr</label></h4>
<div>
<input
id="remoteNode"
value="/dns4/node-01.ac-cn-hongkong-c.go-waku.prod.statusim.net/tcp/443/wss/p2p/16Uiu2HAm1fVVprL9EaDpDw4frNX3CPfZu5cBqhtk9Ncm6WCvprpv"
/>
<button id="connectRemoteNode">Dial</button>
</div>

<h4><label for="webrtcPeer">WebRTC Peer</label></h4>
<div>
<input id="webrtcPeer" />
<button id="connectWebrtcPeer">Dial</button>
</div>

<div>
<button id="relayWebRTC">Ensure WebRTC Relay connection</button>
<button id="dropNonWebRTC">Drop non WebRTC connections</button>
</div>

<details open>
<summary>Peer's information</summary>

<h4>Content topic</h4>
<p id="contentTopic"></p>

<h4>Local Peer Id</h4>
<p id="localPeerId"></p>

<h4>Remote Peer Id</h4>
<p id="remotePeerId"></p>

<h4>Relay mesh's protocols</h4>
<p id="relayMeshInfo"></p>
</details>
</div>

<div id="messages"></div>

<div class="footer">
<div class="inputArea">
<input type="text" id="nickText" placeholder="Nickname" />
<textarea id="messageText" placeholder="Message"></textarea>
</div>

<div class="controls">
<button id="send">Send</button>
<button id="exit">Exit chat</button>
</div>
</div>
</div>

<script src="//cdn.jsdelivr.net/npm/protobufjs@7.X.X/dist/protobuf.min.js"></script>
<script type="module" src="./index.js"></script>
</body>
</html>
Loading
Loading