WebPEER.js

Decentralized P2P JS library for communication between applications in browser.

WebPEER.js enables browser to browser connectivity without a central server. Build completely peer-to-peer web applications, no trackers or relay servers required. Connecting projects safely, privately, and reliably.

Basic Connection Demo

Security

WebPEER.js uses libp2p gossipsub to enables communication between peers.

By default, the gossipsub implementation will sign all messages with the author’s private key, and require a valid signature before accepting or propagating a message further. This prevents messages from being altered in flight, and allows recipients to authenticate the sender.

However, as a cooperative protocol, it may be possible for peers to interfere with the message routing algorithm in a way that disrupts the flow of messages through the network.

Features

• ✅ Decentralized P2P
• ✅ Scalable Peers
• ✅ Works in Browsers
• ✅ Broadcast Messages
• ✅ Censorship Resistant

Browser Support

Latest ✔	Latest ✔	Latest ✔	Latest ✔	Latest ✔	Latest ✔

Quickstart

Try now in Playground :

https://jsbin.com/suwesaliro/1/edit?html,output

NPM install:

npm i webpeerjs

Browser <script> tag :

Uses built-in JS files from latest release or CDN will make it's exports available as webpeerjs in the global namespace.

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/umd/webpeerjs.min.js"></script>

Usage

import { webpeerjs } from 'webpeerjs'

void async function main() {

	const node = await webpeerjs.createWebpeer()
	
	console.log(`My node id : ${node.id}`)
	
	const [broadcast,listen,members] = node.joinRoom('globalroom')
	
	listen((message,id) => {
		console.log(`Message from ${id} : ${message}`)
	})
	
	members((data) => {
		console.log(`Members : ${data}`)
		broadcast('hello')
	})
	
}()

API

• createWebpeer() - Create a new node.
• id - The unique ID of the node as an identity in the global network.
• status - Get the node status, returns connected or unconnected.
• peers - Get all connected peers.
• joinRoom(namespace) - Join to the room, returns an array of three functions (Broadcaster, onListenBroadcast, onMembersUpdate).

API Docs

https://nuzulul.github.io/webpeerjs

License

MIT

Maintainers

Nuzulul Zulkarnain