feat: Invite over internet

package.json

@@ -193,7 +193,7 @@
     "bcp-47-normalize": "^2.3.0",
     "better-sqlite3": "^11.10.0",
     "big-sparse-array": "^1.0.3",
-    "bogon": "^1.1.0",
+    "bogon": "^1.2.0",
     "comapeocat": "^1.0.0",
     "compact-encoding": "^2.12.0",
     "corestore": "6.8.4",
@@ -209,6 +209,7 @@
     "hypercore": "10.19.0",
     "hypercore-crypto": "3.4.2",
     "hyperdrive": "11.5.3",
+    "hyperswarm": "^4.17.0",
     "iso-3166": "^4.3.0",
     "json-stable-stringify": "^1.1.1",
     "magic-bytes.js": "^1.10.0",

proto/rpc.proto

@@ -36,6 +36,10 @@ message ProjectJoinDetails {
   EncryptionKeys encryptionKeys = 3;
 }
 
+message RedeemInviteOverInternet {
+  bytes inviteId = 1;
+}
+
 message DeviceInfo {
   enum DeviceType {
     device_type_unspecified = 0;
@@ -68,6 +72,10 @@ message ProjectJoinDetailsAck {
   bytes inviteId = 1;
 }
 
+message RedeemInviteOverInternetAck {
+  bytes inviteId = 1;
+}
+
 message MapShareExtension {
   // URLs to map share
   repeated string mapShareUrls = 1;

src/discovery/remote-discovery.js

@@ -0,0 +1,113 @@
+import { TypedEmitter } from 'tiny-typed-emitter'
+import { Logger } from '../logger.js'
+import Hyperswarm from 'hyperswarm'
+import { pEvent } from 'p-event'
+
+/** @import {OpenedNoiseStream} from '../lib/noise-secret-stream-helpers.js' */
+
+/**
+ * @typedef {Object} DiscoveryEvents
+ * @property {(connection: OpenedNoiseStream) => void} connection
+ */
+
+/**
+ * @extends {TypedEmitter<DiscoveryEvents>}
+ */
+export class RemoteDiscovery extends TypedEmitter {
+  #l
+  /** @type {Hyperswarm?} */
+  #swarm = null
+  /** @type {Promise<Hyperswarm>?} */
+  #loading = null
+  #identityKeypair
+
+  /**
+   * @param {Object} opts
+   * @param {import('./local-discovery.js').Keypair} opts.identityKeypair
+   * @param {Logger} [opts.logger]
+   */
+  constructor({ identityKeypair, logger }) {
+    super()
+    this.#l = Logger.create('RemoteDiscovery', logger)
+    this.#identityKeypair = identityKeypair
+  }
+
+  async #initSwarm() {
+    this.#l.log('Initializing swarm')
+
+    const swarm = new Hyperswarm({
+      keyPair: this.#identityKeypair,
+      maxPeers: 4,
+    })
+    swarm.on('connection', this.#handleHyperswarmConnection.bind(this))
+    this.#l.log('Starting listen')
+    await swarm.listen()
+    this.#l.log('Listening')
+    return swarm
+  }
+
+  /**
+   * @returns {Promise<Hyperswarm>}
+   */
+  async #ensureSwarm() {
+    await this.#loading
+    if (!this.#swarm) {
+      this.#loading = this.#initSwarm()
+      this.#swarm = await this.#loading
+    }
+    return this.#swarm
+  }
+
+  /**
+   * Start listening for incoming connections
+   */
+  async start() {
+    // TODO: Use start stop state machine
+    const swarm = await this.#ensureSwarm()
+    await swarm.resume()
+  }
+  /**
+   * Close all connections and stop listening
+   */
+  async stop() {
+    await this.#loading
+    await this.#swarm?.suspend()
+  }
+
+  async close() {
+    await this.#loading
+    await this.#swarm?.destroy()
+    this.#l.log('Closed swarm')
+  }
+
+  /**
+   * Connect to another peer by their NOISE public key
+   * @param {string} publicKey
+   * @param {object} [opts]
+   * @param {number} [opts.timeout]
+   */
+  async connectPeer(publicKey, { timeout = 60_000 } = {}) {
+    const swarm = await this.#ensureSwarm()
+    const noisePublicKey = Buffer.from(publicKey, 'hex')
+
+    const onConnected = pEvent(this, 'connection', {
+      filter: (connection) => connection.remotePublicKey.equals(noisePublicKey),
+      timeout,
+    })
+    // Start trying to connect
+    swarm.joinPeer(noisePublicKey)
+    this.#l.log('Connecting to %S', publicKey)
+
+    const socket = await onConnected
+
+    return socket
+  }
+
+  /**
+   * @param {OpenedNoiseStream} socket
+   * @param {import('hyperswarm').PeerInfo} _peerInfo
+   */
+  #handleHyperswarmConnection(socket, _peerInfo) {
+    this.emit('connection', socket)
+  }
+}

src/generated/rpc.d.ts

@@ -34,6 +34,9 @@ export interface ProjectJoinDetails {
     projectKey: Buffer;
     encryptionKeys: EncryptionKeys | undefined;
 }
+export interface RedeemInviteOverInternet {
+    inviteId: Buffer;
+}
 export interface DeviceInfo {
     name: string;
     deviceType?: DeviceInfo_DeviceType | undefined;
@@ -69,6 +72,9 @@ export interface InviteResponseAck {
 export interface ProjectJoinDetailsAck {
     inviteId: Buffer;
 }
+export interface RedeemInviteOverInternetAck {
+    inviteId: Buffer;
+}
 export interface MapShareExtension {
     /** URLs to map share */
     mapShareUrls: string[];
@@ -117,6 +123,12 @@ export declare const ProjectJoinDetails: {
     create<I extends Exact<DeepPartial<ProjectJoinDetails>, I>>(base?: I): ProjectJoinDetails;
     fromPartial<I extends Exact<DeepPartial<ProjectJoinDetails>, I>>(object: I): ProjectJoinDetails;
 };
+export declare const RedeemInviteOverInternet: {
+    encode(message: RedeemInviteOverInternet, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): RedeemInviteOverInternet;
+    create<I extends Exact<DeepPartial<RedeemInviteOverInternet>, I>>(base?: I): RedeemInviteOverInternet;
+    fromPartial<I extends Exact<DeepPartial<RedeemInviteOverInternet>, I>>(object: I): RedeemInviteOverInternet;
+};
 export declare const DeviceInfo: {
     encode(message: DeviceInfo, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): DeviceInfo;
@@ -147,6 +159,12 @@ export declare const ProjectJoinDetailsAck: {
     create<I extends Exact<DeepPartial<ProjectJoinDetailsAck>, I>>(base?: I): ProjectJoinDetailsAck;
     fromPartial<I extends Exact<DeepPartial<ProjectJoinDetailsAck>, I>>(object: I): ProjectJoinDetailsAck;
 };
+export declare const RedeemInviteOverInternetAck: {
+    encode(message: RedeemInviteOverInternetAck, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): RedeemInviteOverInternetAck;
+    create<I extends Exact<DeepPartial<RedeemInviteOverInternetAck>, I>>(base?: I): RedeemInviteOverInternetAck;
+    fromPartial<I extends Exact<DeepPartial<RedeemInviteOverInternetAck>, I>>(object: I): RedeemInviteOverInternetAck;
+};
 export declare const MapShareExtension: {
     encode(message: MapShareExtension, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): MapShareExtension;

src/generated/rpc.js

@@ -413,6 +413,48 @@ export var ProjectJoinDetails = {
         return message;
     },
 };
+function createBaseRedeemInviteOverInternet() {
+    return { inviteId: Buffer.alloc(0) };
+}
+export var RedeemInviteOverInternet = {
+    encode: function (message, writer) {
+        if (writer === void 0) { writer = _m0.Writer.create(); }
+        if (message.inviteId.length !== 0) {
+            writer.uint32(10).bytes(message.inviteId);
+        }
+        return writer;
+    },
+    decode: function (input, length) {
+        var reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        var end = length === undefined ? reader.len : reader.pos + length;
+        var message = createBaseRedeemInviteOverInternet();
+        while (reader.pos < end) {
+            var tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.inviteId = reader.bytes();
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    create: function (base) {
+        return RedeemInviteOverInternet.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial: function (object) {
+        var _a;
+        var message = createBaseRedeemInviteOverInternet();
+        message.inviteId = (_a = object.inviteId) !== null && _a !== void 0 ? _a : Buffer.alloc(0);
+        return message;
+    },
+};
 function createBaseDeviceInfo() {
     return { name: "", features: [] };
 }
@@ -653,6 +695,48 @@ export var ProjectJoinDetailsAck = {
         return message;
     },
 };
+function createBaseRedeemInviteOverInternetAck() {
+    return { inviteId: Buffer.alloc(0) };
+}
+export var RedeemInviteOverInternetAck = {
+    encode: function (message, writer) {
+        if (writer === void 0) { writer = _m0.Writer.create(); }
+        if (message.inviteId.length !== 0) {
+            writer.uint32(10).bytes(message.inviteId);
+        }
+        return writer;
+    },
+    decode: function (input, length) {
+        var reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        var end = length === undefined ? reader.len : reader.pos + length;
+        var message = createBaseRedeemInviteOverInternetAck();
+        while (reader.pos < end) {
+            var tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.inviteId = reader.bytes();
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    create: function (base) {
+        return RedeemInviteOverInternetAck.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial: function (object) {
+        var _a;
+        var message = createBaseRedeemInviteOverInternetAck();
+        message.inviteId = (_a = object.inviteId) !== null && _a !== void 0 ? _a : Buffer.alloc(0);
+        return message;
+    },
+};
 function createBaseMapShareExtension() {
     return {
         mapShareUrls: [],