@libp2p/yamux 7.0.4

package/dist/src/stream.js

@@ -0,0 +1,240 @@
+import { AbstractStream } from '@libp2p/utils';
+import { Uint8ArrayList } from 'uint8arraylist';
+import { defaultConfig } from './config.js';
+import { INITIAL_STREAM_WINDOW } from './constants.js';
+import { isDataFrame } from "./decode.js";
+import { InvalidFrameError, ReceiveWindowExceededError } from './errors.js';
+import { Flag, FrameType, HEADER_LENGTH } from './frame.js';
+export var StreamState;
+(function (StreamState) {
+    StreamState[StreamState["Init"] = 0] = "Init";
+    StreamState[StreamState["SYNSent"] = 1] = "SYNSent";
+    StreamState[StreamState["SYNReceived"] = 2] = "SYNReceived";
+    StreamState[StreamState["Established"] = 3] = "Established";
+    StreamState[StreamState["Finished"] = 4] = "Finished";
+    StreamState[StreamState["Paused"] = 5] = "Paused";
+})(StreamState || (StreamState = {}));
+/** YamuxStream is used to represent a logical stream within a session */
+export class YamuxStream extends AbstractStream {
+    streamId;
+    state;
+    /** The number of available bytes to send */
+    sendWindowCapacity;
+    /** The number of bytes available to receive in a full window */
+    recvWindow;
+    /** The number of available bytes to receive */
+    recvWindowCapacity;
+    maxStreamWindowSize;
+    /**
+     * An 'epoch' is the time it takes to process and read data
+     *
+     * Used in conjunction with RTT to determine whether to increase the recvWindow
+     */
+    epochStart;
+    getRTT;
+    sendFrame;
+    constructor(init) {
+        super({
+            ...init,
+            maxMessageSize: (init.maxMessageSize ?? defaultConfig.maxMessageSize) - HEADER_LENGTH
+        });
+        this.streamId = init.streamId;
+        this.state = init.state;
+        this.sendWindowCapacity = INITIAL_STREAM_WINDOW;
+        this.recvWindow = init.initialStreamWindowSize ?? defaultConfig.initialStreamWindowSize;
+        this.recvWindowCapacity = this.recvWindow;
+        this.maxStreamWindowSize = init.maxStreamWindowSize ?? defaultConfig.maxStreamWindowSize;
+        this.epochStart = Date.now();
+        this.getRTT = init.getRTT;
+        this.sendFrame = init.sendFrame;
+        const setStateToFinishedOnCloseListener = () => {
+            this.state = StreamState.Finished;
+        };
+        this.addEventListener('close', setStateToFinishedOnCloseListener);
+    }
+    /**
+     * Send a data message to the remote muxer
+     */
+    sendData(buf) {
+        const totalBytes = buf.byteLength;
+        let sentBytes = 0;
+        let canSendMore = true;
+        // send in chunks, waiting for window updates
+        while (buf.byteLength !== 0) {
+            // we exhausted the send window, sending will resume later
+            if (this.sendWindowCapacity === 0) {
+                canSendMore = false;
+                this.log?.trace('sent %d/%d bytes, wait for send window update, status %s', sentBytes, totalBytes, this.status);
+                break;
+            }
+            // send as much as we can
+            const toSend = Math.min(this.sendWindowCapacity, buf.length);
+            const flags = this.getSendFlags();
+            const muxerSendMore = this.sendFrame({
+                type: FrameType.Data,
+                flag: flags,
+                streamID: this.streamId,
+                length: toSend
+            }, buf.sublist(0, toSend));
+            this.sendWindowCapacity -= toSend;
+            sentBytes += toSend;
+            buf.consume(toSend);
+            if (!muxerSendMore) {
+                canSendMore = muxerSendMore;
+                this.log('sent %d/%d bytes, wait for muxer to have more send capacity', sentBytes, totalBytes);
+                break;
+            }
+        }
+        return {
+            sentBytes,
+            canSendMore
+        };
+    }
+    /**
+     * Send a reset message to the remote muxer
+     */
+    async sendReset() {
+        this.sendFrame({
+            type: FrameType.WindowUpdate,
+            flag: Flag.RST,
+            streamID: this.streamId,
+            length: 0
+        });
+    }
+    /**
+     * Send a message to the remote muxer, informing them no more data messages
+     * will be sent by this end of the stream
+     */
+    async sendCloseWrite() {
+        const flags = this.getSendFlags() | Flag.FIN;
+        this.sendFrame({
+            type: FrameType.WindowUpdate,
+            flag: flags,
+            streamID: this.streamId,
+            length: 0
+        });
+    }
+    /**
+     * Send a message to the remote muxer, informing them no more data messages
+     * will be read by this end of the stream - this is a no-op on Yamux streams
+     */
+    async sendCloseRead(options) {
+        options?.signal?.throwIfAborted();
+    }
+    /**
+     * Stop sending window updates temporarily - in the interim the the remote
+     * send window will exhaust and the remote will stop sending data
+     */
+    sendPause() {
+        this.state = StreamState.Paused;
+    }
+    /**
+     * Start sending window updates as normal
+     */
+    sendResume() {
+        this.state = StreamState.Established;
+        this.sendWindowUpdate();
+    }
+    /**
+     * handleWindowUpdate is called when the stream receives a window update frame
+     */
+    handleWindowUpdate(frame) {
+        this.processFlags(frame.header.flag);
+        // increase send window
+        const available = this.sendWindowCapacity;
+        this.sendWindowCapacity += frame.header.length;
+        // if the update increments a 0 availability, notify the stream that sending can resume
+        if (available === 0 && frame.header.length > 0) {
+            this.log?.trace('window update of %d bytes allows more data to be sent', frame.header.length);
+            this.safeDispatchEvent('drain');
+        }
+    }
+    /**
+     * handleData is called when the stream receives a data frame
+     */
+    handleData(frame) {
+        if (!isDataFrame(frame)) {
+            throw new InvalidFrameError('Frame was not data frame');
+        }
+        this.processFlags(frame.header.flag);
+        // check that our recv window is not exceeded
+        if (this.recvWindowCapacity < frame.header.length) {
+            throw new ReceiveWindowExceededError('Receive window exceeded');
+        }
+        this.recvWindowCapacity -= frame.header.length;
+        this.onData(frame.data);
+        this.sendWindowUpdate();
+    }
+    /**
+     * processFlags is used to update the state of the stream based on set flags, if any.
+     */
+    processFlags(flags) {
+        if ((flags & Flag.ACK) === Flag.ACK) {
+            if (this.state === StreamState.SYNSent) {
+                this.state = StreamState.Established;
+            }
+        }
+        if ((flags & Flag.FIN) === Flag.FIN) {
+            this.onRemoteCloseWrite();
+        }
+        if ((flags & Flag.RST) === Flag.RST) {
+            this.onRemoteReset();
+        }
+    }
+    /**
+     * getSendFlags determines any flags that are appropriate
+     * based on the current stream state.
+     *
+     * The state is updated as a side-effect.
+     */
+    getSendFlags() {
+        switch (this.state) {
+            case StreamState.Init:
+                this.state = StreamState.SYNSent;
+                return Flag.SYN;
+            case StreamState.SYNReceived:
+                this.state = StreamState.Established;
+                return Flag.ACK;
+            default:
+                return 0;
+        }
+    }
+    /**
+     * Potentially sends a window update enabling further remote writes to take
+     * place.
+     */
+    sendWindowUpdate() {
+        // determine the flags if any
+        const flags = this.getSendFlags();
+        // If the stream has already been established
+        // and we've processed data within the time it takes for 4 round trips
+        // then we (up to) double the recvWindow
+        const now = Date.now();
+        const rtt = this.getRTT();
+        if (flags === 0 && rtt > -1 && now - this.epochStart < rtt * 4) {
+            // we've already validated that maxStreamWindowSize can't be more than MAX_UINT32
+            this.recvWindow = Math.min(this.recvWindow * 2, this.maxStreamWindowSize);
+        }
+        if (this.recvWindowCapacity >= this.recvWindow && flags === 0) {
+            // a window update isn't needed
+            return;
+        }
+        if (this.state === StreamState.Paused) {
+            // we don't want any more data from the remote right now
+            return;
+        }
+        // update the receive window
+        const delta = this.recvWindow - this.recvWindowCapacity;
+        this.recvWindowCapacity = this.recvWindow;
+        // update the epoch start
+        this.epochStart = now;
+        // send window update
+        this.sendFrame({
+            type: FrameType.WindowUpdate,
+            flag: flags,
+            streamID: this.streamId,
+            length: delta
+        });
+    }
+}
+//# sourceMappingURL=stream.js.map

