@libp2p/utils 6.7.2 → 7.0.0-049bfa0fa

package/dist/src/abstract-stream-muxer.d.ts

@@ -0,0 +1,53 @@
+import { TypedEventEmitter } from '@libp2p/interface';
+import type { AbstractStream } from './abstract-stream.ts';
+import type { AbortOptions, CounterGroup, CreateStreamOptions, EventHandler, Logger, MessageStream, StreamMuxer, StreamMuxerEvents, StreamMuxerOptions, StreamMuxerStatus, StreamOptions } from '@libp2p/interface';
+import type { Uint8ArrayList } from 'uint8arraylist';
+export interface AbstractStreamMuxerInit extends StreamMuxerOptions {
+    /**
+     * The protocol name for the muxer
+     */
+    protocol: string;
+    /**
+     * The name of the muxer, used to create a new logging scope from the passed
+     * connection's logger
+     */
+    name: string;
+    /**
+     * A counter for muxer metrics
+     */
+    metrics?: CounterGroup;
+}
+export declare abstract class AbstractStreamMuxer<MuxedStream extends AbstractStream = AbstractStream> extends TypedEventEmitter<StreamMuxerEvents<MuxedStream>> implements StreamMuxer<MuxedStream> {
+    streams: MuxedStream[];
+    protocol: string;
+    status: StreamMuxerStatus;
+    protected log: Logger;
+    protected maConn: MessageStream;
+    protected streamOptions?: StreamOptions;
+    protected earlyStreams: MuxedStream[];
+    protected maxEarlyStreams: number;
+    private readonly metrics?;
+    constructor(maConn: MessageStream, init: AbstractStreamMuxerInit);
+    send(data: Uint8Array | Uint8ArrayList): boolean;
+    close(options?: AbortOptions): Promise<void>;
+    abort(err: Error): void;
+    onTransportClosed(err?: Error): void;
+    createStream(options?: CreateStreamOptions): Promise<MuxedStream>;
+    /**
+     * Extending classes should invoke this method when a new stream was created
+     * by the remote muxer
+     */
+    onRemoteStream(stream: MuxedStream): void;
+    private cleanUpStream;
+    addEventListener<K extends keyof StreamMuxerEvents<MuxedStream>>(type: K, listener: EventHandler<StreamMuxerEvents<MuxedStream>[K]> | null, options?: boolean | AddEventListenerOptions): void;
+    addEventListener(type: string, listener: EventHandler<Event>, options?: boolean | AddEventListenerOptions): void;
+    /**
+     * A new outgoing stream needs to be created
+     */
+    abstract onCreateStream(options: CreateStreamOptions): MuxedStream | Promise<MuxedStream>;
+    /**
+     * Multiplexed data was received from the remote muxer
+     */
+    abstract onData(data: Uint8Array | Uint8ArrayList): void;
+}
+//# sourceMappingURL=abstract-stream-muxer.d.ts.map

package/dist/src/abstract-stream-muxer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-stream-muxer.d.ts","sourceRoot":"","sources":["../../src/abstract-stream-muxer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAIvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAgD,WAAW,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjQ,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAEpD,MAAM,WAAW,uBAAwB,SAAQ,kBAAkB;IACjE;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,YAAY,CAAA;CACvB;AAED,8BAAsB,mBAAmB,CAAE,WAAW,SAAS,cAAc,GAAG,cAAc,CAAE,SAAQ,iBAAiB,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAE,YAAW,WAAW,CAAC,WAAW,CAAC;IACpL,OAAO,EAAE,WAAW,EAAE,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,iBAAiB,CAAA;IAEhC,SAAS,CAAC,GAAG,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,MAAM,EAAE,aAAa,CAAA;IAC/B,SAAS,CAAC,aAAa,CAAC,EAAE,aAAa,CAAA;IACvC,SAAS,CAAC,YAAY,EAAE,WAAW,EAAE,CAAA;IACrC,SAAS,CAAC,eAAe,EAAE,MAAM,CAAA;IAEjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAc;gBAE1B,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,uBAAuB;IAyCjE,IAAI,CAAE,IAAI,EAAE,UAAU,GAAG,cAAc,GAAG,OAAO;IAc3C,KAAK,CAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBnD,KAAK,CAAE,GAAG,EAAE,KAAK,GAAG,IAAI;IAcxB,iBAAiB,CAAE,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI;IAc/B,YAAY,CAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,CAAC;IAoBxE;;;OAGG;IACH,cAAc,CAAE,MAAM,EAAE,WAAW,GAAG,IAAI;IAqB1C,OAAO,CAAC,aAAa;IAuBrB,gBAAgB,CAAC,CAAC,SAAS,MAAM,iBAAiB,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,uBAAuB,GAAG,IAAI;IAC9L,gBAAgB,CAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,uBAAuB,GAAG,IAAI;IAsBjH;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAE,OAAO,EAAE,mBAAmB,GAAG,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAE1F;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAE,IAAI,EAAE,UAAU,GAAG,cAAc,GAAG,IAAI;CAC1D"}

