WebPEER

WebPEER is a Decentralized P2P Network in the Browser. It allows developers to build peer-to-peer webapps without relying on centralized servers or specialized browsers. Aims to return internet control back to users.

>DEMO<

Library

• WebPEER.js - JavaScript implementation of WebPEER designed as minimal low level API. It uses IPFS and libp2p modular stack for the specific purpose of propagating messages across the network through direct WebRTC connections between browsers. Consequently these messages may arrive asyncrhonously depending on the how many iterations the message goes through.

Security

WebPEER Network run over libp2p gossipsub protocol 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.

Benefit

• ✅ Decentralized
• ✅ True P2P
• ✅ Scalable
• ✅ Standard Browser
• ✅ Broadcast Channel
• ✅ No Server
• ✅ No Cloud
• ✅ No Admin
• ✅ Freedom

Ideas

• Blockchain
• Voting / Polling
• Collaborative activity
• IoT
• Social media
• Remote control
• Multiplayer
• Distributed web
• Signalling
• Location tracker
• Activity tracker.
• Chat messenger

Try it out!

• Go to a deployed chat demo at : p2pchat .
• Open the app on another device.
• Both your devices should connected.
• Now start sending message.

Browser Support

Quickstart

NPM install:

npm install webpeerjs

CDN :

• https://esm.sh/webpeerjs

<script type="importmap">
{
	"imports": {
		"webpeerjs" : "https://esm.sh/webpeerjs"
	}
}
</script>

Usage

import { createWebPEER } from 'webpeerjs'

const config = {
	appName : 'myAppHelloWorld'
}

const peer = await createWebPEER();

console.log(`My peer id : ${peer.id}`)

const room = peer.joinRoom('lobbyroom')

room.onMessage((message,id) => {
	console.log(`Message from ${id} : ${message}`)
})

room.onMembers((data) => {
	console.log(`Members : ${data}`)
	room.sendMessage('hello')
})
	

API

peer = await createWebPEER(config)

Create a new peer node.

config - Configuration object contains:

• appName - Unique application name.

peer.id

Get the unique ID of this peer node.

peer.status

Get the peer node status, returns connecting or connected.

• connecting - Currently not connected and is trying to connect to the network.
• connected - Currently connected to the network.

room = peer.joinRoom(namespace)

Join to a room, returns an object.

• room.sendMessage(message) - Method to broadcast message.
• romm.onMessage((message,peer_id)=>{}) - Listen on incoming broadcast message.
• room.onMembers((members)=>{}) - Listen on members update when peer appears and disappears.

See Also

• p2p.js - Alternative simple api WebRTC library with auto matchmaking without signaling server.

License

MIT (c) 2024 Nuzulul Zulkarnain