Merge pull request oasisprotocol#2371 from oasisprotocol/ZigaMr/feat/rofl-client-rs

feat(rofl-client/rs): add Rust ROFL client

Author: njelich

Cargo.lock

@@ -23,6 +23,7 @@ members = [
     "rofl-containers",
     "rofl-scheduler",
     "rofl-proxy",
+    "rofl-client/rs",
 
     # Test runtimes.
     "tests/runtimes/benchmarking",

Cargo.toml

@@ -0,0 +1,35 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog], and this project adheres to [Semantic Versioning].
+
+## [Unreleased]
+
+### Added
+- 
+
+### Changed
+- 
+
+### Fixed
+- 
+
+## 0.1.0 - 2025-10-21
+
+### Added
+- Initial public release of the Rust ROFL client (`oasis-rofl-client`).
+- Core API:
+  - `RoflClient::get_app_id`
+  - `RoflClient::generate_key` with `KeyKind` (`raw-256`, `raw-384`, `ed25519`, `secp256k1`)
+  - `RoflClient::sign_submit` (supports `eth` and `std` tx kinds)
+  - `RoflClient::sign_submit_eth` convenience helper
+  - `RoflClient::get_metadata` getter for Metadata entries
+  - `RoflClient::set_metadata` setter for Metadata entries
+  - `RoflClient::query` on-chain data queries
+- HTTP-over-UDS transport targeting `/run/rofl-appd.sock` with async methods offloading blocking I/O.
+- Example: `examples/basic.rs`.
+- README with quickstart.
+
+[Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
+[Semantic Versioning]: https://semver.org/spec/v2.0.0.html

rofl-client/rs/CHANGELOG.md

@@ -0,0 +1,17 @@
+[package]
+name = "oasis-rofl-client"
+version = "0.1.0"
+edition = "2021"
+license = "Apache-2.0"
+description = "Rust client for ROFL appd (Unix domain socket HTTP)."
+
+[dependencies]
+serde = { version = "1", features = ["derive"] }
+serde_json = "1"
+tokio = { version = "1", features = ["full", "test-util"] }
+hex = "0.4.3"
+thiserror = "1.0"
+anyhow = "1.0"
+
+[dev-dependencies]
+tempfile = "3.8"

rofl-client/rs/Cargo.toml

@@ -0,0 +1,29 @@
+# rofl-client/rs/README.md
+Rust client for the ROFL appd over a Unix domain socket.
+
+- Default socket: `/run/rofl-appd.sock`
+- Endpoints used:
+  - `GET /rofl/v1/app/id`
+  - `POST /rofl/v1/keys/generate`
+  - `POST /rofl/v1/tx/sign-submit`
+
+Quickstart:
+
+```rust
+use oasis_rofl_client::{KeyKind, RoflClient};
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let client = RoflClient::new()?;
+    println!("app id: {}", client.get_app_id().await?);
+    println!(
+        "key: {}",
+        client.generate_key("example", KeyKind::Ed25519).await?
+    );
+    Ok(())
+}
+```
+
+Notes:
+- Requires Unix socks. Windows is not supported unless using WSL.
+- Methods are `async` and internally offload blocking UDS I/O via `tokio::task::spawn_blocking`.

rofl-client/rs/README.md

@@ -0,0 +1,13 @@
+// rofl-client/rs/examples/basic.rs
+use oasis_rofl_client::{KeyKind, RoflClient};
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let client = RoflClient::new()?;
+    println!("app id: {}", client.get_app_id().await?);
+    println!(
+        "key: {}",
+        client.generate_key("example", KeyKind::Ed25519).await?
+    );
+    Ok(())
+}