package/dist/src/abstract-stream-muxer.js

@@ -0,0 +1,169 @@
+import { MuxerClosedError, TypedEventEmitter } from '@libp2p/interface';
+import { raceSignal } from 'race-signal';
+import { MaxEarlyStreamsError } from "./errors.js";
+import { isPromise } from "./is-promise.js";
+export class AbstractStreamMuxer extends TypedEventEmitter {
+    streams;
+    protocol;
+    status;
+    log;
+    maConn;
+    streamOptions;
+    earlyStreams;
+    maxEarlyStreams;
+    metrics;
+    constructor(maConn, init) {
+        super();
+        this.maConn = maConn;
+        this.protocol = init.protocol;
+        this.streams = [];
+        this.earlyStreams = [];
+        this.status = 'open';
+        this.log = maConn.log.newScope(init.name);
+        this.streamOptions = init.streamOptions;
+        this.maxEarlyStreams = init.maxEarlyStreams ?? 10;
+        this.metrics = init.metrics;
+        // read/write all data from/to underlying maConn
+        const muxerMaConnOnMessage = (evt) => {
+            try {
+                this.onData(evt.data);
+            }
+            catch (err) {
+                this.abort(err);
+                this.maConn.abort(err);
+            }
+        };
+        this.maConn.addEventListener('message', muxerMaConnOnMessage);
+        // signal stream writers when the underlying connection can accept more data
+        const muxerMaConnOnDrain = () => {
+            this.log('underlying stream drained, signal %d streams to continue writing', this.streams.length);
+            this.streams.forEach(stream => {
+                stream.onMuxerDrain();
+            });
+        };
+        this.maConn.addEventListener('drain', muxerMaConnOnDrain);
+        const muxerOnMaConnClose = () => {
+            this.log('underlying stream closed with status %s and %d streams', this.status, this.streams.length);
+            this.onTransportClosed();
+        };
+        this.maConn.addEventListener('close', muxerOnMaConnClose);
+    }
+    send(data) {
+        const result = this.maConn.send(data);
+        if (result === false) {
+            this.log('underlying stream saturated, signal %d streams to pause writing', this.streams.length);
+            this.streams.forEach(stream => {
+                stream.onMuxerNeedsDrain();
+            });
+        }
+        return result;
+    }
+    async close(options) {
+        if (this.status === 'closed' || this.status === 'closing') {
+            return;
+        }
+        this.status = 'closing';
+        await raceSignal(Promise.all([...this.streams].map(async (s) => {
+            await s.close(options);
+        })), options?.signal);
+        this.status = 'closed';
+    }
+    abort(err) {
+        if (this.status === 'closed') {
+            return;
+        }
+        this.status = 'closing';
+        [...this.streams].forEach(s => {
+            s.abort(err);
+        });
+        this.status = 'closed';
+    }
+    onTransportClosed(err) {
+        this.status = 'closing';
+        try {
+            [...this.streams].forEach(stream => {
+                stream.onTransportClosed(err);
+            });
+        }
+        catch (err) {
+            this.abort(err);
+        }
+        this.status = 'closed';
+    }
+    async createStream(options) {
+        if (this.status !== 'open') {
+            throw new MuxerClosedError();
+        }
+        let stream = this.onCreateStream({
+            ...this.streamOptions,
+            ...options
+        });
+        if (isPromise(stream)) {
+            stream = await stream;
+        }
+        this.streams.push(stream);
+        this.cleanUpStream(stream);
+        return stream;
+    }
+    /**
+     * Extending classes should invoke this method when a new stream was created
+     * by the remote muxer
+     */
+    onRemoteStream(stream) {
+        this.streams.push(stream);
+        this.cleanUpStream(stream);
+        if (this.listenerCount('stream') === 0) {
+            // no listener has been added for the stream event yet, store the stream
+            // to emit it later
+            this.earlyStreams.push(stream);
+            if (this.earlyStreams.length > this.maxEarlyStreams) {
+                this.abort(new MaxEarlyStreamsError(`Too many early streams were opened - ${this.earlyStreams.length}/${this.maxEarlyStreams}`));
+            }
+            return;
+        }
+        this.safeDispatchEvent('stream', {
+            detail: stream
+        });
+    }
+    cleanUpStream(stream) {
+        const muxerOnStreamEnd = (evt) => {
+            const index = this.streams.findIndex(s => s === stream);
+            if (index !== -1) {
+                this.streams.splice(index, 1);
+            }
+            if (evt.error != null) {
+                if (evt.local) {
+                    this.metrics?.increment({ [`${stream.direction}_stream_reset`]: true });
+                }
+                else {
+                    this.metrics?.increment({ [`${stream.direction}_stream_abort`]: true });
+                }
+            }
+            else {
+                this.metrics?.increment({ [`${stream.direction}_stream_end`]: true });
+            }
+        };
+        stream.addEventListener('close', muxerOnStreamEnd);
+        this.metrics?.increment({ [`${stream.direction}_stream`]: true });
+    }
+    addEventListener(...args) {
+        // @ts-expect-error cannot ensure args has enough members
+        super.addEventListener.apply(this, args);
+        // if a 'stream' listener is being added and we have early streams, emit
+        // them
+        if (args[0] === 'stream' && this.earlyStreams.length > 0) {
+            // event listeners can be added in constructors and often use object
+            // properties - if this the case we can access a class member before it
+            // has been initialized so dispatch the message in the microtask queue
+            queueMicrotask(() => {
+                this.earlyStreams.forEach(stream => {
+                    this.safeDispatchEvent('stream', {
+                        detail: stream
+                    });
+                });
+                this.earlyStreams = [];
+            });
+        }
+    }
+}
+//# sourceMappingURL=abstract-stream-muxer.js.map

