webpeerjs 0.1.6 → 0.1.7

package/package.json

@@ -1,88 +1,88 @@
-{
-  "name": "webpeerjs",
-  "version": "0.1.6",
-  "description": "WebPEER.js is decentralized P2P JS library for communication between applications in browser.",
-  "main": "./dist/umd/webpeerjs.js",
-  "module": "./src/webpeerjs.js",
-  "exports": {
-    ".": {
-      "import": "./src/webpeerjs.js",
-      "require": "./dist/umd/webpeerjs.js"
-    }
-  },
-  "files": [
-    "dist/",
-    "src/",
-    "LICENSE"
-  ],
-  "scripts": {
-    "start": "npm run dev",
-    "dev": "vite serve test",
-    "demo": "vite serve demo",
-    "eslint": "eslint -c ./config/eslint.config.mjs ./src",
-    "eslint:fix": "eslint -c ./config/eslint.config.mjs ./src --fix",
-    "removedir": "node -e \"var fs = require('fs'); try{process.argv.slice(1).map((fpath) => fs.rmdirSync(fpath, { recursive: true }))}catch(err){console.log(`Dist not found`)}; process.exit(0);\"",
-    "build-all": "tsc -p config/tsconfig-rollup.json && rollup -c temp/config/rollup.config.build.js && echo {\"type\": \"commonjs\"}>dist\\umd\\package.json && echo {\"type\": \"module\"}>dist\\esm\\package.json",
-    "build-types": "tsc -p config/tsconfig-esm.json",
-    "build": "npm run removedir dist temp && npm run build-all",
-    "test": "cd test && cd project && npm start"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/nuzulul/webpeerjs.git"
-  },
-  "keywords": [
-    "p2p",
-    "ipfs",
-	"libp2p",
-    "peer",
-    "peer-to-peer",
-    "decentralized",
-    "browser-to-browser",
-	"dapp",
-	"distributed",
-	"decentralized-web",
-	"distributed-web",
-	"serverless"
-  ],
-  "author": {
-    "name": "Nuzulul Zulkarnain",
-    "url": "https://nuzulul.github.io"
-  },
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/nuzulul/webpeerjs/issues"
-  },
-  "homepage": "https://github.com/nuzulul/webpeerjs#readme",
-  "dependencies": {
-    "@chainsafe/libp2p-gossipsub": "^13.0.0",
-    "@chainsafe/libp2p-noise": "^15.0.0",
-    "@chainsafe/libp2p-yamux": "^6.0.2",
-    "@helia/delegated-routing-v1-http-api-client": "^3.0.1",
-    "@libp2p/circuit-relay-v2": "^1.0.24",
-    "@libp2p/dcutr": "^1.1.0",
-    "@libp2p/identify": "^2.0.2",
-    "@libp2p/kad-dht": "^12.0.17",
-    "@libp2p/peer-id": "^4.1.2",
-    "@libp2p/pubsub-peer-discovery": "^10.0.2",
-    "@libp2p/simple-metrics": "^1.0.2",
-    "@libp2p/webrtc": "^4.1.0",
-    "@libp2p/websockets": "^8.1.0",
-    "@libp2p/webtransport": "^4.0.32",
-    "datastore-idb": "^2.1.9",
-    "libp2p": "^1.6.0"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.4.0",
-    "@rollup/plugin-commonjs": "^25.0.8",
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^11.1.6",
-    "eslint": "^9.4.0",
-    "globals": "^15.3.0",
-    "rollup": "^4.18.0",
-    "tslib": "^2.6.2",
-    "typescript": "^5.4.5",
-    "vite": "^5.2.11"
-  }
-}
+{
+  "name": "webpeerjs",
+  "version": "0.1.7",
+  "description": "WebPEER.js is decentralized P2P JS library for communication between applications in browser.",
+  "main": "./dist/umd/webpeerjs.js",
+  "module": "./src/webpeerjs.js",
+  "exports": {
+    ".": {
+      "import": "./src/webpeerjs.js",
+      "require": "./dist/umd/webpeerjs.js"
+    }
+  },
+  "files": [
+    "dist/",
+    "src/",
+    "LICENSE"
+  ],
+  "scripts": {
+    "start": "npm run dev",
+    "dev": "vite serve test",
+    "demo": "vite serve demo",
+    "eslint": "eslint -c ./config/eslint.config.mjs ./src",
+    "eslint:fix": "eslint -c ./config/eslint.config.mjs ./src --fix",
+    "removedir": "node -e \"var fs = require('fs'); try{process.argv.slice(1).map((fpath) => fs.rmdirSync(fpath, { recursive: true }))}catch(err){console.log(`Dist not found`)}; process.exit(0);\"",
+    "build-all": "tsc -p config/tsconfig-rollup.json && rollup -c temp/config/rollup.config.build.js && echo {\"type\": \"commonjs\"}>dist\\umd\\package.json && echo {\"type\": \"module\"}>dist\\esm\\package.json",
+    "build-types": "tsc -p config/tsconfig-esm.json",
+    "build": "npm run removedir dist temp && npm run build-all",
+    "test": "cd test && cd project && npm start"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nuzulul/webpeerjs.git"
+  },
+  "keywords": [
+    "p2p",
+    "ipfs",
+	"libp2p",
+    "peer",
+    "peer-to-peer",
+    "decentralized",
+    "browser-to-browser",
+	"dapp",
+	"distributed",
+	"decentralized-web",
+	"distributed-web",
+	"serverless"
+  ],
+  "author": {
+    "name": "Nuzulul Zulkarnain",
+    "url": "https://nuzulul.github.io"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/nuzulul/webpeerjs/issues"
+  },
+  "homepage": "https://github.com/nuzulul/webpeerjs#readme",
+  "dependencies": {
+    "@chainsafe/libp2p-gossipsub": "^13.0.0",
+    "@chainsafe/libp2p-noise": "^15.0.0",
+    "@chainsafe/libp2p-yamux": "^6.0.2",
+    "@helia/delegated-routing-v1-http-api-client": "^3.0.1",
+    "@libp2p/circuit-relay-v2": "^1.0.24",
+    "@libp2p/dcutr": "^1.1.0",
+    "@libp2p/identify": "^2.0.2",
+    "@libp2p/kad-dht": "^12.0.17",
+    "@libp2p/peer-id": "^4.1.2",
+    "@libp2p/pubsub-peer-discovery": "^10.0.2",
+    "@libp2p/simple-metrics": "^1.0.2",
+    "@libp2p/webrtc": "^4.1.0",
+    "@libp2p/websockets": "^8.1.0",
+    "@libp2p/webtransport": "^4.0.32",
+    "datastore-idb": "^2.1.9",
+    "libp2p": "^1.6.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.4.0",
+    "@rollup/plugin-commonjs": "^25.0.8",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "eslint": "^9.4.0",
+    "globals": "^15.3.0",
+    "rollup": "^4.18.0",
+    "tslib": "^2.6.2",
+    "typescript": "^5.4.5",
+    "vite": "^5.2.11"
+  }
+}

