@libp2p/interface 0.1.5 → 0.1.6-0b4a2ee79

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

@@ -1,323 +1,9 @@
-import { abortableSource } from 'abortable-iterator';
-import { pushable } from 'it-pushable';
-import defer, {} from 'p-defer';
-import { raceSignal } from 'race-signal';
-import { Uint8ArrayList } from 'uint8arraylist';
-import { CodeError } from '../errors.js';
-const ERR_STREAM_RESET = 'ERR_STREAM_RESET';
-const ERR_SINK_INVALID_STATE = 'ERR_SINK_INVALID_STATE';
-const DEFAULT_SEND_CLOSE_WRITE_TIMEOUT = 5000;
-function isPromise(res) {
-    return res != null && typeof res.then === 'function';
-}
-export class AbstractStream {
-    id;
-    direction;
-    timeline;
-    protocol;
-    metadata;
-    source;
-    status;
-    readStatus;
-    writeStatus;
-    sinkController;
-    sinkEnd;
-    endErr;
-    streamSource;
-    onEnd;
-    onCloseRead;
-    onCloseWrite;
-    onReset;
-    onAbort;
-    sendCloseWriteTimeout;
-    log;
-    constructor(init) {
-        this.sinkController = new AbortController();
-        this.sinkEnd = defer();
-        this.log = init.log;
-        // stream status
-        this.status = 'open';
-        this.readStatus = 'ready';
-        this.writeStatus = 'ready';
-        this.id = init.id;
-        this.metadata = init.metadata ?? {};
-        this.direction = init.direction;
-        this.timeline = {
-            open: Date.now()
-        };
-        this.sendCloseWriteTimeout = init.sendCloseWriteTimeout ?? DEFAULT_SEND_CLOSE_WRITE_TIMEOUT;
-        this.onEnd = init.onEnd;
-        this.onCloseRead = init?.onCloseRead;
-        this.onCloseWrite = init?.onCloseWrite;
-        this.onReset = init?.onReset;
-        this.onAbort = init?.onAbort;
-        this.source = this.streamSource = pushable({
-            onEnd: (err) => {
-                if (err != null) {
-                    this.log.trace('source ended with error', err);
-                }
-                else {
-                    this.log.trace('source ended');
-                }
-                this.onSourceEnd(err);
-            }
-        });
-        // necessary because the libp2p upgrader wraps the sink function
-        this.sink = this.sink.bind(this);
-    }
-    async sink(source) {
-        if (this.writeStatus !== 'ready') {
-            throw new CodeError(`writable end state is "${this.writeStatus}" not "ready"`, ERR_SINK_INVALID_STATE);
-        }
-        try {
-            this.writeStatus = 'writing';
-            const options = {
-                signal: this.sinkController.signal
-            };
-            if (this.direction === 'outbound') { // If initiator, open a new stream
-                const res = this.sendNewStream(options);
-                if (isPromise(res)) {
-                    await res;
-                }
-            }
-            source = abortableSource(source, this.sinkController.signal, {
-                returnOnAbort: true
-            });
-            this.log.trace('sink reading from source');
-            for await (let data of source) {
-                data = data instanceof Uint8Array ? new Uint8ArrayList(data) : data;
-                const res = this.sendData(data, options);
-                if (isPromise(res)) { // eslint-disable-line max-depth
-                    await res;
-                }
-            }
-            this.log.trace('sink finished reading from source, write status is "%s"', this.writeStatus);
-            if (this.writeStatus === 'writing') {
-                this.writeStatus = 'closing';
-                this.log.trace('send close write to remote');
-                await this.sendCloseWrite({
-                    signal: AbortSignal.timeout(this.sendCloseWriteTimeout)
-                });
-                this.writeStatus = 'closed';
-            }
-            this.onSinkEnd();
-        }
-        catch (err) {
-            this.log.trace('sink ended with error, calling abort with error', err);
-            this.abort(err);
-            throw err;
-        }
-        finally {
-            this.log.trace('resolve sink end');
-            this.sinkEnd.resolve();
-        }
-    }
-    onSourceEnd(err) {
-        if (this.timeline.closeRead != null) {
-            return;
-        }
-        this.timeline.closeRead = Date.now();
-        this.readStatus = 'closed';
-        if (err != null && this.endErr == null) {
-            this.endErr = err;
-        }
-        this.onCloseRead?.();
-        if (this.timeline.closeWrite != null) {
-            this.log.trace('source and sink ended');
-            this.timeline.close = Date.now();
-            if (this.status !== 'aborted' && this.status !== 'reset') {
-                this.status = 'closed';
-            }
-            if (this.onEnd != null) {
-                this.onEnd(this.endErr);
-            }
-        }
-        else {
-            this.log.trace('source ended, waiting for sink to end');
-        }
-    }
-    onSinkEnd(err) {
-        if (this.timeline.closeWrite != null) {
-            return;
-        }
-        this.timeline.closeWrite = Date.now();
-        this.writeStatus = 'closed';
-        if (err != null && this.endErr == null) {
-            this.endErr = err;
-        }
-        this.onCloseWrite?.();
-        if (this.timeline.closeRead != null) {
-            this.log.trace('sink and source ended');
-            this.timeline.close = Date.now();
-            if (this.status !== 'aborted' && this.status !== 'reset') {
-                this.status = 'closed';
-            }
-            if (this.onEnd != null) {
-                this.onEnd(this.endErr);
-            }
-        }
-        else {
-            this.log.trace('sink ended, waiting for source to end');
-        }
-    }
-    // Close for both Reading and Writing
-    async close(options) {
-        this.log.trace('closing gracefully');
-        this.status = 'closing';
-        await Promise.all([
-            this.closeRead(options),
-            this.closeWrite(options)
-        ]);
-        this.status = 'closed';
-        this.log.trace('closed gracefully');
-    }
-    async closeRead(options = {}) {
-        if (this.readStatus === 'closing' || this.readStatus === 'closed') {
-            return;
-        }
-        this.log.trace('closing readable end of stream with starting read status "%s"', this.readStatus);
-        const readStatus = this.readStatus;
-        this.readStatus = 'closing';
-        if (this.status !== 'reset' && this.status !== 'aborted' && this.timeline.closeRead == null) {
-            this.log.trace('send close read to remote');
-            await this.sendCloseRead(options);
-        }
-        if (readStatus === 'ready') {
-            this.log.trace('ending internal source queue');
-            this.streamSource.end();
-        }
-        this.log.trace('closed readable end of stream');
-    }
-    async closeWrite(options = {}) {
-        if (this.writeStatus === 'closing' || this.writeStatus === 'closed') {
-            return;
-        }
-        this.log.trace('closing writable end of stream with starting write status "%s"', this.writeStatus);
-        if (this.writeStatus === 'ready') {
-            this.log.trace('sink was never sunk, sink an empty array');
-            await raceSignal(this.sink([]), options.signal);
-        }
-        if (this.writeStatus === 'writing') {
-            // stop reading from the source passed to `.sink` in the microtask queue
-            // - this lets any data queued by the user in the current tick get read
-            // before we exit
-            await new Promise((resolve, reject) => {
-                queueMicrotask(() => {
-                    this.log.trace('aborting source passed to .sink');
-                    this.sinkController.abort();
-                    raceSignal(this.sinkEnd.promise, options.signal)
-                        .then(resolve, reject);
-                });
-            });
-        }
-        this.writeStatus = 'closed';
-        this.log.trace('closed writable end of stream');
-    }
-    /**
-     * Close immediately for reading and writing and send a reset message (local
-     * error)
-     */
-    abort(err) {
-        if (this.status === 'closed' || this.status === 'aborted' || this.status === 'reset') {
-            return;
-        }
-        this.log('abort with error', err);
-        // try to send a reset message
-        this.log('try to send reset to remote');
-        const res = this.sendReset();
-        if (isPromise(res)) {
-            res.catch((err) => {
-                this.log.error('error sending reset message', err);
-            });
-        }
-        this.status = 'aborted';
-        this.timeline.abort = Date.now();
-        this._closeSinkAndSource(err);
-        this.onAbort?.(err);
-    }
-    /**
-     * Receive a reset message - close immediately for reading and writing (remote
-     * error)
-     */
-    reset() {
-        if (this.status === 'closed' || this.status === 'aborted' || this.status === 'reset') {
-            return;
-        }
-        const err = new CodeError('stream reset', ERR_STREAM_RESET);
-        this.status = 'reset';
-        this.timeline.reset = Date.now();
-        this._closeSinkAndSource(err);
-        this.onReset?.();
-    }
-    _closeSinkAndSource(err) {
-        this._closeSink(err);
-        this._closeSource(err);
-    }
-    _closeSink(err) {
-        // if the sink function is running, cause it to end
-        if (this.writeStatus === 'writing') {
-            this.log.trace('end sink source');
-            this.sinkController.abort();
-        }
-        this.onSinkEnd(err);
-    }
-    _closeSource(err) {
-        // if the source is not ending, end it
-        if (this.readStatus !== 'closing' && this.readStatus !== 'closed') {
-            this.log.trace('ending source with %d bytes to be read by consumer', this.streamSource.readableLength);
-            this.readStatus = 'closing';
-            this.streamSource.end(err);
-        }
-    }
-    /**
-     * The remote closed for writing so we should expect to receive no more
-     * messages
-     */
-    remoteCloseWrite() {
-        if (this.readStatus === 'closing' || this.readStatus === 'closed') {
-            this.log('received remote close write but local source is already closed');
-            return;
-        }
-        this.log.trace('remote close write');
-        this._closeSource();
-    }
-    /**
-     * The remote closed for reading so we should not send any more
-     * messages
-     */
-    remoteCloseRead() {
-        if (this.writeStatus === 'closing' || this.writeStatus === 'closed') {
-            this.log('received remote close read but local sink is already closed');
-            return;
-        }
-        this.log.trace('remote close read');
-        this._closeSink();
-    }
-    /**
-     * The underlying muxer has closed, no more messages can be sent or will
-     * be received, close immediately to free up resources
-     */
-    destroy() {
-        if (this.status === 'closed' || this.status === 'aborted' || this.status === 'reset') {
-            this.log('received destroy but we are already closed');
-            return;
-        }
-        this.log.trace('stream destroyed');
-        this._closeSinkAndSource();
-    }
-    /**
-     * 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) {
-        this.streamSource.push(data);
-    }
-    /**
-     * 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() {
-        return this.streamSource.readableLength;
-    }
-}
+// TODO: remove this file and the dep-check override in package.json for
+// @libp2p/utils when yamux is updated.
+// This is a hack to defeat TypeScript trying to inspect the types for
+// @libp2p/utils/abstract-stream which depends on this module - making the
+// import path only resolvable at runtime breaks the transpile time circular
+// dependency
+const s = await import('@libp2p/utils' + '/abstract-stream');
+export const AbstractStream = s.AbstractStream;
 //# sourceMappingURL=stream.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"stream.js","sourceRoot":"","sources":["../../../src/stream-muxer/stream.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,EAAiB,QAAQ,EAAE,MAAM,aAAa,CAAA;AACrD,OAAO,KAAK,EAAE,EAAwB,MAAM,SAAS,CAAA;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAaxC,MAAM,gBAAgB,GAAG,kBAAkB,CAAA;AAC3C,MAAM,sBAAsB,GAAG,wBAAwB,CAAA;AACvD,MAAM,gCAAgC,GAAG,IAAI,CAAA;AA6D7C,SAAS,SAAS,CAAE,GAAS;IAC3B,OAAO,GAAG,IAAI,IAAI,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,UAAU,CAAA;AACtD,CAAC;AAED,MAAM,OAAgB,cAAc;IAC3B,EAAE,CAAQ;IACV,SAAS,CAAW;IACpB,QAAQ,CAAgB;IACxB,QAAQ,CAAS;IACjB,QAAQ,CAAyB;IACjC,MAAM,CAA+C;IACrD,MAAM,CAAc;IACpB,UAAU,CAAY;IACtB,WAAW,CAAa;IAEd,cAAc,CAAiB;IAC/B,OAAO,CAAuB;IACvC,MAAM,CAAmB;IAChB,YAAY,CAA0B;IACtC,KAAK,CAAoC;IACzC,WAAW,CAAa;IACxB,YAAY,CAAa;IACzB,OAAO,CAAa;IACpB,OAAO,CAAuB;IAC9B,qBAAqB,CAAQ;IAE3B,GAAG,CAAQ;IAE9B,YAAa,IAAwB;QACnC,IAAI,CAAC,cAAc,GAAG,IAAI,eAAe,EAAE,CAAA;QAC3C,IAAI,CAAC,OAAO,GAAG,KAAK,EAAE,CAAA;QACtB,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;QAEnB,gBAAgB;QAChB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAA;QACzB,IAAI,CAAC,WAAW,GAAG,OAAO,CAAA;QAE1B,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAA;QACjB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAA;QACnC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;QAC/B,IAAI,CAAC,QAAQ,GAAG;YACd,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;SACjB,CAAA;QACD,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB,IAAI,gCAAgC,CAAA;QAE3F,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;QACvB,IAAI,CAAC,WAAW,GAAG,IAAI,EAAE,WAAW,CAAA;QACpC,IAAI,CAAC,YAAY,GAAG,IAAI,EAAE,YAAY,CAAA;QACtC,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,OAAO,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,OAAO,CAAA;QAE5B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAiB;YACzD,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE;gBACb,IAAI,GAAG,IAAI,IAAI,EAAE;oBACf,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAA;iBAC/C;qBAAM;oBACL,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;iBAC/B;gBAED,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;YACvB,CAAC;SACF,CAAC,CAAA;QAEF,gEAAgE;QAChE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAClC,CAAC;IAED,KAAK,CAAC,IAAI,CAAE,MAA2C;QACrD,IAAI,IAAI,CAAC,WAAW,KAAK,OAAO,EAAE;YAChC,MAAM,IAAI,SAAS,CAAC,0BAA0B,IAAI,CAAC,WAAW,eAAe,EAAE,sBAAsB,CAAC,CAAA;SACvG;QAED,IAAI;YACF,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA;YAE5B,MAAM,OAAO,GAAiB;gBAC5B,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM;aACnC,CAAA;YAED,IAAI,IAAI,CAAC,SAAS,KAAK,UAAU,EAAE,EAAE,kCAAkC;gBACrE,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;gBAEvC,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;oBAClB,MAAM,GAAG,CAAA;iBACV;aACF;YAED,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;gBAC3D,aAAa,EAAE,IAAI;aACpB,CAAC,CAAA;YAEF,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAA;YAE1C,IAAI,KAAK,EAAE,IAAI,IAAI,IAAI,MAAM,EAAE;gBAC7B,IAAI,GAAG,IAAI,YAAY,UAAU,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;gBAEnE,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;gBAExC,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,gCAAgC;oBACpD,MAAM,GAAG,CAAA;iBACV;aACF;YAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yDAAyD,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;YAE3F,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;gBAClC,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA;gBAE5B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAA;gBAC5C,MAAM,IAAI,CAAC,cAAc,CAAC;oBACxB,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC;iBACxD,CAAC,CAAA;gBAEF,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAA;aAC5B;YAED,IAAI,CAAC,SAAS,EAAE,CAAA;SACjB;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iDAAiD,EAAE,GAAG,CAAC,CAAA;YACtE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAEf,MAAM,GAAG,CAAA;SACV;gBAAS;YACR,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAA;YAClC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAA;SACvB;IACH,CAAC;IAES,WAAW,CAAE,GAAW;QAChC,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,IAAI,IAAI,EAAE;YACnC,OAAM;SACP;QAED,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACpC,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAA;QAE1B,IAAI,GAAG,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACtC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAA;SAClB;QAED,IAAI,CAAC,WAAW,EAAE,EAAE,CAAA;QAEpB,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,IAAI,IAAI,EAAE;YACpC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAA;YACvC,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;YAEhC,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO,EAAE;gBACxD,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAA;aACvB;YAED,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE;gBACtB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;aACxB;SACF;aAAM;YACL,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAA;SACxD;IACH,CAAC;IAES,SAAS,CAAE,GAAW;QAC9B,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,IAAI,IAAI,EAAE;YACpC,OAAM;SACP;QAED,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACrC,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAA;QAE3B,IAAI,GAAG,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACtC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAA;SAClB;QAED,IAAI,CAAC,YAAY,EAAE,EAAE,CAAA;QAErB,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,IAAI,IAAI,EAAE;YACnC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAA;YACvC,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;YAEhC,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO,EAAE;gBACxD,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAA;aACvB;YAED,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE;gBACtB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;aACxB;SACF;aAAM;YACL,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAA;SACxD;IACH,CAAC;IAED,qCAAqC;IACrC,KAAK,CAAC,KAAK,CAAE,OAAsB;QACjC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAA;QAEpC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;QAEvB,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YACvB,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;SACzB,CAAC,CAAA;QAEF,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAA;QAEtB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAA;IACrC,CAAC;IAED,KAAK,CAAC,SAAS,CAAE,UAAwB,EAAE;QACzC,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,QAAQ,EAAE;YACjE,OAAM;SACP;QAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+DAA+D,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;QAEhG,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAA;QAClC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAA;QAE3B,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,IAAI,IAAI,EAAE;YAC3F,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAA;YAC3C,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;SAClC;QAED,IAAI,UAAU,KAAK,OAAO,EAAE;YAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAA;YAC9C,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,CAAA;SACxB;QAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAA;IACjD,CAAC;IAED,KAAK,CAAC,UAAU,CAAE,UAAwB,EAAE;QAC1C,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,QAAQ,EAAE;YACnE,OAAM;SACP;QAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gEAAgE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;QAElG,IAAI,IAAI,CAAC,WAAW,KAAK,OAAO,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAA;YAE1D,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;SAChD;QAED,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;YAClC,wEAAwE;YACxE,uEAAuE;YACvE,iBAAiB;YACjB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACpC,cAAc,CAAC,GAAG,EAAE;oBAClB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAA;oBACjD,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAA;oBAC3B,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC;yBAC7C,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;gBAC1B,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;SACH;QAED,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAA;QAE3B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAA;IACjD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAE,GAAU;QACf,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO,EAAE;YACpF,OAAM;SACP;QAED,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAA;QAEjC,8BAA8B;QAC9B,IAAI,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAA;QACvC,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;QAE5B,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;YAClB,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBAChB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAA;YACpD,CAAC,CAAC,CAAA;SACH;QAED,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;QACvB,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAChC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAA;QAC7B,IAAI,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAA;IACrB,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO,EAAE;YACpF,OAAM;SACP;QAED,MAAM,GAAG,GAAG,IAAI,SAAS,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAA;QAE3D,IAAI,CAAC,MAAM,GAAG,OAAO,CAAA;QACrB,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAChC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAA;QAC7B,IAAI,CAAC,OAAO,EAAE,EAAE,CAAA;IAClB,CAAC;IAED,mBAAmB,CAAE,GAAW;QAC9B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;QACpB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;IACxB,CAAC;IAED,UAAU,CAAE,GAAW;QACrB,mDAAmD;QACnD,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;YAClC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAA;YACjC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAA;SAC5B;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;IACrB,CAAC;IAED,YAAY,CAAE,GAAW;QACvB,sCAAsC;QACtC,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,QAAQ,EAAE;YACjE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oDAAoD,EAAE,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAA;YACtG,IAAI,CAAC,UAAU,GAAG,SAAS,CAAA;YAC3B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;SAC3B;IACH,CAAC;IAED;;;OAGG;IACH,gBAAgB;QACd,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,QAAQ,EAAE;YACjE,IAAI,CAAC,GAAG,CAAC,gEAAgE,CAAC,CAAA;YAC1E,OAAM;SACP;QAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAA;QACpC,IAAI,CAAC,YAAY,EAAE,CAAA;IACrB,CAAC;IAED;;;OAGG;IACH,eAAe;QACb,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,QAAQ,EAAE;YACnE,IAAI,CAAC,GAAG,CAAC,6DAA6D,CAAC,CAAA;YACvE,OAAM;SACP;QAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAA;QACnC,IAAI,CAAC,UAAU,EAAE,CAAA;IACnB,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO,EAAE;YACpF,IAAI,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAA;YACtD,OAAM;SACP;QAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAA;QAElC,IAAI,CAAC,mBAAmB,EAAE,CAAA;IAC5B,CAAC;IAED;;;OAGG;IACH,UAAU,CAAE,IAAoB;QAC9B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC9B,CAAC;IAED;;;OAGG;IACH,oBAAoB;QAClB,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,CAAA;IACzC,CAAC;CA6BF"}
+{"version":3,"file":"stream.js","sourceRoot":"","sources":["../../../src/stream-muxer/stream.ts"],"names":[],"mappings":"AAAA,wEAAwE;AACxE,uCAAuC;AACvC,sEAAsE;AACtE,0EAA0E;AAC1E,4EAA4E;AAC5E,aAAa;AACb,MAAM,CAAC,GAAG,MAAM,MAAM,CAAC,eAAe,GAAG,kBAAkB,CAAC,CAAA;AAI5D,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,cAAc,CAAA"}

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

@@ -1,8 +1,6 @@
 import type { Connection } from '../connection/index.js';
 import type { PeerId } from '../peer-id/index.js';
 export interface Topology {
-    min?: number;
-    max?: number;
     /**
      * If true, invoke `onConnect` for this topology on transient (e.g. short-lived
      * and/or data-limited) connections. (default: false)

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/topology/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAEjD,MAAM,WAAW,QAAQ;IACvB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAE3B;;;OAGG;IACH,SAAS,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,IAAI,CAAA;IAElD;;;OAGG;IACH,YAAY,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;CACpC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/topology/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAEjD,MAAM,WAAW,QAAQ;IACvB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAE3B;;;OAGG;IACH,SAAS,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,IAAI,CAAA;IAElD;;;OAGG;IACH,YAAY,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;CACpC"}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@libp2p/interface",
-  "version": "0.1.5",
+  "version": "0.1.6-0b4a2ee79",
   "description": "The interface implemented by a libp2p node",
   "license": "Apache-2.0 OR MIT",
-  "homepage": "https://github.com/libp2p/js-libp2p/tree/master/packages/interface#readme",
+  "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/interface#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/libp2p/js-libp2p.git"
@@ -39,9 +39,6 @@
     "!dist/test",
     "!**/*.tsbuildinfo"
   ],