package/dist/src/stream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream.js","sourceRoot":"","sources":["../../src/stream.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAAE,iBAAiB,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAA;AAC3E,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAM3D,MAAM,CAAN,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,6CAAI,CAAA;IACJ,mDAAO,CAAA;IACP,2DAAW,CAAA;IACX,2DAAW,CAAA;IACX,qDAAQ,CAAA;IACR,iDAAM,CAAA;AACR,CAAC,EAPW,WAAW,KAAX,WAAW,QAOtB;AAYD,yEAAyE;AACzE,MAAM,OAAO,WAAY,SAAQ,cAAc;IAC7C,QAAQ,CAAQ;IAChB,KAAK,CAAa;IAElB,4CAA4C;IACpC,kBAAkB,CAAQ;IAClC,gEAAgE;IACxD,UAAU,CAAQ;IAC1B,+CAA+C;IACvC,kBAAkB,CAAQ;IAC1B,mBAAmB,CAAQ;IAEnC;;;;OAIG;IACK,UAAU,CAAQ;IACT,MAAM,CAAc;IAEpB,SAAS,CAAyD;IAEnF,YAAa,IAAqB;QAChC,KAAK,CAAC;YACJ,GAAG,IAAI;YACP,cAAc,EAAE,CAAC,IAAI,CAAC,cAAc,IAAI,aAAa,CAAC,cAAc,CAAC,GAAG,aAAa;SACtF,CAAC,CAAA;QAEF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;QAC7B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;QACvB,IAAI,CAAC,kBAAkB,GAAG,qBAAqB,CAAA;QAC/C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,uBAAuB,IAAI,aAAa,CAAC,uBAAuB,CAAA;QACvF,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,UAAU,CAAA;QACzC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAAmB,IAAI,aAAa,CAAC,mBAAmB,CAAA;QACxF,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAC5B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;QACzB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;QAE/B,MAAM,iCAAiC,GAAG,GAAS,EAAE;YACnD,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,QAAQ,CAAA;QACnC,CAAC,CAAA;QACD,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,iCAAiC,CAAC,CAAA;IACnE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAE,GAAmB;QAC3B,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAA;QACjC,IAAI,SAAS,GAAG,CAAC,CAAA;QACjB,IAAI,WAAW,GAAG,IAAI,CAAA;QAEtB,6CAA6C;QAC7C,OAAO,GAAG,CAAC,UAAU,KAAK,CAAC,EAAE,CAAC;YAC5B,0DAA0D;YAC1D,IAAI,IAAI,CAAC,kBAAkB,KAAK,CAAC,EAAE,CAAC;gBAClC,WAAW,GAAG,KAAK,CAAA;gBACnB,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,0DAA0D,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;gBAC/G,MAAK;YACP,CAAC;YAED,yBAAyB;YACzB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;YAC5D,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAA;YAEjC,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC;gBACnC,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,IAAI,EAAE,KAAK;gBACX,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,MAAM,EAAE,MAAM;aACf,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAA;YAE1B,IAAI,CAAC,kBAAkB,IAAI,MAAM,CAAA;YAEjC,SAAS,IAAI,MAAM,CAAA;YACnB,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;YAEnB,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,WAAW,GAAG,aAAa,CAAA;gBAC3B,IAAI,CAAC,GAAG,CAAC,6DAA6D,EAAE,SAAS,EAAE,UAAU,CAAC,CAAA;gBAC9F,MAAK;YACP,CAAC;QACH,CAAC;QAED,OAAO;YACL,SAAS;YACT,WAAW;SACZ,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS;QACb,IAAI,CAAC,SAAS,CAAC;YACb,IAAI,EAAE,SAAS,CAAC,YAAY;YAC5B,IAAI,EAAE,IAAI,CAAC,GAAG;YACd,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,MAAM,EAAE,CAAC;SACV,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc;QAClB,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC,GAAG,CAAA;QAC5C,IAAI,CAAC,SAAS,CAAC;YACb,IAAI,EAAE,SAAS,CAAC,YAAY;YAC5B,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,MAAM,EAAE,CAAC;SACV,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa,CAAE,OAAsB;QACzC,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,CAAA;IACnC,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,MAAM,CAAA;IACjC,CAAC;IAED;;OAEG;IACH,UAAU;QACR,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,WAAW,CAAA;QACpC,IAAI,CAAC,gBAAgB,EAAE,CAAA;IACzB,CAAC;IAED;;OAEG;IACH,kBAAkB,CAAE,KAAY;QAC9B,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAEpC,uBAAuB;QACvB,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAA;QACzC,IAAI,CAAC,kBAAkB,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAA;QAE9C,uFAAuF;QACvF,IAAI,SAAS,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/C,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,uDAAuD,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;YAC7F,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAA;QACjC,CAAC;IACH,CAAC;IAED;;OAEG;IACH,UAAU,CAAE,KAAY;QACtB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,iBAAiB,CAAC,0BAA0B,CAAC,CAAA;QACzD,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAEpC,6CAA6C;QAC7C,IAAI,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YAClD,MAAM,IAAI,0BAA0B,CAAC,yBAAyB,CAAC,CAAA;QACjE,CAAC;QAED,IAAI,CAAC,kBAAkB,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAA;QAE9C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAEvB,IAAI,CAAC,gBAAgB,EAAE,CAAA;IACzB,CAAC;IAED;;OAEG;IACK,YAAY,CAAE,KAAa;QACjC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC;YACpC,IAAI,IAAI,CAAC,KAAK,KAAK,WAAW,CAAC,OAAO,EAAE,CAAC;gBACvC,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,WAAW,CAAA;YACtC,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC;YACpC,IAAI,CAAC,kBAAkB,EAAE,CAAA;QAC3B,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC;YACpC,IAAI,CAAC,aAAa,EAAE,CAAA;QACtB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,YAAY;QAClB,QAAQ,IAAI,CAAC,KAAK,EAAE,CAAC;YACnB,KAAK,WAAW,CAAC,IAAI;gBACnB,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,OAAO,CAAA;gBAChC,OAAO,IAAI,CAAC,GAAG,CAAA;YACjB,KAAK,WAAW,CAAC,WAAW;gBAC1B,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,WAAW,CAAA;gBACpC,OAAO,IAAI,CAAC,GAAG,CAAA;YACjB;gBACE,OAAO,CAAC,CAAA;QACZ,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,gBAAgB;QACd,6BAA6B;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,CAAA;QAEjC,6CAA6C;QAC7C,sEAAsE;QACtE,wCAAwC;QACxC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACtB,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAA;QACzB,IAAI,KAAK,KAAK,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,IAAI,GAAG,GAAG,IAAI,CAAC,UAAU,GAAG,GAAG,GAAG,CAAC,EAAE,CAAC;YAC/D,iFAAiF;YACjF,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAA;QAC3E,CAAC;QAED,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI,CAAC,UAAU,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YAC9D,+BAA+B;YAC/B,OAAM;QACR,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,KAAK,WAAW,CAAC,MAAM,EAAE,CAAC;YACtC,wDAAwD;YACxD,OAAM;QACR,CAAC;QAED,4BAA4B;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAA;QACvD,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,UAAU,CAAA;QAEzC,yBAAyB;QACzB,IAAI,CAAC,UAAU,GAAG,GAAG,CAAA;QAErB,qBAAqB;QACrB,IAAI,CAAC,SAAS,CAAC;YACb,IAAI,EAAE,SAAS,CAAC,YAAY;YAC5B,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,MAAM,EAAE,KAAK;SACd,CAAC,CAAA;IACJ,CAAC;CACF"}

