https://github.com/avrabe/wrt
A minimal webassembly runtime supporting the component model preview 2
https://github.com/avrabe/wrt
rust wasi wasm
Last synced: about 2 months ago
JSON representation
A minimal webassembly runtime supporting the component model preview 2
- Host: GitHub
- URL: https://github.com/avrabe/wrt
- Owner: avrabe
- License: mit
- Created: 2025-03-14T10:10:08.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-03-24T07:31:20.000Z (about 2 months ago)
- Last Synced: 2025-03-24T08:34:47.730Z (about 2 months ago)
- Topics: rust, wasi, wasm
- Language: Rust
- Homepage: https://avrabe.github.io/wrt/
- Size: 1.27 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WRT - WebAssembly Runtime
[](https://github.com/avrabe/wrt/actions/workflows/ci.yml)
[](https://codecov.io/gh/avrabe/wrt)
WRT is a pure Rust implementation of a WebAssembly runtime that supports both the core WebAssembly specification and the WebAssembly Component Model. The project provides both a library (`wrt`) for embedding the runtime in Rust applications and a standalone daemon (`wrtd`) for executing WebAssembly modules.
## Features
- **Core WebAssembly Support**: Implements the WebAssembly 1.0 specification
- **Component Model**: Supports the WebAssembly Component Model for language-agnostic interoperability
- **`no_std` Compatible**: Can be used in environments without the standard library
- **Memory Safety**: Provides safe memory management for WebAssembly modules
- **Extensible**: Easily extendable architecture for adding new features
## Project Structure
- `wrt/` - Core WebAssembly runtime library
- `wrtd/` - WebAssembly Runtime Daemon for executing modules
- `example/` - Example Component Model implementation
- `docs/` - Documentation including requirements and specifications
- `justfile` - Command runner for development tasks
## Installation
### Prerequisites
- Rust 1.70 or newer
- For development: [just](https://github.com/casey/just) command runner
```bash
# Install Rust (if not already installed)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# Install just command runner
cargo install just
# Setup project dependencies
just setup
```
## Getting Started
### Building the Project
The easiest way to build the project is using the provided justfile:
```bash
# Build all crates
just build
# Build specific components
just build-wrt # Build only the library
just build-wrtd # Build only the daemon
just build-example # Build the example component
```
### Running the Example
The project includes an example WebAssembly component that demonstrates basic functionality:
```bash
# Build and run the example
just build-example
just link-example
just run-example
```
### Using WRT in Your Project
Add WRT to your Cargo.toml:
```toml
[dependencies]
wrt = { git = "https://github.com/yourusername/wrt" }
```
Basic usage example:
```rust
use wrt::{Module, Engine, Result};
fn run_wasm_module(wasm_path: &str) -> Result<()> {
// Create a new engine
let mut engine = wrt::new_engine();
// Load WebAssembly bytes from a file
let wasm_bytes = std::fs::read(wasm_path)?;
// Parse the WebAssembly module
let module = Module::from_bytes(&wasm_bytes)?;
// Instantiate the module
let instance_idx = engine.instantiate(&module)?;
// Execute a function (assuming exported function "main" exists)
let results = engine.execute(instance_idx, 0, vec![])?;
println!("Execution completed with results: {:?}", results);
Ok(())
}
```
For more advanced examples, see the [example directory](./example).
## Development
The project uses the `just` command runner to simplify development tasks.
### Available Commands
```bash
# List all available commands
just --list
# Build everything
just build
# Run tests
just test
# Generate code coverage report
just coverage # Creates HTML report at target/coverage/html/index.html
# Code quality checks
just check
just check-imports # Check import organization
just check-udeps # Check for unused dependencies
just check-all # Run all checks
# Documentation
just docs-html # Build HTML documentation
just docs-pdf # Build PDF documentation (requires LaTeX)
# Clean build artifacts
just clean
```
### Code Organization Standards
The project follows these guidelines:
1. Imports are organized in this order:
- Standard library imports (std, core, alloc)
- External crates/third-party dependencies
- Internal modules (crate:: imports)
2. All public API should be documented following the format in CLAUDE.md.
3. Each module is organized by functionality with clear separation of concerns.
## Documentation
WRT uses two documentation systems:
1. **Rust API Documentation**: Generated with `cargo doc`
```bash
cargo doc --open
```
2. **Requirements and Specifications**: Using Sphinx with sphinx-needs
```bash
just docs-html
# Documentation will be available in docs/_build/html
```
## CI/CD
This project includes GitHub Actions workflows that automatically run on pull requests and pushes to main:
- Build and test checks
- Code style enforcement
- Code coverage reporting (with Codecov integration)
- Documentation generation
- Security audit
- Unused dependency detection
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.