package/src/config.js

@@ -24,13 +24,19 @@ export const CONFIG_TIMEOUT_DIAL_KNOWN_PEERS = 15000
 export const CONFIG_RUN_ON_TRANSIENT_CONNECTION = false
 export const CONFIG_WEBRTC_STUN_URLS = 'stun:stun.l.google.com:19302'
 export const CONFIG_WEBRTC_STUN_URLS_BACKUP = 'stun:global.stun.twilio.com:3478'
-export const CONFIG_WEBRTC_TURN_HOST = 'dHVybjpyZWxheTEuZXhwcmVzc3R1cm4uY29tOjM0Nzg='
-export const CONFIG_WEBRTC_TURN_USER = 'ZWZJSllZNjdDNElRMzFZQUlP'
-export const CONFIG_WEBRTC_TURN_PWD = 'Vk01SmdhODlkYjJaWU9aSA=='
-export const CONFIG_WEBRTC_TURN_HOST_BACKUP = 'dHVybjpzdGFuZGFyZC5yZWxheS5tZXRlcmVkLmNhOjgw'
-export const CONFIG_WEBRTC_TURN_USER_BACKUP = 'ZmZlNmIxOThjOGMxYjM5ODg1OWFiOGY4'
-export const CONFIG_WEBRTC_TURN_PWD_BACKUP = 'aWpkQjVTcTIwREVsZzdDRg=='
-export const CONFIG_MESSAGE_SIZE_LIMIT = 10240 // 10KB
+export const CONFIG_WEBRTC_TURN_HOST = 'dHVybjp0dXJuMDEuYnJpZS5maTo1MzQ5'
+export const CONFIG_WEBRTC_TURN_USER = 'YnJpZQ=='
+export const CONFIG_WEBRTC_TURN_PWD = 'Zmk='
+export const CONFIG_WEBRTC_TURN_HOST_BACKUP = 'dHVybjpyZWxheTEuZXhwcmVzc3R1cm4uY29tOjM0Nzg='
+export const CONFIG_WEBRTC_TURN_USER_BACKUP = 'ZWZJSllZNjdDNElRMzFZQUlP'
+export const CONFIG_WEBRTC_TURN_PWD_BACKUP = 'Vk01SmdhODlkYjJaWU9aSA=='
+export const CONFIG_WEBRTC_TURN_HOST_BACKUP1 = 'dHVybjpzdGFuZGFyZC5yZWxheS5tZXRlcmVkLmNhOjgw'
+export const CONFIG_WEBRTC_TURN_USER_BACKUP1 = 'ZmZlNmIxOThjOGMxYjM5ODg1OWFiOGY4'
+export const CONFIG_WEBRTC_TURN_PWD_BACKUP1 = 'aWpkQjVTcTIwREVsZzdDRg=='
+export const CONFIG_MESSAGE_SIZE_LIMIT = 100*1024 // 100KB
+export const CONFIG_DEBUG_ENABLED = false
+export const CONFIG_AUTODIAL_MAX_ERROR_LIMIT = 45
+export const CONFIG_DIAL_MAX_ERROR_LIMIT = 55
 
 // this list comes from https://github.com/ipfs/kubo/blob/196887cbe5fbcd41243c1dfb0db681a1cc2914ff/config/bootstrap_peers.go
 export const CONFIG_KNOWN_DEFAULT_BOOTSTRAP_ADDRESSES = [

package/src/utils.js

@@ -28,7 +28,7 @@ const prefix = config.CONFIG_PREFIX
 export const mkErr = msg => new Error(`${prefix}: ${msg}`)
 
 export function mkDebug(msg){
-	console.debug(msg)
+	if(config.CONFIG_DEBUG_ENABLED)console.debug(msg)
 	return
 }
 
@@ -51,6 +51,28 @@ export async function first(farr){
 		}
 }
 