package/package.json

@@ -0,0 +1,188 @@
+{
+  "name": "@libp2p/yamux",
+  "version": "7.0.4",
+  "description": "Yamux stream multiplexer for libp2p",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/ChainSafe/js-libp2p-yamux#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ChainSafe/js-libp2p-yamux.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ChainSafe/js-libp2p-yamux/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "IPFS",
+    "libp2p",
+    "multiplexer",
+    "muxer",
+    "stream"
+  ],
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ],
+      "src/*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ]
+    }
+  },
+  "files": [
+    "src",
+    "dist",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
+    },
+    "./config": {
+      "types": "./dist/src/config.d.ts",
+      "import": "./dist/src/config.js"
+    },
+    "./stream": {
+      "types": "./dist/src/stream.d.ts",
+      "import": "./dist/src/stream.js"
+    }
+  },
+  "release": {
+    "branches": [
+      "master"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "major"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "type": "deps",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "docs",
+                "section": "Documentation"
+              },
+              {
+                "type": "deps",
+                "section": "Dependencies"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      [
+        "@semantic-release/git",
+        {
+          "assets": [
+            "CHANGELOG.md",
+            "package.json"
+          ]
+        }
+      ]
+    ]
+  },
+  "scripts": {
+    "clean": "aegir clean",
+    "lint": "aegir lint",
+    "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
+    "benchmark": "benchmark dist/test/bench/*.bench.js --timeout 400000",
+    "build": "aegir build",
+    "test": "aegir test",
+    "test:chrome": "aegir test -t browser",
+    "test:chrome-webworker": "aegir test -t webworker",
+    "test:firefox": "aegir test -t browser -- --browser firefox",
+    "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
+    "test:node": "aegir test -t node --cov",
+    "test:electron-main": "aegir test -t electron-main",
+    "release": "aegir release",
+    "docs": "aegir docs"
+  },
+  "dependencies": {
+    "@libp2p/interface": "^2.0.0",
+    "@libp2p/utils": "^6.0.0",
+    "race-signal": "^2.0.0",
+    "uint8arraylist": "^2.4.8"
+  },
+  "devDependencies": {
+    "@dapplion/benchmark": "^1.0.0",
+    "@libp2p/interface-compliance-tests": "^6.4.12",
+    "@libp2p/mplex": "^11.0.0",
+    "aegir": "^47.0.17",
+    "it-all": "^3.0.9",
+    "it-drain": "^3.0.5",
+    "it-pushable": "^3.2.3",
+    "p-event": "^6.0.1"
+  }
+}