-  "browser": {
-    "events": "./dist/src/events.browser.js"
-  },
   "exports": {
     ".": {
       "types": "./dist/src/index.d.ts",
@@ -150,7 +147,7 @@
   "scripts": {
     "clean": "aegir clean",
     "lint": "aegir lint",
-    "dep-check": "aegir dep-check",
+    "dep-check": "aegir dep-check -i @libp2p/utils",
     "build": "aegir build",
     "test": "aegir test",
     "test:chrome": "aegir test -t browser --cov",
@@ -161,22 +158,19 @@
     "test:electron-main": "aegir test -t electron-main"
   },
   "dependencies": {
-    "@multiformats/multiaddr": "^12.1.5",
-    "abortable-iterator": "^5.0.1",
-    "it-pushable": "^3.2.0",
+    "@multiformats/multiaddr": "^12.1.10",
+    "it-pushable": "^3.2.1",
     "it-stream-types": "^2.0.1",
-    "multiformats": "^12.0.1",
-    "p-defer": "^4.0.0",
-    "race-signal": "^1.0.0",
+    "multiformats": "^12.1.3",
     "uint8arraylist": "^2.4.3"
   },
   "devDependencies": {
-    "@types/sinon": "^10.0.15",
+    "@types/sinon": "^17.0.0",
     "aegir": "^41.0.2",
-    "delay": "^6.0.0",
-    "it-all": "^3.0.3",
-    "it-drain": "^3.0.3",
     "sinon": "^17.0.0",
     "sinon-ts": "^2.0.0"
+  },
+  "browser": {
+    "events": "./dist/src/events.browser.js"
   }
 }

package/src/connection/index.ts

@@ -1,4 +1,4 @@
-import type { AbortOptions } from '../index.js'
+import type { AbortOptions, Logger } from '../index.js'
 import type { PeerId } from '../peer-id/index.js'
 import type { Multiaddr } from '@multiformats/multiaddr'
 import type { Duplex, Source } from 'it-stream-types'
@@ -169,6 +169,11 @@ export interface Stream extends Duplex<AsyncGenerator<Uint8ArrayList>, Source<Ui
    * The current status of the writable end of the stream
    */
   writeStatus: WriteStatus
+
+  /**
+   * The stream logger
+   */
+  log: Logger
 }
 
 export interface NewStreamOptions extends AbortOptions {
@@ -268,6 +273,11 @@ export interface Connection {
    * Immediately close the connection, any queued data will be discarded
    */
   abort(err: Error): void
+
+  /**
+   * The connection logger
+   */
+  log: Logger
 }
 
 export const symbol = Symbol.for('@libp2p/connection')
@@ -329,4 +339,9 @@ export interface MultiaddrConnection extends Duplex<AsyncGenerator<Uint8Array>,
    * When connection lifecycle events occurred
    */
   timeline: MultiaddrConnectionTimeline
+
+  /**
+   * The multiaddr connection logger
+   */
+  log: Logger
 }

