@openlv/signaling 0.0.2 → 0.1.0

package/dist/gundb/index.js

@@ -6,14 +6,15 @@ import { log } from "../utils/log.js";
  * GunDB Signaling Layer
  * https://openlv.sh/api/signaling/gun
  */
-export const gundb = ({ topic, url = "wss://try.axe.eco/gun", }) => {
+export const gundb = ({ topic, url }) => {
+    const endpoint = url || "wss://try.axe.eco/gun";
     let connection;
     return createSignalingLayer({
         type: "gundb",
         async setup() {
             log("GUNDB: Setting up");
             const x = new Gun({
-                peers: [url],
+                peers: [endpoint],
                 file: undefined,
                 localStorage: undefined,
             });
@@ -21,7 +22,7 @@ export const gundb = ({ topic, url = "wss://try.axe.eco/gun", }) => {
             await connection?.get(topic);
         },
         teardown() {
-            // connection?.();
+            connection?.get(topic).off();
             connection = undefined;
         },
         async publish(payload) {

package/dist/gundb/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/gundb/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,GAAG,EAAE,EAAgC,MAAM,KAAK,CAAC;AAExD,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAEnD,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAEtC;;;GAGG;AACH,MAAM,CAAC,MAAM,KAAK,GAAsB,CAAC,EACvC,KAAK,EACL,GAAG,GAAG,uBAAuB,GAC9B,EAAE,EAAE;IACH,IAAI,UAAoC,CAAC;IAEzC,OAAO,oBAAoB,CAAC;QAC1B,IAAI,EAAE,OAAO;QACb,KAAK,CAAC,KAAK;YACT,GAAG,CAAC,mBAAmB,CAAC,CAAC;YACzB,MAAM,CAAC,GAAG,IAAK,GAAuB,CAAC;gBACrC,KAAK,EAAE,CAAC,GAAG,CAAC;gBACZ,IAAI,EAAE,SAAS;gBACf,YAAY,EAAE,SAAS;aACxB,CAAC,CAAC;YAEH,UAAU,GAAG,CAAC,CAAC;YAEf,MAAM,UAAU,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;QACD,QAAQ;YACN,kBAAkB;YAClB,UAAU,GAAG,SAAS,CAAC;QACzB,CAAC;QACD,KAAK,CAAC,OAAO,CAAC,OAAO;YACnB,IAAI,CAAC,UAAU;gBAAE,MAAM,IAAI,uBAAuB,EAAE,CAAC;YAErD,GAAG,CAAC,2BAA2B,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;YACjD,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QAC/C,CAAC;QACD,KAAK,CAAC,SAAS,CAAC,OAAO;YACrB,IAAI,CAAC,UAAU;gBAAE,MAAM,IAAI,uBAAuB,EAAE,CAAC;YAErD,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE;gBAChC,GAAG,CAAC,yBAAyB,EAAE,IAAI,CAAC,CAAC;gBAErC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC;gBAEtC,IAAI,CAAC,OAAO;oBAAE,OAAO;gBAErB,OAAO,CAAC,OAAO,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;QACL,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE;IACnB,MAAM,EAAE,OAAO;CAChB,CAAC,CAAC","sourcesContent":["import { SignalNoConnectionError } from \"@openlv/core/errors\";\nimport Gun, { type IGun, type IGunInstance } from \"gun\";\n\nimport { createSignalingLayer } from \"../index.js\";\nimport type { SignalingProtocol } from \"../protocol.js\";\nimport { log } from \"../utils/log.js\";\n\n/**\n * GunDB Signaling Layer\n * https://openlv.sh/api/signaling/gun\n */\nexport const gundb: SignalingProtocol = ({\n  topic,\n  url = \"wss://try.axe.eco/gun\",\n}) => {\n  let connection: IGunInstance | undefined;\n\n  return createSignalingLayer({\n    type: \"gundb\",\n    async setup() {\n      log(\"GUNDB: Setting up\");\n      const x = new (Gun as unknown as IGun)({\n        peers: [url],\n        file: undefined,\n        localStorage: undefined,\n      });\n\n      connection = x;\n\n      await connection?.get(topic);\n    },\n    teardown() {\n      // connection?.();\n      connection = undefined;\n    },\n    async publish(payload) {\n      if (!connection) throw new SignalNoConnectionError();\n\n      log(\"GUNDB: Publishing message\", topic, payload);\n      connection.get(topic).put({ data: payload });\n    },\n    async subscribe(handler) {\n      if (!connection) throw new SignalNoConnectionError();\n\n      connection.get(topic).on((data) => {\n        log(\"GUNDB: Received message\", data);\n\n        const message = data.data?.toString();\n\n        if (!message) return;\n\n        handler(message);\n      });\n    },\n  });\n};\n\nObject.assign(gundb, {\n  __name: \"gundb\",\n});\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/gundb/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,GAAG,EAAE,EAAgC,MAAM,KAAK,CAAC;AAExD,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAEnD,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAEtC;;;GAGG;AACH,MAAM,CAAC,MAAM,KAAK,GAAsB,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE;IACzD,MAAM,QAAQ,GAAG,GAAG,IAAI,uBAAuB,CAAC;IAChD,IAAI,UAAoC,CAAC;IAEzC,OAAO,oBAAoB,CAAC;QAC1B,IAAI,EAAE,OAAO;QACb,KAAK,CAAC,KAAK;YACT,GAAG,CAAC,mBAAmB,CAAC,CAAC;YACzB,MAAM,CAAC,GAAG,IAAK,GAAuB,CAAC;gBACrC,KAAK,EAAE,CAAC,QAAQ,CAAC;gBACjB,IAAI,EAAE,SAAS;gBACf,YAAY,EAAE,SAAS;aACxB,CAAC,CAAC;YAEH,UAAU,GAAG,CAAC,CAAC;YAEf,MAAM,UAAU,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;QACD,QAAQ;YACN,UAAU,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC;YAC7B,UAAU,GAAG,SAAS,CAAC;QACzB,CAAC;QACD,KAAK,CAAC,OAAO,CAAC,OAAO;YACnB,IAAI,CAAC,UAAU;gBAAE,MAAM,IAAI,uBAAuB,EAAE,CAAC;YAErD,GAAG,CAAC,2BAA2B,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;YACjD,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QAC/C,CAAC;QACD,KAAK,CAAC,SAAS,CAAC,OAAO;YACrB,IAAI,CAAC,UAAU;gBAAE,MAAM,IAAI,uBAAuB,EAAE,CAAC;YAErD,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE;gBAChC,GAAG,CAAC,yBAAyB,EAAE,IAAI,CAAC,CAAC;gBAErC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC;gBAEtC,IAAI,CAAC,OAAO;oBAAE,OAAO;gBAErB,OAAO,CAAC,OAAO,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;QACL,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE;IACnB,MAAM,EAAE,OAAO;CAChB,CAAC,CAAC","sourcesContent":["import { SignalNoConnectionError } from \"@openlv/core/errors\";\nimport Gun, { type IGun, type IGunInstance } from \"gun\";\n\nimport { createSignalingLayer } from \"../index.js\";\nimport type { SignalingProtocol } from \"../protocol.js\";\nimport { log } from \"../utils/log.js\";\n\n/**\n * GunDB Signaling Layer\n * https://openlv.sh/api/signaling/gun\n */\nexport const gundb: SignalingProtocol = ({ topic, url }) => {\n  const endpoint = url || \"wss://try.axe.eco/gun\";\n  let connection: IGunInstance | undefined;\n\n  return createSignalingLayer({\n    type: \"gundb\",\n    async setup() {\n      log(\"GUNDB: Setting up\");\n      const x = new (Gun as unknown as IGun)({\n        peers: [endpoint],\n        file: undefined,\n        localStorage: undefined,\n      });\n\n      connection = x;\n\n      await connection?.get(topic);\n    },\n    teardown() {\n      connection?.get(topic).off();\n      connection = undefined;\n    },\n    async publish(payload) {\n      if (!connection) throw new SignalNoConnectionError();\n\n      log(\"GUNDB: Publishing message\", topic, payload);\n      connection.get(topic).put({ data: payload });\n    },\n    async subscribe(handler) {\n      if (!connection) throw new SignalNoConnectionError();\n\n      connection.get(topic).on((data) => {\n        log(\"GUNDB: Received message\", data);\n\n        const message = data.data?.toString();\n\n        if (!message) return;\n\n        handler(message);\n      });\n    },\n  });\n};\n\nObject.assign(gundb, {\n  __name: \"gundb\",\n});\n"]}

package/dist/handshake.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/handshake.test.js

@@ -0,0 +1,226 @@
+import { deriveSymmetricKey, generateKeyPair, hashPublicKey, parseEncryptionKey, } from "@openlv/core/encryption";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { createSignalingLayer, SIGNAL_STATE } from "./index.js";
+/**
+ * In-memory topic emulating a public relay: every publish is delivered to
+ * all subscribers (including the sender, like MQTT echo). A `drop` predicate
+ * simulates lossy delivery.
+ */
+const neverDrop = () => false;
+const createTopic = () => {
+    const subscribers = [];
+    let drop = neverDrop;
+    let published = 0;
+    return {
+        setDrop(fn) {
+            drop = fn;
+        },
+        inject(payload) {
+            for (const subscriber of subscribers)
+                subscriber(payload);
+        },
+        channel() {
+            return {
+                type: "memory",
+                setup: () => { },
+                teardown: () => { },
+                publish: (payload) => {
+                    const index = published++;
+                    if (drop(payload, index))
+                        return;
+                    // Deliver asynchronously, as a real relay would.
+                    queueMicrotask(() => {
+                        for (const subscriber of subscribers)
+                            subscriber(payload);
+                    });
+                },
+                subscribe: (handler) => {
+                    subscribers.push(handler);
+                },
+            };
+        },
+    };
+};
+const CLIENT_CAPABILITIES = {
+    transports: ["wrtc"],
+    info: { identity: "com.example.wallet", name: "Example Wallet" },
+};
+const createPeer = async (channel, { isHost, h, k }) => {
+    const { encryptionKey, decryptionKey } = await generateKeyPair();
+    let relyingKey;
+    let peerCapabilities;
+    const layer = await createSignalingLayer(channel)({
+        isHost,
+        h,
+        k: await deriveSymmetricKey(k),
+        publicKey: encryptionKey,
+        canEncrypt: () => relyingKey !== undefined,
+        encrypt: (message) => {
+            if (!relyingKey)
+                throw new Error("no peer key");
+            return relyingKey.encrypt(message);
+        },
+        decrypt: (message) => decryptionKey.decrypt(message),
+        rpDiscovered: async (rpKey) => {
+            relyingKey = await parseEncryptionKey(rpKey);
+        },
+        capabilities: CLIENT_CAPABILITIES,
+        peerCapabilities: (capabilities) => {
+            peerCapabilities = capabilities;
+        },
+    });
+    return { layer, encryptionKey, getPeerCapabilities: () => peerCapabilities };
+};
+const K = "00112233445566778899aabbccddeeff";
+const setupPair = async (topic) => {
+    // Mirror createSession: the host's h is the hash of its own key, the
+    // client receives that h out-of-band (via the URI).
+    const hostKeys = await generateKeyPair();
+    const h = await hashPublicKey(hostKeys.encryptionKey);
+    const HOST_CAPABILITIES = {
+        transports: ["wrtc", "ws"],
+        info: { identity: "com.example.dapp", name: "Example dApp" },
+    };
+    let hostRelying;
+    let hostPeerCapabilities;
+    const host = await createSignalingLayer(topic.channel())({
+        isHost: true,
+        h,
+        k: await deriveSymmetricKey(K),
+        publicKey: hostKeys.encryptionKey,
+        canEncrypt: () => hostRelying !== undefined,
+        encrypt: (message) => {
+            if (!hostRelying)
+                throw new Error("no peer key");
+            return hostRelying.encrypt(message);
+        },
+        decrypt: (message) => hostKeys.decryptionKey.decrypt(message),
+        rpDiscovered: async (rpKey) => {
+            hostRelying = await parseEncryptionKey(rpKey);
+        },
+        capabilities: HOST_CAPABILITIES,
+        peerCapabilities: (capabilities) => {
+            hostPeerCapabilities = capabilities;
+        },
+    });
+    const { layer: client, getPeerCapabilities: getClientPeerCapabilities } = await createPeer(topic.channel(), {
+        isHost: false,
+        h,
+        k: K,
+    });
+    return {
+        host,
+        client,
+        hostCapabilities: HOST_CAPABILITIES,
+        getHostPeerCapabilities: () => hostPeerCapabilities,
+        getClientPeerCapabilities,
+    };
+};
+const waitForState = (layer, target) => new Promise((resolve, reject) => {
+    if (layer.getState().state === target)
+        return resolve();
+    layer.on("state_change", (state) => {
+        if (state === target)
+            resolve();
+        if (state === SIGNAL_STATE.ERROR && target !== SIGNAL_STATE.ERROR) {
+            reject(new Error("signaling errored"));
+        }
+    });
+});
+describe("signaling handshake (in-memory relay)", () => {
+    let host;
+    let client;
+    afterEach(async () => {
+        await host?.teardown();
+        await client?.teardown();
+    });
+    it("completes and exchanges data on a reliable relay", async () => {
+        const topic = createTopic();
+        const pair = await setupPair(topic);
+        ({ host, client } = pair);
+        await host.setup();
+        const encrypted = Promise.all([
+            waitForState(host, SIGNAL_STATE.ENCRYPTED),
+            waitForState(client, SIGNAL_STATE.ENCRYPTED),
+        ]);
+        await client.setup();
+        await encrypted;
+        const received = new Promise(resolve => host.on("message", resolve));
+        await client.send({ hello: "world" });
+        expect(await received).toEqual({ hello: "world" });
+    });
+    it("exchanges capabilities in both directions during the handshake", async () => {
+        const topic = createTopic();
+        const pair = await setupPair(topic);
+        ({ host, client } = pair);
+        await host.setup();
+        const encrypted = Promise.all([
+            waitForState(host, SIGNAL_STATE.ENCRYPTED),
+            waitForState(client, SIGNAL_STATE.ENCRYPTED),
+        ]);
+        await client.setup();
+        await encrypted;
+        expect(pair.getClientPeerCapabilities()).toEqual(pair.hostCapabilities);
+        expect(pair.getHostPeerCapabilities()).toEqual(CLIENT_CAPABILITIES);
+    });
+    it("ignores garbage frames on the public topic", async () => {
+        const topic = createTopic();
+        ({ host, client } = await setupPair(topic));
+        await host.setup();
+        // Garbage before and during the handshake: random text, valid-looking
+        // frames with undecryptable bodies, and truncated frames.
+        topic.inject("not-a-frame");
+        topic.inject("hh");
+        topic.inject("hcQUJDRA==");
+        topic.inject("xh!!!not-base64!!!");
+        const encrypted = Promise.all([
+            waitForState(host, SIGNAL_STATE.ENCRYPTED),
+            waitForState(client, SIGNAL_STATE.ENCRYPTED),
+        ]);
+        await client.setup();
+        topic.inject("hcgarbage-mid-handshake");
+        await encrypted;
+    });
+    describe("lossy relay", () => {
+        beforeEach(() => {
+            vi.useFakeTimers();
+        });
+        afterEach(() => {
+            vi.useRealTimers();
+        });
+        it("recovers when handshake frames are dropped", async () => {
+            const topic = createTopic();
+            // Drop the first delivery of every frame; re-sends get through.
+            const seen = new Set();
+            topic.setDrop((payload) => {
+                if (seen.has(payload.slice(0, 2) + payload.length))
+                    return false;
+                seen.add(payload.slice(0, 2) + payload.length);
+                return true;
+            });
+            ({ host, client } = await setupPair(topic));
+            await host.setup();
+            await client.setup();
+            const encrypted = Promise.all([
+                waitForState(host, SIGNAL_STATE.ENCRYPTED),
+                waitForState(client, SIGNAL_STATE.ENCRYPTED),
+            ]);
+            // Let several resend intervals elapse.
+            for (let index = 0; index < 10; index += 1) {
+                await vi.advanceTimersByTimeAsync(2100);
+            }
+            await encrypted;
+        });
+        it("errors out when the peer never appears", async () => {
+            const topic = createTopic();
+            topic.setDrop(() => true);
+            ({ host, client } = await setupPair(topic));
+            await client.setup();
+            const errored = waitForState(client, SIGNAL_STATE.ERROR);
+            await vi.advanceTimersByTimeAsync(31000);
+            await errored;
+            expect(client.getState().state).toBe(SIGNAL_STATE.ERROR);
+        });
+    });
+});
+//# sourceMappingURL=handshake.test.js.map

package/dist/handshake.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handshake.test.js","sourceRoot":"","sources":["../src/handshake.test.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAElB,eAAe,EACf,aAAa,EACb,kBAAkB,GACnB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAEzE,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAuB,MAAM,YAAY,CAAC;AAIrF;;;;GAIG;AACH,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC;AAE9B,MAAM,WAAW,GAAG,GAAG,EAAE;IACvB,MAAM,WAAW,GAAkC,EAAE,CAAC;IACtD,IAAI,IAAI,GAAgD,SAAS,CAAC;IAClE,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,OAAO;QACL,OAAO,CAAC,EAA+C;YACrD,IAAI,GAAG,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,CAAC,OAAe;YACpB,KAAK,MAAM,UAAU,IAAI,WAAW;gBAAE,UAAU,CAAC,OAAO,CAAC,CAAC;QAC5D,CAAC;QACD,OAAO;YACL,OAAO;gBACL,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC;gBACf,QAAQ,EAAE,GAAG,EAAE,GAAE,CAAC;gBAClB,OAAO,EAAE,CAAC,OAAe,EAAE,EAAE;oBAC3B,MAAM,KAAK,GAAG,SAAS,EAAE,CAAC;oBAE1B,IAAI,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC;wBAAE,OAAO;oBAEjC,iDAAiD;oBACjD,cAAc,CAAC,GAAG,EAAE;wBAClB,KAAK,MAAM,UAAU,IAAI,WAAW;4BAAE,UAAU,CAAC,OAAO,CAAC,CAAC;oBAC5D,CAAC,CAAC,CAAC;gBACL,CAAC;gBACD,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE;oBACrB,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC5B,CAAC;aACF,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAqB;IAC5C,UAAU,EAAE,CAAC,MAAM,CAAC;IACpB,IAAI,EAAE,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE,gBAAgB,EAAE;CACjE,CAAC;AAEF,MAAM,UAAU,GAAG,KAAK,EACtB,OAAyB,EACzB,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAA8C,EAC5D,EAAE;IACF,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,GAAG,MAAM,eAAe,EAAE,CAAC;IACjE,IAAI,UAAqC,CAAC;IAC1C,IAAI,gBAA8C,CAAC;IAEnD,MAAM,KAAK,GAAG,MAAM,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAChD,MAAM;QACN,CAAC;QACD,CAAC,EAAE,MAAM,kBAAkB,CAAC,CAAC,CAAC;QAC9B,SAAS,EAAE,aAAa;QACxB,UAAU,EAAE,GAAG,EAAE,CAAC,UAAU,KAAK,SAAS;QAC1C,OAAO,EAAE,CAAC,OAAe,EAAE,EAAE;YAC3B,IAAI,CAAC,UAAU;gBAAE,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;YAEhD,OAAO,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC;QAC5D,YAAY,EAAE,KAAK,EAAE,KAAa,EAAE,EAAE;YACpC,UAAU,GAAG,MAAM,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC/C,CAAC;QACD,YAAY,EAAE,mBAAmB;QACjC,gBAAgB,EAAE,CAAC,YAAY,EAAE,EAAE;YACjC,gBAAgB,GAAG,YAAY,CAAC;QAClC,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,GAAG,EAAE,CAAC,gBAAgB,EAAE,CAAC;AAC/E,CAAC,CAAC;AAEF,MAAM,CAAC,GAAG,kCAAkC,CAAC;AAE7C,MAAM,SAAS,GAAG,KAAK,EAAE,KAAqC,EAAE,EAAE;IAChE,qEAAqE;IACrE,oDAAoD;IACpD,MAAM,QAAQ,GAAG,MAAM,eAAe,EAAE,CAAC;IACzC,MAAM,CAAC,GAAG,MAAM,aAAa,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IAEtD,MAAM,iBAAiB,GAAqB;QAC1C,UAAU,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC;QAC1B,IAAI,EAAE,EAAE,QAAQ,EAAE,kBAAkB,EAAE,IAAI,EAAE,cAAc,EAAE;KAC7D,CAAC;IAEF,IAAI,WAAsC,CAAC;IAC3C,IAAI,oBAAkD,CAAC;IACvD,MAAM,IAAI,GAAG,MAAM,oBAAoB,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACvD,MAAM,EAAE,IAAI;QACZ,CAAC;QACD,CAAC,EAAE,MAAM,kBAAkB,CAAC,CAAC,CAAC;QAC9B,SAAS,EAAE,QAAQ,CAAC,aAAa;QACjC,UAAU,EAAE,GAAG,EAAE,CAAC,WAAW,KAAK,SAAS;QAC3C,OAAO,EAAE,CAAC,OAAe,EAAE,EAAE;YAC3B,IAAI,CAAC,WAAW;gBAAE,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;YAEjD,OAAO,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC;QACD,OAAO,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC;QACrE,YAAY,EAAE,KAAK,EAAE,KAAa,EAAE,EAAE;YACpC,WAAW,GAAG,MAAM,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAChD,CAAC;QACD,YAAY,EAAE,iBAAiB;QAC/B,gBAAgB,EAAE,CAAC,YAAY,EAAE,EAAE;YACjC,oBAAoB,GAAG,YAAY,CAAC;QACtC,CAAC;KACF,CAAC,CAAC;IAEH,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,GACnE,MAAM,UAAU,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE;QAClC,MAAM,EAAE,KAAK;QACb,CAAC;QACD,CAAC,EAAE,CAAC;KACL,CAAC,CAAC;IAEL,OAAO;QACL,IAAI;QACJ,MAAM;QACN,gBAAgB,EAAE,iBAAiB;QACnC,uBAAuB,EAAE,GAAG,EAAE,CAAC,oBAAoB;QACnD,yBAAyB;KAC1B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,KAAqB,EAAE,MAAc,EAAE,EAAE,CAC7D,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;IACpC,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC,KAAK,KAAK,MAAM;QAAE,OAAO,OAAO,EAAE,CAAC;IAExD,KAAK,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,KAAK,EAAE,EAAE;QACjC,IAAI,KAAK,KAAK,MAAM;YAAE,OAAO,EAAE,CAAC;QAEhC,IAAI,KAAK,KAAK,YAAY,CAAC,KAAK,IAAI,MAAM,KAAK,YAAY,CAAC,KAAK,EAAE,CAAC;YAClE,MAAM,CAAC,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC;QACzC,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEL,QAAQ,CAAC,uCAAuC,EAAE,GAAG,EAAE;IACrD,IAAI,IAAoB,CAAC;IACzB,IAAI,MAAsB,CAAC;IAE3B,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,IAAI,EAAE,QAAQ,EAAE,CAAC;QACvB,MAAM,MAAM,EAAE,QAAQ,EAAE,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAChE,MAAM,KAAK,GAAG,WAAW,EAAE,CAAC;QAC5B,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,CAAC;QAEpC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;QAE1B,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QAEnB,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC;YAC5B,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,SAAS,CAAC;YAC1C,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC;SAC7C,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QACrB,MAAM,SAAS,CAAC;QAEhB,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAS,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;QAE7E,MAAM,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;QACtC,MAAM,CAAC,MAAM,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,KAAK,GAAG,WAAW,EAAE,CAAC;QAC5B,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,CAAC;QAEpC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;QAE1B,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QAEnB,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC;YAC5B,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,SAAS,CAAC;YAC1C,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC;SAC7C,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QACrB,MAAM,SAAS,CAAC;QAEhB,MAAM,CAAC,IAAI,CAAC,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACxE,MAAM,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QAC1D,MAAM,KAAK,GAAG,WAAW,EAAE,CAAC;QAE5B,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QAE5C,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QAEnB,sEAAsE;QACtE,0DAA0D;QAC1D,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC5B,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACnB,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC3B,KAAK,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;QAEnC,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC;YAC5B,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,SAAS,CAAC;YAC1C,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC;SAC7C,CAAC,CAAC;QAEH,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QACrB,KAAK,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC;QACxC,MAAM,SAAS,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAC3B,UAAU,CAAC,GAAG,EAAE;YACd,EAAE,CAAC,aAAa,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,GAAG,EAAE;YACb,EAAE,CAAC,aAAa,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;YAC1D,MAAM,KAAK,GAAG,WAAW,EAAE,CAAC;YAE5B,gEAAgE;YAChE,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;YAE/B,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBACxB,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;oBAAE,OAAO,KAAK,CAAC;gBAEjE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;gBAE/C,OAAO,IAAI,CAAC;YACd,CAAC,CAAC,CAAC;YAEH,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAE5C,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;YACnB,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;YAErB,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC;gBAC5B,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,SAAS,CAAC;gBAC1C,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC;aAC7C,CAAC,CAAC;YAEH,uCAAuC;YACvC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,EAAE,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;gBAC3C,MAAM,EAAE,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;YAC1C,CAAC;YAED,MAAM,SAAS,CAAC;QAClB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACtD,MAAM,KAAK,GAAG,WAAW,EAAE,CAAC;YAE5B,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;YAE1B,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAE5C,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;YAErB,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC;YAEzD,MAAM,EAAE,CAAC,wBAAwB,CAAC,KAAM,CAAC,CAAC;YAC1C,MAAM,OAAO,CAAC;YACd,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import {\n  deriveSymmetricKey,\n  type EncryptionKey,\n  generateKeyPair,\n  hashPublicKey,\n  parseEncryptionKey,\n} from \"@openlv/core/encryption\";\nimport { afterEach, beforeEach, describe, expect, it, vi } from \"vitest\";\n\nimport { createSignalingLayer, SIGNAL_STATE, type SignalingLayer } from \"./index.js\";\nimport type { PeerCapabilities } from \"./messages.js\";\nimport type { SignalingChannel } from \"./protocol.js\";\n\n/**\n * In-memory topic emulating a public relay: every publish is delivered to\n * all subscribers (including the sender, like MQTT echo). A `drop` predicate\n * simulates lossy delivery.\n */\nconst neverDrop = () => false;\n\nconst createTopic = () => {\n  const subscribers: ((payload: string) => void)[] = [];\n  let drop: (payload: string, index: number) => boolean = neverDrop;\n  let published = 0;\n\n  return {\n    setDrop(fn: (payload: string, index: number) => boolean) {\n      drop = fn;\n    },\n    inject(payload: string) {\n      for (const subscriber of subscribers) subscriber(payload);\n    },\n    channel(): SignalingChannel {\n      return {\n        type: \"memory\",\n        setup: () => {},\n        teardown: () => {},\n        publish: (payload: string) => {\n          const index = published++;\n\n          if (drop(payload, index)) return;\n\n          // Deliver asynchronously, as a real relay would.\n          queueMicrotask(() => {\n            for (const subscriber of subscribers) subscriber(payload);\n          });\n        },\n        subscribe: (handler) => {\n          subscribers.push(handler);\n        },\n      };\n    },\n  };\n};\n\nconst CLIENT_CAPABILITIES: PeerCapabilities = {\n  transports: [\"wrtc\"],\n  info: { identity: \"com.example.wallet\", name: \"Example Wallet\" },\n};\n\nconst createPeer = async (\n  channel: SignalingChannel,\n  { isHost, h, k }: { isHost: boolean; h: string; k: string; },\n) => {\n  const { encryptionKey, decryptionKey } = await generateKeyPair();\n  let relyingKey: EncryptionKey | undefined;\n  let peerCapabilities: PeerCapabilities | undefined;\n\n  const layer = await createSignalingLayer(channel)({\n    isHost,\n    h,\n    k: await deriveSymmetricKey(k),\n    publicKey: encryptionKey,\n    canEncrypt: () => relyingKey !== undefined,\n    encrypt: (message: string) => {\n      if (!relyingKey) throw new Error(\"no peer key\");\n\n      return relyingKey.encrypt(message);\n    },\n    decrypt: (message: string) => decryptionKey.decrypt(message),\n    rpDiscovered: async (rpKey: string) => {\n      relyingKey = await parseEncryptionKey(rpKey);\n    },\n    capabilities: CLIENT_CAPABILITIES,\n    peerCapabilities: (capabilities) => {\n      peerCapabilities = capabilities;\n    },\n  });\n\n  return { layer, encryptionKey, getPeerCapabilities: () => peerCapabilities };\n};\n\nconst K = \"00112233445566778899aabbccddeeff\";\n\nconst setupPair = async (topic: ReturnType<typeof createTopic>) => {\n  // Mirror createSession: the host's h is the hash of its own key, the\n  // client receives that h out-of-band (via the URI).\n  const hostKeys = await generateKeyPair();\n  const h = await hashPublicKey(hostKeys.encryptionKey);\n\n  const HOST_CAPABILITIES: PeerCapabilities = {\n    transports: [\"wrtc\", \"ws\"],\n    info: { identity: \"com.example.dapp\", name: \"Example dApp\" },\n  };\n\n  let hostRelying: EncryptionKey | undefined;\n  let hostPeerCapabilities: PeerCapabilities | undefined;\n  const host = await createSignalingLayer(topic.channel())({\n    isHost: true,\n    h,\n    k: await deriveSymmetricKey(K),\n    publicKey: hostKeys.encryptionKey,\n    canEncrypt: () => hostRelying !== undefined,\n    encrypt: (message: string) => {\n      if (!hostRelying) throw new Error(\"no peer key\");\n\n      return hostRelying.encrypt(message);\n    },\n    decrypt: (message: string) => hostKeys.decryptionKey.decrypt(message),\n    rpDiscovered: async (rpKey: string) => {\n      hostRelying = await parseEncryptionKey(rpKey);\n    },\n    capabilities: HOST_CAPABILITIES,\n    peerCapabilities: (capabilities) => {\n      hostPeerCapabilities = capabilities;\n    },\n  });\n\n  const { layer: client, getPeerCapabilities: getClientPeerCapabilities }\n    = await createPeer(topic.channel(), {\n      isHost: false,\n      h,\n      k: K,\n    });\n\n  return {\n    host,\n    client,\n    hostCapabilities: HOST_CAPABILITIES,\n    getHostPeerCapabilities: () => hostPeerCapabilities,\n    getClientPeerCapabilities,\n  };\n};\n\nconst waitForState = (layer: SignalingLayer, target: string) =>\n  new Promise<void>((resolve, reject) => {\n    if (layer.getState().state === target) return resolve();\n\n    layer.on(\"state_change\", (state) => {\n      if (state === target) resolve();\n\n      if (state === SIGNAL_STATE.ERROR && target !== SIGNAL_STATE.ERROR) {\n        reject(new Error(\"signaling errored\"));\n      }\n    });\n  });\n\ndescribe(\"signaling handshake (in-memory relay)\", () => {\n  let host: SignalingLayer;\n  let client: SignalingLayer;\n\n  afterEach(async () => {\n    await host?.teardown();\n    await client?.teardown();\n  });\n\n  it(\"completes and exchanges data on a reliable relay\", async () => {\n    const topic = createTopic();\n    const pair = await setupPair(topic);\n\n    ({ host, client } = pair);\n\n    await host.setup();\n\n    const encrypted = Promise.all([\n      waitForState(host, SIGNAL_STATE.ENCRYPTED),\n      waitForState(client, SIGNAL_STATE.ENCRYPTED),\n    ]);\n\n    await client.setup();\n    await encrypted;\n\n    const received = new Promise<object>(resolve => host.on(\"message\", resolve));\n\n    await client.send({ hello: \"world\" });\n    expect(await received).toEqual({ hello: \"world\" });\n  });\n\n  it(\"exchanges capabilities in both directions during the handshake\", async () => {\n    const topic = createTopic();\n    const pair = await setupPair(topic);\n\n    ({ host, client } = pair);\n\n    await host.setup();\n\n    const encrypted = Promise.all([\n      waitForState(host, SIGNAL_STATE.ENCRYPTED),\n      waitForState(client, SIGNAL_STATE.ENCRYPTED),\n    ]);\n\n    await client.setup();\n    await encrypted;\n\n    expect(pair.getClientPeerCapabilities()).toEqual(pair.hostCapabilities);\n    expect(pair.getHostPeerCapabilities()).toEqual(CLIENT_CAPABILITIES);\n  });\n\n  it(\"ignores garbage frames on the public topic\", async () => {\n    const topic = createTopic();\n\n    ({ host, client } = await setupPair(topic));\n\n    await host.setup();\n\n    // Garbage before and during the handshake: random text, valid-looking\n    // frames with undecryptable bodies, and truncated frames.\n    topic.inject(\"not-a-frame\");\n    topic.inject(\"hh\");\n    topic.inject(\"hcQUJDRA==\");\n    topic.inject(\"xh!!!not-base64!!!\");\n\n    const encrypted = Promise.all([\n      waitForState(host, SIGNAL_STATE.ENCRYPTED),\n      waitForState(client, SIGNAL_STATE.ENCRYPTED),\n    ]);\n\n    await client.setup();\n    topic.inject(\"hcgarbage-mid-handshake\");\n    await encrypted;\n  });\n\n  describe(\"lossy relay\", () => {\n    beforeEach(() => {\n      vi.useFakeTimers();\n    });\n\n    afterEach(() => {\n      vi.useRealTimers();\n    });\n\n    it(\"recovers when handshake frames are dropped\", async () => {\n      const topic = createTopic();\n\n      // Drop the first delivery of every frame; re-sends get through.\n      const seen = new Set<string>();\n\n      topic.setDrop((payload) => {\n        if (seen.has(payload.slice(0, 2) + payload.length)) return false;\n\n        seen.add(payload.slice(0, 2) + payload.length);\n\n        return true;\n      });\n\n      ({ host, client } = await setupPair(topic));\n\n      await host.setup();\n      await client.setup();\n\n      const encrypted = Promise.all([\n        waitForState(host, SIGNAL_STATE.ENCRYPTED),\n        waitForState(client, SIGNAL_STATE.ENCRYPTED),\n      ]);\n\n      // Let several resend intervals elapse.\n      for (let index = 0; index < 10; index += 1) {\n        await vi.advanceTimersByTimeAsync(2100);\n      }\n\n      await encrypted;\n    });\n\n    it(\"errors out when the peer never appears\", async () => {\n      const topic = createTopic();\n\n      topic.setDrop(() => true);\n\n      ({ host, client } = await setupPair(topic));\n\n      await client.setup();\n\n      const errored = waitForState(client, SIGNAL_STATE.ERROR);\n\n      await vi.advanceTimersByTimeAsync(31_000);\n      await errored;\n      expect(client.getState().state).toBe(SIGNAL_STATE.ERROR);\n    });\n  });\n});\n"]}

package/dist/index.d.ts

@@ -1,7 +1,9 @@
 import type { EncryptionKey, SymmetricKey } from "@openlv/core/encryption";
 import { EventEmitter } from "eventemitter3";
 import type { MaybePromise } from "viem";
+import { type PeerCapabilities } from "./messages.js";
 import type { SignalingChannel } from "./protocol.js";
+export * from "./messages.js";
 export * from "./protocol.js";
 export declare const SIGNAL_STATE: {
     readonly STANDBY: "standby";
@@ -22,6 +24,8 @@ export type SignalingProperties = {
     h: string;
     k?: SymmetricKey;
     rpDiscovered: (rpKey: string) => MaybePromise<void>;
+    capabilities: PeerCapabilities;
+    peerCapabilities: (capabilities: PeerCapabilities) => MaybePromise<void>;
     decrypt: (message: string) => MaybePromise<string>;
     encrypt: (message: string) => MaybePromise<string>;
     publicKey: EncryptionKey;