@libp2p/tcp 9.1.5 → 9.1.6

package/dist/src/tcp.d.ts

@@ -0,0 +1,61 @@
+/**
+ * @packageDocumentation
+ *
+ * A [libp2p transport](https://docs.libp2p.io/concepts/transports/overview/) based on the TCP networking stack.
+ *
+ * @example
+ *
+ * ```TypeScript
+ * import { createLibp2p } from 'libp2p'
+ * import { tcp } from '@libp2p/tcp'
+ * import { multiaddr } from '@multiformats/multiaddr'
+ *
+ * const node = await createLibp2p({
+ *   transports: [
+ *     tcp()
+ *   ]
+ * })
+ *
+ * const ma = multiaddr('/ip4/123.123.123.123/tcp/1234')
+ *
+ * // dial a TCP connection, timing out after 10 seconds
+ * const connection = await node.dial(ma, {
+ *   signal: AbortSignal.timeout(10_000)
+ * })
+ *
+ * // use connection...
+ * ```
+ */
+/// <reference types="node" />
+import { serviceCapabilities, transportSymbol } from '@libp2p/interface';
+import type { TCPComponents, TCPCreateListenerOptions, TCPDialEvents, TCPDialOptions, TCPOptions } from './index.js';
+import type { Connection, Transport, Listener } from '@libp2p/interface';
+import type { Multiaddr } from '@multiformats/multiaddr';
+import type { Socket } from 'net';
+export declare class TCP implements Transport<TCPDialEvents> {
+    private readonly opts;
+    private readonly metrics?;
+    private readonly components;
+    private readonly log;
+    constructor(components: TCPComponents, options?: TCPOptions);
+    readonly [transportSymbol] = true;
+    readonly [Symbol.toStringTag] = "@libp2p/tcp";
+    readonly [serviceCapabilities]: string[];
+    dial(ma: Multiaddr, options: TCPDialOptions): Promise<Connection>;
+    _connect(ma: Multiaddr, options: TCPDialOptions): Promise<Socket>;
+    /**
+     * Creates a TCP listener. The provided `handler` function will be called
+     * anytime a new incoming Connection has been successfully upgraded via
+     * `upgrader.upgradeInbound`.
+     */
+    createListener(options: TCPCreateListenerOptions): Listener;
+    /**
+     * Takes a list of `Multiaddr`s and returns only valid TCP addresses
+     */
+    listenFilter(multiaddrs: Multiaddr[]): Multiaddr[];
+    /**
+     * Filter check for all Multiaddrs that this transport can dial
+     */
+    dialFilter(multiaddrs: Multiaddr[]): Multiaddr[];
+}
+//# sourceMappingURL=tcp.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tcp.d.ts","sourceRoot":"","sources":["../../src/tcp.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;;AAGH,OAAO,EAAyB,mBAAmB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAO/F,OAAO,KAAK,EAAE,aAAa,EAAE,wBAAwB,EAAE,aAAa,EAAE,cAAc,EAAc,UAAU,EAAE,MAAM,YAAY,CAAA;AAChI,OAAO,KAAK,EAAU,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAChF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,MAAM,EAA8C,MAAM,KAAK,CAAA;AAE7E,qBAAa,GAAI,YAAW,SAAS,CAAC,aAAa,CAAC;IAClD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAY;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAY;IACrC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAe;IAC1C,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;gBAEf,UAAU,EAAE,aAAa,EAAE,OAAO,GAAE,UAAe;IAehE,QAAQ,CAAC,CAAC,eAAe,CAAC,QAAO;IAEjC,QAAQ,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,iBAAgB;IAE7C,QAAQ,CAAC,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAEvC;IAEK,IAAI,CAAE,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC;IA4ClE,QAAQ,CAAE,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAsExE;;;;OAIG;IACH,cAAc,CAAE,OAAO,EAAE,wBAAwB,GAAG,QAAQ;IAc5D;;OAEG;IACH,YAAY,CAAE,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS,EAAE;IAgBnD;;OAEG;IACH,UAAU,CAAE,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS,EAAE;CAGlD"}

package/dist/src/tcp.js