package/src/errors.ts

@@ -65,3 +65,10 @@ export class InvalidCryptoTransmissionError extends Error {
 
   static readonly code = 'ERR_INVALID_CRYPTO_TRANSMISSION'
 }
+
+// Error codes
+
+export const ERR_TIMEOUT = 'ERR_TIMEOUT'
+export const ERR_INVALID_PARAMETERS = 'ERR_INVALID_PARAMETERS'
+export const ERR_NOT_FOUND = 'ERR_NOT_FOUND'
+export const ERR_INVALID_MESSAGE = 'ERR_INVALID_MESSAGE'

package/src/index.ts

@@ -17,7 +17,6 @@
 import type { Connection, NewStreamOptions, Stream } from './connection/index.js'
 import type { ContentRouting } from './content-routing/index.js'
 import type { TypedEventTarget } from './events.js'
-import type { KeyChain } from './keychain/index.js'
 import type { Metrics } from './metrics/index.js'
 import type { PeerId } from './peer-id/index.js'
 import type { PeerInfo } from './peer-info/index.js'
@@ -106,6 +105,23 @@ export interface IdentifyResult {
   connection: Connection
 }
 
+/**
+ * Logger component for libp2p
+ */
+export interface Logger {
+  (formatter: any, ...args: any[]): void
+  error(formatter: any, ...args: any[]): void
+  trace(formatter: any, ...args: any[]): void
+  enabled: boolean
+}
+
+/**
+ * Peer logger component for libp2p
+ */
+export interface ComponentLogger {
+  forComponent(name: string): Logger
+}
+
 /**
  * Once you have a libp2p instance, you can listen to several events it emits,
  * so that you can be notified of relevant network events.
@@ -377,20 +393,6 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    */
   contentRouting: ContentRouting
 
