fixup! 0a36a79

Author: f3r10

sim-cli/src/main.rs

@@ -1,7 +1,5 @@
-use anyhow::anyhow;
-use clap::Parser;
 use log::LevelFilter;
-use sim_cli::parsing::{create_simulation, create_simulation_with_network, read_sim_path, Cli};
+use sim_cli::parsing::{create_simulation, create_simulation_with_network, parse_cli};
 use simple_logger::SimpleLogger;
 use tokio_util::task::TaskTracker;
 
@@ -13,7 +11,7 @@ async fn main() -> anyhow::Result<()> {
         console_subscriber::init();
     }
 
-    let cli = Cli::parse();
+    let (cli, sim_params) = parse_cli().await?;
 
     SimpleLogger::new()
         .with_level(LevelFilter::Warn)
@@ -22,16 +20,6 @@ async fn main() -> anyhow::Result<()> {
         .init()
         .unwrap();
 
-    let sim_path = read_sim_path(cli.data_dir.clone(), cli.sim_file.clone()).await?;
-    let sim_params = serde_json::from_str(&std::fs::read_to_string(sim_path)?).map_err(|e| {
-        anyhow!(
-            "Could not deserialize node connection data or activity description from simulation file (line {}, col {}, err: {}).",
-            e.line(),
-            e.column(),
-            e.to_string()
-        )
-        })?;
-
     cli.validate(&sim_params)?;
 
     let tasks = TaskTracker::new();

sim-cli/src/parsing.rs

@@ -27,7 +27,7 @@ pub const DEFAULT_DATA_DIR: &str = ".";
 /// The default simulation file to be used by the simulator.
 pub const DEFAULT_SIM_FILE: &str = "sim.json";
 
-/// The default expected payment amount for the simulation, around ~$10 at the time of w.
+/// The default expected payment amount for the simulation, around ~$10 at the time of writing.
 pub const DEFAULT_EXPECTED_PAYMENT_AMOUNT: u64 = 3_800_000;
 
 /// The number of times over each node in the network sends its total deployed capacity in a calendar month.
@@ -88,7 +88,7 @@ pub struct Cli {
 
 impl Cli {
     pub fn validate(&self, sim_params: &SimParams) -> Result<(), anyhow::Error> {
-        // Validate that nodes and sim_graph are exclusively set, and setup node clients from the populated field.
+        // Validate that nodes and sim_graph are exclusively set
         if !sim_params.nodes.is_empty() && !sim_params.sim_network.is_empty() {
             return Err(anyhow!(
                 "Simulation file cannot contain {} nodes and {} sim_graph entries, simulation can only be run with real 
@@ -112,7 +112,7 @@ pub struct SimParams {
     #[serde(default)]
     pub sim_network: Vec<NetworkParser>,
     #[serde(default)]
-    pub activity: Vec<ActivityParser>,
+    activity: Vec<ActivityParser>,
 }
 
 #[derive(Serialize, Deserialize, Debug, Clone)]
@@ -147,7 +147,7 @@ impl From<NetworkParser> for SimulatedChannel {
 /// Data structure used to parse information from the simulation file. It allows source and destination to be
 /// [NodeId], which enables the use of public keys and aliases in the simulation description.
 #[derive(Debug, Clone, Serialize, Deserialize)]
-pub struct ActivityParser {
+struct ActivityParser {
     /// The source of the payment.
     #[serde(with = "serializers::serde_node_id")]
     pub source: NodeId,
@@ -188,6 +188,8 @@ impl TryFrom<&Cli> for SimulationCfg {
     }
 }
 
+struct NodeMapping(HashMap<PublicKey, NodeInfo>, HashMap<String, NodeInfo>);
+
 pub async fn create_simulation_with_network(
     cli: &Cli,
     sim_params: &SimParams,
@@ -208,16 +210,11 @@ pub async fn create_simulation_with_network(
         .collect::<Vec<SimulatedChannel>>();
 
     let mut nodes_info = HashMap::new();
-    for sim_channel in sim_network {
-        nodes_info.insert(
-            sim_channel.node_1.pubkey,
-            node_info(sim_channel.node_1.pubkey),
-        );
-        nodes_info.insert(
-            sim_channel.node_2.pubkey,
-            node_info(sim_channel.node_2.pubkey),
-        );
+    for channel in &channels {
+        let (pubkey, node_info) = channel.create_simulated_node();
+        nodes_info.insert(pubkey, node_info);
     }
+
     let get_node_info = async |pk: &PublicKey| -> Result<NodeInfo, LightningError> {
         if let Some(node) = nodes_info.get(pk) {
             Ok(node_info(node.pubkey))
@@ -228,7 +225,7 @@ pub async fn create_simulation_with_network(
             )))
         }
     };
-    let (pk_node_map, alias_node_map) = add_node_to_maps(&nodes_info)?;
+    let NodeMapping(pk_node_map, alias_node_map) = add_node_to_maps(&nodes_info)?;
     let validated_activities = validate_activities(
         activity.to_vec(),
         pk_node_map,
@@ -285,12 +282,13 @@ pub async fn create_simulation(
         if let Some(c) = clients.values().next() {
             return c.lock().await.get_node_info(pk).await;
         }
+
         Err(LightningError::GetNodeInfoError(
             "no nodes for query".to_string(),
         ))
     };
 
-    let (pk_node_map, alias_node_map) = add_node_to_maps(&clients_info)?;
+    let NodeMapping(pk_node_map, alias_node_map) = add_node_to_maps(&clients_info)?;
     let validated_activities =
         validate_activities(activity.to_vec(), pk_node_map, alias_node_map, get_node).await?;
     let (shutdown_trigger, shutdown_listener) = triggered::trigger();
@@ -338,12 +336,9 @@ async fn get_clients(
     Ok((clients, clients_info))
 }
 
-type NodeMapping =
-    Result<(HashMap<PublicKey, NodeInfo>, HashMap<String, NodeInfo>), LightningError>;
-
 /// Adds a lightning node to a client map and tracking maps used to lookup node pubkeys and aliases for activity
 /// validation.
-fn add_node_to_maps(nodes: &HashMap<PublicKey, NodeInfo>) -> NodeMapping {
+fn add_node_to_maps(nodes: &HashMap<PublicKey, NodeInfo>) -> Result<NodeMapping, LightningError> {
     let mut pk_node_map = HashMap::new();
     let mut alias_node_map = HashMap::new();
 
@@ -375,7 +370,7 @@ fn add_node_to_maps(nodes: &HashMap<PublicKey, NodeInfo>) -> NodeMapping {
         pk_node_map.insert(node_info.pubkey, node_info.clone());
     }
 
-    Ok((pk_node_map, alias_node_map))
+    Ok(NodeMapping(pk_node_map, alias_node_map))
 }
 
 /// Validates a set of defined activities, cross-checking aliases and public keys against the set of clients that
@@ -490,3 +485,17 @@ fn mkdir(dir: PathBuf) -> anyhow::Result<PathBuf> {
     fs::create_dir_all(&dir)?;
     Ok(dir)
 }
+
+pub async fn parse_cli() -> anyhow::Result<(Cli, SimParams)> {
+    let cli = Cli::parse();
+    let sim_path = read_sim_path(cli.data_dir.clone(), cli.sim_file.clone()).await?;
+    let sim_params = serde_json::from_str(&std::fs::read_to_string(sim_path)?).map_err(|e| {
+        anyhow!(
+            "Could not deserialize node connection data or activity description from simulation file (line {}, col {}, err: {}).",
+            e.line(),
+            e.column(),
+            e.to_string()
+        )
+        })?;
+    Ok((cli, sim_params))
+}

simln-lib/src/sim_node.rs

@@ -424,6 +424,13 @@ impl SimulatedChannel {
         self.get_node(forwarding_node)?
             .check_htlc_forward(cltv_delta, amount_msat, fee_msat)
     }
+
+    pub fn create_simulated_node(&self) -> (PublicKey, NodeInfo) {
+        (
+            self.node_1.policy.pubkey,
+            node_info(self.node_1.policy.pubkey),
+        )
+    }
 }
 
 /// SimNetwork represents a high level network coordinator that is responsible for the task of actually propagating