smoldot 0.3.6 → 0.7.11

package/src/index.js

@@ -1,192 +0,0 @@
-// Smoldot
-// Copyright (C) 2019-2021  Parity Technologies (UK) Ltd.
-// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.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
-// (at your option) any later version.
-
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
-
-// You should have received a copy of the GNU General Public License
-// along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-import { Worker, workerOnError, workerOnMessage } from './compat-nodejs.js';
-export * from './health.js';
-
-export class SmoldotError extends Error {
-  constructor(message) {
-    super(message);
-  }
-}
-
-export async function start(config) {
-  config = config || {};
-
-  const logCallback = config.logCallback || ((level, target, message) => {
-    if (level <= 1) {
-      console.error("[" + target + "]", message);
-    } else if (level == 2) {
-      console.warn("[" + target + "]", message);
-    } else if (level == 3) {
-      console.info("[" + target + "]", message);
-    } else if (level == 4) {
-      console.debug("[" + target + "]", message);
-    } else {
-      console.trace("[" + target + "]", message);
-    }
-  });
-
-  // The actual execution of Smoldot is performed in a worker thread.
-  //
-  // The line of code below (`new Worker(...)`) is designed to hopefully work across all
-  // platforms. It should work in NodeJS, browsers, webpack
-  // (https://webpack.js.org/guides/web-workers/), and parcel
-  // (https://github.com/parcel-bundler/parcel/pull/5846)
-  const worker = new Worker(new URL('./worker.js', import.meta.url));
-  let workerError = null;
-
-  // Whenever an `addChain` or `removeChain` message is sent to the worker, a corresponding entry
-  // is pushed to this array. The worker needs to send back a confirmation, which pops the first
-  // element of this array. In the case of `addChain`, additional fields are stored in this array
-  // to finish the initialization of the chain.
-  let pendingConfirmations = [];
-
-  // For each chain that is currently running, contains the callback to use to send back JSON-RPC
-  // responses corresponding to this chain.
-  // Entries are instantly removed when the user desires to remove a chain even before the worker
-  // has confirmed the removal. Doing so avoids a race condition where the worker sends back a
-  // JSON-RPC response even though we've already sent a `removeChain` message to it.
-  let chainsJsonRpcCallbacks = {};
-
-  // The worker can send us messages whose type is identified through a `kind` field.
-  workerOnMessage(worker, (message) => {
-    if (message.kind == 'jsonrpc') {
-      const cb = chainsJsonRpcCallbacks[message.chainId];
-      if (cb) cb(message.data);
-
-    } else if (message.kind == 'chainAddedOk') {
-      const expected = pendingConfirmations.pop();
-      const chainId = message.chainId;
-
-      if (!!chainsJsonRpcCallbacks[chainId]) // Sanity check.
-        throw 'Unexpected reuse of a chain ID';
-      chainsJsonRpcCallbacks[chainId] = expected.jsonRpcCallback;
-
-      // `expected` was pushed by the `addChain` method.
-      // Resolve the promise that `addChain` returned to the user.
-      expected.resolve({
-        sendJsonRpc: (request) => {
-          if (workerError)
-            throw workerError;
-          if (!chainsJsonRpcCallbacks[message.chainId])
-            throw new SmoldotError('Chain isn\'t capable of serving JSON-RPC requests');
-          worker.postMessage({ ty: 'request', request, chainId });
-        },
-        remove: () => {
-          if (workerError)
-            throw workerError;
-          pendingConfirmations.push({ ty: 'chainRemoved', chainId });
-          worker.postMessage({ ty: 'removeChain', chainId });
-          // Because the `removeChain` message is asynchronous, it is possible for a JSON-RPC
-          // response concerning that `chainId` to arrive after the `remove` function has
-          // returned. We solve that by removing the callback immediately.
-          delete chainsJsonRpcCallbacks[message.chainId];
-        },
-        // Hacky internal method that later lets us access the `chainId` of this chain for
-        // implementation reasons.
-        __internal_smoldot_id: () => chainId,
-      });
-
-    } else if (message.kind == 'chainAddedErr') {
-      const expected = pendingConfirmations.pop();
-      // `expected` was pushed by the `addChain` method.
-      // Reject the promise that `addChain` returned to the user.
-      expected.reject(message.error);
-
-    } else if (message.kind == 'chainRemoved') {
-      pendingConfirmations.pop();
-
-    } else if (message.kind == 'log') {
-      logCallback(message.level, message.target, message.message);
-
-    } else {
-      console.error('Unknown message type', message);
-    }
-  });
-
-  workerOnError(worker, (error) => {
-    // A worker error should only happen in case of a critical error as the result of a bug
-    // somewhere. Consequently, nothing is really in place to cleanly report the error.
-    console.error(error);
-    workerError = error;
-
-    // Reject all promises returned by `addChain`.
-    for (var pending of pendingConfirmations) {
-      if (pending.ty == 'chainAdded')
-        pending.reject(error);
-    }
-    pendingConfirmations = [];
-  });
-
-  // The first message expected by the worker contains the configuration.
-  worker.postMessage({
-    // Maximum level of log entries sent by the client.
-    // 0 = Logging disabled, 1 = Error, 2 = Warn, 3 = Info, 4 = Debug, 5 = Trace
-    maxLogLevel: config.maxLogLevel || 3,
-    forbidTcp: config.forbidTcp,
-    forbidWs: config.forbidWs,
-    forbidWss: config.forbidWss,
-  });
-
-  return {
-    addChain: (options) => {
-      if (workerError)
-        throw workerError;
-
-      let potentialRelayChainsIds = [];
-      if (!!options.potentialRelayChains) {
-        for (var chain of options.potentialRelayChains) {
-          // The content of `options.potentialRelayChains` are supposed to be chains earlier
-          // returned by `addChain`. The hacky `__internal_smoldot_id` method lets us obtain the
-          // internal ID of these chains.
-          const id = chain.__internal_smoldot_id();
-          potentialRelayChainsIds.push(id);
-        }
-      }
-
-      // Build a promise that will be resolved or rejected after the chain has been added.
-      let chainAddedPromiseResolve;
-      let chainAddedPromiseReject;
-      const chainAddedPromise = new Promise((resolve, reject) => {
-        chainAddedPromiseResolve = resolve;
-        chainAddedPromiseReject = reject;
-      });
-
-      pendingConfirmations.push({
-        ty: 'chainAdded',
-        reject: chainAddedPromiseReject,
-        resolve: chainAddedPromiseResolve,
-        jsonRpcCallback: options.jsonRpcCallback,
-      });
-
-      worker.postMessage({
-        ty: 'addChain',
-        chainSpec: options.chainSpec,
-        potentialRelayChains: potentialRelayChainsIds,
-        jsonRpcRunning: !!options.jsonRpcCallback,
-      });
-
-      return chainAddedPromise;
-    },
-    terminate: () => {
-      worker.terminate();
-      if (!workerError)
-        workerError = new Error("terminate() has been called");
-    }
-  }
-}

