Rust: Added env check to examples (iotaledger#1676)

* Added check

* changed to expect

* allow single for loop

* fix logger test

* changed to unwrap_or

Author: Brord van Wierst

sdk/Cargo.toml

@@ -847,7 +847,7 @@ required-features = ["wallet", "participation"]
 [[example]]
 name = "logger"
 path = "examples/wallet/logger.rs"
-required-features = ["wallet"]
+required-features = ["wallet", "storage"]
 
 [[example]]
 name = "recover_accounts"

sdk/examples/client/01_generate_addresses.rs

@@ -19,6 +19,10 @@ async fn main() -> Result<()> {
     // This example uses secrets in environment variables for simplicity which should not be done in production.
     dotenvy::dotenv().ok();
 
+    for var in ["NODE_URL", "MNEMONIC"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     // Create a node client.
     let client = Client::builder()
         .with_node(&std::env::var("NODE_URL").unwrap())?

sdk/examples/client/02_address_balance.rs

@@ -22,6 +22,10 @@ async fn main() -> Result<()> {
     // This example uses secrets in environment variables for simplicity which should not be done in production.
     dotenvy::dotenv().ok();
 
+    for var in ["NODE_URL", "MNEMONIC"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     // Create a node client.
     let client = Client::builder()
         .with_node(&std::env::var("NODE_URL").unwrap())?

sdk/examples/client/block/00_block_no_payload.rs

@@ -15,6 +15,10 @@ async fn main() -> Result<()> {
     // This example uses secrets in environment variables for simplicity which should not be done in production.
     dotenvy::dotenv().ok();
 
+    for var in ["NODE_URL", "EXPLORER_URL"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     let node_url = std::env::var("NODE_URL").unwrap();
 
     // Create a node client.

sdk/examples/client/block/01_block_confirmation_time.rs

@@ -15,6 +15,10 @@ async fn main() -> Result<()> {
     // This example uses secrets in environment variables for simplicity which should not be done in production.
     dotenvy::dotenv().ok();
 
+    for var in ["NODE_URL", "EXPLORER_URL"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     let node_url = std::env::var("NODE_URL").unwrap();
 
     // Create a node client.

sdk/examples/client/block/02_block_custom_parents.rs

@@ -15,6 +15,10 @@ async fn main() -> Result<()> {
     // This example uses secrets in environment variables for simplicity which should not be done in production.
     dotenvy::dotenv().ok();
 
+    for var in ["NODE_URL", "EXPLORER_URL"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     let node_url = std::env::var("NODE_URL").unwrap();
 
     // Create a node client.

sdk/examples/client/block/03_block_custom_payload.rs

@@ -18,6 +18,10 @@ async fn main() -> Result<()> {
     // This example uses secrets in environment variables for simplicity which should not be done in production.
     dotenvy::dotenv().ok();
 
+    for var in ["NODE_URL", "EXPLORER_URL"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     let node_url = std::env::var("NODE_URL").unwrap();
 
     // Create a node client.

sdk/examples/client/block/04_block_tagged_data.rs

@@ -18,6 +18,10 @@ async fn main() -> Result<()> {
     // This example uses secrets in environment variables for simplicity which should not be done in production.
     dotenvy::dotenv().ok();
 
+    for var in ["NODE_URL", "EXPLORER_URL"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     let node_url = std::env::var("NODE_URL").unwrap();
 
     let tag = std::env::args().nth(1).unwrap_or_else(|| "Hello".to_string());

sdk/examples/client/block/custom_inputs.rs

@@ -21,6 +21,10 @@ async fn main() -> Result<()> {
     // This example uses secrets in environment variables for simplicity which should not be done in production.
     dotenvy::dotenv().ok();
 
+    for var in ["NODE_URL", "EXPLORER_URL", "FAUCET_URL", "MNEMONIC"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     let node_url = std::env::var("NODE_URL").unwrap();
     let faucet_url = std::env::var("FAUCET_URL").unwrap();
 

sdk/examples/client/block/output.rs

@@ -18,6 +18,10 @@ async fn main() -> Result<()> {
     // This example uses secrets in environment variables for simplicity which should not be done in production.
     dotenvy::dotenv().ok();
 
+    for var in ["NODE_URL", "EXPLORER_URL", "FAUCET_URL", "MNEMONIC"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     let node_url = std::env::var("NODE_URL").unwrap();
     let faucet_url = std::env::var("FAUCET_URL").unwrap();
 

sdk/examples/client/block/transaction.rs

@@ -15,6 +15,10 @@ async fn main() -> Result<()> {
     // This example uses secrets in environment variables for simplicity which should not be done in production.
     dotenvy::dotenv().ok();
 
+    for var in ["NODE_URL", "EXPLORER_URL", "FAUCET_URL", "MNEMONIC"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     let node_url = std::env::var("NODE_URL").unwrap();
     let faucet_url = std::env::var("FAUCET_URL").unwrap();
 

sdk/examples/client/custom_remainder_address.rs

@@ -16,14 +16,18 @@ use iota_sdk::client::{
 
 #[tokio::main]
 async fn main() -> Result<()> {
+    // This example uses secrets in environment variables for simplicity which should not be done in production.
+    dotenvy::dotenv().ok();
+
+    for var in ["NODE_URL", "MNEMONIC", "FAUCET_URL", "EXPLORER_URL"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     let amount = std::env::args()
         .nth(1)
         .map(|s| s.parse::<u64>().unwrap())
         .unwrap_or(9_000_000);
 
-    // This example uses secrets in environment variables for simplicity which should not be done in production.
-    dotenvy::dotenv().ok();
-
     // Create a client instance.
     let client = Client::builder()
         .with_node(&std::env::var("NODE_URL").unwrap())?

sdk/examples/client/get_block.rs

@@ -15,6 +15,11 @@ async fn main() -> Result<()> {
     // This example uses secrets in environment variables for simplicity which should not be done in production.
     dotenvy::dotenv().ok();
 
+    #[allow(clippy::single_element_loop)]
+    for var in ["NODE_URL"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     // Create a node client.
     let client = Client::builder()
         .with_node(&std::env::var("NODE_URL").unwrap())?

sdk/examples/client/high_level/consolidation.rs

@@ -15,6 +15,10 @@ async fn main() -> Result<()> {
     // This example uses secrets in environment variables for simplicity which should not be done in production.
     dotenvy::dotenv().ok();
 
+    for var in ["NODE_URL", "EXPLORER_URL", "MNEMONIC"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     let address_range_start = std::env::args().nth(1).map(|s| s.parse::<u32>().unwrap()).unwrap_or(0);
     let address_range_len = std::env::args().nth(2).map(|s| s.parse::<u32>().unwrap()).unwrap_or(10);
 

sdk/examples/client/high_level/inputs_from_transaction_id.rs

@@ -20,6 +20,11 @@ async fn main() -> Result<()> {
     // This example uses secrets in environment variables for simplicity which should not be done in production.
     dotenvy::dotenv().ok();
 
+    #[allow(clippy::single_element_loop)]
+    for var in ["NODE_URL"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     let node_url = std::env::var("NODE_URL").unwrap();
 
     // Create a node client.

sdk/examples/client/high_level/search_address.rs

@@ -20,6 +20,10 @@ async fn main() -> Result<()> {
     // This example uses secrets in environment variables for simplicity which should not be done in production.
     dotenvy::dotenv().ok();
 
+    for var in ["NODE_URL", "MNEMONIC"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     let node_url = std::env::var("NODE_URL").unwrap();
 
     // Create a node client.

sdk/examples/client/ledger_nano_transaction.rs

@@ -30,6 +30,10 @@ async fn main() -> Result<()> {
     // This example uses secrets in environment variables for simplicity which should not be done in production.
     dotenvy::dotenv().ok();
 
+    for var in ["NODE_URL", "EXPLORER_URL"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     // Create a client instance
     let client = Client::builder()
         .with_node(&std::env::var("NODE_URL").unwrap())?

sdk/examples/client/logger.rs

@@ -15,6 +15,11 @@ async fn main() -> Result<()> {
     // This example uses secrets in environment variables for simplicity which should not be done in production.
     dotenvy::dotenv().ok();
 
+    #[allow(clippy::single_element_loop)]
+    for var in ["NODE_URL"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     // Generates a client.log file with logs for debugging.
     // We exclude logs from h2, hyper and rustls to reduce the noise.
     let logger_output_config = fern_logger::LoggerOutputConfigBuilder::new()

sdk/examples/client/node_api_core/01_get_routes.rs

@@ -14,11 +14,10 @@ use iota_sdk::client::{Client, Result};
 async fn main() -> Result<()> {
     // If not provided we use the default node from the `.env` file.
     dotenvy::dotenv().ok();
-
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(1)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder()

sdk/examples/client/node_api_core/03_get_tips.rs

@@ -18,7 +18,7 @@ async fn main() -> Result<()> {
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(1)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder().with_node(&node_url)?.finish().await?;

sdk/examples/client/node_api_core/04_post_block.rs

@@ -15,10 +15,15 @@ async fn main() -> Result<()> {
     // If not provided we use the default node from the `.env` file.
     dotenvy::dotenv().ok();
 
+    #[allow(clippy::single_element_loop)]
+    for var in ["EXPLORER_URL"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(1)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder().with_node(&node_url)?.finish().await?;

sdk/examples/client/node_api_core/05_post_block_raw.rs

@@ -15,10 +15,15 @@ async fn main() -> Result<()> {
     // If not provided we use the default node from the `.env` file.
     dotenvy::dotenv().ok();
 
+    #[allow(clippy::single_element_loop)]
+    for var in ["EXPLORER_URL"] {
+        std::env::var(var).unwrap_or_else(|_| panic!(".env variable '{var}' is undefined, see .env.example"));
+    }
+
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(1)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder().with_node(&node_url)?.finish().await?;

sdk/examples/client/node_api_core/06_get_block.rs

@@ -18,7 +18,7 @@ async fn main() -> Result<()> {
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(2)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder().with_node(&node_url)?.finish().await?;

sdk/examples/client/node_api_core/07_get_block_raw.rs

@@ -18,7 +18,7 @@ async fn main() -> Result<()> {
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(2)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder().with_node(&node_url)?.finish().await?;

sdk/examples/client/node_api_core/08_get_block_metadata.rs

@@ -18,7 +18,7 @@ async fn main() -> Result<()> {
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(2)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder().with_node(&node_url)?.finish().await?;

sdk/examples/client/node_api_core/09_get_output.rs

@@ -23,7 +23,7 @@ async fn main() -> Result<()> {
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(2)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder().with_node(&node_url)?.finish().await?;

sdk/examples/client/node_api_core/10_get_output_raw.rs

@@ -23,7 +23,7 @@ async fn main() -> Result<()> {
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(2)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder().with_node(&node_url)?.finish().await?;

sdk/examples/client/node_api_core/11_get_output_metadata.rs

@@ -23,7 +23,7 @@ async fn main() -> Result<()> {
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(2)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder().with_node(&node_url)?.finish().await?;

sdk/examples/client/node_api_core/12_get_receipts.rs

@@ -18,7 +18,7 @@ async fn main() -> Result<()> {
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(1)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder().with_node(&node_url)?.finish().await?;

sdk/examples/client/node_api_core/13_get_receipts_migrated_at.rs

@@ -19,7 +19,7 @@ async fn main() -> Result<()> {
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(2)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder().with_node(&node_url)?.finish().await?;

sdk/examples/client/node_api_core/14_get_treasury.rs

@@ -18,7 +18,7 @@ async fn main() -> Result<()> {
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(1)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder().with_node(&node_url)?.finish().await?;

sdk/examples/client/node_api_core/17_get_milestone_by_id.rs

@@ -22,7 +22,7 @@ async fn main() -> Result<()> {
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(2)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder().with_node(&node_url)?.finish().await?;

sdk/examples/client/node_api_core/18_get_milestone_by_id_raw.rs

@@ -22,7 +22,7 @@ async fn main() -> Result<()> {
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(2)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder().with_node(&node_url)?.finish().await?;

sdk/examples/client/node_api_core/19_get_utxo_changes_by_id.rs

@@ -22,7 +22,7 @@ async fn main() -> Result<()> {
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(2)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder().with_node(&node_url)?.finish().await?;

sdk/examples/client/node_api_core/20_get_milestone_by_index.rs

@@ -19,7 +19,7 @@ async fn main() -> Result<()> {
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(2)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder().with_node(&node_url)?.finish().await?;

sdk/examples/client/node_api_core/21_get_milestone_by_index_raw.rs

@@ -19,7 +19,7 @@ async fn main() -> Result<()> {
     // Take the node URL from command line argument or use one from env as default.
     let node_url = std::env::args()
         .nth(2)
-        .unwrap_or_else(|| std::env::var("NODE_URL").unwrap());
+        .unwrap_or_else(|| std::env::var("NODE_URL").expect("NODE_URL not set"));
 
     // Create a node client.
     let client = Client::builder().with_node(&node_url)?.finish().await?;