Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/subins2000/p2pt
Simple WebRTC Peer 2 Peer connections using WebTorrent trackers as the signalling server. Use WebTorrent trackers for any kind of WebRTC app ! 🔥 Make WebRTC apps fast & easy ! 🚀⭐
https://github.com/subins2000/p2pt
p2p signalling-server webrtc websocket-trackers webtorrent webtorrent-trackers
Last synced: 6 days ago
JSON representation
Simple WebRTC Peer 2 Peer connections using WebTorrent trackers as the signalling server. Use WebTorrent trackers for any kind of WebRTC app ! 🔥 Make WebRTC apps fast & easy ! 🚀⭐
- Host: GitHub
- URL: https://github.com/subins2000/p2pt
- Owner: subins2000
- License: mit
- Created: 2020-04-26T19:10:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-11T17:24:38.000Z (10 months ago)
- Last Synced: 2024-05-02T05:58:18.943Z (8 months ago)
- Topics: p2p, signalling-server, webrtc, websocket-trackers, webtorrent, webtorrent-trackers
- Language: JavaScript
- Homepage: https://WebDrop.Space
- Size: 260 KB
- Stars: 517
- Watchers: 13
- Forks: 55
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# P2PT
Simple library to establish P2P connections, communicate messages using WebTorrent Trackers (WebSocket) as the signalling server. Make any kind of WebRTC app using WebTorrent trackers as general-purpose WebRTC signalling servers.
Works in both browser & node environment.
* [Apps made wih P2PT](#examples)
* [API Docs](https://github.com/subins2000/p2pt/blob/master/api-docs.md)
## Features
* Easy to use API
* Send long messages: Data splitted into chunks, sent, received and reassembled all by the library !
* Use WebSocket Trackers as signalling servers
* JSON messaging system
* Send & Respond to messages in a chain using Promise
## How Does It Work ?
The [amazing WebTorrent](https://webtorrent.io/) library created a new kind of Torrent Trackers called "WebSocket Trackers" also known as "WebTorrent Trackers". Some torrent clients can use these new trackers to share files.
Browser torrent clients (example: [BTorrent](https://btorrent.xyz/)) only have the capability to communicate to these WebTorrent trackers and other browser peers (known as **web peers**). Because, JavaScript in browser can't directly make TCP/IP connections and communicate. [Read more about how WebTorrent works here](https://github.com/webtorrent/webtorrent/).
WebRTC is the method by which browsers can communicate to other browsers peer to peer (P2P). WebTorrent makes use of WebRTC for sharing Torrents on web.
But, to establish P2P connections, a signalling server is needed. Signalling servers can be made in any way. But, you'll have to host it yourself. In WebTorrent, it's the **WebSocket trackers** that are the **signalling servers**. What if we use those trackers to establish P2P connections for our apps ?! That is what P2PT does ! :)
How do we find peers for torrent to download ? We use a magnet link. That magnet link has a unique identifier for our torrent called the [Info Hash](https://en.wikipedia.org/wiki/Magnet_URI_scheme#URN,_containing_hash_(xt)). This ID will be unique for all torrents.
Similarly, to build our apps, we use a identifier. This identifier is converted to a valid Info Hash and sent to our **WebTorrent trackers** who will give us a list of **web peers**. These web peers would be the other users also using our app :
```
var p2pt = new P2PT(trackersAnnounceURLs, 'myApp')
```
And that is how P2PT works.
## Examples
### Apps Built With P2PT
* [P2Wiki](//github.com/subins2000/p2wiki): Decentralized P2P proxy to access Wikipedia
* [P2Chat](//github.com/subins2000/p2chat): P2P noregister instant chat
* [Vett](//github.com/subins2000/vett): P2P Dots-and-Boxes game. [Play Here](//dots.subinsb.com)
* [WebDrop](//github.com/subins2000/WebDrop): Easily share file across devices (both LAN & over Internet)
* [Board-IO](//github.com/elvistony/board-io "A Simple Drawing Board thats P2P"): A Simple Drawing Board that's live over P2P. [Try It Out!](https://elvistony.github.io/board-io)
* [Rock Paper Scissor](https://github.com/prinzpiuz/Stone-Paper-Scissor): P2P Rock Paper Scissor game [Play Here](https://silly-fermat-36c0e6.netlify.app/#/)
* [Vaportrade](//github.com/arilotter/vaportrade): P2P Ethereum & Polygon trading dApp with live negotiation. [Make a trade!](https://vaportrade.net/)
Add yours here ! Send a PR ! 🚀
### Simple Example
Open [this webpage](https://codepen.io/subins2000/pen/MWKwRYJ) in two separate browser windows. You'll see the messages. It's a codepen, you can fiddle with the code there.