package/src/config.ts

@@ -0,0 +1,66 @@
+import { InvalidParametersError } from '@libp2p/interface'
+import { INITIAL_STREAM_WINDOW, MAX_STREAM_WINDOW } from './constants.js'
+import type { StreamMuxerOptions } from '@libp2p/interface'
+
+// TODO use config items or delete them
+export interface Config extends StreamMuxerOptions {
+  /**
+   * Used to do periodic keep alive messages using a ping.
+   */
+  enableKeepAlive?: boolean
+
+  /**
+   * How often to perform the keep alive
+   *
+   * measured in milliseconds
+   */
+  keepAliveInterval?: number
+
+  /**
+   * Used to control the initial window size that we allow for a stream.
+   *
+   * measured in bytes
+   */
+  initialStreamWindowSize?: number
+
+  /**
+   * Used to control the maximum window size that we allow for a stream.
+   */
+  maxStreamWindowSize?: number
+}
+
+export const defaultConfig: Required<Config> = {
+  enableKeepAlive: true,
+  keepAliveInterval: 30_000,
+  maxInboundStreams: 1_000,
+  maxOutboundStreams: 1_000,
+  initialStreamWindowSize: INITIAL_STREAM_WINDOW,
+  maxStreamWindowSize: MAX_STREAM_WINDOW,
+  maxMessageSize: 64 * 1024,
+  maxEarlyStreams: 10,
+  streamOptions: {}
+}
+
+export function verifyConfig (config: Config): void {
+  if (config.keepAliveInterval != null && config.keepAliveInterval <= 0) {
+    throw new InvalidParametersError('keep-alive interval must be positive')
+  }
+  if (config.maxInboundStreams != null && config.maxInboundStreams < 0) {
+    throw new InvalidParametersError('max inbound streams must be larger or equal 0')
+  }
+  if (config.maxOutboundStreams != null && config.maxOutboundStreams < 0) {
+    throw new InvalidParametersError('max outbound streams must be larger or equal 0')
+  }
+  if (config.initialStreamWindowSize != null && config.initialStreamWindowSize < INITIAL_STREAM_WINDOW) {
+    throw new InvalidParametersError('InitialStreamWindowSize must be larger or equal 256 kB')
+  }
+  if (config.maxStreamWindowSize != null && config.initialStreamWindowSize != null && config.maxStreamWindowSize < config.initialStreamWindowSize) {
+    throw new InvalidParametersError('MaxStreamWindowSize must be larger than the InitialStreamWindowSize')
+  }
+  if (config.maxStreamWindowSize != null && config.maxStreamWindowSize > 2 ** 32 - 1) {
+    throw new InvalidParametersError('MaxStreamWindowSize must be less than equal MAX_UINT32')
+  }
+  if (config.maxMessageSize != null && config.maxMessageSize < 1024) {
+    throw new InvalidParametersError('MaxMessageSize must be greater than a kilobyte')
+  }
+}