package/src/index.test-d.ts

@@ -1,36 +0,0 @@
-import smoldot, { Smoldot, SmoldotClient } from 'smoldot';
-
-// Test the export type
-
-// smoldot;  // $ExpectType Smoldot
-
-// Test when supplying all options and all params to logCallback
-
-// $ExpectType Promise<SmoldotClient>
-let sp = smoldot.start({
-  maxLogLevel: 3,
-  logCallback: (level, target, message) => { },
-  forbidTcp: false,
-  forbidWs: false,
-  forbidWss: false,
-});
-
-// Test when not supplying optional options and optional params
-
-// $ExpectType Promise<SmoldotClient>
-sp = smoldot.start();
-
-sp.then(async (sm) => {
-  // $ExpectType Promise<SmoldotChain>
-  const chain1 = sm.addChain({ chainSpec: '' });
-  // $ExpectType Promise<SmoldotChain>
-  const chain2Promise = sm.addChain({ chainSpec: '', potentialRelayChains: [await chain1], jsonRpcCallback: (resp) => { } });
-  // $ExpectType SmoldotChain
-  const chain2 = await chain2Promise;
-  // $ExpectType void
-  chain2.sendJsonRpc('{"id":8,"jsonrpc":"2.0","method":"system_health","params":[]}');
-  // $ExpectType void
-  chain2.remove();
-  // $ExpectType void
-  sm.terminate();
-});

package/src/tsconfig.json

@@ -1,13 +0,0 @@
-{
-    "compilerOptions": {
-        "module": "commonjs",
-        "lib": ["es6"],
-        "noImplicitAny": true,
-        "noImplicitThis": true,
-        "strictNullChecks": true,
-        "strictFunctionTypes": true,
-        "noEmit": true,
-        "baseUrl": "./",
-        "paths": { "smoldot": ["./"] }
-    }
-}

package/src/worker.js