@@ -0,0 +1,190 @@
+/**
+ * @packageDocumentation
+ *
+ * A [libp2p transport](https://docs.libp2p.io/concepts/transports/overview/) based on the TCP networking stack.
+ *
+ * @example
+ *
+ * ```TypeScript
+ * import { createLibp2p } from 'libp2p'
+ * import { tcp } from '@libp2p/tcp'
+ * import { multiaddr } from '@multiformats/multiaddr'
+ *
+ * const node = await createLibp2p({
+ *   transports: [
+ *     tcp()
+ *   ]
+ * })
+ *
+ * const ma = multiaddr('/ip4/123.123.123.123/tcp/1234')
+ *
+ * // dial a TCP connection, timing out after 10 seconds
+ * const connection = await node.dial(ma, {
+ *   signal: AbortSignal.timeout(10_000)
+ * })
+ *
+ * // use connection...
+ * ```
+ */
+import net from 'net';
+import { AbortError, CodeError, serviceCapabilities, transportSymbol } from '@libp2p/interface';
+import * as mafmt from '@multiformats/mafmt';
+import { CustomProgressEvent } from 'progress-events';
+import { CODE_CIRCUIT, CODE_P2P, CODE_UNIX } from './constants.js';
+import { TCPListener } from './listener.js';
+import { toMultiaddrConnection } from './socket-to-conn.js';
+import { multiaddrToNetConfig } from './utils.js';
+export class TCP {
+    opts;
+    metrics;
+    components;
+    log;
+    constructor(components, options = {}) {
+        this.log = components.logger.forComponent('libp2p:tcp');
+        this.opts = options;
+        this.components = components;
+        if (components.metrics != null) {
+            this.metrics = {
+                dialerEvents: components.metrics.registerCounterGroup('libp2p_tcp_dialer_events_total', {
+                    label: 'event',
+                    help: 'Total count of TCP dialer events by type'
+                })
+            };
+        }
+    }
+    [transportSymbol] = true;
+    [Symbol.toStringTag] = '@libp2p/tcp';
+    [serviceCapabilities] = [
+        '@libp2p/transport'
+    ];
+    async dial(ma, options) {
+        options.keepAlive = options.keepAlive ?? true;
+        options.noDelay = options.noDelay ?? true;
+        // options.signal destroys the socket before 'connect' event
+        const socket = await this._connect(ma, options);
+        // Avoid uncaught errors caused by unstable connections
+        socket.on('error', err => {
+            this.log('socket error', err);
+        });
+        const maConn = toMultiaddrConnection(socket, {
+            remoteAddr: ma,
+            socketInactivityTimeout: this.opts.outboundSocketInactivityTimeout,
+            socketCloseTimeout: this.opts.socketCloseTimeout,
+            metrics: this.metrics?.dialerEvents,
+            logger: this.components.logger
+        });
+        const onAbort = () => {
+            maConn.close().catch(err => {
+                this.log.error('Error closing maConn after abort', err);
+            });
+        };
+        options.signal?.addEventListener('abort', onAbort, { once: true });
+        this.log('new outbound connection %s', maConn.remoteAddr);
+        const conn = await options.upgrader.upgradeOutbound(maConn);
+        this.log('outbound connection %s upgraded', maConn.remoteAddr);
+        options.signal?.removeEventListener('abort', onAbort);
+        if (options.signal?.aborted === true) {
+            conn.close().catch(err => {
+                this.log.error('Error closing conn after abort', err);
+            });
+            throw new AbortError();
+        }
+        return conn;
+    }
+    async _connect(ma, options) {
+        options.signal?.throwIfAborted();
+        options.onProgress?.(new CustomProgressEvent('tcp:open-connection'));
+        return new Promise((resolve, reject) => {
+            const start = Date.now();
+            const cOpts = multiaddrToNetConfig(ma, {
+                ...(this.opts.dialOpts ?? {}),
+                ...options
+            });
+            this.log('dialing %a', ma);
+            const rawSocket = net.connect(cOpts);
+            const onError = (err) => {
+                const cOptsStr = cOpts.path ?? `${cOpts.host ?? ''}:${cOpts.port}`;
+                err.message = `connection error ${cOptsStr}: ${err.message}`;
+                this.metrics?.dialerEvents.increment({ error: true });
+                done(err);
+            };
+            const onTimeout = () => {
+                this.log('connection timeout %a', ma);
+                this.metrics?.dialerEvents.increment({ timeout: true });
+                const err = new CodeError(`connection timeout after ${Date.now() - start}ms`, 'ERR_CONNECT_TIMEOUT');
+                // Note: this will result in onError() being called
+                rawSocket.emit('error', err);
+            };
+            const onConnect = () => {
+                this.log('connection opened %a', ma);
+                this.metrics?.dialerEvents.increment({ connect: true });
+                done();
+            };
+            const onAbort = () => {
+                this.log('connection aborted %a', ma);
+                this.metrics?.dialerEvents.increment({ abort: true });
+                rawSocket.destroy();
+                done(new AbortError());
+            };
+            const done = (err) => {
+                rawSocket.removeListener('error', onError);
+                rawSocket.removeListener('timeout', onTimeout);
+                rawSocket.removeListener('connect', onConnect);
+                if (options.signal != null) {
+                    options.signal.removeEventListener('abort', onAbort);
+                }
+                if (err != null) {
+                    reject(err);
+                    return;
+                }
+                resolve(rawSocket);
+            };
+            rawSocket.on('error', onError);
+            rawSocket.on('timeout', onTimeout);
+            rawSocket.on('connect', onConnect);
+            if (options.signal != null) {
+                options.signal.addEventListener('abort', onAbort);
+            }
+        });
+    }
+    /**
+     * Creates a TCP listener. The provided `handler` function will be called
+     * anytime a new incoming Connection has been successfully upgraded via
+     * `upgrader.upgradeInbound`.
+     */
+    createListener(options) {
+        return new TCPListener({
+            ...(this.opts.listenOpts ?? {}),
+            ...options,
+            maxConnections: this.opts.maxConnections,
+            backlog: this.opts.backlog,
+            closeServerOnMaxConnections: this.opts.closeServerOnMaxConnections,
+            socketInactivityTimeout: this.opts.inboundSocketInactivityTimeout,
+            socketCloseTimeout: this.opts.socketCloseTimeout,
+            metrics: this.components.metrics,
+            logger: this.components.logger
+        });
+    }
+    /**
+     * Takes a list of `Multiaddr`s and returns only valid TCP addresses
+     */
+    listenFilter(multiaddrs) {
+        multiaddrs = Array.isArray(multiaddrs) ? multiaddrs : [multiaddrs];
+        return multiaddrs.filter(ma => {
+            if (ma.protoCodes().includes(CODE_CIRCUIT)) {
+                return false;
+            }
+            if (ma.protoCodes().includes(CODE_UNIX)) {
+                return true;
+            }
+            return mafmt.TCP.matches(ma.decapsulateCode(CODE_P2P));
+        });
+    }
+    /**
+     * Filter check for all Multiaddrs that this transport can dial
+     */
+    dialFilter(multiaddrs) {
+        return this.listenFilter(multiaddrs);
+    }
+}
+//# sourceMappingURL=tcp.js.map

