sim-cli: surface CLI option to run sim network with speedup

Author: carlaKC

sim-cli/src/parsing.rs

@@ -84,6 +84,10 @@ pub struct Cli {
     /// Seed to run random activity generator deterministically
     #[clap(long, short)]
     pub fix_seed: Option<u64>,
+    /// A multiplier to wall time to speed up the simulation's clock. Only available when when running on a network of
+    /// simulated nodes.
+    #[clap(long, short)]
+    pub speedup_clock: Option<u16>,
 }
 
 impl Cli {
@@ -103,6 +107,12 @@ impl Cli {
                 nodes or sim_graph to run with simulated nodes"
             ));
         }
+        if !sim_params.nodes.is_empty() && self.speedup_clock.is_some() {
+            return Err(anyhow!(
+                "Clock speedup is only allowed when running on a simulated network"
+            ));
+        }
+
         Ok(())
     }
 }
@@ -229,11 +239,13 @@ pub async fn create_simulation_with_network(
             .map_err(|e| SimulationError::SimulatedNetworkError(format!("{:?}", e)))?,
     ));
 
+    let clock = Arc::new(SimulationClock::new(cli.speedup_clock.unwrap_or(1))?);
+
     // Copy all simulated channels into a read-only routing graph, allowing to pathfind for
     // individual payments without locking th simulation graph (this is a duplication of the channels,
     // but the performance tradeoff is worthwhile for concurrent pathfinding).
     let routing_graph = Arc::new(
-        populate_network_graph(channels)
+        populate_network_graph(channels, clock.clone())
             .map_err(|e| SimulationError::SimulatedNetworkError(format!("{:?}", e)))?,
     );
 
@@ -246,7 +258,7 @@ pub async fn create_simulation_with_network(
             cfg,
             nodes,
             tasks,
-            Arc::new(SimulationClock::new(1)?),
+            clock,
             shutdown_trigger,
             shutdown_listener,
         ),
@@ -279,6 +291,8 @@ pub async fn create_simulation(
             cfg,
             clients,
             tasks,
+            // When running on a real network, the underlying node may use wall time so we always use a clock with no
+            // speedup.
             Arc::new(SimulationClock::new(1)?),
             shutdown_trigger,
             shutdown_listener,