smoldot 1.0.0 → 1.0.1

package/dist/cjs/instance/bindings-smoldot-light.d.ts

@@ -63,12 +63,33 @@ export interface Connection {
     /**
      * Queues data to be sent on the given connection.
      *
-     * The connection must currently be in the `Open` state.
+     * The connection and stream must currently be in the `Open` state.
+     *
+     * The number of bytes most never exceed the number of "writable bytes" of the stream.
+     * `onWritableBytes` can be used in order to notify that more writable bytes are available.
      *
      * The `streamId` must be provided if and only if the connection is of type "multi-stream".
      * It indicates which substream to send the data on.
+     *
+     * Must not be called after `closeSend` has been called.
      */
     send(data: Uint8Array, streamId?: number): void;
+    /**
+     * Closes the writing side of the given stream of the given connection.
+     *
+     * Never called for connection types where this isn't possible to implement (i.e. WebSocket
+     * and WebRTC at the moment).
+     *
+     * The connection and stream must currently be in the `Open` state.
+     *
+     * Implicitly sets the "writable bytes" of the stream to zero.
+     *
+     * The `streamId` must be provided if and only if the connection is of type "multi-stream".
+     * It indicates which substream to send the data on.
+     *
+     * Must only be called once per stream.
+     */
+    closeSend(streamId?: number): void;
     /**
      * Start opening an additional outbound substream on the given connection.
      *
@@ -104,6 +125,8 @@ export interface ConnectionConfig {
     onOpen: (info: {
         type: 'single-stream';
         handshake: 'multistream-select-noise-yamux';
+        initialWritableBytes: number;
+        writeClosable: boolean;
     } | {
         type: 'multi-stream';
         handshake: 'webrtc';
@@ -121,7 +144,7 @@ export interface ConnectionConfig {
      *
      * This function must only be called for connections of type "multi-stream".
      */
-    onStreamOpened: (streamId: number, direction: 'inbound' | 'outbound') => void;
+    onStreamOpened: (streamId: number, direction: 'inbound' | 'outbound', initialWritableBytes: number) => void;
     /**
      * Callback called when a stream transitions to the `Reset` state.
      *
@@ -130,6 +153,17 @@ export interface ConnectionConfig {
      * This function must only be called for connections of type "multi-stream".
      */
     onStreamReset: (streamId: number) => void;
+    /**
+     * Callback called when more data can be written on the stream.
+     *
+     * Can only happen while the connection is in the `Open` state.
+     *
+     * This callback must not be called after `closeSend` has been called.
+     *
+     * The `streamId` parameter must be provided if and only if the connection is of type
+     * "multi-stream".
+     */
+    onWritableBytes: (numExtra: number, streamId?: number) => void;
     /**
      * Callback called when a message sent by the remote has been received.
      *

package/dist/cjs/instance/bindings-smoldot-light.js

@@ -97,7 +97,7 @@ function default_1(config) {
             // In browsers, `setTimeout` works as expected when `ms` equals 0. However, NodeJS
             // requires a minimum of 1 millisecond (if `0` is passed, it is automatically replaced
             // with `1`) and wants you to use `setImmediate` instead.
-            if (ms == 0 && typeof setImmediate === "function") {
+            if (ms < 1 && typeof setImmediate === "function") {
                 setImmediate(() => {
                     if (killedTracked.killed)
                         return;
@@ -140,7 +140,7 @@ function default_1(config) {
                         try {
                             switch (info.type) {
                                 case 'single-stream': {
-                                    instance.exports.connection_open_single_stream(connectionId, 0);
+                                    instance.exports.connection_open_single_stream(connectionId, 0, info.initialWritableBytes, info.writeClosable ? 1 : 0);
                                     break;
                                 }
                                 case 'multi-stream': {
@@ -168,6 +168,14 @@ function default_1(config) {
                         }
                         catch (_error) { }
                     },
+                    onWritableBytes: (numExtra, streamId) => {
+                        if (killedTracked.killed)
+                            return;
+                        try {
+                            instance.exports.stream_writable_bytes(connectionId, streamId || 0, numExtra);
+                        }
+                        catch (_error) { }
+                    },
                     onMessage: (message, streamId) => {
                         if (killedTracked.killed)
                             return;
@@ -178,11 +186,11 @@ function default_1(config) {
                         }
                         catch (_error) { }
                     },
-                    onStreamOpened: (streamId, direction) => {
+                    onStreamOpened: (streamId, direction, initialWritableBytes) => {
                         if (killedTracked.killed)
                             return;
                         try {
-                            instance.exports.connection_stream_opened(connectionId, streamId, direction === 'outbound' ? 1 : 0);
+                            instance.exports.connection_stream_opened(connectionId, streamId, direction === 'outbound' ? 1 : 0, initialWritableBytes);
                         }
                         catch (_error) { }
                     },
@@ -244,6 +252,12 @@ function default_1(config) {
             const connection = connections[connectionId];
             connection.send(data, streamId); // TODO: docs says the streamId is provided only for multi-stream connections, but here it's always provided
         },
+        stream_send_close: (connectionId, streamId) => {
+            if (killedTracked.killed)
+                return;
+            const connection = connections[connectionId];
+            connection.closeSend(streamId); // TODO: docs says the streamId is provided only for multi-stream connections, but here it's always provided
+        },
         current_task_entered: (ptr, len) => {
             if (killedTracked.killed)
                 return;

package/dist/cjs/instance/bindings.d.ts

@@ -19,10 +19,11 @@ export interface SmoldotWasmExports extends WebAssembly.Exports {
     json_rpc_responses_peek: (chainId: number) => number;
     json_rpc_responses_pop: (chainId: number) => void;
     timer_finished: (timerId: number) => void;
-    connection_open_single_stream: (connectionId: number, handshakeTy: number) => void;
+    connection_open_single_stream: (connectionId: number, handshakeTy: number, initialWritableBytes: number, writeClosable: number) => void;
     connection_open_multi_stream: (connectionId: number, handshakeTyPtr: number, handshakeTyLen: number) => void;
+    stream_writable_bytes: (connectionId: number, streamId: number, numBytes: number) => void;
     stream_message: (connectionId: number, streamId: number, ptr: number, len: number) => void;
-    connection_stream_opened: (connectionId: number, streamId: number, outbound: number) => void;
+    connection_stream_opened: (connectionId: number, streamId: number, outbound: number, initialWritableBytes: number) => void;
     connection_reset: (connectionId: number, ptr: number, len: number) => void;
     stream_reset: (connectionId: number, streamId: number) => void;
 }

package/dist/mjs/index-browser.js

@@ -40,6 +40,8 @@ export function start(options) {
             return Promise.resolve(inflate(classicDecode(input)));
         },
         registerShouldPeriodicallyYield: (callback) => {
+            if (typeof document === 'undefined') // We might be in a web worker.
+                return [false, () => { }];
             const wrappedCallback = () => callback(document.visibilityState === 'visible');
             document.addEventListener('visibilitychange', wrappedCallback);
             return [document.visibilityState === 'visible', () => { document.removeEventListener('visibilitychange', wrappedCallback); }];
@@ -68,9 +70,8 @@ function connect(config, forbidWs, forbidNonLocalWs, forbidWss, forbidWebRTC) {
     // Attempt to parse the multiaddress.
     // TODO: remove support for `/wss` in a long time (https://github.com/paritytech/smoldot/issues/1940)
     const wsParsed = config.address.match(/^\/(ip4|ip6|dns4|dns6|dns)\/(.*?)\/tcp\/(.*?)\/(ws|wss|tls\/ws)$/);
-    const webRTCParsed = config.address.match(/^\/(ip4|ip6)\/(.*?)\/udp\/(.*?)\/webrtc\/certhash\/(.*?)$/);
+    const webRTCParsed = config.address.match(/^\/(ip4|ip6)\/(.*?)\/udp\/(.*?)\/webrtc-direct\/certhash\/(.*?)$/);
     if (wsParsed != null) {
-        let connection;
         const proto = (wsParsed[4] == 'ws') ? 'ws' : 'wss';
         if ((proto == 'ws' && forbidWs) ||
             (proto == 'ws' && wsParsed[2] != 'localhost' && wsParsed[2] != '127.0.0.1' && forbidNonLocalWs) ||
@@ -80,10 +81,36 @@ function connect(config, forbidWs, forbidNonLocalWs, forbidWss, forbidWebRTC) {
         const url = (wsParsed[1] == 'ip6') ?
             (proto + "://[" + wsParsed[2] + "]:" + wsParsed[3]) :
             (proto + "://" + wsParsed[2] + ":" + wsParsed[3]);
-        connection = new WebSocket(url);
+        const connection = new WebSocket(url);
         connection.binaryType = 'arraybuffer';
+        const bufferedAmountCheck = { quenedUnreportedBytes: 0, nextTimeout: 10 };
+        const checkBufferedAmount = () => {
+            if (connection.readyState != 1)
+                return;
+            // Note that we might expect `bufferedAmount` to always be <= the sum of the lengths
+            // of all the data that has been sent, but that might not be the case. For this
+            // reason, we use `bufferedAmount` as a hint rather than a correct value.
+            const bufferedAmount = connection.bufferedAmount;
+            let wasSent = bufferedAmountCheck.quenedUnreportedBytes - bufferedAmount;
+            if (wasSent < 0)
+                wasSent = 0;
+            bufferedAmountCheck.quenedUnreportedBytes -= wasSent;
+            if (bufferedAmountCheck.quenedUnreportedBytes != 0) {
+                setTimeout(checkBufferedAmount, bufferedAmountCheck.nextTimeout);
+                bufferedAmountCheck.nextTimeout *= 2;
+                if (bufferedAmountCheck.nextTimeout > 500)
+                    bufferedAmountCheck.nextTimeout = 500;
+            }
+            // Note: it is important to call `onWritableBytes` at the very end, as it might
+            // trigger a call to `send`.
+            if (wasSent != 0)
+                config.onWritableBytes(wasSent);
+        };
         connection.onopen = () => {
-            config.onOpen({ type: 'single-stream', handshake: 'multistream-select-noise-yamux' });
+            config.onOpen({
+                type: 'single-stream', handshake: 'multistream-select-noise-yamux',
+                initialWritableBytes: 1024 * 1024, writeClosable: false,
+            });
         };
         connection.onclose = (event) => {
             const message = "Error code " + event.code + (!!event.reason ? (": " + event.reason) : "");
@@ -102,7 +129,13 @@ function connect(config, forbidWs, forbidNonLocalWs, forbidWss, forbidWebRTC) {
             },
             send: (data) => {
                 connection.send(data);
+                if (bufferedAmountCheck.quenedUnreportedBytes == 0) {
+                    bufferedAmountCheck.nextTimeout = 10;
+                    setTimeout(checkBufferedAmount, 10);
+                }
+                bufferedAmountCheck.quenedUnreportedBytes += data.length;
             },
+            closeSend: () => { throw new Error('Wrong connection type'); },
             openOutSubstream: () => { throw new Error('Wrong connection type'); }
         };
     }
@@ -152,16 +185,18 @@ function connect(config, forbidWs, forbidNonLocalWs, forbidWss, forbidWebRTC) {
             pc.onnegotiationneeded = null;
             pc.ondatachannel = null;
             for (const channel of Array.from(dataChannels.values())) {
-                channel.onopen = null;
-                channel.onerror = null;
-                channel.onclose = null;
-                channel.onmessage = null;
+                channel.channel.onopen = null;
+                channel.channel.onerror = null;
+                channel.channel.onclose = null;
+                channel.channel.onbufferedamountlow = null;
+                channel.channel.onmessage = null;
             }
             dataChannels.clear();
             if (handshakeDataChannel) {
                 handshakeDataChannel.onopen = null;
                 handshakeDataChannel.onerror = null;
                 handshakeDataChannel.onclose = null;
+                handshakeDataChannel.onbufferedamountlow = null;
                 handshakeDataChannel.onmessage = null;
             }
             handshakeDataChannel = undefined;
@@ -190,7 +225,7 @@ function connect(config, forbidWs, forbidNonLocalWs, forbidWss, forbidWebRTC) {
                 }
                 else {
                     console.assert(direction !== 'outbound' || !handshakeDataChannel, "handshakeDataChannel still defined");
-                    config.onStreamOpened(dataChannelId, direction);
+                    config.onStreamOpened(dataChannelId, direction, 65536);
                 }
             };
             dataChannel.onerror = dataChannel.onclose = (_error) => {
@@ -212,6 +247,7 @@ function connect(config, forbidWs, forbidNonLocalWs, forbidWss, forbidWebRTC) {
                     handshakeDataChannel.onopen = null;
                     handshakeDataChannel.onerror = null;
                     handshakeDataChannel.onclose = null;
+                    handshakeDataChannel.onbufferedamountlow = null;
                     handshakeDataChannel.onmessage = null;
                     handshakeDataChannel = undefined;
                 }
@@ -228,12 +264,18 @@ function connect(config, forbidWs, forbidNonLocalWs, forbidWss, forbidWebRTC) {
                     config.onStreamReset(dataChannelId);
                 }
             };
+            dataChannel.onbufferedamountlow = () => {
+                const channel = dataChannels.get(dataChannelId);
+                const val = channel.bufferedBytes;
+                channel.bufferedBytes = 0;
+                config.onWritableBytes(val, dataChannelId);
+            };
             dataChannel.onmessage = (m) => {
                 // The `data` field is an `ArrayBuffer`.
                 config.onMessage(new Uint8Array(m.data), dataChannelId);
             };
             if (direction !== 'first-outbound')
-                dataChannels.set(dataChannelId, dataChannel);
+                dataChannels.set(dataChannelId, { channel: dataChannel, bufferedBytes: 0 });
             else
                 handshakeDataChannel = dataChannel;
         };
@@ -375,7 +417,8 @@ function connect(config, forbidWs, forbidNonLocalWs, forbidWss, forbidWebRTC) {
                     // (UDP or TCP)
                     "a=sctp-port:5000" + "\n" +
                     // The maximum SCTP user message size (in bytes) (RFC8841)
-                    "a=max-message-size:16384" + "\n" + // TODO: should this be part of the spec?
+                    // Setting this field is part of the libp2p spec.
+                    "a=max-message-size:16384" + "\n" +
                     // A transport address for a candidate that can be used for connectivity
                     // checks (RFC8839).
                     "a=candidate:1 1 UDP 1 " + targetIp + " " + targetPort + " typ host" + "\n";
@@ -404,17 +447,21 @@ function connect(config, forbidWs, forbidNonLocalWs, forbidWss, forbidWebRTC) {
                 }
                 else {
                     const channel = dataChannels.get(streamId);
-                    channel.onopen = null;
-                    channel.onerror = null;
-                    channel.onclose = null;
-                    channel.onmessage = null;
-                    channel.close();
+                    channel.channel.onopen = null;
+                    channel.channel.onerror = null;
+                    channel.channel.onclose = null;
+                    channel.channel.onbufferedamountlow = null;
+                    channel.channel.onmessage = null;
+                    channel.channel.close();
                     dataChannels.delete(streamId);
                 }
             },
             send: (data, streamId) => {
-                dataChannels.get(streamId).send(data);
+                const channel = dataChannels.get(streamId);
+                channel.channel.send(data);
+                channel.bufferedBytes += data.length;
             },
+            closeSend: () => { throw new Error('Wrong connection type'); },
             openOutSubstream: () => {
                 // `openOutSubstream` can only be called after we have called `config.onOpen`, therefore
                 // `pc` is guaranteed to be non-null.
@@ -426,8 +473,8 @@ function connect(config, forbidWs, forbidNonLocalWs, forbidWss, forbidWebRTC) {
                         // We need to check again if `handshakeDataChannel` is still defined, as the
                         // connection might have been closed.
                         if (handshakeDataChannel) {
-                            config.onStreamOpened(handshakeDataChannel.id, 'outbound');
-                            dataChannels.set(handshakeDataChannel.id, handshakeDataChannel);
+                            config.onStreamOpened(handshakeDataChannel.id, 'outbound', 1024 * 1024);
+                            dataChannels.set(handshakeDataChannel.id, { channel: handshakeDataChannel, bufferedBytes: 0 });
                             handshakeDataChannel = undefined;
                         }
                     }))();

package/dist/mjs/index-deno.js

@@ -99,7 +99,6 @@ function trustedBase64Decode(base64) {
  * @throws {@link ConnectionError} If the multiaddress couldn't be parsed or contains an invalid protocol.
  */
 function connect(config, forbidTcp, forbidWs, forbidNonLocalWs, forbidWss) {
-    let connection;
     // Attempt to parse the multiaddress.
     // TODO: remove support for `/wss` in a long time (https://github.com/paritytech/smoldot/issues/1940)
     const wsParsed = config.address.match(/^\/(ip4|ip6|dns4|dns6|dns)\/(.*?)\/tcp\/(.*?)\/(ws|wss|tls\/ws)$/);
@@ -114,24 +113,72 @@ function connect(config, forbidTcp, forbidWs, forbidNonLocalWs, forbidWss) {
         const url = (wsParsed[1] == 'ip6') ?
             (proto + "://[" + wsParsed[2] + "]:" + wsParsed[3]) :
             (proto + "://" + wsParsed[2] + ":" + wsParsed[3]);
-        connection = {
-            ty: 'websocket',
-            socket: new WebSocket(url)
+        const socket = new WebSocket(url);
+        socket.binaryType = 'arraybuffer';
+        const bufferedAmountCheck = { quenedUnreportedBytes: 0, nextTimeout: 10 };
+        const checkBufferedAmount = () => {
+            if (socket.readyState != 1)
+                return;
+            // Note that we might expect `bufferedAmount` to always be <= the sum of the lengths
+            // of all the data that has been sent, but that might not be the case. For this
+            // reason, we use `bufferedAmount` as a hint rather than a correct value.
+            const bufferedAmount = socket.bufferedAmount;
+            let wasSent = bufferedAmountCheck.quenedUnreportedBytes - bufferedAmount;
+            if (wasSent < 0)
+                wasSent = 0;
+            bufferedAmountCheck.quenedUnreportedBytes -= wasSent;
+            if (bufferedAmountCheck.quenedUnreportedBytes != 0) {
+                setTimeout(checkBufferedAmount, bufferedAmountCheck.nextTimeout);
+                bufferedAmountCheck.nextTimeout *= 2;
+                if (bufferedAmountCheck.nextTimeout > 500)
+                    bufferedAmountCheck.nextTimeout = 500;
+            }
+            // Note: it is important to call `onWritableBytes` at the very end, as it might
+            // trigger a call to `send`.
+            if (wasSent != 0)
+                config.onWritableBytes(wasSent);
         };
-        connection.socket.binaryType = 'arraybuffer';
-        connection.socket.onopen = () => {
-            config.onOpen({ type: 'single-stream', handshake: 'multistream-select-noise-yamux' });
+        socket.onopen = () => {
+            config.onOpen({ type: 'single-stream', handshake: 'multistream-select-noise-yamux', initialWritableBytes: 1024 * 1024, writeClosable: false });
         };
-        connection.socket.onclose = (event) => {
+        socket.onclose = (event) => {
             const message = "Error code " + event.code + (!!event.reason ? (": " + event.reason) : "");
             config.onConnectionReset(message);
         };
-        connection.socket.onmessage = (msg) => {
+        socket.onmessage = (msg) => {
             config.onMessage(new Uint8Array(msg.data));
         };
+        return {
+            reset: () => {
+                // We can't set these fields to null because the TypeScript definitions don't
+                // allow it, but we can set them to dummy values.
+                socket.onopen = () => { };
+                socket.onclose = () => { };
+                socket.onmessage = () => { };
+                socket.onerror = () => { };
+                socket.close();
+            },
+            send: (data) => {
+                // The WebSocket library that we use seems to spontaneously transition connections
+                // to the "closed" state but not call the `onclosed` callback immediately. Calling
+                // `send` on that object throws an exception. In order to avoid panicking smoldot,
+                // we thus absorb any exception thrown here.
+                // See also <https://github.com/paritytech/smoldot/issues/2937>.
+                try {
+                    socket.send(data);
+                    if (bufferedAmountCheck.quenedUnreportedBytes == 0) {
+                        bufferedAmountCheck.nextTimeout = 10;
+                        setTimeout(checkBufferedAmount, 10);
+                    }
+                    bufferedAmountCheck.quenedUnreportedBytes += data.length;
+                }
+                catch (_error) { }
+            },
+            closeSend: () => { throw new Error('Wrong connection type'); },
+            openOutSubstream: () => { throw new Error('Wrong connection type'); }
+        };
     }
     else if (tcpParsed != null) {
-        // `net` module will be missing when we're not in NodeJS.
         if (forbidTcp) {
             throw new ConnectionError('TCP connections not available');
         }
@@ -146,13 +193,12 @@ function connect(config, forbidTcp, forbidWs, forbidNonLocalWs, forbidWss) {
                 return null;
             })
         };
-        connection = { ty: 'tcp', socket };
         socket.inner = socket.inner.then((established) => {
             // TODO: at the time of writing of this comment, `setNoDelay` is still unstable
             //established.setNoDelay();
             if (socket.destroyed)
                 return established;
-            config.onOpen({ type: 'single-stream', handshake: 'multistream-select-noise-yamux' });
+            config.onOpen({ type: 'single-stream', handshake: 'multistream-select-noise-yamux', initialWritableBytes: 1024 * 1024, writeClosable: true });
             // Spawns an asynchronous task that continuously reads from the socket.
             // Every time data is read, the task re-executes itself in order to continue reading.
             // The task ends automatically if an EOF or error is detected, which should also happen
@@ -184,53 +230,21 @@ function connect(config, forbidTcp, forbidWs, forbidNonLocalWs, forbidWss) {
             read(new Uint8Array(1024));
             return established;
         });
-    }
-    else {
-        throw new ConnectionError('Unrecognized multiaddr format');
-    }
-    return {
-        reset: () => {
-            if (connection.ty == 'websocket') {
-                // WebSocket
-                // We can't set these fields to null because the TypeScript definitions don't
-                // allow it, but we can set them to dummy values.
-                connection.socket.onopen = () => { };
-                connection.socket.onclose = () => { };
-                connection.socket.onmessage = () => { };
-                connection.socket.onerror = () => { };
-                connection.socket.close();
-            }
-            else {
-                // TCP
-                connection.socket.destroyed = true;
-                connection.socket.inner.then((connec) => connec.close());
-            }
-        },
-        send: (data) => {
-            if (connection.ty == 'websocket') {
-                // WebSocket
-                // The WebSocket library that we use seems to spontaneously transition connections
-                // to the "closed" state but not call the `onclosed` callback immediately. Calling
-                // `send` on that object throws an exception. In order to avoid panicking smoldot,
-                // we thus absorb any exception thrown here.
-                // See also <https://github.com/paritytech/smoldot/issues/2937>.
-                try {
-                    connection.socket.send(data);
-                }
-                catch (_error) { }
-            }
-            else {
-                // TCP
-                // TODO: at the moment, sending data doesn't have any back-pressure mechanism; as such, we just buffer data indefinitely
+        return {
+            reset: () => {
+                socket.destroyed = true;
+                socket.inner.then((connec) => connec.close());
+            },
+            send: (data) => {
                 let dataCopy = Uint8Array.from(data); // Deep copy of the data
-                const socket = connection.socket;
-                connection.socket.inner = connection.socket.inner.then((c) => __awaiter(this, void 0, void 0, function* () {
+                socket.inner = socket.inner.then((c) => __awaiter(this, void 0, void 0, function* () {
                     while (dataCopy.length > 0) {
                         if (socket.destroyed || c === null)
                             return c;
                         let outcome;
                         try {
                             outcome = yield c.write(dataCopy);
+                            config.onWritableBytes(dataCopy.length);
                         }
                         catch (error) {
                             // The type of `error` is unclear, but we assume that it implements `Error`
@@ -250,8 +264,17 @@ function connect(config, forbidTcp, forbidWs, forbidNonLocalWs, forbidWss) {
                     }
                     return c;
                 }));
-            }
-        },
-        openOutSubstream: () => { throw new Error('Wrong connection type'); }
-    };
+            },
+            closeSend: () => {
+                socket.inner = socket.inner.then((c) => __awaiter(this, void 0, void 0, function* () {
+                    yield (c === null || c === void 0 ? void 0 : c.closeWrite());
+                    return c;
+                }));
+            },
+            openOutSubstream: () => { throw new Error('Wrong connection type'); }
+        };
+    }
+    else {
+        throw new ConnectionError('Unrecognized multiaddr format');
+    }
 }