+//browser detector
+//this code comes from https://stackoverflow.com/a/9851769
+
+// Opera 8.0+
+const isOpera = (!!window.opr && !!window.opr.addons) || !!window.opera || navigator.userAgent.indexOf(' OPR/') >= 0;
+// Firefox 1.0+
+const isFirefox = typeof InstallTrigger !== 'undefined';
+// Safari 3.0+ "[object HTMLElementConstructor]" 
+const isSafari = /constructor/i.test(window.HTMLElement) || (function (p) { return p.toString() === "[object SafariRemoteNotification]"; })(!window['safari'] || (typeof safari !== 'undefined' && window['safari'].pushNotification));
+// Internet Explorer 6-11
+//const isIE = /*@cc_on!@*/false || !!document.documentMode;
+// Edge 20+
+//const isEdge = !isIE && !!window.StyleMedia;
+// Chrome 1 - 79
+const isChrome = !!window.chrome && (!!window.chrome.webstore || !!window.chrome.runtime);
+// Edge (based on chromium) detection
+const isEdgeChromium = isChrome && (navigator.userAgent.indexOf("Edg") != -1);
+// Blink engine detection
+const isBlink = (isChrome || isOpera) && !!window.CSS;
+
+export const browser = {isOpera,isFirefox,isSafari,isChrome,isEdgeChromium,isBlink}
+
 //Add id to pupsub message
 export async function msgIdFnStrictNoSign(msg){
   var enc = new TextEncoder()
@@ -98,11 +120,19 @@ let lastStats = {
     open: 0
 }
 
+let fail = 0
 let isDialEnabled = true
 let lastfailtreshold = 0
-let fail = 0
+let isAutoDialEnabled = true
+let lastfailtresholdauto = 0
+
 
 export function metrics(data){
+	
+	if(isFirefox){
+		return {isDialEnabled,isAutoDialEnabled}
+	}
+	
 	try{
 		const webTransportEvents = data.libp2p_webtransport_dialer_events_total
 		
@@ -154,34 +184,50 @@ export function metrics(data){
 		lastStats = webTransportEvents
 		
 		fail = errors+timeouts
-		const treshold = errors+timeouts+stats.open+stats.pending
-		
-		if(treshold>30){
-			//console.log(`Treeshold hit : ${treshold}`)
-		}
-		
-		if(fail>30){
-			//console.log(`Open : ${stats.open} , Pending : ${stats.pending} , Succes : ${totals.success} , Fail : ${fail} `)
-
-		}
+		//const treshold = errors+timeouts+stats.open+stats.pending
 		
-		if ((fail-lastfailtreshold)>30){
+		if ((fail-lastfailtreshold)>config.CONFIG_DIAL_MAX_ERROR_LIMIT){
 			if(isDialEnabled){
 				isDialEnabled = false
-				//const str = JSON.stringify({isDialEnabled,fail,lastfailtreshold})
 				console.warn('Peer dial is temporary disabled')
+				if(isAutoDialEnabled){
+					isAutoDialEnabled = false
+					console.warn('Peer autodial is temporary disabled')
+				}
 				setTimeout(()=>{
 					if(!isDialEnabled){
 						isDialEnabled = true
 						lastfailtreshold = fail
-						//const str = JSON.stringify({isDialEnabled,fail,lastfailtreshold})
-						console.warn('Peer dial is enabled')
+						console.warn('Peer dial is resumed')
+						if(!isAutoDialEnabled){
+							isAutoDialEnabled = true
+							lastfailtresholdauto = fail
+							console.warn('Peer autodial is resumed')
+						}
+					}
+				},6*60*1000)
+			}
+		}
+
+		if ((fail-lastfailtresholdauto)>config.CONFIG_AUTODIAL_MAX_ERROR_LIMIT){
+			if(isAutoDialEnabled){
+				isAutoDialEnabled = false
+				console.warn('Peer autodial is temporary disabled')
+				const last = fail
+				setTimeout(()=>{
+					if(!isAutoDialEnabled && isDialEnabled){
+						isAutoDialEnabled = true
+						lastfailtresholdauto = fail
+						console.warn('Peer autodial is resumed')
+						if(isDialEnabled){
+							lastfailtreshold = last
+						}
 					}
 				},6*60*1000)
 			}
 		}
 		
-		return isDialEnabled
+		return {isDialEnabled,isAutoDialEnabled}
 		
 	}
 	catch{
@@ -200,4 +246,9 @@ export async function getDigest(){
 	const buf = new TextEncoder().encode(Math.random().toString())
 	const digest = await sha256.encode(buf)
 	return digest
+}
+
+//detect webtransport
+if(!WebTransport){
+	throw mkErr('It seems that your browser does not support the required WebTransport feature')
 }

package/src/webpeerjs.js

@@ -102,16 +102,20 @@ class webpeerjs{
 	//arr to track on connect event
 	#onConnectQueue
 	
+	//callback to websocket dialable
+	#onWebsocketFn
+	
 	id
 	status
 	IPFS
 	address
 	peers
 	
-	constructor(libp2p,dbstore,onMetrics){
+	constructor(libp2p,dbstore,onMetrics,onWebsocketFn,onDialFn){
 		
 		this.#libp2p = libp2p
 		this.#dbstore = dbstore
+		this.#onWebsocketFn = onWebsocketFn
 		this.#dbstoreData = new Map()
 		this.#discoveredPeers = new Map()
 		this.#webPeersId = []
@@ -581,15 +585,16 @@ class webpeerjs{
 			//const multiaddrs = peer.addresses.map(({ multiaddr }) => multiaddr)
 			//console.log(`changed multiaddrs: peer ${peer.id.toString()} multiaddrs: ${multiaddrs}`)
 			const id = peer.id.toString()
-			const mddrs = []
-			peer.addresses.forEach((addr)=>{
-				const maddr = addr.multiaddr.toString()+'/p2p/'+id
-				if(maddr.includes('webtransport') && maddr.includes('certhash')){
-					mddrs.push(maddr)
+			const addrs = []
+			peer.addresses.forEach((address)=>{
+				const addr = address.multiaddr.toString()+'/p2p/'+id
+				if(addr.includes('webtransport') && addr.includes('certhash')){
+					addrs.push(addr)
 				}
 			})
-			//this.#ListenAddressChange(mddrs)
-			this.address = mddrs
+			if(!config.CONFIG_RUN_ON_TRANSIENT_CONNECTION)addrs.reverse()
+			//this.#ListenAddressChange(addrs)
+			this.address = addrs
 			this.#ping()
 			this.#peerDiscoveryHybrid()
 		})
@@ -668,7 +673,8 @@ class webpeerjs{
 
 		onMetrics((data)=>{
 			const signal = metrics(data)
-			this.#isDialEnabled = signal
+			this.#isDialEnabled = signal.isDialEnabled
+			onDialFn(signal.isAutoDialEnabled)
 			
 		})
 		
@@ -1656,7 +1662,7 @@ class webpeerjs{
 
 	//dial based on known bootsrap peers address using Websocket expected
 	#dialKnownBootstrap(){
-		
+		//console.log('#dialKnownBootstrap()')
 		if(!navigator.onLine)return
 		if(!this.#isDialEnabled)return
 
@@ -1676,6 +1682,7 @@ class webpeerjs{
 			
 			this.#dialedKnownBootstrap.set(id,addrs)
 			this.#isDialWebsocket = true
+			this.#onWebsocketFn(true)
 			if(!this.#isConnected(id)){
 				this.#dialMultiaddress(mddrs)
 			}
@@ -1685,7 +1692,7 @@ class webpeerjs{
 	
 	//dial based on known bootstrap DNS
 	async #dialKnownDNS(){
-
+		//console.log('#dialKnownDNS()')
 		if(!navigator.onLine)return
 		if(!this.#isDialEnabled)return
 
@@ -1718,6 +1725,7 @@ class webpeerjs{
 			
 			this.#dialedKnownBootstrap.set(id,addrs)
 			this.#isDialWebsocket = true
+			this.#onWebsocketFn(true)
 			if(!this.#isConnected(id)){
 				this.#dialMultiaddress(mddrs)
 			}
@@ -1728,7 +1736,7 @@ class webpeerjs{
 	
 	//dial based on known bootstrap DNS using DNS resolver only
 	async #dialKnownDNSonly(){
-
+		console.log('#dialKnownDNSonly()')
 		if(!navigator.onLine)return
 		if(!this.#isDialEnabled)return
 
@@ -1765,6 +1773,7 @@ class webpeerjs{
 		
 		
 		this.#isDialWebsocket = true
+		this.#onWebsocketFn(true)
 		this.#dialedKnownBootstrap.set(id,addrs)
 		
 		this.#dialedKnownBootstrap.set(id,addrs)
@@ -1832,6 +1841,21 @@ class webpeerjs{
 
 		let onMetricsFn = () => {}
 		const onMetrics = f => (onMetricsFn = f)
+
+		let isWebsocket = false
+		let onWebsocketFn = () => {}
+		const onWebsocket = f => (onWebsocketFn = f)
+		onWebsocket((data)=>{
+			isWebsocket = data
+		})
+		
+		let isDial = true
+		let onDialFn = () => {}
+		const onDial = f => (onDialFn = f)
+		onDial((data)=>{
+			//if(isDial!=data)console.warn('isDial',data)
+			isDial = data
+		})
 		
 		let listenaddress = []
 		
@@ -1934,6 +1958,7 @@ class webpeerjs{
 			pc.createDataChannel('webpeerjs');
 			pc.createOffer().then(offer => pc.setLocalDescription(offer));
 		})
+		//console.log(ice)
 		
 		//create libp2p instance
 		const libp2p = await createLibp2p({
@@ -1979,24 +2004,26 @@ class webpeerjs{
 			],
 			connectionGater: {
 				filterMultiaddrForPeer: async (peer, multiaddrTest) => {
-					const multiaddrString = multiaddrTest.toString();
+					const multiaddrString = multiaddrTest.toString()
 					if (
 						multiaddrString.includes("/ip4/127.0.0.1") ||
 						multiaddrString.includes("/ip6/")
 					) {
-						return false;
+						return false
 					}
-					return true;
+					if(multiaddrString.includes("/ws/") || multiaddrString.includes("/wss/"))return isWebsocket
+					return isDial
 				},
 				denyDialMultiaddr: async (multiaddrTest) => {
-					const multiaddrString = multiaddrTest.toString();
+					const multiaddrString = multiaddrTest.toString()
 					if (
 						multiaddrString.includes("/ip4/127.0.0.1") ||
 						multiaddrString.includes("/ip6/")
 					) {
-						return true;
+						return true
 					}
-					return false;
+					if(multiaddrString.includes("/ws/") || multiaddrString.includes("/wss/"))return !isWebsocket
+					return !isDial
 				},
 			},
 			peerDiscovery: [
@@ -2042,7 +2069,7 @@ class webpeerjs{
 		
 		
 		//return webpeerjs class
-		return new webpeerjs(libp2p,dbstore,onMetrics)
+		return new webpeerjs(libp2p,dbstore,onMetrics,onWebsocketFn,onDialFn)
 	}
 }