webpeerjs 0.2.1 → 0.2.3

package/README.md

@@ -1,11 +1,15 @@
-# WebPEER.js
+# WebPEER
 
-WebPEER is a P2P Network that Runs in a Standard Browser.
+WebPEER is a Decentralized P2P Network that Runs on Standard 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<](https://nuzulul.github.io/webpeerjs/demo/chat.html)
 
 ![WebPEER](webpeer.png)
 
+## Library
+
+- [WebPEER.js](https://www.npmjs.com/package/webpeerjs) - JavaScript implementation designed as minimal, low level API provided to build decentralized P2P webapss on top WebPEER Network. Internally, it uses libp2p modular JavaScript stack as its engine.
+
 ## Security
 
 WebPEER Network run over [`libp2p gossipsub`](https://docs.libp2p.io/concepts/security/security-considerations/#publish--subscribe) protocol to enables communication between peers. 
@@ -13,12 +17,14 @@ WebPEER Network run over [`libp2p gossipsub`](https://docs.libp2p.io/concepts/se
 
 > 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
+## Benefit
 
-* ✅ Distributed P2P
+* ✅ Decentralized P2P Network
 * ✅ Scalable Peers
-* ✅ Works in Browsers
-* ✅ Broadcast Messages
+* ✅ Accessible in Standard Browser
+* ✅ Broadcast Channel Provided
+* ✅ No Server Required
+* ✅ Freedom
 
 ## Ideas
 
@@ -26,13 +32,14 @@ WebPEER Network run over [`libp2p gossipsub`](https://docs.libp2p.io/concepts/se
 * Voting / Polling
 * Collaborative activity
 * IoT
-* social media
+* Social media
 * Remote control
 * Multiplayer games
 * Distributed web
 * Signalling protocol
 * Location tracker
 * Activity tracker.
+* Chat messenger
 
 ## Try it out!
 
@@ -66,7 +73,7 @@ CDN :
 </script>
 ```
 
-## Example
+## Usage
 
 ```
 import { createWebPEER } from 'webpeerjs'
@@ -100,24 +107,27 @@ Create a new peer node.
 
 `config` - Configuration object contains:
 
-- `networkName` - Unique identifier name of your network.
+- `networkName` - Unique identifier name of the network to build.
 
-- `rtcConfiguration` - **(optional)** Custom [rtcConfiguration](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/RTCPeerConnection) for WebRTC transport.
+- `rtcConfiguration` - **(optional)** Custom [rtcConfiguration](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/RTCPeerConnection) for WebRTC connection.
 		
 ### `peer.id`
 
-Get the unique ID of the peer node.
+Get the unique ID of this peer node.
 
 ### `peer.status`
 
-Get the peer node status, returns `connected` or `disconnected`.
+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()` - Function to broadcast message to the room.
-- `romm.onMessage((message,id)=>{})` - Listen on incoming broadcast message.
+- `room.sendMessage()` - Method to broadcast message to the room.
+- `romm.onMessage((message,peer_id)=>{})` - Listen on incoming broadcast message.
 - `room.onMembersChange((members)=>{})` - Listen on the room members update.
 
 ## See Also
@@ -126,5 +136,5 @@ Join to a room, returns an object.
 
 ## License
 
-[MIT (c) 2024](https://github.com/nuzulul/webpeerjs/blob/main/LICENSE) [Nuzulul Zulkarnain](https://github.com/nuzulul)
+[MIT](https://github.com/nuzulul/webpeerjs/blob/main/LICENSE) (c) 2024 [Nuzulul Zulkarnain](https://github.com/nuzulul)
 

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "webpeerjs",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "type": "module",
-  "description": "WebPEER is P2P Network that Runs in a Standard Browser",
+  "description": "WebPEER is P2P Network that Runs on Standard Browser",
   "main": "./src/webpeer.js",
   "module": "./src/webpeer.js",
   "exports": {
@@ -70,9 +70,9 @@
     "it-map": "^3.1.6",
     "it-pipe": "^3.0.1",
     "libp2p": "^3.3.4",
-    "multiformats": "^14.0.2",
+    "multiformats": "^14.0.3",
     "protons-runtime": "^7.0.0",
-    "signalingserver.js": "^0.0.6",
+    "signalingserver.js": "^0.0.7",
     "uint8arrays": "^6.1.1"
   }
 }

package/src/config.js

@@ -6,7 +6,7 @@ export const CONFIG_PROTOCOL = '/'+prefix+'/1.0.0'
 export const CONFIG_BLOCKSTORE_PATH = prefix+'-blockstore'
 export const CONFIG_DATASTORE_PATH = prefix+'-datastore'
 export const CONFIG_DBSTORE_PATH = prefix+'-dbstore'
-export const CONFIG_MAX_CONNECTIONS = 30
+export const CONFIG_MAX_CONNECTIONS = 50
 export const CONFIG_MIN_CONNECTIONS = 0
 export const CONFIG_DISCOVER_RELAYS = 1
 export const CONFIG_PEER_DISCOVERY_UNIVERSAL_CONNECTIVITY = 'universal-connectivity-browser-peer-discovery'
@@ -20,12 +20,12 @@ export const CONFIG_DELEGATED_API = 'https://delegated-ipfs.dev'
 export const CONFIG_DNS_RESOLVER = 'https://dns.google/resolve'
 export const CONFIG_KNOWN_BOOTSTRAP_DNS = '_dnsaddr.bootstrap.libp2p.io'
 export const CONFIG_JOIN_ROOM_VERSION = 1
-export const CONFIG_TIMEOUT_DIAL_KNOWN_PEERS = 15000
+export const CONFIG_TIMEOUT_DIAL_KNOWN_PEERS = 15*1000
 export const CONFIG_RUN_ON_TRANSIENT_CONNECTION = false
-export const CONFIG_MESSAGE_SIZE_LIMIT = 100*1024 // 100KB
-export const CONFIG_DEBUG_ENABLED = true
+export const CONFIG_DEBUG_ENABLED = false
 export const CONFIG_AUTODIAL_MAX_ERROR_LIMIT = 45
 export const CONFIG_DIAL_MAX_ERROR_LIMIT = 55
+export const CONFIG_DIAL_WEBSOCKET_FIRST = true;
 
 // this list comes from https://github.com/ipfs/kubo/blob/196887cbe5fbcd41243c1dfb0db681a1cc2914ff/config/bootstrap_peers.go
 export const CONFIG_KNOWN_DEFAULT_BOOTSTRAP_ADDRESSES = [

package/src/webpeer.js

@@ -1,5 +1,5 @@
 //! WebPEER.js -- https://github.com/nuzulul/webpeerjs
-
+  
 import * as config from  './config.js'
 import { 
 	mkErr,
@@ -97,9 +97,6 @@ class webpeerjs{
 	//message tracker avoid double
 	#msgIdtracker
 	
-	//inbound message time tracker
-	#msgTimeTracker
-	
 	//map of peer exchange data
 	#peerexchangedata
 	
@@ -146,7 +143,6 @@ class webpeerjs{
 		this.#lastTimeConnectToNetwork = new Date().getTime()
 		this.#lastTimeReceiveData = new Date().getTime()
 		this.#onConnectQueue = []
-		this.#msgTimeTracker = new Map()
 		
 		this.peers = (function(f) {
 			return f
@@ -156,7 +152,7 @@ class webpeerjs{
 			return libp2p.status
 		})(this.#libp2p);
 		
-		this.status = 'disconnected'
+		this.status = 'connecting'
 
 		this.IPFS = (function(libp2p,discoveredPeers) {
 			const obj = {libp2p,discoveredPeers}
@@ -448,17 +444,11 @@ class webpeerjs{
 
 									//inbound message
 									//use #msgIdtracker to prevent double message
-									//use #msgTimeTracker to limit inbound message count /s
 									if(message){
 										const msgID = msgId+id
-										let oldmsgtime = 0
 										let newmsgtime = new Date().getTime()
-										if(this.#msgTimeTracker.has(id))oldmsgtime = this.#msgTimeTracker.get(id)
-										//const msgtimelimit = 1000
-										const msgtimelimit = -1
-										if(!this.#msgIdtracker.has(msgID) && newmsgtime-oldmsgtime>msgtimelimit){
+										if(!this.#msgIdtracker.has(msgID)){
 											this.#msgIdtracker.set(msgID,newmsgtime)
-											this.#msgTimeTracker.set(id,newmsgtime)
 											this.#rooms[room].onMessage(message,id)
 										}
 									}
@@ -592,21 +582,21 @@ class webpeerjs{
 				let count = this.#trackDisconnect.get(id)
 				count++
 				this.#trackDisconnect.set(id,count)
+				
 				//console.log(this.#trackDisconnect)
 				if(count>5){
 					if(config.CONFIG_KNOWN_BOOTSTRAP_PUBLIC_IDS.includes(id)){
 						return
 					}
-				}
-				else if(count>10){
 					if(this.#dbstoreData.has(id)){
 						this.#dbstoreData.delete(id)
 					}
 					
 					if(!this.#webPeersId.includes(id) && !this.#dialedKnownBootstrap.has(id)){
 						return
-					}
+					}					
 				}
+
 			}
 			else{
 				this.#trackDisconnect.set(id,0)
@@ -669,8 +659,14 @@ class webpeerjs{
 			const addrs = []
 			peer.addresses.forEach((address)=>{
 				const addr = address.multiaddr.toString()+'/p2p/'+id
-				if(addr.includes('webtransport') && addr.includes('certhash')){
-					addrs.push(addr)
+				if(config.CONFIG_DIAL_WEBSOCKET_FIRST){
+					if(addr.includes('/webtransport/') || addr.includes('/ws/') || addr.includes('/wss/')){
+						addrs.push(addr)
+					}				
+				}else{
+					if(addr.includes('webtransport') && addr.includes('certhash')){
+						addrs.push(addr)
+					}
 				}
 			})
 			if(!config.CONFIG_RUN_ON_TRANSIENT_CONNECTION)addrs.reverse()
@@ -678,6 +674,7 @@ class webpeerjs{
 			this.address = addrs
 			this.#ping()
 			this.#peerDiscoveryHybrid()
+			
 			if(addrs.length > 0){
 				const broadcast = {
 					id : this.id,
@@ -686,8 +683,13 @@ class webpeerjs{
 				signalingserver.send(broadcast);				
 				this.status = 'connected'
 			}else{
-				this.status = 'disconnected'
+				if(this.#connectedPeers.size > 0){
+					this.status = 'connected'
+				}else{
+					this.status = 'connecting'
+				}
 			}
+			
 		})
 		
 		
@@ -764,10 +766,11 @@ class webpeerjs{
 		
 		this.#registerProtocol()
 		
-
+		//get on signal from metrics
 		onMetrics((data)=>{
 			const signal = metrics(data)
 			this.#isDialEnabled = signal.isDialEnabled
+			if(!this.#isDialEnabled){console.log('dial disabled')};
 			onDialFn(signal.isAutoDialEnabled)
 			
 		})
@@ -792,6 +795,14 @@ class webpeerjs{
 			this.#garbageCollectionMsgIdTracker()
 		},10e3)
 		
+		//if no address and peers after timeout dial bootstarp with websocket
+		/*setTimeout(()=>{
+			if(this.address.length === 0 && this.#connectedPeersArr.length === 0){
+				console.log('backup');
+				this.#dialKnownDNS();
+			}
+		},90e3)*/
+		
 
 		/*setTimeout(async()=>{
 			try{
@@ -874,10 +885,6 @@ class webpeerjs{
 					const msgId = crypto.randomUUID();
 					const data = JSON.stringify({prefix:config.CONFIG_PREFIX,room,message,id:this.#libp2p.peerId.toString(),msgId})
 					const arr = uint8ArrayFromString(data)
-					const sizelimit = config.CONFIG_MESSAGE_SIZE_LIMIT
-					if(arr.byteLength > sizelimit){
-						throw mkErr(`Only message less than ${sizelimit} byte allowed`);
-					}
 					const peer = {
 					  publicKey: this.#libp2p.peerId.publicKey,
 					  addrs: [arr],
@@ -983,6 +990,18 @@ class webpeerjs{
 			const item = {id:peer[0],address:peer[1].addrs}
 			this.#connectedPeersArr.push(item)
 		}
+		
+		//update status
+		if(this.#connectedPeers.size > 0){
+			this.status = 'connected';
+		}else{
+			if(this.address.length > 0){
+				this.status = 'connected';
+			}else{
+				this.status = 'connecting';
+			}
+		}	
+		
 		this.#ping()
 	}
 
@@ -1558,6 +1577,8 @@ class webpeerjs{
 				}
 			}
 	}
+	
+	
 	//track for good connection
 	async #connectionTracker(){
 		
@@ -1591,41 +1612,52 @@ class webpeerjs{
 	}
 	
 	
-	//dial to all known bootstrap peers and DNS
-	#dialKnownPeers(){
-		setTimeout(()=>{
-			this.#dialSavedKnownID()
-			setTimeout(()=>{this.#dialUpdateSavedKnownID()},20000)
-			setTimeout(()=>{this.#findHybridPeer()},30000)
-			setTimeout(()=>{
-				const peers = this.#libp2p.getPeers().length
-				if(peers == 0){
-					this.#dialKnownID()
-					setTimeout(()=>{this.#findHybridPeer()},30000)
-					setTimeout(()=>{
-						const peers = this.#libp2p.getPeers().length
-						if(peers == 0){
-							this.#dialKnownBootstrap()
-							setTimeout(()=>{this.#findHybridPeer()},15000)
-							setTimeout(()=>{
-								const peers = this.#libp2p.getPeers().length
-								if(peers == 0){
-									this.#dialKnownDNS()
-									setTimeout(()=>{this.#findHybridPeer()},15000)
-									setTimeout(()=>{
-										const peers = this.#libp2p.getPeers().length
-										if(peers == 0){
-											this.#dialKnownDNSonly()
-											setTimeout(()=>{this.#findHybridPeer()},15000)
-										}
-									},config.CONFIG_TIMEOUT_DIAL_KNOWN_PEERS)
-								}
-							},config.CONFIG_TIMEOUT_DIAL_KNOWN_PEERS)
-						}
-					},config.CONFIG_TIMEOUT_DIAL_KNOWN_PEERS)
-				}
-			},config.CONFIG_TIMEOUT_DIAL_KNOWN_PEERS)
-		},5000)
+	//dial to all known bootstrap peers
+	
+	#dialKnownPeers(method){
+		
+		const peers = this.#libp2p.getPeers().length;
+		
+		if(!method){
+			if(config.CONFIG_DIAL_WEBSOCKET_FIRST){
+				this.#isDialWebsocket = true
+				this.#onWebsocketFn(true)				
+				setTimeout(()=>this.#dialKnownPeers('default'), 5*1000);
+			}else{
+				setTimeout(()=>this.#dialKnownPeers('webtransport'), 5*1000);
+			}
+		}
+		
+		if(method === 'default' && peers === 0){
+			this.#dialDefaultBootstarp();
+			setTimeout(()=>this.#dialKnownPeers('dnsonly'), config.CONFIG_TIMEOUT_DIAL_KNOWN_PEERS);
+		}		
+		
+		if(method === 'webtransport' && peers === 0){
+			this.#dialSavedKnownID();
+			setTimeout(()=>this.#dialUpdateSavedKnownID(),20*1000);
+			setTimeout(()=>this.#dialKnownPeers('id'), config.CONFIG_TIMEOUT_DIAL_KNOWN_PEERS);
+		}
+		
+		if(method === 'id' && peers === 0){
+			this.#dialKnownID();
+			setTimeout(()=>this.#dialKnownPeers('bootstarp'), config.CONFIG_TIMEOUT_DIAL_KNOWN_PEERS);
+		}
+		
+		if(method === 'bootstarp' && peers === 0){
+			this.#dialKnownBootstrap();
+			setTimeout(()=>this.#dialKnownPeers('dns'), config.CONFIG_TIMEOUT_DIAL_KNOWN_PEERS);
+		}
+		
+		if(method === 'dns' && peers === 0){
+			this.#dialKnownDNS();
+			setTimeout(()=>this.#dialKnownPeers('dnsonly'), config.CONFIG_TIMEOUT_DIAL_KNOWN_PEERS);
+		}
+		
+		if(method === 'dnsonly' && peers === 0){
+			this.#dialKnownDNSonly();
+		}
+		
 	}
 	
 	async #findHybridPeer(){
@@ -1667,6 +1699,19 @@ class webpeerjs{
 		}
 	} 	
 	
+	async #dialDefaultBootstarp(){
+		for(const addr of config.CONFIG_KNOWN_DEFAULT_BOOTSTRAP_ADDRESSES){
+				const mddr = multiaddr(addr)
+				try {
+				  //console.log(`attempting to dial websocket multiaddr: %o`, mddr)
+				  await this.#libp2p.dial(mddr)
+				} catch (error) {
+				  //console.log(`failed to dial websocket multiaddr: %o`, mddr)
+				  mkDebug(error)
+				}
+		}
+	}
+	
 	async #dialSavedKnownID(){
 
 		if(!navigator.onLine)return
@@ -1699,11 +1744,11 @@ class webpeerjs{
 				const id = peer.ID
 				let mddrs = []
 				let addrs = []
-				for(const addr of address){
-					const peeraddr = addr.toString()+'/p2p/'+id.toString()
-					const peermddr = multiaddr(peeraddr)
-					addrs.push(peeraddr)
-					mddrs.push(peermddr)
+				for(const rawaddr of address){
+					const addr = rawaddr.toString()+'/p2p/'+id.toString()
+					const mddr = multiaddr(addr)
+					addrs.push(addr)
+					mddrs.push(mddr)					
 				}
 				
 				this.#dialedKnownBootstrap.set(id,addrs)
@@ -1714,18 +1759,26 @@ class webpeerjs{
 		}
 	}
 	
+	
+	//Update saved bootstrap address
 	async #dialUpdateSavedKnownID(){
 
 		if(!navigator.onLine)return
 		if(!this.#isDialEnabled)return
 
 		let firsttime = true
+		
 		for(const target of config.CONFIG_KNOWN_BOOTSTRAP_PEERS_IDS){
+			
 			if(this.#dbstoreData.has(target)){
 				firsttime = false
 			}
+		}
+		
+		for(const target of config.CONFIG_KNOWN_BOOTSTRAP_PEERS_IDS){
+		
 			if(!this.#connections.has(target) && (this.#dbstoreData.has(target) || firsttime)){
-				//console.log('#dialUpdateSavedKnownID()',target)
+				
 				const api = config.CONFIG_DELEGATED_API
 				const delegatedClient = delegatedRoutingV1HttpApiClient({url:api})({logger: defaultLogger()})
 				const peer = await first(delegatedClient.getPeers(peerIdFromString(target)))
@@ -1739,11 +1792,11 @@ class webpeerjs{
 				const id = peer.ID
 				let mddrs = []
 				let addrs = []
-				for(const addr of address){
-					const peeraddr = addr.toString()+'/p2p/'+id.toString()
-					const peermddr = multiaddr(peeraddr)
-					addrs.push(peeraddr)
-					mddrs.push(peermddr)
+				for(const rawaddr of address){
+					const addr = rawaddr.toString()+'/p2p/'+id.toString()
+					const mddr = multiaddr(addr)
+					addrs.push(addr)
+					mddrs.push(mddr)				
 				}
 				
 				this.#dialedKnownBootstrap.set(id,addrs)
@@ -1865,7 +1918,7 @@ class webpeerjs{
 	
 	//dial based on known bootstrap DNS using DNS resolver only
 	async #dialKnownDNSonly(){
-		console.log('#dialKnownDNSonly()')
+		//console.log('#dialKnownDNSonly()')
 		if(!navigator.onLine)return
 		if(!this.#isDialEnabled)return
 
@@ -2020,7 +2073,7 @@ const createWebPEER = async (configuration) => {
 			listen: listenaddress,
 		},
 		transports:[
-			webTransport(),
+			//webTransport(),
 			webSockets(),
 			webRTC(webrtcconfig),
 			circuitRelayTransport({