package/dist/src/tcp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tcp.js","sourceRoot":"","sources":["../../src/tcp.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,OAAO,GAAG,MAAM,KAAK,CAAA;AACrB,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAC/F,OAAO,KAAK,KAAK,MAAM,qBAAqB,CAAA;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AACrD,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAClE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAMjD,MAAM,OAAO,GAAG;IACG,IAAI,CAAY;IAChB,OAAO,CAAa;IACpB,UAAU,CAAe;IACzB,GAAG,CAAQ;IAE5B,YAAa,UAAyB,EAAE,UAAsB,EAAE;QAC9D,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,CAAA;QACvD,IAAI,CAAC,IAAI,GAAG,OAAO,CAAA;QACnB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAE5B,IAAI,UAAU,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC;YAC/B,IAAI,CAAC,OAAO,GAAG;gBACb,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,oBAAoB,CAAC,gCAAgC,EAAE;oBACtF,KAAK,EAAE,OAAO;oBACd,IAAI,EAAE,0CAA0C;iBACjD,CAAC;aACH,CAAA;QACH,CAAC;IACH,CAAC;IAEQ,CAAC,eAAe,CAAC,GAAG,IAAI,CAAA;IAExB,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,aAAa,CAAA;IAEpC,CAAC,mBAAmB,CAAC,GAAa;QACzC,mBAAmB;KACpB,CAAA;IAED,KAAK,CAAC,IAAI,CAAE,EAAa,EAAE,OAAuB;QAChD,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,IAAI,CAAA;QAC7C,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,IAAI,CAAA;QAEzC,4DAA4D;QAC5D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;QAE/C,uDAAuD;QACvD,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE;YACvB,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,CAAC,CAAA;QAC/B,CAAC,CAAC,CAAA;QAEF,MAAM,MAAM,GAAG,qBAAqB,CAAC,MAAM,EAAE;YAC3C,UAAU,EAAE,EAAE;YACd,uBAAuB,EAAE,IAAI,CAAC,IAAI,CAAC,+BAA+B;YAClE,kBAAkB,EAAE,IAAI,CAAC,IAAI,CAAC,kBAAkB;YAChD,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,YAAY;YACnC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM;SAC/B,CAAC,CAAA;QAEF,MAAM,OAAO,GAAG,GAAS,EAAE;YACzB,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;gBACzB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kCAAkC,EAAE,GAAG,CAAC,CAAA;YACzD,CAAC,CAAC,CAAA;QACJ,CAAC,CAAA;QACD,OAAO,CAAC,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;QAElE,IAAI,CAAC,GAAG,CAAC,4BAA4B,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;QACzD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,CAAA;QAC3D,IAAI,CAAC,GAAG,CAAC,iCAAiC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;QAE9D,OAAO,CAAC,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAErD,IAAI,OAAO,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,EAAE,CAAC;YACrC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;gBACvB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gCAAgC,EAAE,GAAG,CAAC,CAAA;YACvD,CAAC,CAAC,CAAA;YAEF,MAAM,IAAI,UAAU,EAAE,CAAA;QACxB,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,QAAQ,CAAE,EAAa,EAAE,OAAuB;QACpD,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,CAAA;QAChC,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,mBAAmB,CAAC,qBAAqB,CAAC,CAAC,CAAA;QAEpE,OAAO,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC7C,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;YACxB,MAAM,KAAK,GAAG,oBAAoB,CAAC,EAAE,EAAE;gBACrC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC;gBAC7B,GAAG,OAAO;aACX,CAAkD,CAAA;YAEnD,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,CAAC,CAAA;YAC1B,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;YAEpC,MAAM,OAAO,GAAG,CAAC,GAAU,EAAQ,EAAE;gBACnC,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE,IAAI,KAAK,CAAC,IAAI,EAAE,CAAA;gBAClE,GAAG,CAAC,OAAO,GAAG,oBAAoB,QAAQ,KAAK,GAAG,CAAC,OAAO,EAAE,CAAA;gBAC5D,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;gBAErD,IAAI,CAAC,GAAG,CAAC,CAAA;YACX,CAAC,CAAA;YAED,MAAM,SAAS,GAAG,GAAS,EAAE;gBAC3B,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAA;gBACrC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;gBAEvD,MAAM,GAAG,GAAG,IAAI,SAAS,CAAC,4BAA4B,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,EAAE,qBAAqB,CAAC,CAAA;gBACpG,mDAAmD;gBACnD,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;YAC9B,CAAC,CAAA;YAED,MAAM,SAAS,GAAG,GAAS,EAAE;gBAC3B,IAAI,CAAC,GAAG,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAA;gBACpC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;gBACvD,IAAI,EAAE,CAAA;YACR,CAAC,CAAA;YAED,MAAM,OAAO,GAAG,GAAS,EAAE;gBACzB,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAA;gBACrC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;gBACrD,SAAS,CAAC,OAAO,EAAE,CAAA;gBACnB,IAAI,CAAC,IAAI,UAAU,EAAE,CAAC,CAAA;YACxB,CAAC,CAAA;YAED,MAAM,IAAI,GAAG,CAAC,GAAW,EAAQ,EAAE;gBACjC,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;gBAC1C,SAAS,CAAC,cAAc,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;gBAC9C,SAAS,CAAC,cAAc,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;gBAE9C,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;oBAC3B,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;gBACtD,CAAC;gBAED,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;oBAChB,MAAM,CAAC,GAAG,CAAC,CAAC;oBAAC,OAAM;gBACrB,CAAC;gBAED,OAAO,CAAC,SAAS,CAAC,CAAA;YACpB,CAAC,CAAA;YAED,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAC9B,SAAS,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;YAClC,SAAS,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;YAElC,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;gBAC3B,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YACnD,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAE,OAAiC;QAC/C,OAAO,IAAI,WAAW,CAAC;YACrB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC;YAC/B,GAAG,OAAO;YACV,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc;YACxC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO;YAC1B,2BAA2B,EAAE,IAAI,CAAC,IAAI,CAAC,2BAA2B;YAClE,uBAAuB,EAAE,IAAI,CAAC,IAAI,CAAC,8BAA8B;YACjE,kBAAkB,EAAE,IAAI,CAAC,IAAI,CAAC,kBAAkB;YAChD,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,OAAO;YAChC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM;SAC/B,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,YAAY,CAAE,UAAuB;QACnC,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAA;QAElE,OAAO,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;YAC5B,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;gBAC3C,OAAO,KAAK,CAAA;YACd,CAAC;YAED,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;gBACxC,OAAO,IAAI,CAAA;YACb,CAAC;YAED,OAAO,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAA;QACxD,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,UAAU,CAAE,UAAuB;QACjC,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;IACtC,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/tcp",
-  "version": "9.1.5",
+  "version": "9.1.6",
   "description": "A TCP transport for libp2p",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/transport-tcp#readme",