@@ -1,151 +0,0 @@
-// Smoldot
-// Copyright (C) 2019-2021  Parity Technologies (UK) Ltd.
-// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.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
-// (at your option) any later version.
-
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
-
-// You should have received a copy of the GNU General Public License
-// along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-import { Buffer } from 'buffer';
-import * as compat from './compat-nodejs.js';
-import { default as smoldot_js_builder } from './bindings-smoldot-js.js';
-import { default as wasi_builder } from './bindings-wasi.js';
-
-import { default as wasm_base64 } from './autogen/wasm.js';
-
-// This variable represents the state of the worker, and serves three different purposes:
-//
-// - At initialization, it is set to `null`.
-// - Once the first message, containing the configuration, has been received from the parent, it
-//   becomes an array filled with JSON-RPC requests that are received while the Wasm VM is still
-//   initializing.
-// - After the Wasm VM has finished initialization, contains the `WebAssembly.Instance` object.
-//
-let state = null;
-
-// Inject a message coming from `index.js` to a running Wasm VM.
-const injectMessage = (instance, message) => {
-  if (message.ty == 'request') {
-    const len = Buffer.byteLength(message.request, 'utf8');
-    const ptr = instance.exports.alloc(len);
-    Buffer.from(instance.exports.memory.buffer).write(message.request, ptr);
-    instance.exports.json_rpc_send(ptr, len, message.chainId);
-
-  } else if (message.ty == 'addChain') {
-    // Write the chain specification into memory.
-    const chainSpecLen = Buffer.byteLength(message.chainSpec, 'utf8');
-    const chainSpecPtr = instance.exports.alloc(chainSpecLen);
-    Buffer.from(instance.exports.memory.buffer)
-      .write(message.chainSpec, chainSpecPtr);
-
-    // Write the potential relay chains into memory.
-    const potentialRelayChainsLen = message.potentialRelayChains.length;
-    const potentialRelayChainsPtr = instance.exports.alloc(potentialRelayChainsLen * 4);
-    for (let idx in message.potentialRelayChains) {
-      Buffer.from(instance.exports.memory.buffer)
-        .writeUInt32LE(message.potentialRelayChains[idx], potentialRelayChainsPtr + idx * 4);
-    }
-
-    const result = instance.exports.add_chain(
-      chainSpecPtr, chainSpecLen,
-      message.jsonRpcRunning,
-      potentialRelayChainsPtr, potentialRelayChainsLen
-    );
-
-    if (result >= 0x80000000 || result < 0) { // TODO: really crappy error code handling
-      // TODO: better error message
-      // Note that `add_chain` properly de-allocates buffers even if it failed.
-      compat.postMessage({ kind: 'chainAddedErr', error: new Error('Failed to initialize chain') });
-    } else {
-      compat.postMessage({ kind: 'chainAddedOk', chainId: result });
-    }
-
-  } else if (message.ty == 'removeChain') {
-    instance.exports.remove_chain(message.chainId);
-    // `compat.postMessage` is the same as `postMessage`, but works across environments.
-    compat.postMessage({ kind: 'chainRemoved' });
-
-  } else
-    throw new Error('unrecognized message type');
-};
-
-const startInstance = async (config) => {
-  // The actual Wasm bytecode is base64-decoded from a constant found in a different file.
-  // This is suboptimal compared to using `instantiateStreaming`, but it is the most
-  // cross-platform cross-bundler approach.
-  const wasmBytecode = new Uint8Array(Buffer.from(wasm_base64, 'base64'));
-
-  // Used to bind with the smoldot-js bindings. See the `bindings-smoldot-js.js` file.
-  const smoldotJsConfig = {
-    logCallback: (level, target, message) => {
-      // `compat.postMessage` is the same as `postMessage`, but works across environments.
-      compat.postMessage({ kind: 'log', level, target, message });
-    },
-    jsonRpcCallback: (data, chainId) => {
-      // `compat.postMessage` is the same as `postMessage`, but works across environments.
-      compat.postMessage({ kind: 'jsonrpc', data, chainId });
-    },
-    forbidTcp: config.forbidTcp,
-    forbidWs: config.forbidWs,
-    forbidWss: config.forbidWss,
-  };
-
-  const { bindings: smoldotJsBindings } = smoldot_js_builder(smoldotJsConfig);
-
-  // Used to bind with the Wasi bindings. See the `bindings-wasi.js` file.
-  const wasiConfig = {};
-
-  // Start the Wasm virtual machine.
-  // The Rust code defines a list of imports that must be fulfilled by the environment. The second
-  // parameter provides their implementations.
-  const result = await WebAssembly.instantiate(wasmBytecode, {
-    // The functions with the "smoldot" prefix are specific to smoldot.
-    "smoldot": smoldotJsBindings,
-    // As the Rust code is compiled for wasi, some more wasi-specific imports exist.
-    "wasi_snapshot_preview1": wasi_builder(wasiConfig),
-  });
-
-  smoldotJsConfig.instance = result.instance;
-  wasiConfig.instance = result.instance;
-
-  // Start initialization of smoldot.
-  result.instance.exports.init(config.maxLogLevel);
-
-  // Smoldot has finished initializing.
-  // Since this function is an asynchronous function, it is possible that messages have been
-  // received from the parent while it was executing. These messages are now handled.
-  state.forEach((message) => {
-    injectMessage(result.instance, message);
-  });
-
-  state = result.instance;
-};
-
-// `compat.setOnMessage` is the same as `onmessage = ...`, but works across environments.
-compat.setOnMessage((message) => {
-  // What to do depends on the type of `state`.
-  // See the documentation of the `state` variable for information.
-  if (state == null) {
-    // First ever message received by the worker. Always contains the initial configuration.
-    state = [];
-    startInstance(message) // Note that `startInstance` is `async`.
-
-  } else if (Array.isArray(state)) {
-    // A JSON-RPC request has been received while the Wasm VM is still initializing. Queue it
-    // for when initialization is over.
-    state.push(message);
-
-  } else {
-    // Everything is already initialized. Process the message synchronously.
-    injectMessage(state, message);
-  }
-});