Oliphaunt

WASM SDK

First-class WASM/WASIX runtime family for WebAssembly hosts.

WASM at a glance

WASM/WASIX hosts

WASM/WASIX runtime family

Install

cargo add oliphaunt-wasix
oliphaunt-wasix

SDK owns

WASM runtime behavior, WASIX assets, dump and restore flows.

Modes

WASIX

Verify first

Load WASM runtime assets, open a root, and prove dump or restore for data movement.

oliphaunt-wasix is the first-class WASM/WASIX runtime family. It shares public concepts with native Oliphaunt packages while keeping its own runtime assets, WASM packaging story, and WebAssembly-specific behavior.

Use this SDK when the deployment target is a WASM/WASIX host or when a Rust app wants to ship the WASM runtime assets. Native desktop and mobile apps use the native SDKs when the native runtime is available.

Install

Use the WASM package when your deployment target is WebAssembly/WASIX. The package includes the SDK surface. Consumer applications receive the matching portable runtime and target AOT artifacts through package-manager dependencies.

For Rust hosts:

cargo add oliphaunt-wasix

Open And Query

Open a local server-compatible runtime when you want to use existing PostgreSQL clients:

use oliphaunt_wasix::OliphauntServer;

fn open_server() -> Result<(), Box<dyn std::error::Error>> {
    let server = OliphauntServer::builder()
        .path("./app-data/main.oliphaunt")
        .start()?;

    let url = server.database_url();
    server.shutdown()?;
    Ok(())
}

Runtime Shape

WASM mode is separate from native direct, native broker, and native server. It has its own filesystem, startup, server/proxy, dump/restore, and extension behavior. Use capabilities from the selected WASM runtime before enabling advanced features in app UI.

The WASM product can expose direct Rust APIs or a local PostgreSQL-compatible URL depending on the host and configuration. It keeps runtime assets separate from native liboliphaunt while sharing exact extension names and public database concepts.

App Responsibilities

  • Depend on the portable runtime artifact and target-specific AOT artifact for each supported host.
  • Install exact WASIX extension packages for the SQL extensions your app uses.
  • Use the WASM runtime guide for filesystem, server/proxy, and startup behavior.
  • Use dump and restore flows for portable data movement and upgrades.
  • Check capabilities before enabling extension, streaming, server/proxy, or backup features.

First Query

Use Build With WASM for the first query and runtime configuration. Use WASM runtime for server/proxy and asset behavior, and dump and restore for data movement.

On this page