linera-service: faucet URL env var (#4710)

Twey · web-flow · commit cc421e8f6e62 · 2025-10-02T21:30:38.000Z
## Motivation Quality of life: it's pretty annoying when using `linera net up` to have to repeat the faucet URL all the time. ## Proposal Support setting the faucet URL through an environment variable for the CLI, akin to `LINERA_WALLET` and friends. This reduces the need for repeating the URL a lot when testing on a local network. ## Test Plan Used locally. ## Release Plan - Nothing to do / These changes follow the usual release cycle. ## Links - [reviewer checklist](https://github.com/linera-io/linera-protocol/blob/main/CONTRIBUTING.md#reviewer-checklist)
diff --git a/CLI.md b/CLI.md
@@ -989,7 +989,9 @@ Initialize a wallet from the genesis configuration
 
 ###### **Options:**
 
-* `--genesis <GENESIS_CONFIG_PATH>` — The path to the genesis configuration for a Linera deployment. Either this or `--faucet` must be specified
+* `--genesis <GENESIS_CONFIG_PATH>` — The path to the genesis configuration for a Linera deployment. Either this or `--faucet` must be specified.
+
+   Overrides `--faucet` if provided.
 * `--faucet <FAUCET>` — The address of a faucet
 * `--testing-prng-seed <TESTING_PRNG_SEED>` — Force this wallet to generate keys using a PRNG and a given seed. USE FOR TESTING ONLY
 
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/linera-service/Cargo.toml b/linera-service/Cargo.toml
@@ -89,6 +89,7 @@ fs_extra = { workspace = true, optional = true }
 futures.workspace = true
 heck.workspace = true
 http.workspace = true
+insta.workspace = true
 k8s-openapi = { workspace = true, optional = true }
 kube = { workspace = true, optional = true }
 linera-base.workspace = true
diff --git a/linera-service/src/cli/command.rs b/linera-service/src/cli/command.rs
@@ -138,7 +138,7 @@ pub enum BenchmarkCommand {
         processes: usize,
 
         /// The faucet (which implicitly defines the network)
-        #[arg(long)]
+        #[arg(long, env = "LINERA_FAUCET_URL")]
         faucet: String,
 
         /// If specified, a directory with a random name will be created in this directory, and the
@@ -1212,11 +1212,13 @@ pub enum WalletCommand {
     Init {
         /// The path to the genesis configuration for a Linera deployment. Either this or `--faucet`
         /// must be specified.
+        ///
+        /// Overrides `--faucet` if provided.
         #[arg(long = "genesis")]
         genesis_config_path: Option<PathBuf>,
 
         /// The address of a faucet.
-        #[arg(long = "faucet")]
+        #[arg(long, env = "LINERA_FAUCET_URL")]
         faucet: Option<String>,
 
         /// Force this wallet to generate keys using a PRNG and a given seed. USE FOR
@@ -1228,7 +1230,7 @@ pub enum WalletCommand {
     /// Request a new chain from a faucet and add it to the wallet.
     RequestChain {
         /// The address of a faucet.
-        #[arg(long)]
+        #[arg(long, env = "LINERA_FAUCET_URL")]
         faucet: String,
 
         /// Whether this chain should become the default chain.
diff --git a/linera-service/src/cli/main.rs b/linera-service/src/cli/main.rs
@@ -1589,8 +1589,12 @@ impl Runnable for Job {
                 );
             }
 
-            Wallet(WalletCommand::Init { faucet, .. }) => {
-                let Some(faucet_url) = faucet else {
+            Wallet(WalletCommand::Init {
+                faucet,
+                genesis_config_path,
+                ..
+            }) => {
+                let (Some(faucet_url), None) = (faucet, genesis_config_path) else {
                     return Ok(());
                 };
                 let Some(network_description) = storage.read_network_description().await? else {
@@ -2448,7 +2452,10 @@ async fn run(options: &ClientOptions) -> Result<i32, Error> {
             } => {
                 let start_time = Instant::now();
                 let genesis_config: GenesisConfig = match (genesis_config_path, faucet) {
-                    (Some(genesis_config_path), None) => util::read_json(genesis_config_path)?,
+                    (None, None) => {
+                        anyhow::bail!("please specify one of `--faucet` or `--genesis`.")
+                    }
+                    (Some(genesis_config_path), _) => util::read_json(genesis_config_path)?,
                     (None, Some(url)) => {
                         let faucet = cli_wrappers::Faucet::new(url.clone());
                         let version_info = faucet
@@ -2474,7 +2481,6 @@ Make sure to use a Linera client compatible with this network.
                             .await
                             .context("Failed to obtain the genesis configuration from the faucet")?
                     }
-                    (_, _) => bail!("Either --faucet or --genesis must be specified, but not both"),
                 };
                 let mut keystore = options.create_keystore(*testing_prng_seed)?;
                 keystore.persist().await?;
diff --git a/linera-service/src/cli/net_up_utils.rs b/linera-service/src/cli/net_up_utils.rs
@@ -318,21 +318,21 @@ async fn print_messages_and_create_faucet(
         "{}",
         format!(
             "export LINERA_WALLET=\"{}\"",
-            client.wallet_path().display()
+            client.wallet_path().display(),
         )
-        .bold()
+        .bold(),
     );
     println!(
         "{}",
         format!(
             "export LINERA_KEYSTORE=\"{}\"",
-            client.keystore_path().display()
+            client.keystore_path().display(),
         )
         .bold()
     );
     println!(
         "{}",
-        format!("export LINERA_STORAGE=\"{}\"\n", client.storage_path()).bold()
+        format!("export LINERA_STORAGE=\"{}\"", client.storage_path()).bold(),
     );
 
     let wallet = client.load_wallet()?;
@@ -344,16 +344,23 @@ async fn print_messages_and_create_faucet(
             assert!(
                 num_other_initial_chains > faucet_chain_idx,
                 "num_other_initial_chains must be strictly greater than the faucet chain index if \
-            with_faucet is true"
+                 with_faucet is true"
+            );
+
+            eprintln!("To connect to this network, you can use the following faucet URL:");
+            println!(
+                "{}",
+                format!("export LINERA_FAUCET_URL=\"http://localhost:{faucet_port}\"").bold(),
             );
+
             // This picks a lexicographically faucet_chain_idx-th non-admin chain.
             Some(
                 chains
                     .into_iter()
                     .filter(|chain_id| *chain_id != wallet.genesis_admin_chain())
                     .nth(faucet_chain_idx as usize)
-                    .unwrap(),
-            ) // we checked that there are enough chains above, so this should be safe
+                    .expect("there should be at least one non-admin chain"),
+            )
         } else {
             None
         };
@@ -365,6 +372,8 @@ async fn print_messages_and_create_faucet(
         None
     };
 
+    println!();
+
     eprintln!(
         "\nREADY!\nPress ^C to terminate the local test network and clean the temporary directory."
     );
diff --git a/linera-service/src/cli_wrappers/wallet.rs b/linera-service/src/cli_wrappers/wallet.rs
@@ -43,7 +43,6 @@ use tokio::{
     sync::oneshot,
     task::JoinHandle,
 };
-use tracing::{error, info, warn};
 
 use crate::{
     cli::command::BenchmarkCommand,
@@ -486,10 +485,10 @@ impl ClientWrapper {
                 .send()
                 .await;
             if request.is_ok() {
-                info!("Node service has started");
+                tracing::info!("Node service has started");
                 return Ok(NodeService::new(port, child));
             } else {
-                warn!("Waiting for node service to start");
+                tracing::warn!("Waiting for node service to start");
             }
         }
         bail!("Failed to start node service");
@@ -568,10 +567,10 @@ impl ClientWrapper {
                 .send()
                 .await;
             if request.is_ok() {
-                info!("Faucet has started");
+                tracing::info!("Faucet has started");
                 return Ok(FaucetService::new(port, child, temp_dir));
             } else {
-                warn!("Waiting for faucet to start");
+                tracing::debug!("Waiting for faucet to start");
             }
         }
         bail!("Failed to start faucet");
@@ -1120,7 +1119,7 @@ impl ClientWrapper {
 
         let contract_size = fs_err::tokio::metadata(&contract).await?.len();
         let service_size = fs_err::tokio::metadata(&service).await?.len();
-        info!("Done building application {name}: contract_size={contract_size}, service_size={service_size}");
+        tracing::info!("Done building application {name}: contract_size={contract_size}, service_size={service_size}");
 
         Ok((contract, service))
     }
@@ -1135,12 +1134,14 @@ impl Drop for ClientWrapper {
         }
 
         let Ok(binary_path) = self.binary_path.lock() else {
-            error!("Failed to close chains because a thread panicked with a lock to `binary_path`");
+            tracing::error!(
+                "Failed to close chains because a thread panicked with a lock to `binary_path`"
+            );
             return;
         };
 
         let Some(binary_path) = binary_path.as_ref() else {
-            warn!(
+            tracing::warn!(
                 "Assuming no chains need to be closed, because the command binary was never \
                 resolved and therefore presumably never called"
             );
@@ -1159,17 +1160,17 @@ impl Drop for ClientWrapper {
             .args(["wallet", "show", "--short", "--owned"])
             .output()
         else {
-            warn!("Failed to execute `wallet show --short` to list chains to close");
+            tracing::warn!("Failed to execute `wallet show --short` to list chains to close");
             return;
         };
 
         if !wallet_show_output.status.success() {
-            warn!("Failed to list chains in the wallet to close them");
+            tracing::warn!("Failed to list chains in the wallet to close them");
             return;
         }
 
         let Ok(chain_list_string) = String::from_utf8(wallet_show_output.stdout) else {
-            warn!(
+            tracing::warn!(
                 "Failed to close chains because `linera wallet show --short` \
                 returned a non-UTF-8 output"
             );
@@ -1192,8 +1193,8 @@ impl Drop for ClientWrapper {
 
             match close_chain_command.args(["close-chain", chain_id]).status() {
                 Ok(status) if status.success() => (),
-                Ok(failure) => warn!("Failed to close chain {chain_id}: {failure}"),
-                Err(error) => warn!("Failed to close chain {chain_id}: {error}"),
+                Ok(failure) => tracing::warn!("Failed to close chain {chain_id}: {failure}"),
+                Err(error) => tracing::warn!("Failed to close chain {chain_id}: {error}"),
             }
         }
     }
@@ -1412,7 +1413,7 @@ impl NodeService {
                 .send()
                 .await;
             if matches!(result, Err(ref error) if error.is_timeout()) {
-                warn!(
+                tracing::warn!(
                     "Timeout when sending query {} to the node service",
                     truncate_query_output(query)
                 );
@@ -1435,7 +1436,7 @@ impl NodeService {
             );
             let value: Value = response.json().await.context("invalid JSON")?;
             if let Some(errors) = value.get("errors") {
-                warn!(
+                tracing::warn!(
                     "Query \"{}\" failed: {}",
                     truncate_query_output(query),
                     errors
@@ -1617,7 +1618,7 @@ impl<A> ApplicationWrapper<A> {
             let response = match result {
                 Ok(response) => response,
                 Err(error) if i < MAX_RETRIES => {
-                    warn!(
+                    tracing::warn!(
                         "Failed to post query \"{}\": {error}; retrying",
                         truncate_query_output_serialize(&query),
                     );
diff --git a/linera-service/tests/local_net_tests.rs b/linera-service/tests/local_net_tests.rs
@@ -712,37 +712,40 @@ async fn test_storage_service_linera_net_up_simple() -> Result<()> {
     let mut lines = stderr.lines();
 
     let mut is_ready = false;
+    eprintln!("waiting for network to be ready");
     for line in &mut lines {
         let line = line?;
+        eprintln!("[net up]: {line}");
         if line.starts_with("READY!") {
             is_ready = true;
             break;
         }
     }
-    assert!(is_ready, "Unexpected EOF for stderr");
+
+    if !is_ready {
+        assert!(is_ready, "unexpected EOF for stderr");
+    } else {
+        eprintln!("network is ready");
+    }
 
     // Echo faucet stderr for debugging and to empty the buffer.
     std::thread::spawn(move || {
         for line in lines {
-            let line = line.unwrap();
-            eprintln!("{}", line);
+            eprintln!("[net up] {}", line.unwrap());
         }
     });
 
-    let mut exports = stdout.lines();
-    assert!(exports
-        .next()
-        .unwrap()?
-        .starts_with("export LINERA_WALLET="));
-    assert!(exports
-        .next()
-        .unwrap()?
-        .starts_with("export LINERA_KEYSTORE="));
-    assert!(exports
-        .next()
-        .unwrap()?
-        .starts_with("export LINERA_STORAGE="));
-    assert_eq!(exports.next().unwrap()?, "");
+    insta::assert_snapshot!(stdout
+        .lines()
+        .map_while(|line| {
+            println!("{line:?}");
+            line.unwrap()
+                .split_once("=")
+                .map(|x| x.0.to_owned())
+                .filter(|line| line.starts_with("export"))
+        })
+        .collect::<Vec<_>>()
+        .join("\n"));
 
     // Test faucet.
     let faucet = Faucet::new(format!("http://localhost:{}/", port));
@@ -753,7 +756,6 @@ async fn test_storage_service_linera_net_up_simple() -> Result<()> {
         .args(["-s", "INT", &child.id().to_string()])
         .output()?;
 
-    assert!(exports.next().is_none());
     assert!(child.wait()?.success());
     return Ok(());
 }
diff --git a/linera-service/tests/snapshots/local_net_tests__storage_service_linera_net_up_simple.snap b/linera-service/tests/snapshots/local_net_tests__storage_service_linera_net_up_simple.snap
@@ -0,0 +1,8 @@
+---
+source: linera-service/tests/local_net_tests.rs
+expression: "stdout.lines().map_while(|line|\n{\n    println!(\"{line:?}\");\n    line.unwrap().split_once(\"=\").map(|x|\n    x.0.to_owned()).filter(|line| line.starts_with(\"export\"))\n}).collect::<Vec<_>>().join(\"\\n\")"
+---
+export LINERA_WALLET
+export LINERA_KEYSTORE
+export LINERA_STORAGE
+export LINERA_FAUCET_URL
