@libp2p/mplex 11.0.47-6059227cb → 11.0.47-87bc8d4fb

package/dist/src/encode.d.ts

@@ -1,7 +1,8 @@
 import { Uint8ArrayList } from 'uint8arraylist';
 import type { Message } from './message-types.js';
+import type { Source } from 'it-stream-types';
 /**
  * Encode and yield one or more messages
  */
-export declare function encode(message: Message): Uint8ArrayList;
+export declare function encode(source: Source<Message>): AsyncGenerator<Uint8Array | Uint8ArrayList, void, undefined>;
 //# sourceMappingURL=encode.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"encode.d.ts","sourceRoot":"","sources":["../../src/encode.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAG/C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAkDjD;;GAEG;AACH,wBAAgB,MAAM,CAAE,OAAO,EAAE,OAAO,GAAG,cAAc,CAKxD"}
+{"version":3,"file":"encode.d.ts","sourceRoot":"","sources":["../../src/encode.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAG/C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAkD7C;;GAEG;AACH,wBAAwB,MAAM,CAAE,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC,UAAU,GAAG,cAAc,EAAE,IAAI,EAAE,SAAS,CAAC,CAMrH"}

package/dist/src/encode.js

@@ -44,9 +44,11 @@ const encoder = new Encoder();
 /**
  * Encode and yield one or more messages
  */
-export function encode(message) {
-    const list = new Uint8ArrayList();
-    encoder.write(message, list);
-    return list;
+export async function* encode(source) {
+    for await (const message of source) {
+        const list = new Uint8ArrayList();
+        encoder.write(message, list);
+        yield list;
+    }
 }
 //# sourceMappingURL=encode.js.map

package/dist/src/encode.js.map

@@ -1 +1 @@
-{"version":3,"file":"encode.js","sourceRoot":"","sources":["../../src/encode.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAGjD,MAAM,SAAS,GAAG,EAAE,GAAG,IAAI,CAAA;AAE3B,MAAM,OAAO;IACH,KAAK,CAAY;IACjB,WAAW,CAAQ;IAE3B;QACE,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,CAAA;QACnC,IAAI,CAAC,WAAW,GAAG,CAAC,CAAA;IACtB,CAAC;IAED;;OAEG;IACH,KAAK,CAAE,GAAY,EAAE,IAAoB;QACvC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAA;QACvB,IAAI,MAAM,GAAG,IAAI,CAAC,WAAW,CAAA;QAE7B,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;QACnD,MAAM,IAAI,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,CAAA;QAEvD,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,UAAU,IAAI,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,iBAAiB,IAAI,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,gBAAgB,CAAC,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;YAC5J,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;YAC5C,MAAM,IAAI,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAClD,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;YAC9B,MAAM,IAAI,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAA;QACpC,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;QAEtD,IAAI,SAAS,GAAG,MAAM,GAAG,GAAG,EAAE,CAAC;YAC7B,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,CAAA;YACnC,IAAI,CAAC,WAAW,GAAG,CAAC,CAAA;QACtB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,WAAW,GAAG,MAAM,CAAA;QAC3B,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAEnB,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,UAAU,IAAI,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,iBAAiB,IAAI,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,gBAAgB,CAAC,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;YAC5J,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACvB,CAAC;IACH,CAAC;CACF;AAED,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAA;AAE7B;;GAEG;AACH,MAAM,UAAU,MAAM,CAAE,OAAgB;IACtC,MAAM,IAAI,GAAG,IAAI,cAAc,EAAE,CAAA;IACjC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;IAE5B,OAAO,IAAI,CAAA;AACb,CAAC"}
+{"version":3,"file":"encode.js","sourceRoot":"","sources":["../../src/encode.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAIjD,MAAM,SAAS,GAAG,EAAE,GAAG,IAAI,CAAA;AAE3B,MAAM,OAAO;IACH,KAAK,CAAY;IACjB,WAAW,CAAQ;IAE3B;QACE,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,CAAA;QACnC,IAAI,CAAC,WAAW,GAAG,CAAC,CAAA;IACtB,CAAC;IAED;;OAEG;IACH,KAAK,CAAE,GAAY,EAAE,IAAoB;QACvC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAA;QACvB,IAAI,MAAM,GAAG,IAAI,CAAC,WAAW,CAAA;QAE7B,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;QACnD,MAAM,IAAI,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,CAAA;QAEvD,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,UAAU,IAAI,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,iBAAiB,IAAI,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,gBAAgB,CAAC,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;YAC5J,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;YAC5C,MAAM,IAAI,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAClD,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;YAC9B,MAAM,IAAI,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAA;QACpC,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;QAEtD,IAAI,SAAS,GAAG,MAAM,GAAG,GAAG,EAAE,CAAC;YAC7B,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,CAAA;YACnC,IAAI,CAAC,WAAW,GAAG,CAAC,CAAA;QACtB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,WAAW,GAAG,MAAM,CAAA;QAC3B,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAEnB,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,UAAU,IAAI,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,iBAAiB,IAAI,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC,gBAAgB,CAAC,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;YAC5J,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACvB,CAAC;IACH,CAAC;CACF;AAED,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAA;AAE7B;;GAEG;AACH,MAAM,CAAC,KAAK,SAAU,CAAC,CAAC,MAAM,CAAE,MAAuB;IACrD,IAAI,KAAK,EAAE,MAAM,OAAO,IAAI,MAAM,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,IAAI,cAAc,EAAE,CAAA;QACjC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;QAC5B,MAAM,IAAI,CAAA;IACZ,CAAC;AACH,CAAC"}

package/dist/src/index.d.ts

@@ -3,7 +3,7 @@
  *
  * This is a [simple stream multiplexer(https://docs.libp2p.io/concepts/multiplex/mplex/) that has been deprecated.
  *
- * Please use [@libp2p/yamux](https://www.npmjs.com/package/@libp2p/yamux) instead.
+ * Please use [@chainsafe/libp2p-yamux](https://www.npmjs.com/package/@chainsafe/libp2p-yamux) instead.
  *
  * @example
  *
@@ -30,7 +30,9 @@
  * pipe([1, 2, 3], stream)
  * ```
  */
+import type { MplexComponents } from './mplex.js';
 import type { StreamMuxerFactory } from '@libp2p/interface';
+export type { MplexComponents };
 export interface MplexInit {
     /**
      * The maximum size of message that can be sent in one go in bytes.
@@ -38,18 +40,42 @@ export interface MplexInit {
      * messages. If we receive a message larger than this an error will
      * be thrown and the connection closed.
      *
-     * @default 1_048_576
+     * @default 1048576
      */
-    maxMessageSize?: number;
+    maxMsgSize?: number;
     /**
      * Constrains the size of the unprocessed message queue buffer.
      * Before messages are deserialized, the raw bytes are buffered to ensure
      * we have the complete message to deserialized. If the queue gets longer
      * than this value an error will be thrown and the connection closed.
      *
-     * @default 4_194_304
+     * @default 4194304
      */
     maxUnprocessedMessageQueueSize?: number;
+    /**
+     * The maximum number of multiplexed streams that can be open at any
+     * one time. A request to open more than this will have a stream
+     * reset message sent immediately as a response for the newly opened
+     * stream id
+     *
+     * @default 1024
+     */
+    maxInboundStreams?: number;
+    /**
+     * The maximum number of multiplexed streams that can be open at any
+     * one time. An attempt to open more than this will throw
+     *
+     * @default 1024
+     */
+    maxOutboundStreams?: number;
+    /**
+     * Incoming stream messages are buffered until processed by the stream
+     * handler. If the buffer reaches this size in bytes the stream will
+     * be reset
+     *
+     * @default 4194304
+     */
+    maxStreamBufferSize?: number;
     /**
      * When `maxInboundStreams` is hit, if the remote continues try to open
      * more than this many new multiplexed streams per second the connection
@@ -62,5 +88,5 @@ export interface MplexInit {
 /**
  * @deprecated mplex is deprecated as it has no flow control. Please use yamux instead.
  */
-export declare function mplex(init?: MplexInit): () => StreamMuxerFactory;
+export declare function mplex(init?: MplexInit): (components: MplexComponents) => StreamMuxerFactory;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAIH,OAAO,KAAK,EAAoC,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAE7F,MAAM,WAAW,SAAS;IACxB;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;;;;;;OAOG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAA;IAEvC;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B;AAuBD;;GAEG;AACH,wBAAgB,KAAK,CAAE,IAAI,GAAE,SAAc,GAAG,MAAM,kBAAkB,CAErE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAIH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AACjD,OAAO,KAAK,EAAe,kBAAkB,EAAmB,MAAM,mBAAmB,CAAA;AAEzF,YAAY,EAAE,eAAe,EAAE,CAAA;AAE/B,MAAM,WAAW,SAAS;IACxB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;;;;;OAOG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAA;IAEvC;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAE3B;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B;AA0BD;;GAEG;AACH,wBAAgB,KAAK,CAAE,IAAI,GAAE,SAAc,GAAG,CAAC,UAAU,EAAE,eAAe,KAAK,kBAAkB,CAEhG"}

package/dist/src/index.js

@@ -3,7 +3,7 @@
  *
  * This is a [simple stream multiplexer(https://docs.libp2p.io/concepts/multiplex/mplex/) that has been deprecated.
  *
- * Please use [@libp2p/yamux](https://www.npmjs.com/package/@libp2p/yamux) instead.
+ * Please use [@chainsafe/libp2p-yamux](https://www.npmjs.com/package/@chainsafe/libp2p-yamux) instead.
  *
  * @example
  *
@@ -35,15 +35,18 @@ import { MplexStreamMuxer } from './mplex.js';
 class Mplex {
     protocol = '/mplex/6.7.0';
     _init;
-    constructor(init = {}) {
+    components;
+    constructor(components, init = {}) {
+        this.components = components;
         this._init = init;
     }
     [Symbol.toStringTag] = '@libp2p/mplex';
     [serviceCapabilities] = [
         '@libp2p/stream-multiplexing'
     ];
-    createStreamMuxer(maConn) {
-        return new MplexStreamMuxer(maConn, {
+    createStreamMuxer(init) {
+        return new MplexStreamMuxer(this.components, {
+            ...init,
             ...this._init
         });
     }
@@ -52,6 +55,6 @@ class Mplex {
  * @deprecated mplex is deprecated as it has no flow control. Please use yamux instead.
  */
 export function mplex(init = {}) {
-    return () => new Mplex(init);
+    return (components) => new Mplex(components, init);
 }
 //# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAkC7C,MAAM,KAAK;IACF,QAAQ,GAAG,cAAc,CAAA;IACf,KAAK,CAAW;IAEjC,YAAa,OAAkB,EAAE;QAC/B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;IACnB,CAAC;IAEQ,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,eAAe,CAAA;IAEtC,CAAC,mBAAmB,CAAC,GAAa;QACzC,6BAA6B;KAC9B,CAAA;IAED,iBAAiB,CAAE,MAA2B;QAC5C,OAAO,IAAI,gBAAgB,CAAC,MAAM,EAAE;YAClC,GAAG,IAAI,CAAC,KAAK;SACd,CAAC,CAAA;IACJ,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,KAAK,CAAE,OAAkB,EAAE;IACzC,OAAO,GAAG,EAAE,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAA;AAC9B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAgE7C,MAAM,KAAK;IACF,QAAQ,GAAG,cAAc,CAAA;IACf,KAAK,CAAW;IAChB,UAAU,CAAiB;IAE5C,YAAa,UAA2B,EAAE,OAAkB,EAAE;QAC5D,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;IACnB,CAAC;IAEQ,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,eAAe,CAAA;IAEtC,CAAC,mBAAmB,CAAC,GAAa;QACzC,6BAA6B;KAC9B,CAAA;IAED,iBAAiB,CAAE,IAAqB;QACtC,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE;YAC3C,GAAG,IAAI;YACP,GAAG,IAAI,CAAC,KAAK;SACd,CAAC,CAAA;IACJ,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,KAAK,CAAE,OAAkB,EAAE;IACzC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;AACpD,CAAC"}

package/dist/src/mplex.d.ts

@@ -1,23 +1,65 @@
-import { AbstractStreamMuxer } from '@libp2p/utils';
 import type { MplexInit } from './index.js';
 import type { Message } from './message-types.js';
 import type { MplexStream } from './stream.js';
-import type { CreateStreamOptions, MultiaddrConnection, MessageStreamDirection } from '@libp2p/interface';
+import type { AbortOptions, ComponentLogger, Stream, StreamMuxer, StreamMuxerInit } from '@libp2p/interface';
+import type { Sink, Source } from 'it-stream-types';
 import type { Uint8ArrayList } from 'uint8arraylist';
-export declare class MplexStreamMuxer extends AbstractStreamMuxer<MplexStream> {
+export interface MplexComponents {
+    logger: ComponentLogger;
+}
+interface MplexStreamMuxerInit extends MplexInit, StreamMuxerInit {
+    /**
+     * The default timeout to use in ms when shutting down the muxer.
+     */
+    closeTimeout?: number;
+}
+export declare class MplexStreamMuxer implements StreamMuxer {
+    protocol: string;
+    sink: Sink<Source<Uint8ArrayList | Uint8Array>, Promise<void>>;
+    source: AsyncGenerator<Uint8ArrayList | Uint8Array>;
+    private readonly log;
     private _streamId;
+    private readonly _streams;
+    private readonly _init;
+    private readonly _source;
+    private readonly closeController;
     private readonly rateLimiter;
-    private readonly maxMessageSize;
-    private readonly maxUnprocessedMessageQueueSize;
-    private readonly decoder;
-    constructor(maConn: MultiaddrConnection, init: MplexInit);
-    onData(data: Uint8Array | Uint8ArrayList): void;
+    private readonly closeTimeout;
+    private readonly logger;
+    constructor(components: MplexComponents, init?: MplexStreamMuxerInit);
+    /**
+     * Returns a Map of streams and their ids
+     */
+    get streams(): Stream[];
     /**
      * Initiate a new stream with the given name. If no name is
      * provided, the id of the stream will be used.
      */
-    onCreateStream(options: CreateStreamOptions): MplexStream;
-    _newStream(id: number, direction: MessageStreamDirection, options?: CreateStreamOptions): MplexStream;
-    handleMessage(message: Message): void;
+    newStream(name?: string): Stream;
+    /**
+     * Close or abort all tracked streams and stop the muxer
+     */
+    close(options?: AbortOptions): Promise<void>;
+    abort(err: Error): void;
+    /**
+     * Called whenever an inbound stream is created
+     */
+    _newReceiverStream(options: {
+        id: number;
+        name: string;
+    }): MplexStream;
+    _newStream(options: {
+        id: number;
+        name: string;
+        type: 'initiator' | 'receiver';
+        registry: Map<number, MplexStream>;
+    }): MplexStream;
+    /**
+     * Creates a sink with an abortable source. Incoming messages will
+     * also have their size restricted. All messages will be varint decoded.
+     */
+    _createSink(): Sink<Source<Uint8ArrayList | Uint8Array>, Promise<void>>;
+    _handleIncoming(message: Message): Promise<void>;
 }
+export {};
 //# sourceMappingURL=mplex.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"mplex.d.ts","sourceRoot":"","sources":["../../src/mplex.ts"],"names":[],"mappings":"AACA,OAAO,EAAe,mBAAmB,EAAE,MAAM,eAAe,CAAA;AAKhE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAC3C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAC9C,OAAO,KAAK,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AACzG,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAqBpD,qBAAa,gBAAiB,SAAQ,mBAAmB,CAAC,WAAW,CAAC;IACpE,OAAO,CAAC,SAAS,CAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAa;IACzC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAQ;IACvC,OAAO,CAAC,QAAQ,CAAC,8BAA8B,CAAQ;IACvD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBAEpB,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,SAAS;IAkBzD,MAAM,CAAE,IAAI,EAAE,UAAU,GAAG,cAAc,GAAG,IAAI;IAMhD;;;OAGG;IACH,cAAc,CAAE,OAAO,EAAE,mBAAmB,GAAG,WAAW;IAU1D,UAAU,CAAE,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,WAAW;IAetG,aAAa,CAAE,OAAO,EAAE,OAAO,GAAG,IAAI;CAqEvC"}
+{"version":3,"file":"mplex.d.ts","sourceRoot":"","sources":["../../src/mplex.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAC3C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAU,MAAM,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEpH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAyBpD,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,eAAe,CAAA;CACxB;AAED,UAAU,oBAAqB,SAAQ,SAAS,EAAE,eAAe;IAC/D;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,qBAAa,gBAAiB,YAAW,WAAW;IAC3C,QAAQ,SAAiB;IAEzB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,UAAU,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;IAC9D,MAAM,EAAE,cAAc,CAAC,cAAc,GAAG,UAAU,CAAC,CAAA;IAE1D,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;IAC5B,OAAO,CAAC,SAAS,CAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA+E;IACxG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAsB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmB;IAC3C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAa;IACzC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAQ;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;gBAE3B,UAAU,EAAE,eAAe,EAAE,IAAI,CAAC,EAAE,oBAAoB;IAyDrE;;OAEG;IACH,IAAI,OAAO,IAAK,MAAM,EAAE,CAWvB;IAED;;;OAGG;IACH,SAAS,CAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM;IAUjC;;OAEG;IACG,KAAK,CAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IA4BnD,KAAK,CAAE,GAAG,EAAE,KAAK,GAAG,IAAI;IASxB;;OAEG;IACH,kBAAkB,CAAE,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,WAAW;IAMvE,UAAU,CAAE,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,WAAW,GAAG,UAAU,CAAC;QAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;KAAE,GAAG,WAAW;IAmCnI;;;OAGG;IACH,WAAW,IAAK,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,UAAU,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IA6BlE,eAAe,CAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAsGxD"}

package/dist/src/mplex.js

@@ -1,101 +1,257 @@
-import { MuxerClosedError } from '@libp2p/interface';
-import { RateLimiter, AbstractStreamMuxer } from '@libp2p/utils';
+import { TooManyOutboundProtocolStreamsError, MuxerClosedError } from '@libp2p/interface';
+import { closeSource } from '@libp2p/utils/close-source';
+import { RateLimiter } from '@libp2p/utils/rate-limiter';
+import { pipe } from 'it-pipe';
+import { pushable } from 'it-pushable';
 import { toString as uint8ArrayToString } from 'uint8arrays';
-import { Decoder, MAX_MSG_QUEUE_SIZE, MAX_MSG_SIZE } from './decode.js';
+import { Decoder } from './decode.js';
+import { encode } from './encode.js';
+import { StreamInputBufferError } from './errors.js';
 import { MessageTypes, MessageTypeNames } from './message-types.js';
 import { createStream } from './stream.js';
+const MAX_STREAMS_INBOUND_STREAMS_PER_CONNECTION = 1024;
+const MAX_STREAMS_OUTBOUND_STREAMS_PER_CONNECTION = 1024;
+const MAX_STREAM_BUFFER_SIZE = 1024 * 1024 * 4; // 4MB
 const DISCONNECT_THRESHOLD = 5;
+const CLOSE_TIMEOUT = 500;
 function printMessage(msg) {
     const output = {
         ...msg,
         type: `${MessageTypeNames[msg.type]} (${msg.type})`
     };
     if (msg.type === MessageTypes.NEW_STREAM) {
-        output.data = uint8ArrayToString(msg.data.subarray());
+        output.data = uint8ArrayToString(msg.data instanceof Uint8Array ? msg.data : msg.data.subarray());
     }
     if (msg.type === MessageTypes.MESSAGE_INITIATOR || msg.type === MessageTypes.MESSAGE_RECEIVER) {
-        output.data = uint8ArrayToString(msg.data.subarray(), 'base16');
+        output.data = uint8ArrayToString(msg.data instanceof Uint8Array ? msg.data : msg.data.subarray(), 'base16');
     }
     return output;
 }
-export class MplexStreamMuxer extends AbstractStreamMuxer {
+export class MplexStreamMuxer {
+    protocol = '/mplex/6.7.0';
+    sink;
+    source;
+    log;
     _streamId;
+    _streams;
+    _init;
+    _source;
+    closeController;
     rateLimiter;
-    maxMessageSize;
-    maxUnprocessedMessageQueueSize;
-    decoder;
-    constructor(maConn, init) {
-        super(maConn, {
-            ...init,
-            protocol: '/mplex/6.7.0',
-            name: 'mplex'
-        });
+    closeTimeout;
+    logger;
+    constructor(components, init) {
+        init = init ?? {};
+        this.log = init.log?.newScope('mplex') ?? components.logger.forComponent('libp2p:mplex');
+        this.logger = components.logger;
         this._streamId = 0;
-        this.maxMessageSize = init.maxMessageSize ?? MAX_MSG_SIZE;
-        this.maxUnprocessedMessageQueueSize = init.maxUnprocessedMessageQueueSize ?? MAX_MSG_QUEUE_SIZE;
-        this.decoder = new Decoder(this.maxMessageSize, this.maxUnprocessedMessageQueueSize);
+        this._streams = {
+            /**
+             * Stream to ids map
+             */
+            initiators: new Map(),
+            /**
+             * Stream to ids map
+             */
+            receivers: new Map()
+        };
+        this._init = init;
+        this.closeTimeout = init.closeTimeout ?? CLOSE_TIMEOUT;
+        /**
+         * An iterable sink
+         */
+        this.sink = this._createSink();
+        /**
+         * An iterable source
+         */
+        this._source = pushable({
+            objectMode: true,
+            onEnd: () => {
+                // the source has ended, we can't write any more messages to gracefully
+                // close streams so all we can do is destroy them
+                for (const stream of this._streams.initiators.values()) {
+                    stream.destroy();
+                }
+                for (const stream of this._streams.receivers.values()) {
+                    stream.destroy();
+                }
+            }
+        });
+        this.source = pipe(this._source, source => encode(source));
+        /**
+         * Close controller
+         */
+        this.closeController = new AbortController();
         this.rateLimiter = new RateLimiter({
             points: init.disconnectThreshold ?? DISCONNECT_THRESHOLD,
             duration: 1
         });
     }
-    onData(data) {
-        for (const msg of this.decoder.write(data)) {
-            this.handleMessage(msg);
+    /**
+     * Returns a Map of streams and their ids
+     */
+    get streams() {
+        // Inbound and Outbound streams may have the same ids, so we need to make those unique
+        const streams = [];
+        for (const stream of this._streams.initiators.values()) {
+            streams.push(stream);
         }
+        for (const stream of this._streams.receivers.values()) {
+            streams.push(stream);
+        }
+        return streams;
     }
     /**
      * Initiate a new stream with the given name. If no name is
      * provided, the id of the stream will be used.
      */
-    onCreateStream(options) {
-        if (this.status !== 'open') {
+    newStream(name) {
+        if (this.closeController.signal.aborted) {
             throw new MuxerClosedError('Muxer already closed');
         }
         const id = this._streamId++;
-        return this._newStream(id, 'outbound', options);
+        name = name == null ? id.toString() : name.toString();
+        const registry = this._streams.initiators;
+        return this._newStream({ id, name, type: 'initiator', registry });
     }
-    _newStream(id, direction, options) {
-        this.log('new %s stream %s', direction, id);
-        const stream = createStream({
-            ...options,
-            id,
-            direction,
-            maxMsgSize: this.maxMessageSize,
-            log: this.log,
-            muxer: this
-        });
+    /**
+     * Close or abort all tracked streams and stop the muxer
+     */
+    async close(options) {
+        if (this.closeController.signal.aborted) {
+            return;
+        }
+        const signal = options?.signal ?? AbortSignal.timeout(this.closeTimeout);
+        try {
+            // try to gracefully close all streams
+            await Promise.all(this.streams.map(async (s) => s.close({
+                signal
+            })));
+            this._source.end();
+            // try to gracefully close the muxer
+            await this._source.onEmpty({
+                signal
+            });
+            this.closeController.abort();
+        }
+        catch (err) {
+            this.abort(err);
+        }
+    }
+    abort(err) {
+        if (this.closeController.signal.aborted) {
+            return;
+        }
+        this.streams.forEach(s => { s.abort(err); });
+        this.closeController.abort(err);
+    }
+    /**
+     * Called whenever an inbound stream is created
+     */
+    _newReceiverStream(options) {
+        const { id, name } = options;
+        const registry = this._streams.receivers;
+        return this._newStream({ id, name, type: 'receiver', registry });
+    }
+    _newStream(options) {
+        const { id, name, type, registry } = options;
+        this.log('new %s stream %s', type, id);
+        if (type === 'initiator' && this._streams.initiators.size === (this._init.maxOutboundStreams ?? MAX_STREAMS_OUTBOUND_STREAMS_PER_CONNECTION)) {
+            throw new TooManyOutboundProtocolStreamsError('Too many outbound streams open');
+        }
+        if (registry.has(id)) {
+            throw new Error(`${type} stream ${id} already exists!`);
+        }
+        const send = async (msg) => {
+            if (this.log.enabled) {
+                this.log.trace('%s stream %s send', type, id, printMessage(msg));
+            }
+            this._source.push(msg);
+        };
+        const onEnd = () => {
+            this.log('%s stream with id %s and protocol %s ended', type, id, stream.protocol);
+            registry.delete(id);
+            if (this._init.onStreamEnd != null) {
+                this._init.onStreamEnd(stream);
+            }
+        };
+        const stream = createStream({ id, name, send, type, onEnd, maxMsgSize: this._init.maxMsgSize, log: this.log });
+        registry.set(id, stream);
         return stream;
     }
-    handleMessage(message) {
+    /**
+     * Creates a sink with an abortable source. Incoming messages will
+     * also have their size restricted. All messages will be varint decoded.
+     */
+    _createSink() {
+        const sink = async (source) => {
+            const abortListener = () => {
+                closeSource(source, this.log);
+            };
+            this.closeController.signal.addEventListener('abort', abortListener);
+            try {
+                const decoder = new Decoder(this._init.maxMsgSize, this._init.maxUnprocessedMessageQueueSize);
+                for await (const chunk of source) {
+                    for (const msg of decoder.write(chunk)) {
+                        await this._handleIncoming(msg);
+                    }
+                }
+                this._source.end();
+            }
+            catch (err) {
+                this.log('error in sink', err);
+                this._source.end(err); // End the source with an error
+            }
+            finally {
+                this.closeController.signal.removeEventListener('abort', abortListener);
+            }
+        };
+        return sink;
+    }
+    async _handleIncoming(message) {
+        const { id, type } = message;
         if (this.log.enabled) {
             this.log.trace('incoming message', printMessage(message));
         }
         // Create a new stream?
         if (message.type === MessageTypes.NEW_STREAM) {
-            // close the connection if the remote opens too many streams too quickly
-            try {
-                this.rateLimiter.consume('new-stream', 1);
-            }
-            catch {
-                this.log('rate limit hit when opening too many new streams over the inbound stream limit - closing remote connection');
-                // since there's no backpressure in mplex, the only thing we can really do to protect ourselves is close the connection
-                this.abort(new Error('Too many open streams'));
+            if (this._streams.receivers.size === (this._init.maxInboundStreams ?? MAX_STREAMS_INBOUND_STREAMS_PER_CONNECTION)) {
+                this.log('too many inbound streams open');
+                // not going to allow this stream, send the reset message manually
+                // instead of setting it up just to tear it down
+                this._source.push({
+                    id,
+                    type: MessageTypes.RESET_RECEIVER
+                });
+                // if we've hit our stream limit, and the remote keeps trying to open
+                // more new streams, if they are doing this very quickly maybe they
+                // are attacking us and we should close the connection
+                try {
+                    await this.rateLimiter.consume('new-stream', 1);
+                }
+                catch {
+                    this.log('rate limit hit when opening too many new streams over the inbound stream limit - closing remote connection');
+                    // since there's no backpressure in mplex, the only thing we can really do to protect ourselves is close the connection
+                    this.abort(new Error('Too many open streams'));
+                    return;
+                }
                 return;
             }
-            const stream = this._newStream(message.id, 'inbound', this.streamOptions);
-            this.onRemoteStream(stream);
+            const stream = this._newReceiverStream({ id, name: uint8ArrayToString(message.data instanceof Uint8Array ? message.data : message.data.subarray()) });
+            if (this._init.onIncomingStream != null) {
+                this._init.onIncomingStream(stream);
+            }
             return;
         }
-        const id = `${(message.type & 1) === 1 ? 'i' : 'r'}${message.id}`;
-        const stream = this.streams.find(s => s.id === id);
+        const list = (type & 1) === 1 ? this._streams.initiators : this._streams.receivers;
+        const stream = list.get(id);
         if (stream == null) {
-            this.log('missing stream %s for message type %s', id, MessageTypeNames[message.type]);
+            this.log('missing stream %s for message type %s', id, MessageTypeNames[type]);
             // if the remote keeps sending us messages for streams that have been
             // closed or were never opened they may be attacking us so if they do
             // this very quickly all we can do is close the connection
             try {
-                this.rateLimiter.consume('missing-stream', 1);
+                await this.rateLimiter.consume('missing-stream', 1);
             }
             catch {
                 this.log('rate limit hit when receiving messages for streams that do not exist - closing remote connection');
@@ -105,29 +261,39 @@ export class MplexStreamMuxer extends AbstractStreamMuxer {
             }
             return;
         }
+        const maxBufferSize = this._init.maxStreamBufferSize ?? MAX_STREAM_BUFFER_SIZE;
         try {
-            switch (message.type) {
+            switch (type) {
                 case MessageTypes.MESSAGE_INITIATOR:
                 case MessageTypes.MESSAGE_RECEIVER:
+                    if (stream.sourceReadableLength() > maxBufferSize) {
+                        // Stream buffer has got too large, reset the stream
+                        this._source.push({
+                            id: message.id,
+                            type: type === MessageTypes.MESSAGE_INITIATOR ? MessageTypes.RESET_RECEIVER : MessageTypes.RESET_INITIATOR
+                        });
+                        // Inform the stream consumer they are not fast enough
+                        throw new StreamInputBufferError('Input buffer full - increase Mplex maxBufferSize to accommodate slow consumers');
+                    }
                     // We got data from the remote, push it into our local stream
-                    stream.onData(message.data);
+                    stream.sourcePush(message.data);
                     break;
                 case MessageTypes.CLOSE_INITIATOR:
                 case MessageTypes.CLOSE_RECEIVER:
-                    // The remote has stopped writing
-                    stream.onRemoteCloseWrite();
+                    // The remote has stopped writing, so we can stop reading
+                    stream.remoteCloseWrite();
                     break;
                 case MessageTypes.RESET_INITIATOR:
                 case MessageTypes.RESET_RECEIVER:
                     // The remote has errored, stop reading and writing to the stream immediately
-                    stream.onRemoteReset();
+                    stream.reset();
                     break;
                 default:
-                    this.log('unknown message type');
+                    this.log('unknown message type %s', type);
             }
         }
         catch (err) {
-            this.log.error('error while processing message - %e', err);
+            this.log.error('error while processing message', err);
             stream.abort(err);
         }
     }