Merge pull request #144 from dmotz/dev

IPFS update, test fixes

Author: dmotz

.prettierrc

@@ -6,5 +6,6 @@
   "bracketSpacing": false,
   "arrowParens": "avoid",
   "endOfLine": "lf",
-  "trailingComma": "none"
+  "trailingComma": "none",
+  "proseWrap": "always"
 }

README.md

@@ -29,36 +29,35 @@ on top of WebRTC:
 - 🏭⚡ Runs server-side
 - ⚛️🪝 React hooks
 
-You can see what people are building with Trystero [here](https://github.com/jeremyckahn/awesome-trystero).
+You can see what people are building with Trystero
+[here](https://github.com/jeremyckahn/awesome-trystero).
 
 ---
 
 ## Contents
 
-- [✨🤝✨ Trystero](#-trystero)
-  - [Contents](#contents)
-  - [How it works](#how-it-works)
-  - [Get started](#get-started)
-  - [Listen for events](#listen-for-events)
-  - [Broadcast events](#broadcast-events)
-  - [Audio and video](#audio-and-video)
-  - [Advanced](#advanced)
-    - [Binary metadata](#binary-metadata)
-    - [Action promises](#action-promises)
-    - [Progress updates](#progress-updates)
-    - [Encryption](#encryption)
-    - [React hooks](#react-hooks)
-    - [Connection issues](#connection-issues)
-    - [Running server-side (Node, Deno, Bun)](#running-server-side-node-deno-bun)
-    - [Supabase setup](#supabase-setup)
-    - [Firebase setup](#firebase-setup)
-  - [API](#api)
-    - [`joinRoom(config, roomId, [onJoinError])`](#joinroomconfig-roomid-onjoinerror)
-    - [`selfId`](#selfid)
-    - [`getRelaySockets()`](#getrelaysockets)
-    - [`getOccupants(config, roomId)`](#getoccupantsconfig-roomid)
-  - [Strategy comparison](#strategy-comparison)
-    - [How to choose](#how-to-choose)
+- [How it works](#how-it-works)
+- [Get started](#get-started)
+- [Listen for events](#listen-for-events)
+- [Broadcast events](#broadcast-events)
+- [Audio and video](#audio-and-video)
+- [Advanced](#advanced)
+  - [Binary metadata](#binary-metadata)
+  - [Action promises](#action-promises)
+  - [Progress updates](#progress-updates)
+  - [Encryption](#encryption)
+  - [React hooks](#react-hooks)
+  - [Connection issues](#connection-issues)
+  - [Running server-side (Node, Deno, Bun)](#running-server-side-node-deno-bun)
+  - [Supabase setup](#supabase-setup)
+  - [Firebase setup](#firebase-setup)
+- [API](#api)
+  - [`joinRoom(config, roomId, [onJoinError])`](#joinroomconfig-roomid-onjoinerror)
+  - [`selfId`](#selfid)
+  - [`getRelaySockets()`](#getrelaysockets)
+  - [`getOccupants(config, roomId)`](#getoccupantsconfig-roomid)
+- [Strategy comparison](#strategy-comparison)
+  - [How to choose](#how-to-choose)
 
 ---
 
@@ -126,8 +125,8 @@ const room = joinRoom(config, 'yoyodyne')
 ```
 
 The first argument is a configuration object that requires an `appId`. This
-should be a completely unique identifier for your app¹. The second argument
-is the room ID.
+should be a completely unique identifier for your app¹. The second argument is
+the room ID.
 
 > Why rooms? Browsers can only handle a limited amount of WebRTC connections at
 > a time so it's recommended to design your app such that users are divided into
@@ -241,8 +240,8 @@ room.onPeerLeave(peerId =>
 
 > Actions are smart and handle serialization and chunking for you behind the
 > scenes. This means you can send very large files and whatever data you send
-> will be received on the other side as the same type (a number as a number,
-> a string as a string, an object as an object, binary as binary, etc.).
+> will be received on the other side as the same type (a number as a number, a
+> string as a string, an object as an object, binary as binary, etc.).
 
 ## Audio and video
 
@@ -403,8 +402,8 @@ means.
 Trystero functions are idempotent so they already work out of the box as React
 hooks.
 
-Here's a simple example component where each peer syncs their favorite
-color to everyone else:
+Here's a simple example component where each peer syncs their favorite color to
+everyone else:
 
 ```jsx
 import {joinRoom} from 'trystero'
@@ -486,23 +485,24 @@ export const useRoom = (roomConfig, roomId) => {
 WebRTC is powerful but some networks simply don't allow direct P2P connections
 using it. If you find that certain user pairings aren't working in Trystero,
 you're likely encountering an issue at the network provider level. To solve this
-you can configure a TURN server which will act as a proxy layer for peers
-that aren't able to connect directly to one another.
+you can configure a TURN server which will act as a proxy layer for peers that
+aren't able to connect directly to one another.
 
 1. If you can, confirm that the issue is specific to particular network
    conditions (e.g. user with ISP X cannot connect to a user with ISP Y). If
    other user pairings are working (like those between two browsers on the same
    machine), this likely confirms that Trystero is working correctly.
 2. Sign up for a TURN service or host your own. There are various hosted TURN
-   services you can find online like [Cloudflare](https://developers.cloudflare.com/calls/turn/)
-   (which offers a free tier with 1,000 GB traffic per month) or
+   services you can find online like
+   [Cloudflare](https://developers.cloudflare.com/calls/turn/) (which offers a
+   free tier with 1,000 GB traffic per month) or
    [Open Relay](https://www.metered.ca/stun-turn). You can also host an open
    source TURN server like [coturn](https://github.com/coturn/coturn),
    [Pion TURN](https://github.com/pion/turn),
    [Violet](https://github.com/paullouisageneau/violet), or
-   [eturnal](https://github.com/processone/eturnal). Keep in mind data will
-   only go through the TURN server for peers that can't directly connect and
-   will still be end-to-end encrypted.
+   [eturnal](https://github.com/processone/eturnal). Keep in mind data will only
+   go through the TURN server for peers that can't directly connect and will
+   still be end-to-end encrypted.
 3. Once you have a TURN server, configure Trystero with it like this:
    ```js
    const room = joinRoom(
@@ -549,9 +549,8 @@ To use the Supabase strategy:
 
 1. Create a [Supabase](https://supabase.com) project or use an existing one
 2. On the dashboard, go to Project Settings -> API
-3. Copy the Project URL and set that as the `appId` in the Trystero config,
-   copy the `anon public` API key and set it as `supabaseKey` in the Trystero
-   config
+3. Copy the Project URL and set that as the `appId` in the Trystero config, copy
+   the `anon public` API key and set it as `supabaseKey` in the Trystero config
 
 ### Firebase setup
 
@@ -599,9 +598,9 @@ the same namespace will return the same room instance.
 - `config` - Configuration object containing the following keys:
   - `appId` - **(required)** A unique string identifying your app. When using
     Supabase, this should be set to your project URL (see
-    [Supabase setup instructions](#supabase-setup)). If using
-    Firebase, this should be the `databaseURL` from your Firebase config (also
-    see `firebaseApp` below for an alternative way of configuring the Firebase
+    [Supabase setup instructions](#supabase-setup)). If using Firebase, this
+    should be the `databaseURL` from your Firebase config (also see
+    `firebaseApp` below for an alternative way of configuring the Firebase
     strategy).
 
   - `password` - **(optional)** A string to encrypt session descriptions via
@@ -651,15 +650,11 @@ the same namespace will return the same room instance.
     default). Changing this is useful if you want to run multiple apps using the
     same database and don't want to worry about namespace collisions.
 
-  - `libp2pConfig` - **(optional, 🪐 IPFS only)**
-    [`Libp2pOptions`](https://libp2p.github.io/js-libp2p/types/libp2p.index.Libp2pOptions.html)
-    where you can specify a list of static peers for bootstrapping.
-
   - `manualRelayReconnection` - **(optional, 🐦 Nostr and 🌊 BitTorrent only)**
-    Boolean (default: `false`) that when set to `true` disables
-    automatically pausing and resuming reconnection attempts when the browser
-    goes offline and comes back online. This is useful if you want to manage
-    this behavior yourself.
+    Boolean (default: `false`) that when set to `true` disables automatically
+    pausing and resuming reconnection attempts when the browser goes offline and
+    comes back online. This is useful if you want to manage this behavior
+    yourself.
 
 - `roomId` - A string to namespace peers and events within a room.
 
@@ -678,8 +673,8 @@ Returns an object with the following methods:
 
   Returns a map of
   [`RTCPeerConnection`](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection)s
-  for the peers present in room (not including the local user). The keys of
-  this object are the respective peers' IDs.
+  for the peers present in room (not including the local user). The keys of this
+  object are the respective peers' IDs.
 
 - ### `addStream(stream, [targetPeers], [metadata])`
 
@@ -803,8 +798,8 @@ Returns an object with the following methods:
 
   Returns an array of three functions:
   1. #### Sender
-     - Sends data to peers and returns a promise that resolves when all
-       target peers are finished receiving data.
+     - Sends data to peers and returns a promise that resolves when all target
+       peers are finished receiving data.
 
      - `(data, [targetPeers], [metadata], [onProgress])`
        - `data` - Any value to send (primitive, object, binary). Serialization
@@ -908,14 +903,14 @@ console.log(trystero.getRelaySockets())
 ### `pauseRelayReconnection()`
 
 **(🐦 Nostr, 🌊 BitTorrent only)** Normally Trystero will try to automatically
-reconnect to relay sockets unless `manualRelayReconnection: true` is set in
-the room config. Calling this function stops relay reconnection attempts until
+reconnect to relay sockets unless `manualRelayReconnection: true` is set in the
+room config. Calling this function stops relay reconnection attempts until
 `resumeRelayReconnection()` is called.
 
 ### `resumeRelayReconnection()`
 
-**(🐦 Nostr, 🌊 BitTorrent, only)** Allows relay reconnection attempts to resume.
-(See `pauseRelayReconnection()` above).
+**(🐦 Nostr, 🌊 BitTorrent, only)** Allows relay reconnection attempts to
+resume. (See `pauseRelayReconnection()` above).
 
 ### `getOccupants(config, roomId)`
 

docs/index.html

@@ -23,7 +23,7 @@
   <body>
     <div id="canvas"></div>
     <header>
-      <h1>🤝 Trystero<sup>0.21.5</sup></h1>
+      <h1>🤝 Trystero<sup>0.22.0</sup></h1>
       <h2>Make any site multiplayer in a few lines.</h2>
       <h2>Serverless WebRTC matchmaking for painless P2P.</h2>
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "trystero",
-  "version": "0.21.8",
+  "version": "0.22.0",
   "description": "Serverless WebRTC matchmaking for painless P2P",
   "main": "src/index.js",
   "module": "src/index.js",
@@ -27,28 +27,26 @@
   "license": "MIT",
   "dependencies": {
     "@noble/secp256k1": "^3.0.0",
-    "@supabase/supabase-js": "^2.49.8",
-    "@waku/discovery": "^0.0.8",
-    "@waku/sdk": "^0.0.31",
-    "firebase": "^12.2.1",
-    "libp2p": "^2.8.8",
-    "mqtt": "^5.13.0"
+    "@supabase/supabase-js": "^2.75.0",
+    "@waku/sdk": "^0.0.35",
+    "firebase": "^12.4.0",
+    "mqtt": "^5.14.1"
   },
   "devDependencies": {
-    "@eslint/js": "^9.27.0",
-    "@playwright/test": "^1.52.0",
+    "@eslint/js": "^9.37.0",
+    "@playwright/test": "^1.56.0",
     "@rollup/plugin-commonjs": "^28.0.2",
-    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@rollup/plugin-node-resolve": "^16.0.2",
     "@rollup/plugin-replace": "^6.0.2",
     "@rollup/plugin-terser": "^0.4.4",
-    "chalk": "^5.6.0",
-    "eslint": "^9.27.0",
-    "globals": "^16.2.0",
-    "playwright": "^1.52.0",
+    "chalk": "^5.6.2",
+    "eslint": "^9.37.0",
+    "globals": "^16.4.0",
+    "playwright": "^1.56.0",
     "prettier": "^3.5.2",
     "proxy-check": "^1.0.8",
-    "rollup": "^4.49.0",
-    "serve": "^14.2.4",
+    "rollup": "^4.52.4",
+    "serve": "^14.2.5",
     "stun": "^2.1.0",
     "ws": "^8.18.2"
   },

src/ipfs.d.ts

@@ -1,15 +1,7 @@
 declare module 'trystero/ipfs' {
   import {BaseRoomConfig, Room} from 'trystero'
-  import type {Libp2pOptions} from 'libp2p'
 
-  export interface IpfsRoomConfig {
-    libp2pConfig?: Partial<Libp2pOptions>
-  }
-
-  export function joinRoom(
-    config: BaseRoomConfig & IpfsRoomConfig,
-    roomId: string
-  ): Room
+  export function joinRoom(config: BaseRoomConfig, roomId: string): Room
 
   export * from 'trystero'
 }

src/ipfs.js

@@ -1,10 +1,4 @@
-import {
-  createDecoder,
-  createEncoder,
-  createLightNode,
-  Protocols
-} from '@waku/sdk'
-import {wakuPeerExchangeDiscovery} from '@waku/discovery'
+import {createLightNode} from '@waku/sdk'
 import strategy from './strategy.js'
 import {
   all,
@@ -15,40 +9,23 @@ import {
   toJson
 } from './utils.js'
 
-const pubsubTopic = '/waku/2/default-waku/proto'
-
-const contentTopic = topic => `/${libName}/0/${topic}/json`
+const contentTopic = topic => `/${libName}-${topic}/0/msg/json`
 
 const sendMessage = (node, topic, payload) =>
   node.lightPush.send(
-    createEncoder({
-      pubsubTopic,
-      contentTopic: contentTopic(topic),
-      ephemeral: true
-    }),
-    {payload: encodeBytes(payload)}
+    node.createEncoder({contentTopic: contentTopic(topic), ephemeral: true}),
+    {payload: encodeBytes(payload)},
+    {autoRetry: true}
   )
 
 export const joinRoom = strategy({
-  init: config =>
+  init: () =>
     createLightNode({
-      defaultBootstrap: false,
-      pubsubTopics: [pubsubTopic],
-      bootstrapPeers: [
-        '/dns4/waku.myrandomdemos.online/tcp/8000/wss/p2p/16Uiu2HAmKfC2QUvMVyBsVjuEzdo1hVhRddZxo69YkBuXYvuZ83sc',
-        '/dns4/node-01.do-ams3.wakuv2.prod.status.im/tcp/8000/wss/p2p/16Uiu2HAmL5okWopX7NqZWBUKVqW8iUxCEmd5GMHLVPwCgzYzQv3e',
-        '/dns4/node-01.gc-us-central1-a.wakuv2.prod.statusim.net/tcp/8000/wss/p2p/16Uiu2HAmVkKntsECaYfefR1V2yCR79CegLATuTPE6B9TxgxBiiiA',
-        '/dns4/node-01.ac-cn-hongkong-c.wakuv2.prod.status.im/tcp/8000/wss/p2p/16Uiu2HAm4v86W3bmT1BiH6oSPzcsSr24iDQpSN5Qa992BCjjwgrD',
-        '/dns4/node-01.do-ams3.wakuv2.test.status.im/tcp/8000/wss/p2p/16Uiu2HAmPLe7Mzm8TsYUubgCAW1aJoeFScxrLj8ppHFivPo97bUZ'
-      ],
-      libp2p: {
-        peerDiscovery: [wakuPeerExchangeDiscovery([pubsubTopic])],
-        hideWebSocketInfo: true,
-        ...config.libp2pConfig
-      }
+      defaultBootstrap: true,
+      discovery: {dns: true, peerExchange: true, peerCache: true}
     }).then(async node => {
       await node.start()
-      await node.waitForPeers([Protocols.LightPush, Protocols.Filter])
+      await node.waitForPeers()
       return node
     }),
 
@@ -62,12 +39,11 @@ export const joinRoom = strategy({
     }
 
     const unsubFns = await all(
-      [rootTopic, selfTopic].map(topic =>
-        node.filter.subscribe(
-          createDecoder(contentTopic(topic), pubsubTopic),
-          handleMsg(topic)
-        )
-      )
+      [rootTopic, selfTopic].map(topic => {
+        const decoder = node.createDecoder({contentTopic: contentTopic(topic)})
+        node.filter.subscribe(decoder, handleMsg(topic))
+        return () => node.filter.unsubscribe(decoder)
+      })
     )
 
     return () => unsubFns.forEach(f => f())