feat: add api-public-url parameter (#153)

TomasArrachea · web-flow · commit 4509db6efb36 · 2025-11-11T13:57:51.000-08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.12.1 (2025-11-11)
+
+- Added `api-public-url` CLI param to fix the backend and frontend communication ([#153](https://github.com/0xMiden/miden-faucet/pull/153)).
+
 ## 0.12.0 (2025-11-10)
 
 - Added requested `amount` to PoW Challenge ([#68](https://github.com/0xMiden/miden-faucet/pull/68)).
@@ -12,7 +16,7 @@
 - Separated frontend and backend servers ([#119](https://github.com/0xMiden/miden-faucet/pull/119)).
 - Frontend now awaits for the transaction to be committed ([#127](https://github.com/0xMiden/miden-faucet/pull/127)).
 - Added 10-block expiration delta to faucet minting transactions ([#136](https://github.com/0xMiden/miden-faucet/pull/136)).
-- 
+
 ## 0.11.8 (2025-10-27)
 
 - Sync state before creating transactions to avoid desync errors (#[132](https://github.com/0xMiden/miden-faucet/pull/132)).
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -12,7 +12,7 @@ license      = "MIT"
 readme       = "README.md"
 repository   = "https://github.com/0xMiden/miden-faucet"
 rust-version = "1.90"
-version      = "0.12.0"
+version      = "0.12.1"
 
 # Optimize the cryptography for faster tests involving account creation.
 [profile.test.package.miden-crypto]
diff --git a/bin/faucet/.env b/bin/faucet/.env
@@ -13,7 +13,8 @@ MIDEN_FAUCET_MAX_SUPPLY=
 
 # Faucet Service Configuration
 MIDEN_FAUCET_FRONTEND_URL=http://0.0.0.0:8080
-MIDEN_FAUCET_API_URL=http://0.0.0.0:8000
+MIDEN_FAUCET_API_BIND_URL=http://0.0.0.0:8000
+MIDEN_FAUCET_API_PUBLIC_URL=
 MIDEN_FAUCET_MAX_CLAIMABLE_AMOUNT=
 MIDEN_FAUCET_ENABLE_OTEL=false
 MIDEN_FAUCET_BASE_AMOUNT=
diff --git a/bin/faucet/src/frontend.rs b/bin/faucet/src/frontend.rs
@@ -13,10 +13,10 @@ use url::Url;
 use crate::COMPONENT;
 
 /// Serves the frontend API endpoints.
-pub async fn serve_frontend(url: Url, api_url: Url, node_url: String) -> anyhow::Result<()> {
+pub async fn serve_frontend(url: Url, api_public_url: Url, node_url: String) -> anyhow::Result<()> {
     let config_json = Json(
         serde_json::json!({
-            "api_url": api_url.to_string().trim_end_matches('/'),
+            "api_url": api_public_url.to_string().trim_end_matches('/'),
             "node_url": node_url.trim_end_matches('/'),
         })
         .to_string(),
diff --git a/bin/faucet/src/main.rs b/bin/faucet/src/main.rs
@@ -49,7 +49,8 @@ use crate::network::FaucetNetwork;
 pub const REQUESTS_QUEUE_SIZE: usize = 1000;
 const COMPONENT: &str = "miden-faucet-server";
 
-const ENV_API_URL: &str = "MIDEN_FAUCET_API_URL";
+const ENV_API_BIND_URL: &str = "MIDEN_FAUCET_API_BIND_URL";
+const ENV_API_PUBLIC_URL: &str = "MIDEN_FAUCET_API_PUBLIC_URL";
 const ENV_FRONTEND_URL: &str = "MIDEN_FAUCET_FRONTEND_URL";
 const ENV_NETWORK: &str = "MIDEN_FAUCET_NETWORK";
 const ENV_NODE_URL: &str = "MIDEN_FAUCET_NODE_URL";
@@ -129,12 +130,15 @@ pub enum Command {
         #[clap(flatten)]
         config: ClientConfig,
 
-        /// API URL, in the format `<ip>:<port>`.
-        #[arg(long = "api-url", value_name = "URL", env = ENV_API_URL)]
-        api_url: Url,
+        /// URL to bind the API server.
+        #[arg(long = "api-bind-url", value_name = "URL", env = ENV_API_BIND_URL)]
+        api_bind_url: Url,
 
-        /// Frontend API URL, in the format `<ip>:<port>`. If not set, the frontend will not be
-        /// served.
+        /// Public URL to access the API server. If not set, the bind url will be used.
+        #[arg(long = "api-public-url", value_name = "URL", env = ENV_API_PUBLIC_URL)]
+        api_public_url: Option<Url>,
+
+        /// URL to bind the frontend server. If not set, the frontend will not be served.
         #[arg(long = "frontend-url", value_name = "URL", env = ENV_FRONTEND_URL)]
         frontend_url: Option<Url>,
 
@@ -324,7 +328,8 @@ async fn run_faucet_command(cli: Cli) -> anyhow::Result<()> {
                     network,
                     store_path,
                 },
-            api_url,
+            api_bind_url,
+            api_public_url,
             frontend_url,
             max_claimable_amount,
             pow_secret,
@@ -402,12 +407,16 @@ async fn run_faucet_command(cli: Cli) -> anyhow::Result<()> {
             let mut tasks = JoinSet::new();
             let mut tasks_ids = HashMap::new();
 
-            let api_id = tasks.spawn(api_server.serve(api_url.clone())).id();
+            let api_id = tasks.spawn(api_server.serve(api_bind_url.clone())).id();
             tasks_ids.insert(api_id, "api");
 
             if let Some(frontend_url) = frontend_url {
                 let frontend_id = tasks
-                    .spawn(serve_frontend(frontend_url, api_url, node_endpoint.to_string()))
+                    .spawn(serve_frontend(
+                        frontend_url,
+                        api_public_url.unwrap_or(api_bind_url),
+                        node_endpoint.to_string(),
+                    ))
                     .id();
                 tasks_ids.insert(frontend_id, "frontend");
             }
@@ -628,7 +637,8 @@ mod tests {
                 Box::pin(run_faucet_command(Cli {
                     command: crate::Command::Start {
                         config,
-                        api_url: Url::try_from(api_url).unwrap(),
+                        api_bind_url: Url::try_from(api_url).unwrap(),
+                        api_public_url: None,
                         frontend_url: Some(Url::parse(frontend_url).unwrap()),
                         max_claimable_amount: 1_000_000_000,
                         api_keys: vec![],
diff --git a/docs/src/getting-started/cli.md b/docs/src/getting-started/cli.md
@@ -64,7 +64,8 @@ miden-faucet start \
 
 | Option | Description | Default | Required |
 |--------|-------------|---------|----------|
-| `--api-url` | URL to serve the faucet API | - | Yes |
+| `--api-bind-url` | URL to serve the faucet API | - | Yes |
+| `--api-public-url` | Public URL to access the faucet API. If not set, the bind url will be used. | - | No |
 | `--frontend-url` | URL to serve the Frontend API | - | No |
 | `--node-url` | Miden node RPC endpoint. If not set, it will be derived from the network | - | No |
 | `--network` | Network configuration | `localhost` | No |
@@ -107,7 +108,8 @@ export MIDEN_FAUCET_MAX_SUPPLY=
 
 # Faucet Service Configuration
 export MIDEN_FAUCET_FRONTEND_URL=http://localhost:8080
-export MIDEN_FAUCET_API_URL=http://localhost:8000
+export MIDEN_FAUCET_API_BIND_URL=http://localhost:8000
+export MIDEN_FAUCET_API_PUBLIC_URL=http://localhost:8000
 export MIDEN_FAUCET_MAX_CLAIMABLE_AMOUNT=1000000000
 export MIDEN_FAUCET_ENABLE_OTEL=true
 export MIDEN_FAUCET_BASE_AMOUNT=100000000
