Rename the light-client to web-client

Rename the `light-client` crate to `web-client` and re-write the client code to be `wasm` friendly.
nimiq · Jan 23, 2023 · a5acd75 · a5acd75
1 parent 91ee8a3
commit a5acd75
Show file tree

Hide file tree

Showing 9 changed files with 161 additions and 191 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -24,7 +24,6 @@ members = [
   "keys",
   "lib",
   "light-blockchain",
-  "light-client",
   "log",
   "macros",
   "mempool",
@@ -58,6 +57,7 @@ members = [
   "validator-network",
   "vrf",
   "wallet",
+  "web-client",
   "zkp-component",
 ]
 

diff --git a/light-client/nimiq-client.service b/light-client/nimiq-client.service
diff --git a/light-client/src/main.rs b/light-client/src/main.rs
diff --git a/log/src/lib.rs b/log/src/lib.rs
@@ -31,7 +31,6 @@ pub static NIMIQ_MODULES: &[&str] = &[
     "nimiq_keys",
     "nimiq_lib",
     "nimiq_light_blockchain",
-    "nimiq_light_client",
     "nimiq_log",
     "nimiq_macros",
     "nimiq_mempool",
@@ -60,6 +59,7 @@ pub static NIMIQ_MODULES: &[&str] = &[
     "nimiq_validator_network",
     "nimiq_vrf",
     "nimiq_wallet",
+    "nimiq_web_client",
     "nimiq_zkp_component",
 ];
 

diff --git a/light-client/Cargo.toml → web-client/Cargo.toml b/light-client/Cargo.toml → web-client/Cargo.toml
@@ -1,9 +1,9 @@
 [package]
-name = "nimiq-light-client"
+name = "nimiq-web-client"
 version = "0.1.0"
 authors = ["The Nimiq Core Development Team <info@nimiq.com>"]
 edition = "2021"
-description = "Nimiq's Rust light client"
+description = "Nimiq's Rust to wasm web client"
 homepage = "https://nimiq.com"
 repository = "https://github.com/nimiq/core-rs-albatross"
 license = "Apache-2.0"
@@ -19,21 +19,17 @@ maintenance = { status = "experimental" }
 
 [dependencies]
 futures = { package = "futures-util", version = "0.3" }
+gloo-timers = "0.2"
 log = { package = "tracing", version = "0.1", features = ["log"] }
-tokio = { version = "1.24", features = ["macros", "rt-multi-thread", "time"] }
-tokio-metrics = "0.1"
+wasm-bindgen = "0.2"
+wasm-bindgen-futures = "0.4"
 
 [dependencies.nimiq]
 package = "nimiq-lib"
 path = "../lib"
 version = "0.1"
 default-features = false
 features = [
-    "deadlock",
-    "logging",
-    "metrics-server",
     "panic",
-    "rpc-server",
-    "signal-handling",
-    "wallet",
+    "web-logging",
 ]
diff --git a/web-client/README.md b/web-client/README.md
@@ -0,0 +1,25 @@
+# Nimiq web client
+
+This client is a very light client that only includes the necessary dependencies and constructs
+to compile a client to WebAssembly and to run it in a web browser. This is a web-client intended
+to be used in web browsers only (no WASI support). Although it can be built for other targets,
+it will panic if it is executed outside a web browser.
+
+
+To build the client, the recommended way is to use `wasm-pack`. This tool can be obtained using:
+
+```
+cargo install wasm-pack
+```
+
+Once installed, the client can be built using:
+
+```
+wasm-pack build --target web
+```
+
+The above command will compile the Rust code to WebAssembly and generate the corresponding JS
+bindings required to run the client in a web browser.
+
+After the client has been built, the root directory of this crate can be served with a web server
+(e.g. `python3 -m http.server`) and then the `index.html` file can be loaded from the server.
diff --git a/web-client/index.html b/web-client/index.html
@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8" />
+    <title>Nimiq Web client example</title>
+  </head>
+  <body>
+    <script type="module">
+      import init, { nimiq_web_client } from "./pkg/nimiq_web_client.js";
+      init().then(() => {
+	    nimiq_web_client();
+      });
+    </script>
+  </body>
+</html>
+