Git-Mirrors/veilid
1
0
Fork 0
mirror of https://gitlab.com/veilid/veilid.git synced 2024-12-25 07:19:26 -05:00
Code Issues Packages Projects Releases Wiki Activity
1af71e7154
veilid/veilid-wasm
History
Brandon Vandegrift 1af71e7154 (wasm) re-export helpful length constants
2023-09-24 14:47:22 -04:00
..
.cargo Add VeilidRoutingContext class for WASM 2023-09-03 23:27:20 -04:00
src (wasm) re-export helpful length constants 2023-09-24 14:47:22 -04:00
tests (wasm) re-export helpful length constants 2023-09-24 14:47:22 -04:00
.gitignore ffi work 2022-02-06 21:18:42 -05:00
Cargo.toml (wasm) Treat arbitrary byte data as Uint8Array, instead of base64url marshalling. 2023-09-20 00:46:45 -04:00
LICENSE.md licensing 2023-07-19 12:48:44 -04:00
README.md (wasm) webdriver-based tests for JS/TS apis, update README 2023-09-17 18:17:24 -04:00
wasm_build.sh (wasm) Improved memory management, track by struct so drop works, use --weak-ref for wasm-bindgen 2023-09-04 17:34:49 -04:00
wasm_setup_check.sh (wasm) webdriver-based tests for JS/TS apis, update README 2023-09-17 18:17:24 -04:00
wasm_test.sh (wasm) webdriver-based tests for JS/TS apis, update README 2023-09-17 18:17:24 -04:00
wasm-sourcemap.py WASM work 2022-03-15 09:33:34 -04:00

README.md

veilid-wasm

This package is a Rust cargo crate the generates WebAssembly (WASM) bindings for veilid-core::VeilidAPI, and outputs JavaScript and TypeScript interfaces for calling the WASM module.

Limitations

Running Veilid in the browser via WebAssembly has some limitations:

Browser-based limitaions

  1. TCP/UDP sockets are unavilable in the browser. This limits WASM nodes to communicating using WebSockets.
  2. Lookup of DNS records is unavaible in the browser, which means bootstrapping via TXT record also will work. WASM nodes will need to connect to the bootstrap server directly via WebSockets, using this URL format: ws://bootstrap.veilid.net:5150/ws in the network.routing_table.bootstrap[] section of the veilid config.
  3. Since a WASM node running in the browser can't open ports, WASM nodes select another node to act as it's Inbound Relay, so other nodes can react out to it and open a WS connection.
  4. Because of browser security policy regarding WebSockets:
    1. ws:// only works on http:// sites
    2. wss:// only works on https:// site with SSL certificates.

Running WASM on HTTPS sites [Not currently implemented]

Since WSS connections require WSS peers with valid SSL certificates, veilid-core plans to implment a feature called Outbound Relays. Outbound Relays will likely be hosted by the same host of the WASM web-app, and must run have valid SSL certificates that are signed by a Certificate Authority that's trusted by browsers. Outbound Relays will allow WASM nodes to communicate to other nodes over TCP/UDP/WS/WSS through the Outbound Relay's connection.

Running unit tests

Prerequsites:

  • NodeJS - ensure node and npm are installed.
  • Firefox browser installed, and available as firefox.

Run the test script:

  • ./wasm_test.sh to test with debug symbols.
  • ./wasm_test.sh release to test against a release build.

Development notes

Important cargo crates and their functions

  • wasm-bindgen is used to generate interop code between JavaScript and Rust, as well as basic TypeScript types.
  • tsify is used to export TypeScript types in places where wasm-bindgen runs into limitations, or in places where you don't need the mappings that wasm-bindgen generates.
  • serde-wasm-bindgen enables serialization/deserialization.