mirror of
https://gitlab.com/veilid/veilid.git
synced 2024-10-01 01:26:08 -04:00
41 lines
2.4 KiB
Markdown
41 lines
2.4 KiB
Markdown
# 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.
|
|
1. 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.
|
|
1. 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.
|
|
1. Because of browser security policy regarding WebSockets:
|
|
1. `ws://` only works on `http://` sites
|
|
1. `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`](https://rustwasm.github.io/wasm-bindgen/) is used to generate interop code between JavaScript and Rust, as well as basic TypeScript types.
|
|
- [`tsify`](https://github.com/madonoharu/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`](https://github.com/cloudflare/serde-wasm-bindgen) enables serialization/deserialization.
|