smoldot 1.0.2 → 1.0.3

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

@@ -7,10 +7,6 @@ export interface Config {
      * 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.
-     */
-    performanceNow: () => number;
     /**
      * Tries to open a new connection using the given configuration.
      *
@@ -71,7 +67,7 @@ export interface Connection {
      *
      * 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.
+     * The number of bytes must 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".
@@ -160,7 +156,8 @@ export interface ConnectionConfig {
      */
     onStreamReset: (streamId: number) => void;
     /**
-     * Callback called when more data can be written on the stream.
+     * Callback called when some data sent using {@link Connection.send} has effectively been
+     * written on the stream, meaning that some buffer space is now free.
      *
      * Can only happen while the connection is in the `Open` state.
      *
@@ -168,6 +165,9 @@ export interface ConnectionConfig {
      *
      * The `streamId` parameter must be provided if and only if the connection is of type
      * "multi-stream".
+     *
+     * Only a number of bytes equal to the size of the data provided to {@link Connection.send}
+     * must be reported. In other words, the `initialWritableBytes` must never be exceeded.
      */
     onWritableBytes: (numExtra: number, streamId?: number) => void;
     /**

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

@@ -89,10 +89,6 @@ function default_1(config) {
                 config.logCallback(level, target, message);
             }
         },
-        // Must return the UNIX time in milliseconds.
-        unix_time_ms: () => Date.now(),
-        // Must return the value of a monotonic clock in milliseconds.
-        monotonic_clock_ms: () => config.performanceNow(),
         // Must call `timer_finished` after the given number of milliseconds has elapsed.
         start_timer: (id, ms) => {
             if (killedTracked.killed)

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

@@ -5,6 +5,10 @@ export interface Config {
      * Fills the given buffer with randomly-generated bytes.
      */
     getRandomValues: (buffer: Uint8Array) => void;
+    /**
+     * Returns the number of milliseconds since an arbitrary epoch.
+     */
+    performanceNow: () => number;
     /**
      * List of environment variables to feed to the Rust program. An array of strings.
      * Example: `["RUST_BACKTRACE=1", "RUST_LOG=foo"];`

package/dist/cjs/instance/bindings-wasi.js

@@ -41,6 +41,36 @@ exports.default = (config) => {
             }
             return 0;
         },
+        clock_time_get: (clockId, _precision, outPtr) => {
+            // See <https://github.com/rust-lang/rust/blob/master/library/std/src/sys/wasi/time.rs>
+            // and <docs.rs/wasi/> for help.
+            const instance = config.instance;
+            const mem = new Uint8Array(instance.exports.memory.buffer);
+            outPtr >>>= 0;
+            // We ignore the precision, as it can't be implemented anyway.
+            switch (clockId) {
+                case 0: {
+                    // Realtime clock.
+                    const now = BigInt(Math.floor(Date.now())) * BigInt(1000000);
+                    buffer.writeUInt64LE(mem, outPtr, now);
+                    // Success.
+                    return 0;
+                }
+                case 1: {
+                    // Monotonic clock.
+                    const nowMs = config.performanceNow();
+                    const nowMsInt = Math.floor(nowMs);
+                    const now = BigInt(nowMsInt) * BigInt(1000000) +
+                        BigInt(Math.floor(((nowMs - nowMsInt) * 1000000)));
+                    buffer.writeUInt64LE(mem, outPtr, now);
+                    // Success.
+                    return 0;
+                }
+                default:
+                    // Return an `EINVAL` error.
+                    return 28;
+            }
+        },
         // Writing to a file descriptor is used in order to write to stdout/stderr.
         fd_write: (fd, addr, num, outPtr) => {
             const instance = config.instance;

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

@@ -8,3 +8,4 @@ export declare function readUInt32LE(buffer: Uint8Array, offset: number): number
  */
 export declare function writeUInt8(buffer: Uint8Array, offset: number, value: number): void;
 export declare function writeUInt32LE(buffer: Uint8Array, offset: number, value: number): void;
+export declare function writeUInt64LE(buffer: Uint8Array, offset: number, value: bigint): void;

package/dist/cjs/instance/buffer.js

@@ -3,7 +3,7 @@
 // Copyright (C) 2019-2022  Parity Technologies (UK) Ltd.
 // SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeUInt32LE = exports.writeUInt8 = exports.readUInt32LE = exports.utf8BytesToString = void 0;
+exports.writeUInt64LE = exports.writeUInt32LE = exports.writeUInt8 = exports.readUInt32LE = exports.utf8BytesToString = void 0;
 // This program is free software: you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
 // the Free Software Foundation, either version 3 of the License, or
@@ -45,6 +45,18 @@ function writeUInt32LE(buffer, offset, value) {
     buffer[offset] = value & 0xff;
 }
 exports.writeUInt32LE = writeUInt32LE;
+function writeUInt64LE(buffer, offset, value) {
+    checkRange(buffer, offset, 8);
+    buffer[offset + 7] = Number((value >> BigInt(56)) & BigInt(0xff));
+    buffer[offset + 6] = Number((value >> BigInt(48)) & BigInt(0xff));
+    buffer[offset + 5] = Number((value >> BigInt(40)) & BigInt(0xff));
+    buffer[offset + 4] = Number((value >> BigInt(32)) & BigInt(0xff));
+    buffer[offset + 3] = Number((value >> BigInt(24)) & BigInt(0xff));
+    buffer[offset + 2] = Number((value >> BigInt(16)) & BigInt(0xff));
+    buffer[offset + 1] = Number((value >> BigInt(8)) & BigInt(0xff));
+    buffer[offset] = Number(value & BigInt(0xff));
+}
+exports.writeUInt64LE = writeUInt64LE;
 function checkRange(buffer, offset, length) {
     if (!Number.isInteger(offset) || offset < 0)
         throw new RangeError();

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

@@ -38,7 +38,7 @@ function startInstance(config, platformBindings) {
         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({ bufferIndices, performanceNow: platformBindings.performanceNow, connect: platformBindings.connect, onPanic: (message) => {
+        const smoldotJsConfig = Object.assign({ bufferIndices, connect: platformBindings.connect, onPanic: (message) => {
                 killAll();
                 config.onWasmPanic(message);
                 throw new Error();
@@ -47,6 +47,7 @@ function startInstance(config, platformBindings) {
         const wasiConfig = {
             envVars: [],
             getRandomValues: platformBindings.getRandomValues,
+            performanceNow: platformBindings.performanceNow,
             onProcExit: (retCode) => {
                 killAll();
                 config.onWasmPanic(`proc_exit called: ${retCode}`);

package/dist/mjs/client.js

@@ -77,10 +77,10 @@ export function start(options, platformBindings) {
     // For each chain object returned by `addChain`, the associated internal chain id.
     //
     // Immediately cleared when `remove()` is called on a chain.
-    let chainIds = new WeakMap();
+    const chainIds = new WeakMap();
     // If `Client.terminate()̀  is called, this error is set to a value.
     // All the functions of the public API check if this contains a value.
-    let alreadyDestroyedError = null;
+    const alreadyDestroyedError = { value: null };
     const instance = startInstance({
         // Maximum level of log entries sent by the client.
         // 0 = Logging disabled, 1 = Error, 2 = Warn, 3 = Info, 4 = Debug, 5 = Trace
@@ -94,8 +94,8 @@ export function start(options, platformBindings) {
     }, platformBindings);
     return {
         addChain: (options) => __awaiter(this, void 0, void 0, function* () {
-            if (alreadyDestroyedError)
-                throw alreadyDestroyedError;
+            if (alreadyDestroyedError.value)
+                throw alreadyDestroyedError.value;
             // Passing a JSON object for the chain spec is an easy mistake, so we provide a more
             // readable error.
             if (!(typeof options.chainSpec === 'string'))
@@ -120,8 +120,8 @@ export function start(options, platformBindings) {
             // Resolve the promise that `addChain` returned to the user.
             const newChain = {
                 sendJsonRpc: (request) => {
-                    if (alreadyDestroyedError)
-                        throw alreadyDestroyedError;
+                    if (alreadyDestroyedError.value)
+                        throw alreadyDestroyedError.value;
                     if (wasDestroyed.destroyed)
                         throw new AlreadyDestroyedError();
                     if (options.disableJsonRpc)
@@ -133,8 +133,8 @@ export function start(options, platformBindings) {
                     instance.request(request, chainId);
                 },
                 nextJsonRpcResponse: () => {
-                    if (alreadyDestroyedError)
-                        return Promise.reject(alreadyDestroyedError);
+                    if (alreadyDestroyedError.value)
+                        return Promise.reject(alreadyDestroyedError.value);
                     if (wasDestroyed.destroyed)
                         return Promise.reject(new AlreadyDestroyedError());
                     if (options.disableJsonRpc)
@@ -142,8 +142,8 @@ export function start(options, platformBindings) {
                     return instance.nextJsonRpcResponse(chainId);
                 },
                 remove: () => {
-                    if (alreadyDestroyedError)
-                        throw alreadyDestroyedError;
+                    if (alreadyDestroyedError.value)
+                        throw alreadyDestroyedError.value;
                     if (wasDestroyed.destroyed)
                         throw new AlreadyDestroyedError();
                     wasDestroyed.destroyed = true;
@@ -156,9 +156,9 @@ export function start(options, platformBindings) {
             return newChain;
         }),
         terminate: () => __awaiter(this, void 0, void 0, function* () {
-            if (alreadyDestroyedError)
-                throw alreadyDestroyedError;
-            alreadyDestroyedError = new AlreadyDestroyedError();
+            if (alreadyDestroyedError.value)
+                throw alreadyDestroyedError.value;
+            alreadyDestroyedError.value = new AlreadyDestroyedError();
             instance.startShutdown();
         })
     };