smoldot 1.0.0 → 1.0.2

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

@@ -1,6 +1,12 @@
 import type { SmoldotWasmInstance } from './bindings.js';
 export interface Config {
     instance?: SmoldotWasmInstance;
+    /**
+     * Array used to store the buffers provided to the Rust code.
+     *
+     * When `buffer_size` or `buffer_index` are called, the buffer is found here.
+     */
+    bufferIndices: Array<Uint8Array>;
     /**
      * Returns the number of milliseconds since an arbitrary epoch.
      */
@@ -63,12 +69,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 +131,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 +150,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 +159,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/mjs/instance/bindings-smoldot-light.js

@@ -51,6 +51,16 @@ export default function (config) {
             const message = buffer.utf8BytesToString(new Uint8Array(instance.exports.memory.buffer), ptr, len);
             config.onPanic(message);
         },
+        buffer_size: (bufferIndex) => {
+            const buf = config.bufferIndices[bufferIndex];
+            return buf.byteLength;
+        },
+        buffer_copy: (bufferIndex, targetPtr) => {
+            const instance = config.instance;
+            targetPtr = targetPtr >>> 0;
+            const buf = config.bufferIndices[bufferIndex];
+            new Uint8Array(instance.exports.memory.buffer).set(buf, targetPtr);
+        },
         // Used by the Rust side to notify that a JSON-RPC response or subscription notification
         // is available in the queue of JSON-RPC responses.
         json_rpc_responses_non_empty: (chainId) => {
@@ -93,7 +103,7 @@ export default function (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;
@@ -116,11 +126,11 @@ export default function (config) {
         },
         // Must create a new connection object. This implementation stores the created object in
         // `connections`.
-        connection_new: (connectionId, addrPtr, addrLen, errorPtrPtr) => {
+        connection_new: (connectionId, addrPtr, addrLen, errorBufferIndexPtr) => {
             const instance = config.instance;
             addrPtr >>>= 0;
             addrLen >>>= 0;
-            errorPtrPtr >>>= 0;
+            errorBufferIndexPtr >>>= 0;
             if (!!connections[connectionId]) {
                 throw new Error("internal error: connection already allocated");
             }
@@ -136,17 +146,17 @@ export default function (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': {
-                                    const bufferLen = 1 + info.localTlsCertificateMultihash.length + info.remoteTlsCertificateMultihash.length;
-                                    const ptr = instance.exports.alloc(bufferLen) >>> 0;
-                                    const mem = new Uint8Array(instance.exports.memory.buffer);
-                                    buffer.writeUInt8(mem, ptr, 0);
-                                    mem.set(info.localTlsCertificateMultihash, ptr + 1);
-                                    mem.set(info.remoteTlsCertificateMultihash, ptr + 1 + info.localTlsCertificateMultihash.length);
-                                    instance.exports.connection_open_multi_stream(connectionId, ptr, bufferLen);
+                                    const handshakeTy = new Uint8Array(1 + info.localTlsCertificateMultihash.length + info.remoteTlsCertificateMultihash.length);
+                                    buffer.writeUInt8(handshakeTy, 0, 0);
+                                    handshakeTy.set(info.localTlsCertificateMultihash, 1);
+                                    handshakeTy.set(info.remoteTlsCertificateMultihash, 1 + info.localTlsCertificateMultihash.length);
+                                    config.bufferIndices[0] = handshakeTy;
+                                    instance.exports.connection_open_multi_stream(connectionId, 0);
+                                    delete config.bufferIndices[0];
                                     break;
                                 }
                             }
@@ -157,10 +167,17 @@ export default function (config) {
                         if (killedTracked.killed)
                             return;
                         try {
-                            const encoded = new TextEncoder().encode(message);
-                            const ptr = instance.exports.alloc(encoded.length) >>> 0;
-                            new Uint8Array(instance.exports.memory.buffer).set(encoded, ptr);
-                            instance.exports.connection_reset(connectionId, ptr, encoded.length);
+                            config.bufferIndices[0] = new TextEncoder().encode(message);
+                            instance.exports.connection_reset(connectionId, 0);
+                            delete config.bufferIndices[0];
+                        }
+                        catch (_error) { }
+                    },
+                    onWritableBytes: (numExtra, streamId) => {
+                        if (killedTracked.killed)
+                            return;
+                        try {
+                            instance.exports.stream_writable_bytes(connectionId, streamId || 0, numExtra);
                         }
                         catch (_error) { }
                     },
@@ -168,17 +185,17 @@ export default function (config) {
                         if (killedTracked.killed)
                             return;
                         try {
-                            const ptr = instance.exports.alloc(message.length) >>> 0;
-                            new Uint8Array(instance.exports.memory.buffer).set(message, ptr);
-                            instance.exports.stream_message(connectionId, streamId || 0, ptr, message.length);
+                            config.bufferIndices[0] = message;
+                            instance.exports.stream_message(connectionId, streamId || 0, 0);
+                            delete config.bufferIndices[0];
                         }
                         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) { }
                     },
@@ -201,12 +218,9 @@ export default function (config) {
                     errorStr = error.toString();
                 }
                 const mem = new Uint8Array(instance.exports.memory.buffer);
-                const encoded = new TextEncoder().encode(errorStr);
-                const ptr = instance.exports.alloc(encoded.length) >>> 0;
-                mem.set(encoded, ptr);
-                buffer.writeUInt32LE(mem, errorPtrPtr, ptr);
-                buffer.writeUInt32LE(mem, errorPtrPtr + 4, encoded.length);
-                buffer.writeUInt8(mem, errorPtrPtr + 8, isBadAddress ? 1 : 0);
+                config.bufferIndices[0] = new TextEncoder().encode(errorStr);
+                buffer.writeUInt32LE(mem, errorBufferIndexPtr, 0);
+                buffer.writeUInt8(mem, errorBufferIndexPtr + 4, isBadAddress ? 1 : 0);
                 return 1;
             }
         },
@@ -240,6 +254,12 @@ export default function (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/mjs/instance/bindings.d.ts

@@ -9,21 +9,21 @@ export interface SmoldotWasmExports extends WebAssembly.Exports {
     init: (maxLogLevel: number, enableCurrentTask: number, cpuRateLimit: number, periodicallyYield: number) => void;
     set_periodically_yield: (periodicallyYield: number) => void;
     start_shutdown: () => void;
-    alloc: (len: number) => number;
-    add_chain: (chainSpecPointer: number, chainSpecLen: number, databaseContentPointer: number, databaseContentLen: number, jsonRpcRunning: number, potentialRelayChainsPtr: number, potentialRelayChainsLen: number) => number;
+    add_chain: (chainSpecBufferIndex: number, databaseContentBufferIndex: number, jsonRpcRunning: number, potentialRelayChainsBufferIndex: number) => number;
     remove_chain: (chainId: number) => void;
     chain_is_ok: (chainId: number) => number;
     chain_error_len: (chainId: number) => number;
     chain_error_ptr: (chainId: number) => number;
-    json_rpc_send: (textPtr: number, textLen: number, chainId: number) => number;
+    json_rpc_send: (textBufferIndex: number, chainId: number) => number;
     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_multi_stream: (connectionId: number, handshakeTyPtr: number, handshakeTyLen: number) => void;
-    stream_message: (connectionId: number, streamId: number, ptr: number, len: number) => void;
-    connection_stream_opened: (connectionId: number, streamId: number, outbound: number) => void;
-    connection_reset: (connectionId: number, ptr: number, len: number) => void;
+    connection_open_single_stream: (connectionId: number, handshakeTy: number, initialWritableBytes: number, writeClosable: number) => void;
+    connection_open_multi_stream: (connectionId: number, handshakeTyBufferIndex: number) => void;
+    stream_writable_bytes: (connectionId: number, streamId: number, numBytes: number) => void;
+    stream_message: (connectionId: number, streamId: number, bufferIndex: number) => void;
+    connection_stream_opened: (connectionId: number, streamId: number, outbound: number, initialWritableBytes: number) => void;
+    connection_reset: (connectionId: number, bufferIndex: number) => void;
     stream_reset: (connectionId: number, streamId: number) => void;
 }
 export interface SmoldotWasmInstance extends WebAssembly.Instance {

package/dist/mjs/instance/instance.js

@@ -97,7 +97,7 @@ export function start(configMessage, platformBindings) {
         cpuRateLimit: configMessage.cpuRateLimit,
     };
     state = {
-        initialized: false, promise: instance.startInstance(config, platformBindings).then((instance) => {
+        initialized: false, promise: instance.startInstance(config, platformBindings).then(([instance, bufferIndices]) => {
             // `config.cpuRateLimit` is a floating point that should be between 0 and 1, while the value
             // to pass as parameter must be between `0` and `2^32-1`.
             // The few lines of code below should handle all possible values of `number`, including
@@ -120,8 +120,8 @@ export function start(configMessage, platformBindings) {
                 }
             });
             instance.exports.init(configMessage.maxLogLevel, configMessage.enableCurrentTask ? 1 : 0, cpuRateLimit, periodicallyYield ? 1 : 0);
-            state = { initialized: true, instance, unregisterCallback };
-            return instance;
+            state = { initialized: true, instance, bufferIndices, unregisterCallback };
+            return [instance, bufferIndices];
         })
     };
     function queueOperation(operation) {
@@ -131,11 +131,11 @@ export function start(configMessage, platformBindings) {
             if (!state.initialized) {
                 // A message has been received while the Wasm VM is still initializing. Queue it for when
                 // initialization is over.
-                return state.promise.then((instance) => operation(instance));
+                return state.promise.then(([instance, bufferIndices]) => operation(instance, bufferIndices));
             }
             else {
                 // Everything is already initialized. Process the message synchronously.
-                return operation(state.instance);
+                return operation(state.instance, state.bufferIndices);
             }
         });
     }
@@ -150,10 +150,8 @@ export function start(configMessage, platformBindings) {
                 throw crashError.error;
             let retVal;
             try {
-                const encoded = new TextEncoder().encode(request);
-                const ptr = state.instance.exports.alloc(encoded.length) >>> 0;
-                new Uint8Array(state.instance.exports.memory.buffer).set(encoded, ptr);
-                retVal = state.instance.exports.json_rpc_send(ptr, encoded.length, chainId) >>> 0;
+                state.bufferIndices[0] = new TextEncoder().encode(request);
+                retVal = state.instance.exports.json_rpc_send(0, chainId) >>> 0;
             }
             catch (_error) {
                 console.assert(crashError.error);
@@ -200,29 +198,25 @@ export function start(configMessage, platformBindings) {
             }
         }),
         addChain: (chainSpec, databaseContent, potentialRelayChains, disableJsonRpc) => {
-            return queueOperation((instance) => {
+            return queueOperation((instance, bufferIndices) => {
                 if (crashError.error)
                     throw crashError.error;
                 try {
-                    // Write the chain specification into memory.
-                    const chainSpecEncoded = new TextEncoder().encode(chainSpec);
-                    const chainSpecPtr = instance.exports.alloc(chainSpecEncoded.length) >>> 0;
-                    new Uint8Array(instance.exports.memory.buffer).set(chainSpecEncoded, chainSpecPtr);
-                    // Write the database content into memory.
-                    const databaseContentEncoded = new TextEncoder().encode(databaseContent);
-                    const databaseContentPtr = instance.exports.alloc(databaseContentEncoded.length) >>> 0;
-                    new Uint8Array(instance.exports.memory.buffer).set(databaseContentEncoded, databaseContentPtr);
-                    // Write the potential relay chains into memory.
-                    const potentialRelayChainsLen = potentialRelayChains.length;
-                    const potentialRelayChainsPtr = instance.exports.alloc(potentialRelayChainsLen * 4) >>> 0;
-                    for (let idx = 0; idx < potentialRelayChains.length; ++idx) {
-                        buffer.writeUInt32LE(new Uint8Array(instance.exports.memory.buffer), potentialRelayChainsPtr + idx * 4, potentialRelayChains[idx]);
-                    }
                     // `add_chain` unconditionally allocates a chain id. If an error occurs, however, this chain
                     // id will refer to an *erroneous* chain. `chain_is_ok` is used below to determine whether it
                     // has succeeeded or not.
                     // Note that `add_chain` properly de-allocates buffers even if it failed.
-                    const chainId = instance.exports.add_chain(chainSpecPtr, chainSpecEncoded.length, databaseContentPtr, databaseContentEncoded.length, disableJsonRpc ? 0 : 1, potentialRelayChainsPtr, potentialRelayChainsLen);
+                    bufferIndices[0] = new TextEncoder().encode(chainSpec);
+                    bufferIndices[1] = new TextEncoder().encode(databaseContent);
+                    const potentialRelayChainsEncoded = new Uint8Array(potentialRelayChains.length * 4);
+                    for (let idx = 0; idx < potentialRelayChains.length; ++idx) {
+                        buffer.writeUInt32LE(potentialRelayChainsEncoded, idx * 4, potentialRelayChains[idx]);
+                    }
+                    bufferIndices[2] = potentialRelayChainsEncoded;
+                    const chainId = instance.exports.add_chain(0, 1, disableJsonRpc ? 0 : 1, 2);
+                    delete bufferIndices[0];
+                    delete bufferIndices[1];
+                    delete bufferIndices[2];
                     if (instance.exports.chain_is_ok(chainId) != 0) {
                         console.assert(!chains.has(chainId));
                         chains.set(chainId, {

package/dist/mjs/instance/raw-instance.d.ts

@@ -62,4 +62,4 @@ export interface PlatformBindings {
      */
     connect(config: ConnectionConfig): Connection;
 }
-export declare function startInstance(config: Config, platformBindings: PlatformBindings): Promise<SmoldotWasmInstance>;
+export declare function startInstance(config: Config, platformBindings: PlatformBindings): Promise<[SmoldotWasmInstance, Array<Uint8Array>]>;

package/dist/mjs/instance/raw-instance.js

@@ -32,8 +32,9 @@ export function startInstance(config, platformBindings) {
         // cross-platform cross-bundler approach.
         const wasmBytecode = yield platformBindings.trustedBase64DecodeAndZlibInflate(wasmBase64);
         let killAll;
+        const bufferIndices = new Array;
         // Used to bind with the smoldot-light bindings. See the `bindings-smoldot-light.js` file.
-        const smoldotJsConfig = Object.assign({ performanceNow: platformBindings.performanceNow, connect: platformBindings.connect, onPanic: (message) => {
+        const smoldotJsConfig = Object.assign({ bufferIndices, performanceNow: platformBindings.performanceNow, connect: platformBindings.connect, onPanic: (message) => {
                 killAll();
                 config.onWasmPanic(message);
                 throw new Error();
@@ -62,6 +63,6 @@ export function startInstance(config, platformBindings) {
         const instance = result.instance;
         smoldotJsConfig.instance = instance;
         wasiConfig.instance = instance;
-        return instance;
+        return [instance, bufferIndices];
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smoldot",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Light client that connects to Polkadot and Substrate-based blockchains",
   "author": "Parity Technologies <admin@parity.io>",
   "license": "GPL-3.0-or-later WITH Classpath-exception-2.0",
@@ -47,7 +47,7 @@
     "ava": "^5.0.1",
     "dtslint": "^4.0.6",
     "rimraf": "^4.1.2",
-    "typedoc": "^0.23.15",
-    "typescript": "^4.5.4"
+    "typedoc": "^0.24.1",
+    "typescript": "^5.0.2"
   }
 }