@libp2p/websockets 0.16.2

package/LICENSE

@@ -0,0 +1,4 @@
+This project is dual licensed under MIT and Apache-2.0.
+
+MIT: https://www.opensource.org/licenses/mit
+Apache-2.0: https://www.apache.org/licenses/license-2.0

package/README.md

@@ -0,0 +1,122 @@
+# js-libp2p-websockets <!-- omit in toc -->
+
+[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
+[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
+[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
+[![Coverage Status](https://coveralls.io/repos/github/libp2p/js-libp2p-websockets/badge.svg?branch=master)](https://coveralls.io/github/libp2p/js-libp2p-websockets?branch=master)
+[![Build Status](https://github.com/libp2p/js-libp2p-websockets/actions/workflows/js-test-and-release.yml/badge.svg?branch=main)](https://github.com/libp2p/js-libp2p-websockets/actions/workflows/js-test-and-release.yml)
+[![Dependency Status](https://david-dm.org/libp2p/js-libp2p-websockets.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-websockets)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
+![](https://img.shields.io/badge/Node.js-%3E%3D14.0.0-orange.svg?style=flat-square)
+
+[![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport)
+[![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png)](https://github.com/libp2p/interface-connection)
+
+> JavaScript implementation of the WebSockets module that libp2p uses and that implements the interface-transport interface
+
+## Table of Contents <!-- omit in toc -->
+
+- [Description](#description)
+- [Usage](#usage)
+- [Install](#install)
+  - [npm](#npm)
+  - [Constructor properties](#constructor-properties)
+- [Libp2p Usage Example](#libp2p-usage-example)
+- [API](#api)
+  - [Transport](#transport)
+  - [Connection](#connection)
+- [License](#license)
+  - [Contribution](#contribution)
+
+## Description
+
+`libp2p-websockets` is the WebSockets implementation compatible with libp2p.
+
+## Usage
+
+## Install
+
+### npm
+
+```sh
+> npm i @libp2p/websockets
+```
+
+### Constructor properties
+
+```js
+import WS from '@libp2p/websockets'
+
+const properties = {
+  upgrader,
+  filter
+}
+
+const ws = new WS(properties)
+```
+
+| Name | Type | Description | Default |
+|------|------|-------------|---------|
+| upgrader | [`Upgrader`](https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/transport#upgrader) | connection upgrader object with `upgradeOutbound` and `upgradeInbound` | **REQUIRED** |
+| filter | `(multiaddrs: Array<Multiaddr>) => Array<Multiaddr>` | override transport addresses filter | **Browser:** DNS+WSS multiaddrs / **Node.js:** DNS+{WS, WSS} multiaddrs |
+
+You can create your own address filters for this transports, or rely in the filters [provided](./src/filters.js).
+
+The available filters are:
+
+- `filters.all`
+  - Returns all TCP and DNS based addresses, both with `ws` or `wss`.
+- `filters.dnsWss`
+  - Returns all DNS based addresses with `wss`.
+- `filters.dnsWsOrWss`
+  - Returns all DNS based addresses, both with `ws` or `wss`.
+
+## Libp2p Usage Example
+
+```js
+import Libp2p from 'libp2p'
+import { Websockets } from '@libp2p/websockets'
+import filters from 'libp2p-websockets/filters'
+import { MPLEX } from 'libp2p-mplex'
+import { NOISE } from 'libp2p-noise'
+
+const transportKey = Websockets.prototype[Symbol.toStringTag]
+const node = await Libp2p.create({
+  modules: {
+    transport: [Websockets],
+    streamMuxer: [MPLEX],
+    connEncryption: [NOISE]
+  },
+  config: {
+    transport: {
+      [transportKey]: { // Transport properties -- Libp2p upgrader is automatically added
+        filter: filters.dnsWsOrWss
+      }
+    }
+  }
+})
+```
+
+For more information see [libp2p/js-libp2p/doc/CONFIGURATION.md#customizing-transports](https://github.com/libp2p/js-libp2p/blob/master/doc/CONFIGURATION.md#customizing-transports).
+
+## API
+
+### Transport
+
+[![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport)
+
+### Connection
+
+[![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png)](https://github.com/libp2p/interface-connection)
+
+## License
+
+Licensed under either of
+
+ * Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT)
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

package/dist/src/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const CODE_P2P = 421;
+export declare const CODE_CIRCUIT = 290;
+export declare const CODE_TCP = 6;
+export declare const CODE_WS = 477;
+export declare const CODE_WSS = 478;
+export declare const CLOSE_TIMEOUT = 2000;
+//# sourceMappingURL=constants.d.ts.map

package/dist/src/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,QAAQ,MAAM,CAAA;AAC3B,eAAO,MAAM,YAAY,MAAM,CAAA;AAE/B,eAAO,MAAM,QAAQ,IAAI,CAAA;AACzB,eAAO,MAAM,OAAO,MAAM,CAAA;AAC1B,eAAO,MAAM,QAAQ,MAAM,CAAA;AAG3B,eAAO,MAAM,aAAa,OAAO,CAAA"}

package/dist/src/constants.js

@@ -0,0 +1,9 @@
+// p2p multi-address code
+export const CODE_P2P = 421;
+export const CODE_CIRCUIT = 290;
+export const CODE_TCP = 6;
+export const CODE_WS = 477;
+export const CODE_WSS = 478;
+// Time to wait for a connection to close gracefully before destroying it manually
+export const CLOSE_TIMEOUT = 2000;
+//# sourceMappingURL=constants.js.map

package/dist/src/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAG,CAAA;AAC3B,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,CAAA;AAE/B,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAA;AACzB,MAAM,CAAC,MAAM,OAAO,GAAG,GAAG,CAAA;AAC1B,MAAM,CAAC,MAAM,QAAQ,GAAG,GAAG,CAAA;AAE3B,kFAAkF;AAClF,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,CAAA"}

package/dist/src/filters.d.ts

@@ -0,0 +1,5 @@
+import type { Multiaddr } from '@multiformats/multiaddr';
+export declare function all(multiaddrs: Multiaddr[]): Multiaddr[];
+export declare function dnsWss(multiaddrs: Multiaddr[]): Multiaddr[];
+export declare function dnsWsOrWss(multiaddrs: Multiaddr[]): Multiaddr[];
+//# sourceMappingURL=filters.d.ts.map

package/dist/src/filters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filters.d.ts","sourceRoot":"","sources":["../../src/filters.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AASxD,wBAAgB,GAAG,CAAE,UAAU,EAAE,SAAS,EAAE,eAW3C;AAED,wBAAgB,MAAM,CAAE,UAAU,EAAE,SAAS,EAAE,eAW9C;AAED,wBAAgB,UAAU,CAAE,UAAU,EAAE,SAAS,EAAE,eAiBlD"}

package/dist/src/filters.js

@@ -0,0 +1,38 @@
+import * as mafmt from '@multiformats/mafmt';
+import { CODE_CIRCUIT, CODE_P2P, CODE_TCP, CODE_WS, CODE_WSS } from './constants.js';
+export function all(multiaddrs) {
+    return multiaddrs.filter((ma) => {
+        if (ma.protoCodes().includes(CODE_CIRCUIT)) {
+            return false;
+        }
+        const testMa = ma.decapsulateCode(CODE_P2P);
+        return mafmt.WebSockets.matches(testMa) ||
+            mafmt.WebSocketsSecure.matches(testMa);
+    });
+}
+export function dnsWss(multiaddrs) {
+    return multiaddrs.filter((ma) => {
+        if (ma.protoCodes().includes(CODE_CIRCUIT)) {
+            return false;
+        }
+        const testMa = ma.decapsulateCode(CODE_P2P);
+        return mafmt.WebSocketsSecure.matches(testMa) &&
+            mafmt.DNS.matches(testMa.decapsulateCode(CODE_TCP).decapsulateCode(CODE_WSS));
+    });
+}
+export function dnsWsOrWss(multiaddrs) {
+    return multiaddrs.filter((ma) => {
+        if (ma.protoCodes().includes(CODE_CIRCUIT)) {
+            return false;
+        }
+        const testMa = ma.decapsulateCode(CODE_P2P);
+        // WS
+        if (mafmt.WebSockets.matches(testMa)) {
+            return mafmt.DNS.matches(testMa.decapsulateCode(CODE_TCP).decapsulateCode(CODE_WS));
+        }
+        // WSS
+        return mafmt.WebSocketsSecure.matches(testMa) &&
+            mafmt.DNS.matches(testMa.decapsulateCode(CODE_TCP).decapsulateCode(CODE_WSS));
+    });
+}
+//# sourceMappingURL=filters.js.map

package/dist/src/filters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filters.js","sourceRoot":"","sources":["../../src/filters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,qBAAqB,CAAA;AAE5C,OAAO,EACL,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,QAAQ,EACT,MAAM,gBAAgB,CAAA;AAEvB,MAAM,UAAU,GAAG,CAAE,UAAuB;IAC1C,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE;QAC9B,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;YAC1C,OAAO,KAAK,CAAA;SACb;QAED,MAAM,MAAM,GAAG,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAA;QAE3C,OAAO,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC;YACrC,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,UAAU,MAAM,CAAE,UAAuB;IAC7C,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE;QAC9B,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;YAC1C,OAAO,KAAK,CAAA;SACb;QAED,MAAM,MAAM,GAAG,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAA;QAE3C,OAAO,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC;YAC3C,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAA;IACjF,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,UAAU,UAAU,CAAE,UAAuB;IACjD,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE;QAC9B,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;YAC1C,OAAO,KAAK,CAAA;SACb;QAED,MAAM,MAAM,GAAG,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAA;QAE3C,KAAK;QACL,IAAI,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACpC,OAAO,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;SACpF;QAED,MAAM;QACN,OAAO,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC;YAC3C,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAA;IACjF,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/dist/src/index.d.ts

@@ -0,0 +1,32 @@
+import { WebSocketOptions } from 'it-ws/client';
+import type { Transport, Upgrader, MultiaddrFilter } from '@libp2p/interfaces/transport';
+import type { AbortOptions } from '@libp2p/interfaces';
+import type { WebSocketListenerOptions } from './listener.js';
+import type { Multiaddr } from '@multiformats/multiaddr';
+import type { DuplexWebSocket } from 'it-ws/dist/src/duplex';
+/**
+ * @class WebSockets
+ */
+export declare class WebSockets implements Transport<AbortOptions & WebSocketOptions, WebSocketListenerOptions> {
+    private readonly upgrader;
+    private readonly _filter?;
+    constructor(opts: {
+        upgrader: Upgrader;
+        filter?: MultiaddrFilter;
+    });
+    dial(ma: Multiaddr, options?: AbortOptions & WebSocketOptions): Promise<import("@libp2p/interfaces/dist/src/connection").Connection>;
+    _connect(ma: Multiaddr, options: AbortOptions & WebSocketOptions): Promise<DuplexWebSocket>;
+    /**
+     * Creates a Websockets listener. The provided `handler` function will be called
+     * anytime a new incoming Connection has been successfully upgraded via
+     * `upgrader.upgradeInbound`
+     */
+    createListener(options?: WebSocketListenerOptions): import("@libp2p/interfaces/transport").Listener;
+    /**
+     * Takes a list of `Multiaddr`s and returns only valid Websockets addresses.
+     * By default, in a browser environment only DNS+WSS multiaddr is accepted,
+     * while in a Node.js environment DNS+{WS, WSS} multiaddrs are accepted.
+     */
+    filter(multiaddrs: Multiaddr[]): Multiaddr[];
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,gBAAgB,EAAE,MAAM,cAAc,CAAA;AASxD,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAA;AACxF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAA;AAC7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAI5D;;GAEG;AACH,qBAAa,UAAW,YAAW,SAAS,CAAC,YAAY,GAAG,gBAAgB,EAAE,wBAAwB,CAAC;IACrG,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IACnC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAiB;gBAE7B,IAAI,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,MAAM,CAAC,EAAE,eAAe,CAAA;KAAE;IAW7D,IAAI,CAAE,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,gBAAgB;IAa9D,QAAQ,CAAE,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,GAAG,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IA8DlG;;;;OAIG;IACH,cAAc,CAAE,OAAO,CAAC,EAAE,wBAAwB;IAIlD;;;;OAIG;IACH,MAAM,CAAE,UAAU,EAAE,SAAS,EAAE;CAchC"}

package/dist/src/index.js

@@ -0,0 +1,110 @@
+import { connect } from 'it-ws/client';
+import { multiaddrToUri as toUri } from '@multiformats/multiaddr-to-uri';
+import { AbortError } from '@libp2p/interfaces/errors';
+import pDefer from 'p-defer';
+import { logger } from '@libp2p/logger';
+import env from 'wherearewe';
+import { createListener } from './listener.js';
+import { socketToMaConn } from './socket-to-conn.js';
+import * as filters from './filters.js';
+const log = logger('libp2p:websockets');
+/**
+ * @class WebSockets
+ */
+export class WebSockets {
+    constructor(opts) {
+        const { upgrader, filter } = opts;
+        if (upgrader == null) {
+            throw new Error('An upgrader must be provided. See https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/transport#upgrader');
+        }
+        this.upgrader = upgrader;
+        this._filter = filter;
+    }
+    async dial(ma, options) {
+        log('dialing %s', ma);
+        options = options ?? {};
+        const socket = await this._connect(ma, options);
+        const maConn = socketToMaConn(socket, ma);
+        log('new outbound connection %s', maConn.remoteAddr);
+        const conn = await this.upgrader.upgradeOutbound(maConn);
+        log('outbound connection %s upgraded', maConn.remoteAddr);
+        return conn;
+    }
+    async _connect(ma, options) {
+        if (options?.signal?.aborted === true) {
+            throw new AbortError();
+        }
+        const cOpts = ma.toOptions();
+        log('dialing %s:%s', cOpts.host, cOpts.port);
+        const errorPromise = pDefer();
+        const errfn = (err) => {
+            log.error('connection error:', err);
+            errorPromise.reject(err);
+        };
+        const rawSocket = connect(toUri(ma), options);
+        if (rawSocket.socket.on != null) {
+            rawSocket.socket.on('error', errfn);
+        }
+        else {
+            rawSocket.socket.onerror = errfn;
+        }
+        if (options.signal == null) {
+            await Promise.race([rawSocket.connected(), errorPromise.promise]);
+            log('connected %s', ma);
+            return rawSocket;
+        }
+        // Allow abort via signal during connect
+        let onAbort;
+        const abort = new Promise((resolve, reject) => {
+            onAbort = () => {
+                reject(new AbortError());
+                // FIXME: https://github.com/libp2p/js-libp2p-websockets/issues/121
+                setTimeout(() => {
+                    rawSocket.close().catch(err => {
+                        log.error('error closing raw socket', err);
+                    });
+                });
+            };
+            // Already aborted?
+            if (options?.signal?.aborted === true) {
+                return onAbort();
+            }
+            options?.signal?.addEventListener('abort', onAbort);
+        });
+        try {
+            await Promise.race([abort, errorPromise.promise, rawSocket.connected()]);
+        }
+        finally {
+            if (onAbort != null) {
+                options?.signal?.removeEventListener('abort', onAbort);
+            }
+        }
+        log('connected %s', ma);
+        return rawSocket;
+    }
+    /**
+     * Creates a Websockets listener. The provided `handler` function will be called
+     * anytime a new incoming Connection has been successfully upgraded via
+     * `upgrader.upgradeInbound`
+     */
+    createListener(options) {
+        return createListener(this.upgrader, options);
+    }
+    /**
+     * Takes a list of `Multiaddr`s and returns only valid Websockets addresses.
+     * By default, in a browser environment only DNS+WSS multiaddr is accepted,
+     * while in a Node.js environment DNS+{WS, WSS} multiaddrs are accepted.
+     */
+    filter(multiaddrs) {
+        multiaddrs = Array.isArray(multiaddrs) ? multiaddrs : [multiaddrs];
+        if (this._filter != null) {
+            return this._filter(multiaddrs);
+        }
+        // Browser
+        if (env.isBrowser || env.isWebWorker) {
+            return filters.dnsWss(multiaddrs);
+        }
+        return filters.all(multiaddrs);
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAoB,MAAM,cAAc,CAAA;AACxD,OAAO,EAAE,cAAc,IAAI,KAAK,EAAE,MAAM,gCAAgC,CAAA;AACxE,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AACtD,OAAO,MAAM,MAAM,SAAS,CAAA;AAC5B,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,GAAG,MAAM,YAAY,CAAA;AAC5B,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAOvC,MAAM,GAAG,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAA;AAEvC;;GAEG;AACH,MAAM,OAAO,UAAU;IAIrB,YAAa,IAAsD;QACjE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;QAEjC,IAAI,QAAQ,IAAI,IAAI,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,gJAAgJ,CAAC,CAAA;SAClK;QAED,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;IACvB,CAAC;IAED,KAAK,CAAC,IAAI,CAAE,EAAa,EAAE,OAAyC;QAClE,GAAG,CAAC,YAAY,EAAE,EAAE,CAAC,CAAA;QACrB,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;QAEvB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;QAC/C,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;QACzC,GAAG,CAAC,4BAA4B,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;QAEpD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,CAAA;QACxD,GAAG,CAAC,iCAAiC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;QACzD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,QAAQ,CAAE,EAAa,EAAE,OAAwC;QACrE,IAAI,OAAO,EAAE,MAAM,EAAE,OAAO,KAAK,IAAI,EAAE;YACrC,MAAM,IAAI,UAAU,EAAE,CAAA;SACvB;QACD,MAAM,KAAK,GAAG,EAAE,CAAC,SAAS,EAAE,CAAA;QAC5B,GAAG,CAAC,eAAe,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;QAE5C,MAAM,YAAY,GAAG,MAAM,EAAE,CAAA;QAC7B,MAAM,KAAK,GAAG,CAAC,GAAQ,EAAE,EAAE;YACzB,GAAG,CAAC,KAAK,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAA;YAEnC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC1B,CAAC,CAAA;QAED,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAA;QAE7C,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE,IAAI,IAAI,EAAE;YAC/B,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;SACpC;aAAM;YACL,SAAS,CAAC,MAAM,CAAC,OAAO,GAAG,KAAK,CAAA;SACjC;QAED,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE;YAC1B,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;YAEjE,GAAG,CAAC,cAAc,EAAE,EAAE,CAAC,CAAA;YACvB,OAAO,SAAS,CAAA;SACjB;QAED,wCAAwC;QACxC,IAAI,OAAO,CAAA;QACX,MAAM,KAAK,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC5C,OAAO,GAAG,GAAG,EAAE;gBACb,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC,CAAA;gBACxB,mEAAmE;gBACnE,UAAU,CAAC,GAAG,EAAE;oBACd,SAAS,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;wBAC5B,GAAG,CAAC,KAAK,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAA;oBAC5C,CAAC,CAAC,CAAA;gBACJ,CAAC,CAAC,CAAA;YACJ,CAAC,CAAA;YAED,mBAAmB;YACnB,IAAI,OAAO,EAAE,MAAM,EAAE,OAAO,KAAK,IAAI,EAAE;gBACrC,OAAO,OAAO,EAAE,CAAA;aACjB;YAED,OAAO,EAAE,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACrD,CAAC,CAAC,CAAA;QAEF,IAAI;YACF,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC,CAAA;SACzE;gBAAS;YACR,IAAI,OAAO,IAAI,IAAI,EAAE;gBACnB,OAAO,EAAE,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;aACvD;SACF;QAED,GAAG,CAAC,cAAc,EAAE,EAAE,CAAC,CAAA;QACvB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAE,OAAkC;QAChD,OAAO,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;IAC/C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAE,UAAuB;QAC7B,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAA;QAElE,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,EAAE;YACxB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;SAChC;QAED,UAAU;QACV,IAAI,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,WAAW,EAAE;YACpC,OAAO,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;SAClC;QAED,OAAO,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;IAChC,CAAC;CACF"}

package/dist/src/listener.browser.d.ts

@@ -0,0 +1,2 @@
+export declare function createListener(): void;
+//# sourceMappingURL=listener.browser.d.ts.map

package/dist/src/listener.browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listener.browser.d.ts","sourceRoot":"","sources":["../../src/listener.browser.ts"],"names":[],"mappings":"AACA,wBAAgB,cAAc,SAE7B"}

package/dist/src/listener.browser.js

@@ -0,0 +1,4 @@
+export function createListener() {
+    throw new Error('WebSocket Servers can not be created in the browser!');
+}
+//# sourceMappingURL=listener.browser.js.map

package/dist/src/listener.browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listener.browser.js","sourceRoot":"","sources":["../../src/listener.browser.ts"],"names":[],"mappings":"AACA,MAAM,UAAU,cAAc;IAC5B,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;AACzE,CAAC"}

package/dist/src/listener.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import type { ListenerOptions, Upgrader, Listener } from '@libp2p/interfaces/transport';
+import type { Server } from 'http';
+export interface WebSocketListenerOptions extends ListenerOptions {
+    server?: Server;
+}
+export declare function createListener(upgrader: Upgrader, options?: WebSocketListenerOptions): Listener;
+//# sourceMappingURL=listener.d.ts.map

package/dist/src/listener.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"listener.d.ts","sourceRoot":"","sources":["../../src/listener.ts"],"names":[],"mappings":";AAMA,OAAO,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,EAAkB,MAAM,8BAA8B,CAAA;AACvG,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAgJlC,MAAM,WAAW,wBAAyB,SAAQ,eAAe;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,wBAAgB,cAAc,CAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,wBAAwB,GAAG,QAAQ,CAIhG"}

package/dist/src/listener.js

@@ -0,0 +1,121 @@
+import os from 'os';
+import { Multiaddr, protocols } from '@multiformats/multiaddr';
+import { createServer } from 'it-ws/server';
+import { logger } from '@libp2p/logger';
+import { socketToMaConn } from './socket-to-conn.js';
+import { ipPortToMultiaddr as toMultiaddr } from '@libp2p/utils/ip-port-to-multiaddr';
+import { EventEmitter, CustomEvent } from '@libp2p/interfaces';
+const log = logger('libp2p:websockets:listener');
+class WebSocketListener extends EventEmitter {
+    constructor(upgrader, options) {
+        super();
+        // Keep track of open connections to destroy when the listener is closed
+        this.connections = new Set();
+        const self = this; // eslint-disable-line @typescript-eslint/no-this-alias
+        this.server = createServer({
+            ...options,
+            onConnection: (stream) => {
+                const maConn = socketToMaConn(stream, toMultiaddr(stream.remoteAddress ?? '', stream.remotePort ?? 0));
+                log('new inbound connection %s', maConn.remoteAddr);
+                this.connections.add(stream);
+                stream.socket.on('close', function () {
+                    self.connections.delete(stream);
+                });
+                try {
+                    void upgrader.upgradeInbound(maConn)
+                        .then((conn) => {
+                        log('inbound connection %s upgraded', maConn.remoteAddr);
+                        if (options?.handler != null) {
+                            options?.handler(conn);
+                        }
+                        self.dispatchEvent(new CustomEvent('connection', {
+                            detail: conn
+                        }));
+                    })
+                        .catch(async (err) => {
+                        log.error('inbound connection failed to upgrade', err);
+                        await maConn.close().catch(err => {
+                            log.error('inbound connection failed to close after upgrade failed', err);
+                        });
+                    });
+                }
+                catch (err) {
+                    log.error('inbound connection failed to upgrade', err);
+                    maConn.close().catch(err => {
+                        log.error('inbound connection failed to close after upgrade failed', err);
+                    });
+                }
+            }
+        });
+        this.server.on('listening', () => {
+            this.dispatchEvent(new CustomEvent('listening'));
+        });
+        this.server.on('error', (err) => {
+            this.dispatchEvent(new CustomEvent('error', {
+                detail: err
+            }));
+        });
+        this.server.on('close', () => {
+            this.dispatchEvent(new CustomEvent('close'));
+        });
+    }
+    async close() {
+        await Promise.all(Array.from(this.connections).map(async (maConn) => await maConn.close()));
+        if (this.server.address() == null) {
+            // not listening, close will throw an error
+            return;
+        }
+        return await this.server.close();
+    }
+    async listen(ma) {
+        this.listeningMultiaddr = ma;
+        await this.server.listen(ma.toOptions());
+    }
+    getAddrs() {
+        const multiaddrs = [];
+        const address = this.server.address();
+        if (address == null) {
+            throw new Error('Listener is not ready yet');
+        }
+        if (typeof address === 'string') {
+            throw new Error('Wrong address type received - expected AddressInfo, got string - are you trying to listen on a unix socket?');
+        }
+        if (this.listeningMultiaddr == null) {
+            throw new Error('Listener is not ready yet');
+        }
+        const ipfsId = this.listeningMultiaddr.getPeerId();
+        const protos = this.listeningMultiaddr.protos();
+        // Because TCP will only return the IPv6 version
+        // we need to capture from the passed multiaddr
+        if (protos.some(proto => proto.code === protocols('ip4').code)) {
+            const wsProto = protos.some(proto => proto.code === protocols('ws').code) ? '/ws' : '/wss';
+            let m = this.listeningMultiaddr.decapsulate('tcp');
+            m = m.encapsulate(`/tcp/${address.port}${wsProto}`);
+            if (ipfsId != null) {
+                m = m.encapsulate(`/p2p/${ipfsId}`);
+            }
+            if (m.toString().includes('0.0.0.0')) {
+                const netInterfaces = os.networkInterfaces();
+                Object.values(netInterfaces).forEach(niInfos => {
+                    if (niInfos == null) {
+                        return;
+                    }
+                    niInfos.forEach(ni => {
+                        if (ni.family === 'IPv4') {
+                            multiaddrs.push(new Multiaddr(m.toString().replace('0.0.0.0', ni.address)));
+                        }
+                    });
+                });
+            }
+            else {
+                multiaddrs.push(m);
+            }
+        }
+        return multiaddrs;
+    }
+}
+export function createListener(upgrader, options) {
+    options = options ?? {};
+    return new WebSocketListener(upgrader, options);
+}
+//# sourceMappingURL=listener.js.map

package/dist/src/listener.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"listener.js","sourceRoot":"","sources":["../../src/listener.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAA;AACnB,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,iBAAiB,IAAI,WAAW,EAAE,MAAM,oCAAoC,CAAA;AAKrF,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAE9D,MAAM,GAAG,GAAG,MAAM,CAAC,4BAA4B,CAAC,CAAA;AAEhD,MAAM,iBAAkB,SAAQ,YAA4B;IAK1D,YAAa,QAAkB,EAAE,OAAiC;QAChE,KAAK,EAAE,CAAA;QAEP,wEAAwE;QACxE,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAmB,CAAA;QAE7C,MAAM,IAAI,GAAG,IAAI,CAAA,CAAC,uDAAuD;QAEzE,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC;YACzB,GAAG,OAAO;YACV,YAAY,EAAE,CAAC,MAAuB,EAAE,EAAE;gBACxC,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,aAAa,IAAI,EAAE,EAAE,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,CAAA;gBACtG,GAAG,CAAC,2BAA2B,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;gBAEnD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;gBAE5B,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE;oBACxB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;gBACjC,CAAC,CAAC,CAAA;gBAEF,IAAI;oBACF,KAAK,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC;yBACjC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;wBACb,GAAG,CAAC,gCAAgC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;wBAExD,IAAI,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE;4BAC5B,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;yBACvB;wBAED,IAAI,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,YAAY,EAAE;4BAC/C,MAAM,EAAE,IAAI;yBACb,CAAC,CAAC,CAAA;oBACL,CAAC,CAAC;yBACD,KAAK,CAAC,KAAK,EAAC,GAAG,EAAC,EAAE;wBACjB,GAAG,CAAC,KAAK,CAAC,sCAAsC,EAAE,GAAG,CAAC,CAAA;wBAEtD,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;4BAC/B,GAAG,CAAC,KAAK,CAAC,yDAAyD,EAAE,GAAG,CAAC,CAAA;wBAC3E,CAAC,CAAC,CAAA;oBACJ,CAAC,CAAC,CAAA;iBACL;gBAAC,OAAO,GAAG,EAAE;oBACZ,GAAG,CAAC,KAAK,CAAC,sCAAsC,EAAE,GAAG,CAAC,CAAA;oBACtD,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;wBACzB,GAAG,CAAC,KAAK,CAAC,yDAAyD,EAAE,GAAG,CAAC,CAAA;oBAC3E,CAAC,CAAC,CAAA;iBACH;YACH,CAAC;SACF,CAAC,CAAA;QAEF,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;YAC/B,IAAI,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,WAAW,CAAC,CAAC,CAAA;QAClD,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAU,EAAE,EAAE;YACrC,IAAI,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE;gBAC1C,MAAM,EAAE,GAAG;aACZ,CAAC,CAAC,CAAA;QACL,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAC3B,IAAI,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,CAAA;QAC9C,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,OAAO,CAAC,GAAG,CACf,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,KAAK,EAAC,MAAM,EAAC,EAAE,CAAC,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC,CACvE,CAAA;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,IAAI,EAAE;YACjC,2CAA2C;YAC3C,OAAM;SACP;QAED,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;IAClC,CAAC;IAED,KAAK,CAAC,MAAM,CAAE,EAAa;QACzB,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAA;QAE5B,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,CAAA;IAC1C,CAAC;IAED,QAAQ;QACN,MAAM,UAAU,GAAG,EAAE,CAAA;QACrB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAA;QAErC,IAAI,OAAO,IAAI,IAAI,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;SAC7C;QAED,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC/B,MAAM,IAAI,KAAK,CAAC,6GAA6G,CAAC,CAAA;SAC/H;QAED,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI,EAAE;YACnC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;SAC7C;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,CAAA;QAClD,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAA;QAE/C,gDAAgD;QAChD,+CAA+C;QAC/C,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE;YAC9D,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAA;YAC1F,IAAI,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;YAClD,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,QAAQ,OAAO,CAAC,IAAI,GAAG,OAAO,EAAE,CAAC,CAAA;YACnD,IAAI,MAAM,IAAI,IAAI,EAAE;gBAClB,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,QAAQ,MAAM,EAAE,CAAC,CAAA;aACpC;YAED,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;gBACpC,MAAM,aAAa,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAA;gBAC5C,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;oBAC7C,IAAI,OAAO,IAAI,IAAI,EAAE;wBACnB,OAAM;qBACP;oBAED,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;wBACnB,IAAI,EAAE,CAAC,MAAM,KAAK,MAAM,EAAE;4BACxB,UAAU,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;yBAC5E;oBACH,CAAC,CAAC,CAAA;gBACJ,CAAC,CAAC,CAAA;aACH;iBAAM;gBACL,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;aACnB;SACF;QAED,OAAO,UAAU,CAAA;IACnB,CAAC;CACF;AAMD,MAAM,UAAU,cAAc,CAAE,QAAkB,EAAE,OAAkC;IACpF,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;IAEvB,OAAO,IAAI,iBAAiB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;AACjD,CAAC"}

package/dist/src/socket-to-conn.d.ts

@@ -0,0 +1,9 @@
+import type { AbortOptions } from '@libp2p/interfaces';
+import type { MultiaddrConnection } from '@libp2p/interfaces/transport';
+import type { Multiaddr } from '@multiformats/multiaddr';
+import type { DuplexWebSocket } from 'it-ws/duplex';
+export interface SocketToConnOptions extends AbortOptions {
+    localAddr?: Multiaddr;
+}
+export declare function socketToMaConn(stream: DuplexWebSocket, remoteAddr: Multiaddr, options?: SocketToConnOptions): MultiaddrConnection;
+//# sourceMappingURL=socket-to-conn.d.ts.map

package/dist/src/socket-to-conn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"socket-to-conn.d.ts","sourceRoot":"","sources":["../../src/socket-to-conn.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAA;AACvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAInD,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,SAAS,CAAC,EAAE,SAAS,CAAA;CACtB;AAID,wBAAgB,cAAc,CAAE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,mBAAmB,CAmDlI"}

package/dist/src/socket-to-conn.js

@@ -0,0 +1,52 @@
+import { abortableSource } from 'abortable-iterator';
+import { CLOSE_TIMEOUT } from './constants.js';
+import pTimeout from 'p-timeout';
+import { logger } from '@libp2p/logger';
+const log = logger('libp2p:websockets:socket');
+// Convert a stream into a MultiaddrConnection
+// https://github.com/libp2p/interface-transport#multiaddrconnection
+export function socketToMaConn(stream, remoteAddr, options) {
+    options = options ?? {};
+    const maConn = {
+        async sink(source) {
+            if ((options?.signal) != null) {
+                source = abortableSource(source, options.signal);
+            }
+            try {
+                await stream.sink(source);
+            }
+            catch (err) {
+                if (err.type !== 'aborted') {
+                    log.error(err);
+                }
+            }
+        },
+        source: (options.signal != null) ? abortableSource(stream.source, options.signal) : stream.source,
+        remoteAddr,
+        timeline: { open: Date.now() },
+        async close() {
+            const start = Date.now();
+            try {
+                await pTimeout(stream.close(), CLOSE_TIMEOUT);
+            }
+            catch (err) {
+                const { host, port } = maConn.remoteAddr.toOptions();
+                log('timeout closing stream to %s:%s after %dms, destroying it manually', host, port, Date.now() - start);
+                stream.destroy();
+            }
+            finally {
+                maConn.timeline.close = Date.now();
+            }
+        }
+    };
+    stream.socket.once != null && stream.socket.once('close', () => {
+        // In instances where `close` was not explicitly called,
+        // such as an iterable stream ending, ensure we have set the close
+        // timeline
+        if (maConn.timeline.close == null) {
+            maConn.timeline.close = Date.now();
+        }
+    });
+    return maConn;
+}
+//# sourceMappingURL=socket-to-conn.js.map

package/dist/src/socket-to-conn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"socket-to-conn.js","sourceRoot":"","sources":["../../src/socket-to-conn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAC9C,OAAO,QAAQ,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAMvC,MAAM,GAAG,GAAG,MAAM,CAAC,0BAA0B,CAAC,CAAA;AAM9C,8CAA8C;AAC9C,oEAAoE;AACpE,MAAM,UAAU,cAAc,CAAE,MAAuB,EAAE,UAAqB,EAAE,OAA6B;IAC3G,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;IAEvB,MAAM,MAAM,GAAwB;QAClC,KAAK,CAAC,IAAI,CAAE,MAAM;YAChB,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,IAAI,EAAE;gBAC7B,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;aACjD;YAED,IAAI;gBACF,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;aAC1B;YAAC,OAAO,GAAQ,EAAE;gBACjB,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE;oBAC1B,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;iBACf;aACF;QACH,CAAC;QAED,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM;QAEjG,UAAU;QAEV,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE;QAE9B,KAAK,CAAC,KAAK;YACT,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;YAExB,IAAI;gBACF,MAAM,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,aAAa,CAAC,CAAA;aAC9C;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,CAAA;gBACpD,GAAG,CAAC,oEAAoE,EACtE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,CAAA;gBAEjC,MAAM,CAAC,OAAO,EAAE,CAAA;aACjB;oBAAS;gBACR,MAAM,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;aACnC;QACH,CAAC;KACF,CAAA;IAED,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;QAC7D,wDAAwD;QACxD,kEAAkE;QAClE,WAAW;QACX,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,IAAI,IAAI,EAAE;YACjC,MAAM,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;SACnC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,MAAM,CAAA;AACf,CAAC"}

package/package.json

@@ -0,0 +1,166 @@
+{
+  "name": "@libp2p/websockets",
+  "version": "0.16.2",
+  "description": "JavaScript implementation of the WebSockets module that libp2p uses and that implements the interface-transport spec",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/libp2p/js-libp2p-websockets#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/libp2p/js-libp2p-websockets.git"
+  },
+  "bugs": {
+    "url": "https://github.com/libp2p/js-libp2p-websockets/issues"
+  },
+  "keywords": [
+    "IPFS"
+  ],
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.0.0"
+  },
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "src",
+    "dist/src",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/src/index.js"
+    }
+  },
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module"
+    }
+  },
+  "release": {
+    "branches": [
+      "master"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "major"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "chore",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "docs",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
+  },
+  "scripts": {
+    "lint": "aegir lint",
+    "dep-check": "aegir dep-check dist/src/**/*.js dist/test/**/*.js",
+    "build": "tsc",
+    "pretest": "npm run build",
+    "test": "aegir test",
+    "test:chrome": "npm run test -- -t browser -f ./dist/test/browser.js --cov",
+    "test:chrome-webworker": "npm run test -- -t webworker -f ./dist/test/browser.js",
+    "test:firefox": "npm run test -- -t browser -f ./dist/test/browser.js -- --browser firefox",
+    "test:firefox-webworker": "npm run test -- -t webworker -f ./dist/test/browser.js -- --browser firefox",
+    "test:node": "npm run test -- -t node -f ./dist/test/node.js --cov",
+    "test:electron-main": "npm run test -- -t electron-main -f ./dist/test/node.js --cov",
+    "release": "semantic-release"
+  },
+  "dependencies": {
+    "@libp2p/logger": "^1.0.2",
+    "@libp2p/utils": "^1.0.0",
+    "@multiformats/mafmt": "^11.0.1",
+    "@multiformats/multiaddr": "^10.0.0",
+    "@multiformats/multiaddr-to-uri": "^9.0.0",
+    "abortable-iterator": "^4.0.2",
+    "err-code": "^3.0.1",
+    "it-ws": "^5.0.0",
+    "p-defer": "^4.0.0",
+    "p-timeout": "^5.0.2",
+    "wherearewe": "^1.0.0"
+  },
+  "devDependencies": {
+    "@libp2p/interface-compliance-tests": "^1.1.2",
+    "@libp2p/interfaces": "^1.3.2",
+    "@types/ws": "^8.2.2",
+    "aegir": "^36.1.3",
+    "is-loopback-addr": "^2.0.1",
+    "it-all": "^1.0.6",
+    "it-drain": "^1.0.5",
+    "it-goodbye": "^4.0.1",
+    "it-pipe": "^2.0.2",
+    "it-take": "^1.0.2",
+    "p-wait-for": "^4.1.0",
+    "uint8arrays": "^3.0.0",
+    "util": "^0.12.3"
+  },
+  "browser": {
+    "./dist/src/listener.js": "./dist/src/listener.browser.js"
+  }
+}

package/src/constants.ts

@@ -0,0 +1,10 @@
+// p2p multi-address code
+export const CODE_P2P = 421
+export const CODE_CIRCUIT = 290
+
+export const CODE_TCP = 6
+export const CODE_WS = 477
+export const CODE_WSS = 478
+
+// Time to wait for a connection to close gracefully before destroying it manually
+export const CLOSE_TIMEOUT = 2000

package/src/filters.ts

@@ -0,0 +1,54 @@
+import * as mafmt from '@multiformats/mafmt'
+import type { Multiaddr } from '@multiformats/multiaddr'
+import {
+  CODE_CIRCUIT,
+  CODE_P2P,
+  CODE_TCP,
+  CODE_WS,
+  CODE_WSS
+} from './constants.js'
+
+export function all (multiaddrs: Multiaddr[]) {
+  return multiaddrs.filter((ma) => {
+    if (ma.protoCodes().includes(CODE_CIRCUIT)) {
+      return false
+    }
+
+    const testMa = ma.decapsulateCode(CODE_P2P)
+
+    return mafmt.WebSockets.matches(testMa) ||
+      mafmt.WebSocketsSecure.matches(testMa)
+  })
+}
+
+export function dnsWss (multiaddrs: Multiaddr[]) {
+  return multiaddrs.filter((ma) => {
+    if (ma.protoCodes().includes(CODE_CIRCUIT)) {
+      return false
+    }
+
+    const testMa = ma.decapsulateCode(CODE_P2P)
+
+    return mafmt.WebSocketsSecure.matches(testMa) &&
+      mafmt.DNS.matches(testMa.decapsulateCode(CODE_TCP).decapsulateCode(CODE_WSS))
+  })
+}
+
+export function dnsWsOrWss (multiaddrs: Multiaddr[]) {
+  return multiaddrs.filter((ma) => {
+    if (ma.protoCodes().includes(CODE_CIRCUIT)) {
+      return false
+    }
+
+    const testMa = ma.decapsulateCode(CODE_P2P)
+
+    // WS
+    if (mafmt.WebSockets.matches(testMa)) {
+      return mafmt.DNS.matches(testMa.decapsulateCode(CODE_TCP).decapsulateCode(CODE_WS))
+    }
+
+    // WSS
+    return mafmt.WebSocketsSecure.matches(testMa) &&
+      mafmt.DNS.matches(testMa.decapsulateCode(CODE_TCP).decapsulateCode(CODE_WSS))
+  })
+}

package/src/index.ts

@@ -0,0 +1,139 @@
+import { connect, WebSocketOptions } from 'it-ws/client'
+import { multiaddrToUri as toUri } from '@multiformats/multiaddr-to-uri'
+import { AbortError } from '@libp2p/interfaces/errors'
+import pDefer from 'p-defer'
+import { logger } from '@libp2p/logger'
+import env from 'wherearewe'
+import { createListener } from './listener.js'
+import { socketToMaConn } from './socket-to-conn.js'
+import * as filters from './filters.js'
+import type { Transport, Upgrader, MultiaddrFilter } from '@libp2p/interfaces/transport'
+import type { AbortOptions } from '@libp2p/interfaces'
+import type { WebSocketListenerOptions } from './listener.js'
+import type { Multiaddr } from '@multiformats/multiaddr'
+import type { DuplexWebSocket } from 'it-ws/dist/src/duplex'
+
+const log = logger('libp2p:websockets')
+
+/**
+ * @class WebSockets
+ */
+export class WebSockets implements Transport<AbortOptions & WebSocketOptions, WebSocketListenerOptions> {
+  private readonly upgrader: Upgrader
+  private readonly _filter?: MultiaddrFilter
+
+  constructor (opts: { upgrader: Upgrader, filter?: MultiaddrFilter }) {
+    const { upgrader, filter } = opts
+
+    if (upgrader == null) {
+      throw new Error('An upgrader must be provided. See https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/transport#upgrader')
+    }
+
+    this.upgrader = upgrader
+    this._filter = filter
+  }
+
+  async dial (ma: Multiaddr, options?: AbortOptions & WebSocketOptions) {
+    log('dialing %s', ma)
+    options = options ?? {}
+
+    const socket = await this._connect(ma, options)
+    const maConn = socketToMaConn(socket, ma)
+    log('new outbound connection %s', maConn.remoteAddr)
+
+    const conn = await this.upgrader.upgradeOutbound(maConn)
+    log('outbound connection %s upgraded', maConn.remoteAddr)
+    return conn
+  }
+
+  async _connect (ma: Multiaddr, options: AbortOptions & WebSocketOptions): Promise<DuplexWebSocket> {
+    if (options?.signal?.aborted === true) {
+      throw new AbortError()
+    }
+    const cOpts = ma.toOptions()
+    log('dialing %s:%s', cOpts.host, cOpts.port)
+
+    const errorPromise = pDefer()
+    const errfn = (err: any) => {
+      log.error('connection error:', err)
+
+      errorPromise.reject(err)
+    }
+
+    const rawSocket = connect(toUri(ma), options)
+
+    if (rawSocket.socket.on != null) {
+      rawSocket.socket.on('error', errfn)
+    } else {
+      rawSocket.socket.onerror = errfn
+    }
+
+    if (options.signal == null) {
+      await Promise.race([rawSocket.connected(), errorPromise.promise])
+
+      log('connected %s', ma)
+      return rawSocket
+    }
+
+    // Allow abort via signal during connect
+    let onAbort
+    const abort = new Promise((resolve, reject) => {
+      onAbort = () => {
+        reject(new AbortError())
+        // FIXME: https://github.com/libp2p/js-libp2p-websockets/issues/121
+        setTimeout(() => {
+          rawSocket.close().catch(err => {
+            log.error('error closing raw socket', err)
+          })
+        })
+      }
+
+      // Already aborted?
+      if (options?.signal?.aborted === true) {
+        return onAbort()
+      }
+
+      options?.signal?.addEventListener('abort', onAbort)
+    })
+
+    try {
+      await Promise.race([abort, errorPromise.promise, rawSocket.connected()])
+    } finally {
+      if (onAbort != null) {
+        options?.signal?.removeEventListener('abort', onAbort)
+      }
+    }
+
+    log('connected %s', ma)
+    return rawSocket
+  }
+
+  /**
+   * Creates a Websockets listener. The provided `handler` function will be called
+   * anytime a new incoming Connection has been successfully upgraded via
+   * `upgrader.upgradeInbound`
+   */
+  createListener (options?: WebSocketListenerOptions) {
+    return createListener(this.upgrader, options)
+  }
+
+  /**
+   * Takes a list of `Multiaddr`s and returns only valid Websockets addresses.
+   * By default, in a browser environment only DNS+WSS multiaddr is accepted,
+   * while in a Node.js environment DNS+{WS, WSS} multiaddrs are accepted.
+   */
+  filter (multiaddrs: Multiaddr[]) {
+    multiaddrs = Array.isArray(multiaddrs) ? multiaddrs : [multiaddrs]
+
+    if (this._filter != null) {
+      return this._filter(multiaddrs)
+    }
+
+    // Browser
+    if (env.isBrowser || env.isWebWorker) {
+      return filters.dnsWss(multiaddrs)
+    }
+
+    return filters.all(multiaddrs)
+  }
+}

package/src/listener.browser.ts

@@ -0,0 +1,4 @@
+
+export function createListener () {
+  throw new Error('WebSocket Servers can not be created in the browser!')
+}

package/src/listener.ts

@@ -0,0 +1,160 @@
+import os from 'os'
+import { Multiaddr, protocols } from '@multiformats/multiaddr'
+import { createServer } from 'it-ws/server'
+import { logger } from '@libp2p/logger'
+import { socketToMaConn } from './socket-to-conn.js'
+import { ipPortToMultiaddr as toMultiaddr } from '@libp2p/utils/ip-port-to-multiaddr'
+import type { ListenerOptions, Upgrader, Listener, ListenerEvents } from '@libp2p/interfaces/transport'
+import type { Server } from 'http'
+import type { WebSocketServer } from 'it-ws/server'
+import type { DuplexWebSocket } from 'it-ws/duplex'
+import { EventEmitter, CustomEvent } from '@libp2p/interfaces'
+
+const log = logger('libp2p:websockets:listener')
+
+class WebSocketListener extends EventEmitter<ListenerEvents> implements Listener {
+  private readonly connections: Set<DuplexWebSocket>
+  private listeningMultiaddr?: Multiaddr
+  private readonly server: WebSocketServer
+
+  constructor (upgrader: Upgrader, options: WebSocketListenerOptions) {
+    super()
+
+    // Keep track of open connections to destroy when the listener is closed
+    this.connections = new Set<DuplexWebSocket>()
+
+    const self = this // eslint-disable-line @typescript-eslint/no-this-alias
+
+    this.server = createServer({
+      ...options,
+      onConnection: (stream: DuplexWebSocket) => {
+        const maConn = socketToMaConn(stream, toMultiaddr(stream.remoteAddress ?? '', stream.remotePort ?? 0))
+        log('new inbound connection %s', maConn.remoteAddr)
+
+        this.connections.add(stream)
+
+        stream.socket.on('close', function () {
+          self.connections.delete(stream)
+        })
+
+        try {
+          void upgrader.upgradeInbound(maConn)
+            .then((conn) => {
+              log('inbound connection %s upgraded', maConn.remoteAddr)
+
+              if (options?.handler != null) {
+                options?.handler(conn)
+              }
+
+              self.dispatchEvent(new CustomEvent('connection', {
+                detail: conn
+              }))
+            })
+            .catch(async err => {
+              log.error('inbound connection failed to upgrade', err)
+
+              await maConn.close().catch(err => {
+                log.error('inbound connection failed to close after upgrade failed', err)
+              })
+            })
+        } catch (err) {
+          log.error('inbound connection failed to upgrade', err)
+          maConn.close().catch(err => {
+            log.error('inbound connection failed to close after upgrade failed', err)
+          })
+        }
+      }
+    })
+
+    this.server.on('listening', () => {
+      this.dispatchEvent(new CustomEvent('listening'))
+    })
+    this.server.on('error', (err: Error) => {
+      this.dispatchEvent(new CustomEvent('error', {
+        detail: err
+      }))
+    })
+    this.server.on('close', () => {
+      this.dispatchEvent(new CustomEvent('close'))
+    })
+  }
+
+  async close () {
+    await Promise.all(
+      Array.from(this.connections).map(async maConn => await maConn.close())
+    )
+
+    if (this.server.address() == null) {
+      // not listening, close will throw an error
+      return
+    }
+
+    return await this.server.close()
+  }
+
+  async listen (ma: Multiaddr) {
+    this.listeningMultiaddr = ma
+
+    await this.server.listen(ma.toOptions())
+  }
+
+  getAddrs () {
+    const multiaddrs = []
+    const address = this.server.address()
+
+    if (address == null) {
+      throw new Error('Listener is not ready yet')
+    }
+
+    if (typeof address === 'string') {
+      throw new Error('Wrong address type received - expected AddressInfo, got string - are you trying to listen on a unix socket?')
+    }
+
+    if (this.listeningMultiaddr == null) {
+      throw new Error('Listener is not ready yet')
+    }
+
+    const ipfsId = this.listeningMultiaddr.getPeerId()
+    const protos = this.listeningMultiaddr.protos()
+
+    // Because TCP will only return the IPv6 version
+    // we need to capture from the passed multiaddr
+    if (protos.some(proto => proto.code === protocols('ip4').code)) {
+      const wsProto = protos.some(proto => proto.code === protocols('ws').code) ? '/ws' : '/wss'
+      let m = this.listeningMultiaddr.decapsulate('tcp')
+      m = m.encapsulate(`/tcp/${address.port}${wsProto}`)
+      if (ipfsId != null) {
+        m = m.encapsulate(`/p2p/${ipfsId}`)
+      }
+
+      if (m.toString().includes('0.0.0.0')) {
+        const netInterfaces = os.networkInterfaces()
+        Object.values(netInterfaces).forEach(niInfos => {
+          if (niInfos == null) {
+            return
+          }
+
+          niInfos.forEach(ni => {
+            if (ni.family === 'IPv4') {
+              multiaddrs.push(new Multiaddr(m.toString().replace('0.0.0.0', ni.address)))
+            }
+          })
+        })
+      } else {
+        multiaddrs.push(m)
+      }
+    }
+
+    return multiaddrs
+  }
+}
+
+export interface WebSocketListenerOptions extends ListenerOptions {
+  server?: Server
+}
+
+export function createListener (upgrader: Upgrader, options?: WebSocketListenerOptions): Listener {
+  options = options ?? {}
+
+  return new WebSocketListener(upgrader, options)
+}

package/src/socket-to-conn.ts

@@ -0,0 +1,69 @@
+import { abortableSource } from 'abortable-iterator'
+import { CLOSE_TIMEOUT } from './constants.js'
+import pTimeout from 'p-timeout'
+import { logger } from '@libp2p/logger'
+import type { AbortOptions } from '@libp2p/interfaces'
+import type { MultiaddrConnection } from '@libp2p/interfaces/transport'
+import type { Multiaddr } from '@multiformats/multiaddr'
+import type { DuplexWebSocket } from 'it-ws/duplex'
+
+const log = logger('libp2p:websockets:socket')
+
+export interface SocketToConnOptions extends AbortOptions {
+  localAddr?: Multiaddr
+}
+
+// Convert a stream into a MultiaddrConnection
+// https://github.com/libp2p/interface-transport#multiaddrconnection
+export function socketToMaConn (stream: DuplexWebSocket, remoteAddr: Multiaddr, options?: SocketToConnOptions): MultiaddrConnection {
+  options = options ?? {}
+
+  const maConn: MultiaddrConnection = {
+    async sink (source) {
+      if ((options?.signal) != null) {
+        source = abortableSource(source, options.signal)
+      }
+
+      try {
+        await stream.sink(source)
+      } catch (err: any) {
+        if (err.type !== 'aborted') {
+          log.error(err)
+        }
+      }
+    },
+
+    source: (options.signal != null) ? abortableSource(stream.source, options.signal) : stream.source,
+
+    remoteAddr,
+
+    timeline: { open: Date.now() },
+
+    async close () {
+      const start = Date.now()
+
+      try {
+        await pTimeout(stream.close(), CLOSE_TIMEOUT)
+      } catch (err) {
+        const { host, port } = maConn.remoteAddr.toOptions()
+        log('timeout closing stream to %s:%s after %dms, destroying it manually',
+          host, port, Date.now() - start)
+
+        stream.destroy()
+      } finally {
+        maConn.timeline.close = Date.now()
+      }
+    }
+  }
+
+  stream.socket.once != null && stream.socket.once('close', () => { // eslint-disable-line @typescript-eslint/prefer-optional-chain
+    // In instances where `close` was not explicitly called,
+    // such as an iterable stream ending, ensure we have set the close
+    // timeline
+    if (maConn.timeline.close == null) {
+      maConn.timeline.close = Date.now()
+    }
+  })
+
+  return maConn
+}