refactor: FM-321 move orb relay client

.gitignore

@@ -14,6 +14,7 @@
 
 # IDE stuff
 .idea/
+.vscode/
 
 # Allow developers to use python pre-commit locally
 /.pre-commit-config.yaml

relay-client/Cargo.toml

@@ -1,20 +1,26 @@
 [package]
 name = "orb-relay-client"
 version = "0.1.0"
-edition.workspace = true
 publish = false
 
+# orb-core can't consume crates that use workspace inheritance :(
+edition = "2021"
+license = "MIT OR (Apache-2.0 WITH LLVM-exception)"
+repository = "https://github.com/worldcoin/orb-software"
+rust-version = "1.82.0"
+
 [dependencies]
 clap = { version = "4", features = ["derive"] }
 eyre.workspace = true
-json5 = "0.4"
 orb-relay-messages.workspace = true
 orb-security-utils = { workspace = true, features = ["reqwest"] }
+orb-telemetry.workspace = true
 rand = "0.8"
 serde_json.workspace = true
+secrecy.workspace = true
 sha2 = "0.10"
 tokio-stream.workspace = true
 tokio-util.workspace = true
 tokio.workspace = true
-tracing-subscriber = "0.3"
+tracing-subscriber.workspace = true
 tracing.workspace = true

relay-client/src/bin/decode-msg.rs