-  /**
-   * The keychain contains the keys used by the current node, and can create new
-   * keys, export them, import them, etc.
-   *
-   * @example
-   *
-   * ```js
-   * const keyInfo = await libp2p.keychain.createKey('new key')
-   * console.info(keyInfo)
-   * // { id: '...', name: 'new key' }
-   * ```
-   */
-  keychain: KeyChain
-
   /**
    * The metrics subsystem allows recording values to assess the health/performance
    * of the running node.
@@ -408,6 +410,8 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    */
   metrics?: Metrics
 
+  logger: ComponentLogger
+
   /**
    * Get a deduplicated list of peer advertising multiaddrs by concatenating
    * the listen addresses used by transports with any configured
@@ -605,6 +609,21 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
   services: T
 }
 
+/**
+ * Metadata about the current node
+ */
+export interface NodeInfo {
+  /**
+   * The implementation name
+   */
+  name: string
+
+  /**
+   * The implementation version
+   */
+  version: string
+}
+
 /**
  * An object that contains an AbortSignal as
  * the optional `signal` property.
@@ -626,6 +645,13 @@ export interface AbortOptions {
   signal?: AbortSignal
 }
 
+/**
+ * An object that contains a Logger as the `log` property.
+ */
+export interface LoggerOptions {
+  log: Logger
+}
+
 /**
  * Returns a new type with all fields marked optional.
  *

package/src/peer-info/index.ts

@@ -1,8 +1,20 @@
 import type { PeerId } from '../peer-id/index.js'
 import type { Multiaddr } from '@multiformats/multiaddr'
 
+/**
+ * A `PeerInfo` is a lightweight object that represents a remote peer, it can be
+ * obtained from peer discovery mechanisms, HTTP RPC endpoints, etc.
+ *
+ * @see https://docs.libp2p.io/concepts/fundamentals/peers/#peer-info
+ */
 export interface PeerInfo {
+  /**
+   * The identifier of the remote peer
+   */
   id: PeerId
+
+  /**
+   * The multiaddrs a peer is listening on
+   */
   multiaddrs: Multiaddr[]
-  protocols: string[]
 }

package/src/startable.ts

@@ -2,8 +2,6 @@
  * Implemented by components that have a lifecycle
  */
 export interface Startable {
-  isStarted(): boolean
-
   /**
    * If implemented, this method will be invoked before the start method.
    *