package/dist/src/abstract-stream-muxer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-stream-muxer.js","sourceRoot":"","sources":["../../src/abstract-stream-muxer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACvE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAuB3C,MAAM,OAAgB,mBAA0E,SAAQ,iBAAiD;IAChJ,OAAO,CAAe;IACtB,QAAQ,CAAQ;IAChB,MAAM,CAAmB;IAEtB,GAAG,CAAQ;IACX,MAAM,CAAe;IACrB,aAAa,CAAgB;IAC7B,YAAY,CAAe;IAC3B,eAAe,CAAQ;IAEhB,OAAO,CAAe;IAEvC,YAAa,MAAqB,EAAE,IAA6B;QAC/D,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;QAC7B,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;QACjB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAA;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACzC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAA;QACvC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,EAAE,CAAA;QACjD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAE3B,gDAAgD;QAChD,MAAM,oBAAoB,GAAG,CAAC,GAAuB,EAAQ,EAAE;YAC7D,IAAI,CAAC;gBACH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;YACvB,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;gBACf,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACxB,CAAC;QACH,CAAC,CAAA;QACD,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAA;QAE7D,4EAA4E;QAC5E,MAAM,kBAAkB,GAAG,GAAS,EAAE;YACpC,IAAI,CAAC,GAAG,CAAC,kEAAkE,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;YAEjG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBAC5B,MAAM,CAAC,YAAY,EAAE,CAAA;YACvB,CAAC,CAAC,CAAA;QACJ,CAAC,CAAA;QACD,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAA;QAEzD,MAAM,kBAAkB,GAAG,GAAS,EAAE;YACpC,IAAI,CAAC,GAAG,CAAC,wDAAwD,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;YACpG,IAAI,CAAC,iBAAiB,EAAE,CAAA;QAC1B,CAAC,CAAA;QACD,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAA;IAC3D,CAAC;IAED,IAAI,CAAE,IAAiC;QACrC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAErC,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;YACrB,IAAI,CAAC,GAAG,CAAC,iEAAiE,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;YAEhG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBAC5B,MAAM,CAAC,iBAAiB,EAAE,CAAA;YAC5B,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAED,KAAK,CAAC,KAAK,CAAE,OAAsB;QACjC,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC1D,OAAM;QACR,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;QAEvB,MAAM,UAAU,CAAC,OAAO,CAAC,GAAG,CAC1B,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,KAAK,EAAC,CAAC,EAAC,EAAE;YAC9B,MAAM,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACxB,CAAC,CAAC,CACH,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;QAEnB,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAA;IACxB,CAAC;IAED,KAAK,CAAE,GAAU;QACf,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAM;QACR,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,SAAS,CAEtB;QAAA,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YAC7B,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACd,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAA;IACxB,CAAC;IAED,iBAAiB,CAAE,GAAW;QAC5B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;QAEvB,IAAI,CAAC;YACH,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBACjC,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAA;YAC/B,CAAC,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACjB,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAA;IACxB,CAAC;IAED,KAAK,CAAC,YAAY,CAAE,OAA6B;QAC/C,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAC3B,MAAM,IAAI,gBAAgB,EAAE,CAAA;QAC9B,CAAC;QAED,IAAI,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC;YAC/B,GAAG,IAAI,CAAC,aAAa;YACrB,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;YACtB,MAAM,GAAG,MAAM,MAAM,CAAA;QACvB,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACzB,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;QAE1B,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;OAGG;IACH,cAAc,CAAE,MAAmB;QACjC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACzB,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;QAE1B,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACvC,wEAAwE;YACxE,mBAAmB;YACnB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YAE9B,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;gBACpD,IAAI,CAAC,KAAK,CAAC,IAAI,oBAAoB,CAAC,wCAAwC,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC,CAAA;YAClI,CAAC;YAED,OAAM;QACR,CAAC;QAED,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;YAC/B,MAAM,EAAE,MAAM;SACf,CAAC,CAAA;IACJ,CAAC;IAEO,aAAa,CAAE,MAAc;QACnC,MAAM,gBAAgB,GAAG,CAAC,GAAqB,EAAQ,EAAE;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,CAAA;YAEvD,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBACjB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;YAC/B,CAAC;YAED,IAAI,GAAG,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;gBACtB,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;oBACd,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,SAAS,eAAe,CAAC,EAAE,IAAI,EAAE,CAAC,CAAA;gBACzE,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,SAAS,eAAe,CAAC,EAAE,IAAI,EAAE,CAAC,CAAA;gBACzE,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,SAAS,aAAa,CAAC,EAAE,IAAI,EAAE,CAAC,CAAA;YACvE,CAAC;QACH,CAAC,CAAA;QACD,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAA;QAElD,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,SAAS,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,CAAA;IACnE,CAAC;IAID,gBAAgB,CAAE,GAAG,IAAW;QAC9B,yDAAyD;QACzD,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAExC,wEAAwE;QACxE,OAAO;QACP,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzD,oEAAoE;YACpE,uEAAuE;YACvE,sEAAsE;YACtE,cAAc,CAAC,GAAG,EAAE;gBAClB,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;oBACjC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;wBAC/B,MAAM,EAAE,MAAM;qBACf,CAAC,CAAA;gBACJ,CAAC,CAAC,CAAA;gBACF,IAAI,CAAC,YAAY,GAAG,EAAE,CAAA;YACxB,CAAC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;CAWF"}