package/src/constants.ts

@@ -0,0 +1,25 @@
+// Protocol violation errors
+
+import { BothClientsError, DecodeInvalidVersionError, InvalidFrameError, NotMatchingPingError, ReceiveWindowExceededError, StreamAlreadyExistsError, UnRequestedPingError } from './errors.js'
+
+export const PROTOCOL_ERRORS = new Set([
+  InvalidFrameError.name,
+  UnRequestedPingError.name,
+  NotMatchingPingError.name,
+  StreamAlreadyExistsError.name,
+  DecodeInvalidVersionError.name,
+  BothClientsError.name,
+  ReceiveWindowExceededError.name
+])
+
+/**
+ * INITIAL_STREAM_WINDOW is the initial stream window size.
+ *
+ * Not an implementation choice, this is defined in the specification
+ */
+export const INITIAL_STREAM_WINDOW = 256 * 1024
+
+/**
+ * Default max stream window
+ */
+export const MAX_STREAM_WINDOW = 16 * 1024 * 1024

package/src/decode.ts

@@ -0,0 +1,104 @@
+import { Uint8ArrayList } from 'uint8arraylist'
+import { InvalidFrameError } from './errors.js'
+import { FrameType, HEADER_LENGTH, YAMUX_VERSION } from './frame.js'
+import type { FrameHeader } from './frame.js'
+
+export interface Frame {
+  header: FrameHeader
+  data?: Uint8ArrayList
+}
+
+export interface DataFrame {
+  header: FrameHeader
+  data: Uint8ArrayList
+}
+
+export function isDataFrame (frame: Frame): frame is DataFrame {
+  return frame.header.type === FrameType.Data && frame.data !== null
+}
+
+// used to bit shift in decoding
+// native bit shift can overflow into a negative number, so we bit shift by
+// multiplying by a power of 2
+const twoPow24 = 2 ** 24
+
+/**
+ * Decode a header from the front of a buffer
+ *
+ * @param data - Assumed to have enough bytes for a header
+ */
+export function decodeHeader (data: Uint8Array): FrameHeader {
+  if (data[0] !== YAMUX_VERSION) {
+    throw new InvalidFrameError('Invalid frame version')
+  }
+
+  return {
+    type: data[1],
+    flag: (data[2] << 8) + data[3],
+    streamID: (data[4] * twoPow24) + (data[5] << 16) + (data[6] << 8) + data[7],
+    length: (data[8] * twoPow24) + (data[9] << 16) + (data[10] << 8) + data[11]
+  }
+}
+
+/**
+ * Decodes yamux frames from a source
+ */
+export class Decoder {
+  /** Buffer for in-progress frames */
+  private readonly buffer: Uint8ArrayList
+
+  constructor () {
+    this.buffer = new Uint8ArrayList()
+  }
+
+  /**
+   * Emits frames from the decoder source.
+   *
+   * Note: If `readData` is emitted, it _must_ be called before the next iteration
+   * Otherwise an error is thrown
+   */
+  * emitFrames (buf: Uint8Array | Uint8ArrayList): Generator<Frame> {
+    this.buffer.append(buf)
+
+    // Loop to consume as many bytes from the buffer as possible
+    // Eg: when a single chunk contains several frames
+    while (true) {
+      const frame = this.readFrame()
+
+      if (frame === undefined) {
+        break
+      }
+
+      yield frame
+    }
+  }
+
+  private readFrame (): Frame | undefined {
+    let frameSize = HEADER_LENGTH
+
+    if (this.buffer.byteLength < HEADER_LENGTH) {
+      // not enough data yet
+      return
+    }
+
+    const header = decodeHeader(this.buffer.subarray(0, HEADER_LENGTH))
+
+    if (header.type === FrameType.Data) {
+      frameSize += header.length
+
+      if (this.buffer.byteLength < frameSize) {
+        // not enough data yet
+        return
+      }
+
+      const data = this.buffer.sublist(HEADER_LENGTH, frameSize)
+      this.buffer.consume(frameSize)
+
+      return { header, data }
+    }
+
+    this.buffer.consume(frameSize)
+
+    return { header }
+  }
+}

package/src/encode.ts

@@ -0,0 +1,26 @@
+import { HEADER_LENGTH } from './frame.js'
+import type { FrameHeader } from './frame.js'
+
+export function encodeHeader (header: FrameHeader): Uint8Array {
+  const frame = new Uint8Array(HEADER_LENGTH)
+
+  // always assume version 0
+  // frameView.setUint8(0, header.version)
+
+  frame[1] = header.type
+
+  frame[2] = header.flag >>> 8
+  frame[3] = header.flag
+
+  frame[4] = header.streamID >>> 24
+  frame[5] = header.streamID >>> 16
+  frame[6] = header.streamID >>> 8
+  frame[7] = header.streamID
+
+  frame[8] = header.length >>> 24
+  frame[9] = header.length >>> 16
+  frame[10] = header.length >>> 8
+  frame[11] = header.length
+
+  return frame
+}