@elizaos/rust 2.0.0-alpha

package/LICENSE

@@ -0,0 +1,26 @@
+MIT License
+
+Copyright (c) 2025 Shaw Walters and elizaOS Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+
+
+

package/README.md

@@ -0,0 +1,151 @@
+# elizaOS Core - Rust Implementation
+
+This is the Rust implementation of the elizaOS core runtime. It provides a fully compatible implementation that can be compiled to both native binaries and WebAssembly.
+
+## Features
+
+- **Full Type Compatibility**: All types serialize to JSON in a format identical to the TypeScript implementation
+- **Native Performance**: Compile to native code for maximum performance
+- **WASM Support**: Compile to WebAssembly for browser and Node.js environments
+- **Character Loading**: Parse and validate character files matching TypeScript behavior
+- **Plugin System**: Load, validate, and resolve plugin dependencies
+- **Agent Runtime**: Core runtime for elizaOS agents
+
+## Runtime Settings (cross-language parity)
+
+These settings are read by the runtime/message loop to keep behavior aligned with the TypeScript and Python implementations:
+
+- `ALLOW_NO_DATABASE`: when truthy, allow running without a persistent database adapter (benchmarks/tests).
+- `USE_MULTI_STEP`: when truthy, enable the iterative multi-step workflow.
+- `MAX_MULTISTEP_ITERATIONS`: maximum iterations for multi-step mode (default: `6`).
+
+### Benchmark & Trajectory Tracing
+
+Benchmarks and harnesses can attach metadata to inbound messages (stored under `Memory.metadata` as custom JSON):
+
+- `trajectoryStepId`: enables trajectory tracing for provider access + model calls.
+- `benchmarkContext`: enables the `CONTEXT_BENCH` provider and sets `state.values["benchmark_has_context"]=true`, which forces action-based execution to exercise the full loop.
+
+## Model output contract (XML preferred, plain text tolerated)
+
+The canonical message loop expects model outputs in the `<response>...</response>` XML format (with `<actions>`, `<providers>`, and `<text>` fields).
+
+Some deterministic/offline backends may return **plain text** instead. In that case, the runtime will treat the raw output as a simple **`REPLY`** so the system remains usable even when strict XML formatting is unavailable.
+
+## Building
+
+### Prerequisites
+
+- Rust 1.70 or later
+- wasm-pack (for WASM builds)
+
+### Native Build
+
+```bash
+cargo build --release
+```
+
+### WASM Build
+
+```bash
+# For web browsers
+wasm-pack build --target web --out-dir pkg/web --features wasm
+
+# For Node.js
+wasm-pack build --target nodejs --out-dir pkg/node --features wasm
+```
+
+### Build Script
+
+```bash
+./build.sh
+```
+
+## Testing
+
+```bash
+cargo test
+```
+
+## Usage
+
+### Rust (Native)
+
+```rust
+use elizaos::{AgentRuntime, Character, parse_character};
+
+#[tokio::main]
+async fn main() -> anyhow::Result<()> {
+    let json = r#"{"name": "TestAgent", "bio": "A test agent"}"#;
+    let character = parse_character(json)?;
+
+    let runtime = AgentRuntime::new(RuntimeOptions {
+        character: Some(character),
+        ..Default::default()
+    }).await?;
+
+    runtime.initialize().await?;
+
+    Ok(())
+}
+```
+
+### JavaScript (WASM)
+
+```javascript
+import init, {
+  WasmAgentRuntime,
+  parse_character,
+  validate_character,
+} from "@elizaos/core/rust";
+
+// Initialize WASM module
+await init();
+
+// Create a runtime
+const runtime = await new WasmAgentRuntime(
+  '{"name": "TestAgent", "bio": "A test agent"}',
+);
+await runtime.initialize();
+
+console.log(`Agent ID: ${runtime.agent_id}`);
+console.log(`Character: ${runtime.character_name}`);
+```
+
+## Architecture
+
+```
+src/
+├── lib.rs           # Library entry point
+├── types/           # Core type definitions
+│   ├── mod.rs       # Type module exports
+│   ├── primitives.rs # UUID, Content, etc.
+│   ├── memory.rs    # Memory types
+│   ├── agent.rs     # Character, Agent types
+│   ├── plugin.rs    # Plugin types
+│   ├── components.rs # Action, Provider, Evaluator
+│   ├── environment.rs # Entity, Room, World
+│   ├── events.rs    # Event system types
+│   ├── database.rs  # Database types
+│   ├── model.rs     # Model types
+│   ├── service.rs   # Service types
+│   ├── state.rs     # State types
+│   └── ...
+├── character.rs     # Character parsing/validation
+├── plugin.rs        # Plugin loading/resolution
+├── runtime.rs       # AgentRuntime implementation
+└── wasm.rs          # WASM bindings
+```
+
+## Compatibility
+
+This implementation is designed to be 100% compatible with the TypeScript version:
+
+- **JSON Serialization**: All types use `#[serde(rename_all = "camelCase")]` to match TypeScript
+- **UUID Format**: UUIDs are validated and stored in lowercase format
+- **Character Files**: Existing character files work without modification
+- **Plugin Loading**: Plugins are resolved using the same dependency algorithm
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@elizaos/rust",
+  "version": "2.0.0-alpha",
+  "description": "elizaOS Core - Rust runtime and types",
+  "type": "module",
+  "main": "pkg/node/elizaos.js",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "browser": {
+        "import": "./pkg/web/elizaos.js",
+        "default": "./pkg/web/elizaos.js"
+      },
+      "node": {
+        "import": "./pkg/node/elizaos.js",
+        "default": "./pkg/node/elizaos.js"
+      },
+      "default": "./pkg/node/elizaos.js"
+    }
+  },
+  "files": [
+    "pkg"
+  ],
+  "scripts": {
+    "build": "./build.sh",
+    "build:native": "cargo build --release",
+    "build:wasm": "wasm-pack build --target web --out-dir pkg/web --no-default-features --features wasm && wasm-pack build --target nodejs --out-dir pkg/node --no-default-features --features wasm",
+    "test": "cargo test",
+    "lint": "cargo clippy --lib --features native --fix --allow-dirty --allow-staged -- -D warnings && cargo fmt",
+    "lint:fix": "cargo clippy --all-targets --all-features --fix --allow-dirty",
+    "typecheck": "cargo check --lib --features native",
+    "example:native:basic": "cargo run --example basic_runtime --features native",
+    "example:native:handlers": "cargo run --example with_handlers --features native",
+    "example:wasm:basic": "bun run examples/wasm/basic.ts",
+    "example:wasm:runtime": "bun run examples/wasm/runtime.ts",
+    "example:wasm:chat": "bun run examples/wasm/chat.ts",
+    "example:wasm:benchmark": "bun run examples/wasm/benchmark.ts",
+    "test:wasm": "./wasm-test.sh"
+  },
+  "author": "elizaOS",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "53fe0ff5652913ee99f49d363262dc5291993e26"
+}