Max/tcp proxy bin sdk readme (#5354)

* removed old todos
* add bin files to proxy
* add readme to sdk
* fmt

Author: mfahampshire

Cargo.lock

@@ -6,6 +6,14 @@ license.workspace = true
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
+[[bin]]
+name = "nym-proxy-server"
+path = "src/tcp_proxy/bin/proxy_server.rs"
+
+[[bin]]
+name = "nym-proxy-client"
+path = "src/tcp_proxy/bin/proxy_client.rs"
+
 [dependencies]
 async-trait = { workspace = true }
 bip39 = { workspace = true }
@@ -33,6 +41,10 @@ nym-validator-client = { path = "../../../common/client-libs/validator-client",
 nym-socks5-requests = { path = "../../../common/socks5/requests" }
 nym-ordered-buffer = { path = "../../../common/socks5/ordered-buffer" }
 nym-service-providers-common = { path = "../../../service-providers/common" }
+nym-sphinx-addressing = { path = "../../../common/nymsphinx/addressing" }
+nym-bin-common = { path = "../../../common/bin-common", features = [
+    "basic_tracing",
+] }
 bytecodec = { workspace = true }
 httpcodec = { workspace = true }
 bytes = { workspace = true }
@@ -48,6 +60,7 @@ url = { workspace = true }
 toml = { workspace = true }
 
 # tcpproxy dependencies
+clap = { workspace = true, features = ["derive"] }
 anyhow.workspace = true
 dashmap.workspace = true
 tokio.workspace = true

sdk/rust/nym-sdk/Cargo.toml

@@ -0,0 +1,8 @@
+# Nym Rust SDK
+
+This repo contains several components:
+- `mixnet`: exposes Nym Client builders and methods. This is useful if you want to interact directly with the Client, or build transport abstractions.
+- `tcp_proxy`: exposes functionality to set up client/server instances that expose a localhost TcpSocket to read/write to like a 'normal' socket connection. `tcp_proxy/bin/` contains standalone `nym-proxy-client` and `nym-proxy-server` binaries.
+- `clientpool`: a configurable pool of ephemeral Nym Clients which can be created as a background process and quickly grabbed.
+
+Documentation can be found [here](https://nym.com/docs/developers/rust).

sdk/rust/nym-sdk/README.md

@@ -0,0 +1,54 @@
+use anyhow::Result;
+use clap::Parser;
+use nym_sdk::tcp_proxy;
+use nym_sphinx_addressing::Recipient;
+
+#[derive(Parser, Debug)]
+struct Args {
+    /// Send timeout in seconds
+    #[clap(long, default_value_t = 30)]
+    close_timeout: u64,
+
+    /// Nym address of the NymProxyServer e.g. EjYsntVxxBJrcRugiX5VnbKMbg7gyBGSp9SLt7RgeVFV.EzRtVdHCHoP2ho3DJgKMisMQ3zHkqMtAFAW4pxsq7Y2a@Hs463Wh5LtWZU@NyAmt4trcCbNVsuUhry1wpEXpVnAAfn
+    #[clap(short, long)]
+    server_address: String,
+
+    /// Listen address
+    #[clap(long, default_value = "127.0.0.1")]
+    listen_address: String,
+
+    /// Listen port
+    #[clap(long, default_value = "8080")]
+    listen_port: String,
+
+    /// Optional env filepath - if none is supplied then the proxy defaults to using mainnet else just use a path to one of the supplied files in envs/ e.g. ./envs/sandbox.env
+    #[clap(short, long)]
+    env_path: Option<String>,
+
+    /// How many clients to have running in reserve for quick access by incoming connections
+    #[clap(long, default_value_t = 2)]
+    client_pool_reserve: usize,
+}
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    nym_bin_common::logging::setup_tracing_logger();
+    let args = Args::parse();
+
+    let nym_addr: Recipient =
+        Recipient::try_from_base58_string(&args.server_address).expect("Invalid server address");
+
+    let proxy_client = tcp_proxy::NymProxyClient::new(
+        nym_addr,
+        &args.listen_address,
+        &args.listen_port,
+        args.close_timeout,
+        args.env_path.clone(),
+        args.client_pool_reserve,
+    )
+    .await?;
+
+    proxy_client.run().await.unwrap();
+
+    Ok(())
+}

sdk/rust/nym-sdk/src/tcp_proxy/bin/proxy_client.rs

@@ -0,0 +1,37 @@
+use anyhow::Result;
+use clap::Parser;
+use nym_sdk::tcp_proxy;
+
+#[derive(Parser, Debug)]
+struct Args {
+    /// Upstream address of the server process we want to proxy traffic to e.g. 127.0.0.1:9067
+    #[clap(short, long)]
+    upstream_tcp_address: String,
+
+    /// Config directory
+    #[clap(short, long, default_value = "/tmp/nym-tcp-proxy-server")]
+    config_dir: String,
+
+    /// Optional env filepath - if none is supplied then the proxy defaults to using mainnet else just use a path to one of the supplied files in envs/ e.g. ./envs/sandbox.env
+    #[clap(short, long)]
+    env_path: Option<String>,
+}
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    nym_bin_common::logging::setup_logging();
+
+    let args = Args::parse();
+
+    let home_dir = dirs::home_dir().expect("Unable to get home directory");
+    let conf_path = format!("{}{}", home_dir.display(), args.config_dir);
+
+    let mut proxy_server = tcp_proxy::NymProxyServer::new(
+        &args.upstream_tcp_address,
+        &conf_path,
+        args.env_path.clone(),
+    )
+    .await?;
+
+    proxy_server.run_with_shutdown().await
+}