@@ -52,6 +52,10 @@
     "doc-check": "aegir doc-check",
     "build": "aegir build",
     "test": "aegir test -t node -t electron-main",
+    "test:chrome": "aegir test -t browser -f ./dist/test/browser.js --cov",
+    "test:chrome-webworker": "aegir test -t webworker -f ./dist/test/browser.js",
+    "test:firefox": "aegir test -t browser -f ./dist/test/browser.js -- --browser firefox",
+    "test:firefox-webworker": "aegir test -t webworker -f ./dist/test/browser.js -- --browser firefox",
     "test:node": "aegir test -t node --cov",
     "test:electron-main": "aegir test -t electron-main"
   },
@@ -72,7 +76,11 @@
     "it-pipe": "^3.0.1",
     "p-defer": "^4.0.1",
     "sinon": "^18.0.0",
-    "uint8arrays": "^5.1.0"
+    "uint8arrays": "^5.1.0",
+    "wherearewe": "^2.0.1"
+  },
+  "browser": {
+    "./dist/src/tcp.js": "./dist/src/tcp.browser.js"
   },
   "sideEffects": false
 }

package/src/index.ts

@@ -27,17 +27,10 @@
  * ```
  */
 
-import net from 'net'
-import { AbortError, CodeError, serviceCapabilities, transportSymbol } from '@libp2p/interface'
-import * as mafmt from '@multiformats/mafmt'
-import { CustomProgressEvent } from 'progress-events'
-import { CODE_CIRCUIT, CODE_P2P, CODE_UNIX } from './constants.js'
-import { type CloseServerOnMaxConnectionsOpts, TCPListener } from './listener.js'
-import { toMultiaddrConnection } from './socket-to-conn.js'
-import { multiaddrToNetConfig } from './utils.js'
-import type { ComponentLogger, Logger, Connection, CounterGroup, Metrics, CreateListenerOptions, DialTransportOptions, Transport, Listener, OutboundConnectionUpgradeEvents } from '@libp2p/interface'
-import type { AbortOptions, Multiaddr } from '@multiformats/multiaddr'
-import type { Socket, IpcSocketConnectOpts, TcpSocketConnectOpts } from 'net'
+import { TCP } from './tcp.js'
+import type { CloseServerOnMaxConnectionsOpts } from './listener.js'
+import type { ComponentLogger, CounterGroup, Metrics, CreateListenerOptions, DialTransportOptions, Transport, OutboundConnectionUpgradeEvents } from '@libp2p/interface'
+import type { AbortOptions } from '@multiformats/multiaddr'
 import type { ProgressEvent } from 'progress-events'
 
 export interface TCPOptions {
@@ -131,195 +124,6 @@ export interface TCPMetrics {
   dialerEvents: CounterGroup
 }
 
-class TCP implements Transport<TCPDialEvents> {
-  private readonly opts: TCPOptions
-  private readonly metrics?: TCPMetrics
-  private readonly components: TCPComponents
-  private readonly log: Logger
-
-  constructor (components: TCPComponents, options: TCPOptions = {}) {
-    this.log = components.logger.forComponent('libp2p:tcp')
-    this.opts = options
-    this.components = components
-
-    if (components.metrics != null) {
-      this.metrics = {
-        dialerEvents: components.metrics.registerCounterGroup('libp2p_tcp_dialer_events_total', {
-          label: 'event',
-          help: 'Total count of TCP dialer events by type'
-        })
-      }
-    }
-  }
-
-  readonly [transportSymbol] = true
-
-  readonly [Symbol.toStringTag] = '@libp2p/tcp'
-
-  readonly [serviceCapabilities]: string[] = [
-    '@libp2p/transport'
-  ]
-
-  async dial (ma: Multiaddr, options: TCPDialOptions): Promise<Connection> {
-    options.keepAlive = options.keepAlive ?? true
-    options.noDelay = options.noDelay ?? true
-
-    // options.signal destroys the socket before 'connect' event
-    const socket = await this._connect(ma, options)
-
-    // Avoid uncaught errors caused by unstable connections
-    socket.on('error', err => {
-      this.log('socket error', err)
-    })
-
-    const maConn = toMultiaddrConnection(socket, {
-      remoteAddr: ma,
-      socketInactivityTimeout: this.opts.outboundSocketInactivityTimeout,
-      socketCloseTimeout: this.opts.socketCloseTimeout,
-      metrics: this.metrics?.dialerEvents,
-      logger: this.components.logger
-    })
-
-    const onAbort = (): void => {
-      maConn.close().catch(err => {
-        this.log.error('Error closing maConn after abort', err)
-      })
-    }
-    options.signal?.addEventListener('abort', onAbort, { once: true })
-
-    this.log('new outbound connection %s', maConn.remoteAddr)
-    const conn = await options.upgrader.upgradeOutbound(maConn)
-    this.log('outbound connection %s upgraded', maConn.remoteAddr)
-
-    options.signal?.removeEventListener('abort', onAbort)
-
-    if (options.signal?.aborted === true) {
-      conn.close().catch(err => {
-        this.log.error('Error closing conn after abort', err)
-      })
-
-      throw new AbortError()
-    }
-
-    return conn
-  }
-
-  async _connect (ma: Multiaddr, options: TCPDialOptions): Promise<Socket> {
-    options.signal?.throwIfAborted()
-    options.onProgress?.(new CustomProgressEvent('tcp:open-connection'))
-
-    return new Promise<Socket>((resolve, reject) => {
-      const start = Date.now()
-      const cOpts = multiaddrToNetConfig(ma, {
-        ...(this.opts.dialOpts ?? {}),
-        ...options
-      }) as (IpcSocketConnectOpts & TcpSocketConnectOpts)
-
-      this.log('dialing %a', ma)
-      const rawSocket = net.connect(cOpts)
-
-      const onError = (err: Error): void => {
-        const cOptsStr = cOpts.path ?? `${cOpts.host ?? ''}:${cOpts.port}`
-        err.message = `connection error ${cOptsStr}: ${err.message}`
-        this.metrics?.dialerEvents.increment({ error: true })
-
-        done(err)
-      }
-
-      const onTimeout = (): void => {
-        this.log('connection timeout %a', ma)
-        this.metrics?.dialerEvents.increment({ timeout: true })
-
-        const err = new CodeError(`connection timeout after ${Date.now() - start}ms`, 'ERR_CONNECT_TIMEOUT')
-        // Note: this will result in onError() being called
-        rawSocket.emit('error', err)
-      }
-
-      const onConnect = (): void => {
-        this.log('connection opened %a', ma)
-        this.metrics?.dialerEvents.increment({ connect: true })
-        done()
-      }
-
-      const onAbort = (): void => {
-        this.log('connection aborted %a', ma)
-        this.metrics?.dialerEvents.increment({ abort: true })
-        rawSocket.destroy()
-        done(new AbortError())
-      }
-
-      const done = (err?: Error): void => {
-        rawSocket.removeListener('error', onError)
-        rawSocket.removeListener('timeout', onTimeout)
-        rawSocket.removeListener('connect', onConnect)
-
-        if (options.signal != null) {
-          options.signal.removeEventListener('abort', onAbort)
-        }
-
-        if (err != null) {
-          reject(err); return
-        }
-
-        resolve(rawSocket)
-      }
-
-      rawSocket.on('error', onError)
-      rawSocket.on('timeout', onTimeout)
-      rawSocket.on('connect', onConnect)
-
-      if (options.signal != null) {
-        options.signal.addEventListener('abort', onAbort)
-      }
-    })
-  }
-
-  /**
-   * Creates a TCP listener. The provided `handler` function will be called
-   * anytime a new incoming Connection has been successfully upgraded via
-   * `upgrader.upgradeInbound`.
-   */
-  createListener (options: TCPCreateListenerOptions): Listener {
-    return new TCPListener({
-      ...(this.opts.listenOpts ?? {}),
-      ...options,
-      maxConnections: this.opts.maxConnections,
-      backlog: this.opts.backlog,
-      closeServerOnMaxConnections: this.opts.closeServerOnMaxConnections,
-      socketInactivityTimeout: this.opts.inboundSocketInactivityTimeout,
-      socketCloseTimeout: this.opts.socketCloseTimeout,
-      metrics: this.components.metrics,
-      logger: this.components.logger
-    })
-  }
-
-  /**
-   * Takes a list of `Multiaddr`s and returns only valid TCP addresses
-   */
-  listenFilter (multiaddrs: Multiaddr[]): Multiaddr[] {
-    multiaddrs = Array.isArray(multiaddrs) ? multiaddrs : [multiaddrs]
-
-    return multiaddrs.filter(ma => {
-      if (ma.protoCodes().includes(CODE_CIRCUIT)) {
-        return false
-      }
-
-      if (ma.protoCodes().includes(CODE_UNIX)) {
-        return true
-      }
-
-      return mafmt.TCP.matches(ma.decapsulateCode(CODE_P2P))
-    })
-  }
-
-  /**
-   * Filter check for all Multiaddrs that this transport can dial
-   */
-  dialFilter (multiaddrs: Multiaddr[]): Multiaddr[] {
-    return this.listenFilter(multiaddrs)
-  }
-}
-
 export function tcp (init: TCPOptions = {}): (components: TCPComponents) => Transport {
   return (components: TCPComponents) => {
     return new TCP(components, init)

package/src/tcp.browser.ts

@@ -0,0 +1,68 @@
+/**
+ * @packageDocumentation
+ *
+ * A [libp2p transport](https://docs.libp2p.io/concepts/transports/overview/) based on the TCP networking stack.
+ *
+ * @example
+ *
+ * ```TypeScript
+ * import { createLibp2p } from 'libp2p'
+ * import { tcp } from '@libp2p/tcp'
+ * import { multiaddr } from '@multiformats/multiaddr'
+ *
+ * const node = await createLibp2p({
+ *   transports: [
+ *     tcp()
+ *   ]
+ * })
+ *
+ * const ma = multiaddr('/ip4/123.123.123.123/tcp/1234')
+ *
+ * // dial a TCP connection, timing out after 10 seconds
+ * const connection = await node.dial(ma, {
+ *   signal: AbortSignal.timeout(10_000)
+ * })
+ *
+ * // use connection...
+ * ```
+ */
+
+import { serviceCapabilities, transportSymbol } from '@libp2p/interface'
+import type { TCPComponents, TCPDialEvents, TCPMetrics, TCPOptions } from './index.js'
+import type { Logger, Connection, Transport, Listener } from '@libp2p/interface'
+import type { Multiaddr } from '@multiformats/multiaddr'
+
+export class TCP implements Transport<TCPDialEvents> {
+  private readonly opts: TCPOptions
+  private readonly metrics?: TCPMetrics
+  private readonly components: TCPComponents
+  private readonly log: Logger
+
+  constructor () {
+    throw new Error('TCP connections are not possible in browsers')
+  }
+
+  readonly [transportSymbol] = true
+
+  readonly [Symbol.toStringTag] = '@libp2p/tcp'
+
+  readonly [serviceCapabilities]: string[] = [
+    '@libp2p/transport'
+  ]
+
+  async dial (): Promise<Connection> {
+    throw new Error('TCP connections are not possible in browsers')
+  }
+
+  createListener (): Listener {
+    throw new Error('TCP connections are not possible in browsers')
+  }
+
+  listenFilter (): Multiaddr[] {
+    return []
+  }
+
+  dialFilter (): Multiaddr[] {
+    return []
+  }
+}