package/dist/src/abstract-stream.d.ts

@@ -1,147 +1,31 @@
-import { Uint8ArrayList } from 'uint8arraylist';
-import type { AbortOptions, Direction, ReadStatus, Stream, StreamStatus, StreamTimeline, WriteStatus } from '@libp2p/interface';
-import type { Logger } from '@libp2p/logger';
-import type { Source } from 'it-stream-types';
-export interface AbstractStreamInit {
+import { AbstractMessageStream } from './abstract-message-stream.js';
+import type { MessageStreamInit } from './abstract-message-stream.js';
+import type { AbortOptions, Stream } from '@libp2p/interface';
+export interface AbstractStreamInit extends MessageStreamInit {
     /**
      * A unique identifier for this stream
      */
     id: string;
     /**
-     * The stream direction
+     * The protocol name for the stream, if it is known
      */
-    direction: Direction;
-    /**
-     * A Logger implementation used to log stream-specific information
-     */
-    log: Logger;
-    /**
-     * User specific stream metadata
-     */
-    metadata?: Record<string, unknown>;
-    /**
-     * Invoked when the stream ends
-     */
-    onEnd?(err?: Error): void;
-    /**
-     * Invoked when the readable end of the stream is closed
-     */
-    onCloseRead?(): void;
-    /**
-     * Invoked when the writable end of the stream is closed
-     */
-    onCloseWrite?(): void;
-    /**
-     * Invoked when the stream has been reset by the remote
-     */
-    onReset?(): void;
-    /**
-     * Invoked when the stream has errored
-     */
-    onAbort?(err: Error): void;
-    /**
-     * How long to wait in ms for stream data to be written to the underlying
-     * connection when closing the writable end of the stream.
-     *
-     * @default 500
-     */
-    closeTimeout?: number;
-    /**
-     * After the stream sink has closed, a limit on how long it takes to send
-     * a close-write message to the remote peer.
-     */
-    sendCloseWriteTimeout?: number;
+    protocol?: string;
 }
-export declare abstract class AbstractStream implements Stream {
+export declare abstract class AbstractStream extends AbstractMessageStream implements Stream {
     id: string;
-    direction: Direction;
-    timeline: StreamTimeline;
-    protocol?: string;
-    metadata: Record<string, unknown>;
-    source: AsyncGenerator<Uint8ArrayList, void, unknown>;
-    status: StreamStatus;
-    readStatus: ReadStatus;
-    writeStatus: WriteStatus;
-    readonly log: Logger;
-    private readonly sinkController;
-    private readonly sinkEnd;
-    private readonly closed;
-    private endErr;
-    private readonly streamSource;
-    private readonly onEnd?;
-    private readonly onCloseRead?;
-    private readonly onCloseWrite?;
-    private readonly onReset?;
-    private readonly onAbort?;
-    private readonly sendCloseWriteTimeout;
-    private sendingData?;
+    protocol: string;
     constructor(init: AbstractStreamInit);
-    sink(source: Source<Uint8ArrayList | Uint8Array>): Promise<void>;
-    protected onSourceEnd(err?: Error): void;
-    protected onSinkEnd(err?: Error): void;
     close(options?: AbortOptions): Promise<void>;
     closeRead(options?: AbortOptions): Promise<void>;
-    closeWrite(options?: AbortOptions): Promise<void>;
-    /**
-     * Close immediately for reading and writing and send a reset message (local
-     * error)
-     */
-    abort(err: Error): void;
-    /**
-     * Receive a reset message - close immediately for reading and writing (remote
-     * error)
-     */
-    reset(): void;
-    _closeSinkAndSource(err?: Error): void;
-    _closeSink(err?: Error): void;
-    _closeSource(err?: Error): void;
-    /**
-     * The remote closed for writing so we should expect to receive no more
-     * messages
-     */
-    remoteCloseWrite(): void;
-    /**
-     * The remote closed for reading so we should not send any more
-     * messages
-     */
-    remoteCloseRead(): void;
-    /**
-     * The underlying muxer has closed, no more messages can be sent or will
-     * be received, close immediately to free up resources
-     */
-    destroy(): void;
-    /**
-     * When an extending class reads data from it's implementation-specific source,
-     * call this method to allow the stream consumer to read the data.
-     */
-    sourcePush(data: Uint8ArrayList): void;
-    /**
-     * Returns the amount of unread data - can be used to prevent large amounts of
-     * data building up when the stream consumer is too slow.
-     */
-    sourceReadableLength(): number;
-    /**
-     * Send a message to the remote muxer informing them a new stream is being
-     * opened
-     */
-    abstract sendNewStream(options?: AbortOptions): void | Promise<void>;
-    /**
-     * Send a data message to the remote muxer
-     */
-    abstract sendData(buf: Uint8ArrayList, options?: AbortOptions): void | Promise<void>;
-    /**
-     * Send a reset message to the remote muxer
-     */
-    abstract sendReset(options?: AbortOptions): void | Promise<void>;
     /**
-     * Send a message to the remote muxer, informing them no more data messages
-     * will be sent by this end of the stream
+     * Send a message to the remote end of the stream, informing them that we will
+     * send no more data messages.
      */
-    abstract sendCloseWrite(options?: AbortOptions): void | Promise<void>;
+    abstract sendCloseWrite(options?: AbortOptions): Promise<void>;
     /**
-     * Send a message to the remote muxer, informing them no more data messages
-     * will be read by this end of the stream
+     * If supported, send a message to the remote end of the stream, informing
+     * them that we will read no more data messages.
      */
-    abstract sendCloseRead(options?: AbortOptions): void | Promise<void>;
+    abstract sendCloseRead(options?: AbortOptions): Promise<void>;
 }
 //# sourceMappingURL=abstract-stream.d.ts.map

package/dist/src/abstract-stream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"abstract-stream.d.ts","sourceRoot":"","sources":["../../src/abstract-stream.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAE/C,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/H,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAE5C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAK7C,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAElC;;OAEG;IACH,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,WAAW,CAAC,IAAI,IAAI,CAAA;IAEpB;;OAEG;IACH,YAAY,CAAC,IAAI,IAAI,CAAA;IAErB;;OAEG;IACH,OAAO,CAAC,IAAI,IAAI,CAAA;IAEhB;;OAEG;IACH,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,GAAG,IAAI,CAAA;IAE1B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B;AAYD,8BAAsB,cAAe,YAAW,MAAM;IAC7C,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,SAAS,CAAA;IACpB,QAAQ,EAAE,cAAc,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,MAAM,EAAE,cAAc,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;IACrD,MAAM,EAAE,YAAY,CAAA;IACpB,UAAU,EAAE,UAAU,CAAA;IACtB,WAAW,EAAE,WAAW,CAAA;IAC/B,SAAgB,GAAG,EAAE,MAAM,CAAA;IAE3B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAiB;IAChD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAuB;IAC/C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAuB;IAC9C,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA0B;IACvD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAuB;IAC9C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAY;IACzC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAY;IAC1C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAY;IACrC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAsB;IAC/C,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAQ;IAC9C,OAAO,CAAC,WAAW,CAAC,CAAuB;gBAE9B,IAAI,EAAE,kBAAkB;IAyC/B,IAAI,CAAE,MAAM,EAAE,MAAM,CAAC,cAAc,GAAG,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAsEvE,SAAS,CAAC,WAAW,CAAE,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI;IAgCzC,SAAS,CAAC,SAAS,CAAE,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI;IAiCjC,KAAK,CAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAqB7C,SAAS,CAAE,OAAO,GAAE,YAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBrD,UAAU,CAAE,OAAO,GAAE,YAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IA8B5D;;;OAGG;IACH,KAAK,CAAE,GAAG,EAAE,KAAK,GAAG,IAAI;IAuBxB;;;OAGG;IACH,KAAK,IAAK,IAAI;IAad,mBAAmB,CAAE,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI;IAKvC,UAAU,CAAE,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI;IAU9B,YAAY,CAAE,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI;IAShC;;;OAGG;IACH,gBAAgB,IAAK,IAAI;IAUzB;;;OAGG;IACH,eAAe,IAAK,IAAI;IAUxB;;;OAGG;IACH,OAAO,IAAK,IAAI;IAWhB;;;OAGG;IACH,UAAU,CAAE,IAAI,EAAE,cAAc,GAAG,IAAI;IAIvC;;;OAGG;IACH,oBAAoB,IAAK,MAAM;IAI/B;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAE,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAErE;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAE,GAAG,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAErF;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAE,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAEjE;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAE,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAEtE;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAE,OAAO,CAAC,EAAE,YAAY,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CACtE"}
+{"version":3,"file":"abstract-stream.d.ts","sourceRoot":"","sources":["../../src/abstract-stream.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAE7D,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;IAC3D;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,8BAAsB,cAAe,SAAQ,qBAAsB,YAAW,MAAM;IAC3E,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;gBAEV,IAAI,EAAE,kBAAkB;IAO/B,KAAK,CAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IA2C7C,SAAS,CAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBvD;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/D;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;CAC/D"}