@@ -18,7 +18,7 @@ fn main() -> Result<()> {
 
 fn decode_payload(json: &str) -> Result<String> {
     println!("json: {}", json);
-    let v: Value = json5::from_str(json)?;
+    let v: Value = serde_json::from_str(json)?;
     let any = Any {
         type_url: v["type_url"]
             .as_str()

relay-client/src/bin/manual-test.rs

@@ -1,5 +1,3 @@
-#![allow(dead_code)]
-
 use clap::Parser;
 use eyre::{Ok, Result};
 use orb_relay_client::{client::Client, debug_any, PayloadMatcher};
@@ -56,7 +54,9 @@ struct Args {
 
 #[tokio::main]
 async fn main() -> Result<()> {
-    tracing_subscriber::fmt().init();
+    orb_telemetry::TelemetryConfig::new()
+        .with_journald("worldcoin-relay-client")
+        .init();
 
     let args = Args::parse();
 
@@ -120,7 +120,7 @@ async fn app_to_orb() -> Result<()> {
 
     let now = Instant::now();
     'ext: loop {
-        #[allow(clippy::never_loop)]
+        #[expect(clippy::never_loop)]
         for msg in orb_client.get_buffered_messages().await {
             tracing::info!(
                 "Received message: from: {:?}, to: {:?}, seq: {:?}, payload: {:?}",
@@ -160,7 +160,7 @@ async fn app_to_orb() -> Result<()> {
 
     let now = Instant::now();
     'ext: loop {
-        #[allow(clippy::never_loop)]
+        #[expect(clippy::never_loop)]
         for msg in orb_client.get_buffered_messages().await {
             tracing::info!(
                 "Received message: from: {:?}, to: {:?}, seq: {:?}, payload: {:?}",
@@ -234,7 +234,7 @@ async fn orb_to_app() -> Result<()> {
 
     let now = Instant::now();
     'ext: loop {
-        #[allow(clippy::never_loop)]
+        #[expect(clippy::never_loop)]
         for msg in app_client.get_buffered_messages().await {
             tracing::info!(
                 "Received message: from: {:?}, to: {:?}, seq: {:?}, payload: {:?}",
@@ -274,7 +274,7 @@ async fn orb_to_app() -> Result<()> {
 
     let now = Instant::now();
     'ext: loop {
-        #[allow(clippy::never_loop)]
+        #[expect(clippy::never_loop)]
         for msg in app_client.get_buffered_messages().await {
             tracing::info!(
                 "Received message: from: {:?}, to: {:?}, seq: {:?}, payload: {:?}",
@@ -342,7 +342,7 @@ async fn orb_to_app_with_state_request() -> Result<()> {
 
     let now = Instant::now();
     'ext: loop {
-        #[allow(clippy::never_loop)]
+        #[expect(clippy::never_loop)]
         for msg in app_client.get_buffered_messages().await {
             tracing::info!(
                 "Received message: from: {:?}, to: {:?}, seq: {:?}, payload: {:?}",
@@ -376,7 +376,7 @@ async fn orb_to_app_with_state_request() -> Result<()> {
 
     let now = Instant::now();
     'ext: loop {
-        #[allow(clippy::never_loop)]
+        #[expect(clippy::never_loop)]
         for msg in app_client.get_buffered_messages().await {
             tracing::info!(
                 "Received message: from: {:?}, to: {:?}, seq: {:?}, payload: {:?}",
@@ -404,7 +404,7 @@ async fn orb_to_app_with_state_request() -> Result<()> {
 
     let now = Instant::now();
     'ext: loop {
-        #[allow(clippy::never_loop)]
+        #[expect(clippy::never_loop)]
         for msg in app_client.get_buffered_messages().await {
             tracing::info!(
                 "Received message: from: {:?}, to: {:?}, seq: {:?}, payload: {:?}",
@@ -476,7 +476,7 @@ async fn orb_to_app_blocking_send() -> Result<()> {
 
     let now = Instant::now();
     'ext: loop {
-        #[allow(clippy::never_loop)]
+        #[expect(clippy::never_loop)]
         for msg in app_client.get_buffered_messages().await {
             tracing::info!(
                 "Received message: from: {:?}, to: {:?}, seq: {:?}, payload: {:?}",
@@ -519,7 +519,7 @@ async fn orb_to_app_blocking_send() -> Result<()> {
 
     let now = Instant::now();
     'ext: loop {
-        #[allow(clippy::never_loop)]
+        #[expect(clippy::never_loop)]
         for msg in app_client.get_buffered_messages().await {
             tracing::info!(
                 "Received message: from: {:?}, to: {:?}, seq: {:?}, payload: {:?}",
@@ -595,7 +595,7 @@ async fn orb_to_app_with_clients_created_later_and_delay() -> Result<()> {
 
     let now = Instant::now();
     'ext: loop {
-        #[allow(clippy::never_loop)]
+        #[expect(clippy::never_loop)]
         for msg in app_client.get_buffered_messages().await {
             tracing::info!(
                 "Received message: from: {:?}, to: {:?}, seq: {:?}, payload: {:?}",
@@ -657,7 +657,7 @@ async fn stage_consumer_app() -> Result<()> {
     tracing::info!("Time took to connect: {}ms", now.elapsed().as_millis());
 
     loop {
-        #[allow(clippy::never_loop)]
+        #[expect(clippy::never_loop)]
         for msg in app_client.get_buffered_messages().await {
             tracing::info!(
                 "Received message: from: {:?}, to: {:?}, seq: {:?}, payload: {:?}",
@@ -715,7 +715,7 @@ async fn stage_producer_from_app_start_orb_signup() -> Result<()> {
     tokio::time::sleep(tokio::time::Duration::from_secs(1)).await;
 
     loop {
-        #[allow(clippy::never_loop)]
+        #[expect(clippy::never_loop)]
         for msg in app_client.get_buffered_messages().await {
             tracing::info!(
                 "Received message: from: {:?}, to: {:?}, seq: {:?}, payload: {:?}",

relay-client/src/client.rs

@@ -21,6 +21,7 @@ use orb_security_utils::reqwest::{
     GTS_ROOT_R1_CERT, GTS_ROOT_R2_CERT, GTS_ROOT_R3_CERT, GTS_ROOT_R4_CERT,
     SFS_ROOT_G2_CERT,
 };
+use secrecy::{ExposeSecret, SecretString};
 use std::{
     any::type_name,
     collections::{BTreeMap, VecDeque},
@@ -38,15 +39,15 @@ use tokio_util::sync::CancellationToken;
 
 #[derive(Debug, Clone)]
 pub struct TokenAuth {
-    token: String,
+    token: SecretString,
 }
 
 #[derive(Debug, Clone)]
 pub struct ZkpAuth {
-    root: String,
-    signal: String,
-    nullifier_hash: String,
-    proof: String,
+    root: SecretString,
+    signal: SecretString,
+    nullifier_hash: SecretString,
+    proof: SecretString,
 }
 
 #[derive(Debug, Clone)]
@@ -164,7 +165,9 @@ impl Client {
     ) -> Self {
         Self::new(
             url,
-            Auth::Token(TokenAuth { token }),
+            Auth::Token(TokenAuth {
+                token: token.into(),
+            }),
             orb_id,
             session_id,
             Mode::Orb,
@@ -181,7 +184,9 @@ impl Client {
     ) -> Self {
         Self::new(
             url,
-            Auth::Token(TokenAuth { token }),
+            Auth::Token(TokenAuth {
+                token: token.into(),
+            }),
             session_id,
             orb_id,
             Mode::App,
@@ -202,10 +207,10 @@ impl Client {
         Self::new(
             url,
             Auth::ZKP(ZkpAuth {
-                root,
-                signal,
-                nullifier_hash,
-                proof,
+                root: root.into(),
+                signal: signal.into(),
+                nullifier_hash: nullifier_hash.into(),
+                proof: proof.into(),
             }),
             session_id,
             orb_id,
@@ -665,6 +670,7 @@ impl<'a> PollerAgent<'a> {
         Ok((response_stream, sender_tx))
     }
 
+    // TODO: See if we can move this setup into `orb-security-utils`.
     fn create_tls_config() -> ClientTlsConfig {
         ClientTlsConfig::new().ca_certificates(vec![
             Certificate::from_pem(AWS_ROOT_CA1_CERT),
@@ -693,12 +699,14 @@ impl<'a> PollerAgent<'a> {
                     },
                 }),
                 auth_method: Some(match &self.config.auth {
-                    Auth::Token(t) => AuthMethod::Token(t.token.clone()),
+                    Auth::Token(t) => {
+                        AuthMethod::Token(t.token.expose_secret().to_string())
+                    }
                     Auth::ZKP(z) => AuthMethod::ZkpAuthRequest(ZkpAuthRequest {
-                        root: z.root.clone(),
-                        signal: z.signal.clone(),
-                        nullifier_hash: z.nullifier_hash.clone(),
-                        proof: z.proof.clone(),
+                        root: z.root.expose_secret().to_string(),
+                        signal: z.signal.expose_secret().to_string(),
+                        nullifier_hash: z.nullifier_hash.expose_secret().to_string(),
+                        proof: z.proof.expose_secret().to_string(),
                     }),
                 }),
             })),

relay-client/src/lib.rs

@@ -3,7 +3,6 @@ use orb_relay_messages::{common, prost::Name, prost_types::Any, self_serve};
 
 pub mod client;
 
-#[allow(missing_docs)]
 pub trait PayloadMatcher {
     type Output;
     fn matches(payload: &Any) -> Option<Self::Output>;
@@ -67,7 +66,6 @@ impl PayloadMatcher for self_serve::orb::v1::SignupEnded {
     }
 }
 
-#[allow(missing_docs)]
 pub trait IntoPayload {
     fn into_payload(self) -> Any;
 }