sim-rs: add tx-start-time and tx-stop-time parameters

Author: SupernaviX

data/simulation/config.d.ts

@@ -67,6 +67,14 @@ export interface Config {
   "tx-validation-cpu-time-ms": number;
   /** Only supported by Rust simulation. */
   "tx-max-size-bytes": bigint;
+  /**
+   * When the first transaction should appear.
+   * Only supported by Rust simulation.  */
+  "tx-start-time"?: number | null;
+  /**
+   * The cutoff time after which transactions should not appear.
+   * Only supported by Rust simulation.  */
+  "tx-stop-time"?: number | null;
 
   // Ranking Block Configuration
   "rb-generation-probability": number;

data/simulation/config.schema.json

@@ -351,6 +351,14 @@
       "$ref": "#/definitions/Distribution",
       "description": "Only supported by Rust simulation."
     },
+    "tx-start-time": {
+      "description": "When the first transaction should appear.\nOnly supported by Rust simulation.",
+      "type": "number"
+    },
+    "tx-stop-time": {
+      "description": "The cutoff time after which transactions should not appear.\nOnly supported by Rust simulation.",
+      "type": "number"
+    },
     "tx-validation-cpu-time-ms": {
       "description": "Only supported by Rust simulation.",
       "type": "number"

sim-rs/sim-cli/src/events.rs

@@ -620,6 +620,7 @@ fn compute_stats<Iter: IntoIterator<Item = f64>>(data: Iter) -> Stats {
     }
 }
 
+#[allow(clippy::large_enum_variant)]
 enum OutputTarget {
     AggregatedEventStream {
         aggregation: TraceAggregator,

sim-rs/sim-core/src/config.rs

@@ -8,7 +8,7 @@ use std::{
 use anyhow::{anyhow, bail, Result};
 use serde::{Deserialize, Serialize};
 
-use crate::{model::TransactionId, probability::FloatDistribution};
+use crate::{clock::Timestamp, model::TransactionId, probability::FloatDistribution};
 
 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
 pub struct NodeId(usize);
@@ -70,6 +70,8 @@ pub struct RawParameters {
     pub tx_sharded_percentage: f64,
     pub tx_validation_cpu_time_ms: f64,
     pub tx_max_size_bytes: u64,
+    pub tx_start_time: Option<f64>,
+    pub tx_stop_time: Option<f64>,
 
     // Ranking block configuration
     pub rb_generation_probability: f64,
@@ -377,6 +379,12 @@ impl TransactionConfig {
                 sharded_percentage: params.tx_sharded_percentage,
                 frequency_ms: params.tx_generation_distribution.into(),
                 size_bytes: params.tx_size_bytes_distribution.into(),
+                start_time: params
+                    .tx_start_time
+                    .map(|t| Timestamp::zero() + Duration::from_secs_f64(t)),
+                stop_time: params
+                    .tx_stop_time
+                    .map(|t| Timestamp::zero() + Duration::from_secs_f64(t)),
             })
         } else {
             Self::Mock(MockTransactionConfig {
@@ -394,6 +402,8 @@ pub(crate) struct RealTransactionConfig {
     pub sharded_percentage: f64,
     pub frequency_ms: FloatDistribution,
     pub size_bytes: FloatDistribution,
+    pub start_time: Option<Timestamp>,
+    pub stop_time: Option<Timestamp>,
 }
 
 #[derive(Debug, Clone)]

sim-rs/sim-core/src/sim/tx.rs

@@ -47,6 +47,12 @@ impl TransactionProducer {
         let mut next_tx_id = 0;
         let mut next_tx_at = Timestamp::zero();
         let mut rng = &mut self.rng;
+
+        if let Some(start) = config.start_time {
+            self.clock.wait_until(start).await;
+            next_tx_at = start;
+        };
+
         loop {
             let id = TransactionId::new(next_tx_id);
             let shard = rng
@@ -67,7 +73,12 @@ impl TransactionProducer {
             let millis_until_tx = config.frequency_ms.sample(&mut rng) as u64;
             next_tx_at += Duration::from_millis(millis_until_tx);
 
-            self.clock.wait_until(next_tx_at).await;
+            if config.stop_time.is_some_and(|t| next_tx_at > t) {
+                self.clock.wait_forever().await;
+                return Ok(());
+            } else {
+                self.clock.wait_until(next_tx_at).await;
+            }
         }
     }
 }