Merge pull request #2447 from oasisprotocol/uniyalabhishek/feature/rofl-client-rs-http-transport

feat(rofl-client/rs): add HTTP transport

Author: uniyalabhishek

.github/workflows/ci-test.yaml

@@ -626,8 +626,8 @@ jobs:
         env:
           BUILDKITE_API_TOKEN: ${{ secrets.BUILDKITE_API_TOKEN }}
 
-  test-python-rofl-client:
-    name: test-python-rofl-client
+  test-rofl-client-python:
+    name: test-rofl-client-python
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -648,3 +648,16 @@ jobs:
       - name: Run tests
         working-directory: rofl-client/py
         run: uv run pytest tests
+
+  test-rofl-client-rust:
+    name: test-rofl-client-rust
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Rust
+        run: rustup show
+
+      - name: Run tests
+        run: cargo test -p oasis-rofl-client

Cargo.lock

@@ -63,6 +63,11 @@ client = RoflClient(url="./rofl-appd.sock")
 import { RoflClient } from '@oasisprotocol/rofl-client';
 const client = new RoflClient({ url: './rofl-appd.sock' });
 ```
+
+```rust title="Rust"
+use oasis_rofl_client::RoflClient;
+let client = RoflClient::with_socket_path("./rofl-appd.sock")?;
+```
 </TabItem>
 <TabItem value="TCP port (macOS, Linux)">
 ```shell title="Shell"
@@ -80,6 +85,11 @@ client = RoflClient(url="http://localhost:8549")
 import { RoflClient } from '@oasisprotocol/rofl-client';
 const client = new RoflClient({ url: 'http://localhost:8549' });
 ```
+
+```rust title="Rust"
+use oasis_rofl_client::RoflClient;
+let client = RoflClient::with_url("http://localhost:8549")?;
+```
 </TabItem>
 </Tabs>
 

docs/rofl/workflow/test.mdx

@@ -3,15 +3,13 @@ name = "oasis-rofl-client"
 version = "0.1.0"
 edition = "2021"
 license = "Apache-2.0"
-description = "Rust client for ROFL appd (Unix domain socket HTTP)."
+description = "Rust client for ROFL appd over UNIX domain sockets and 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

@@ -1,11 +1,15 @@
 # rofl-client/rs/README.md
-Rust client for the ROFL appd over a Unix domain socket.
+Rust client for the ROFL appd over UNIX domain sockets and plain HTTP.
 
 - Default socket: `/run/rofl-appd.sock`
+- HTTP constructor: `RoflClient::with_url("http://localhost:8549")`
 - Endpoints used:
   - `GET /rofl/v1/app/id`
   - `POST /rofl/v1/keys/generate`
   - `POST /rofl/v1/tx/sign-submit`
+  - `GET /rofl/v1/metadata`
+  - `POST /rofl/v1/metadata`
+  - `POST /rofl/v1/query`
 
 Quickstart:
 
@@ -14,7 +18,11 @@ use oasis_rofl_client::{KeyKind, RoflClient};
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
-    let client = RoflClient::new()?;
+    let client = match std::env::var("ROFL_CLIENT_URL") {
+        Ok(url) => RoflClient::with_url(&url)?,
+        Err(_) => RoflClient::new()?,
+    };
+
     println!("app id: {}", client.get_app_id().await?);
     println!(
         "key: {}",
@@ -25,5 +33,6 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 ```
 
 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`.
+- `RoflClient::new()` and `RoflClient::with_socket_path()` keep using UNIX sockets.
+- `RoflClient::with_url()` accepts `http://...` URLs and custom socket paths; `https://...` is rejected explicitly.
+- Methods are `async` and internally offload blocking transport I/O via `tokio::task::spawn_blocking`.

rofl-client/rs/README.md

@@ -3,7 +3,11 @@ use oasis_rofl_client::{KeyKind, RoflClient};
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
-    let client = RoflClient::new()?;
+    let client = match std::env::var("ROFL_CLIENT_URL") {
+        Ok(url) => RoflClient::with_url(&url)?,
+        Err(_) => RoflClient::new()?,
+    };
+
     println!("app id: {}", client.get_app_id().await?);
     println!(
         "key: {}",