sim-rs: add id to RB events

SupernaviX · SupernaviX · commit 8597abc135ef · 2025-03-10T21:54:42.000-04:00
diff --git a/data/simulation/trace.rust.d.ts b/data/simulation/trace.rust.d.ts
@@ -43,7 +43,7 @@ interface RustCpuEvent extends Omit<RustBaseEvent, "message"> {
 
 // Block Events
 interface RustBaseBlockEvent {
-    id?: string;
+    id: string;
     slot: number;
     producer: string;
     sender?: string;
diff --git a/data/simulation/trace.rust.schema.json b/data/simulation/trace.rust.schema.json
@@ -74,33 +74,39 @@
             }
           ]
         },
-        "time": {
+        "time_s": {
           "type": "number"
         }
       },
       "type": "object"
     },
     "RustBlockMessageType": {
       "enum": [
-        "EndorserBlockGenerated",
-        "EndorserBlockLotteryWon",
-        "EndorserBlockReceived",
-        "EndorserBlockSent",
-        "InputBlockGenerated",
-        "InputBlockLotteryWon",
-        "InputBlockReceived",
-        "InputBlockSent",
-        "PraosBlockGenerated",
-        "PraosBlockLotteryWon",
-        "PraosBlockReceived",
-        "PraosBlockSent"
+        "EBGenerated",
+        "EBLotteryWon",
+        "EBReceived",
+        "EBSent",
+        "IBGenerated",
+        "IBLotteryWon",
+        "IBReceived",
+        "IBSent",
+        "RBGenerated",
+        "RBLotteryWon",
+        "RBReceived",
+        "RBSent"
       ],
       "type": "string"
     },
     "RustCpuEvent": {
       "properties": {
         "message": {
           "properties": {
+            "cpu_time_s": {
+              "type": "number"
+            },
+            "duration_s": {
+              "type": "number"
+            },
             "extra": {
               "type": "string"
             },
@@ -122,7 +128,7 @@
           },
           "type": "object"
         },
-        "time": {
+        "time_s": {
           "type": "number"
         }
       },
@@ -141,16 +147,16 @@
     },
     "RustCpuTaskType": {
       "enum": [
-        "EndorserBlockGenerated",
-        "EndorserBlockValidated",
-        "InputBlockGenerated",
-        "InputBlockValidated",
-        "PraosBlockGenerated",
-        "PraosBlockValidated",
+        "EBBlockGenerated",
+        "EBBlockValidated",
+        "IBBlockGenerated",
+        "IBBlockValidated",
+        "RBBlockGenerated",
+        "RBBlockValidated",
         "TransactionGenerated",
         "TransactionValidated",
-        "VoteBundleGenerated",
-        "VoteBundleValidated"
+        "VTBundleGenerated",
+        "VTBundleValidated"
       ],
       "type": "string"
     },
@@ -168,7 +174,7 @@
           },
           "type": "object"
         },
-        "time": {
+        "time_s": {
           "type": "number"
         }
       },
@@ -210,7 +216,7 @@
           },
           "type": "object"
         },
-        "time": {
+        "time_s": {
           "type": "number"
         }
       },
@@ -252,7 +258,7 @@
           },
           "type": "object"
         },
-        "time": {
+        "time_s": {
           "type": "number"
         }
       },
diff --git a/sim-rs/sim-cli/src/events.rs b/sim-rs/sim-cli/src/events.rs
@@ -12,7 +12,7 @@ use sim_core::{
     clock::Timestamp,
     config::{NodeId, SimConfiguration},
     events::{Event, Node},
-    model::TransactionId,
+    model::{BlockId, TransactionId},
 };
 use tokio::{
     fs::{self, File},
@@ -181,8 +181,7 @@ impl EventMonitor {
                 }
                 Event::RBLotteryWon { .. } => {}
                 Event::RBGenerated {
-                    slot,
-                    producer,
+                    id: BlockId { slot, producer },
                     vrf,
                     endorsement,
                     transactions,
diff --git a/sim-rs/sim-core/src/events.rs b/sim-rs/sim-core/src/events.rs
@@ -8,8 +8,8 @@ use crate::{
     clock::{Clock, Timestamp},
     config::{NodeConfiguration, NodeId},
     model::{
-        Block, CpuTaskId, Endorsement, EndorserBlockId, InputBlockId, NoVoteReason, Transaction,
-        TransactionId, VoteBundle, VoteBundleId,
+        Block, BlockId, CpuTaskId, Endorsement, EndorserBlockId, InputBlockId, NoVoteReason,
+        Transaction, TransactionId, VoteBundle, VoteBundleId,
     },
 };
 
@@ -93,24 +93,26 @@ pub enum Event {
         recipient: Node,
     },
     RBLotteryWon {
-        slot: u64,
-        producer: Node,
+        #[serde(flatten)]
+        id: BlockId<Node>,
     },
     RBGenerated {
-        slot: u64,
-        producer: Node,
+        #[serde(flatten)]
+        id: BlockId<Node>,
         vrf: u64,
         header_bytes: u64,
         endorsement: Option<Endorsement<Node>>,
         transactions: Vec<TransactionId>,
     },
     RBSent {
-        slot: u64,
+        #[serde(flatten)]
+        id: BlockId<Node>,
         sender: Node,
         recipient: Node,
     },
     RBReceived {
-        slot: u64,
+        #[serde(flatten)]
+        id: BlockId<Node>,
         sender: Node,
         recipient: Node,
     },
@@ -266,15 +268,13 @@ impl EventTracker {
 
     pub fn track_praos_block_lottery_won(&self, block: &Block) {
         self.send(Event::RBLotteryWon {
-            slot: block.slot,
-            producer: self.to_node(block.producer),
+            id: self.to_block(block.id),
         });
     }
 
     pub fn track_praos_block_generated(&self, block: &Block) {
         self.send(Event::RBGenerated {
-            slot: block.slot,
-            producer: self.to_node(block.producer),
+            id: self.to_block(block.id),
             vrf: block.vrf,
             header_bytes: block.header_bytes,
             endorsement: block.endorsement.as_ref().map(|e| Endorsement {
@@ -292,15 +292,15 @@ impl EventTracker {
 
     pub fn track_praos_block_sent(&self, block: &Block, sender: NodeId, recipient: NodeId) {
         self.send(Event::RBSent {
-            slot: block.slot,
+            id: self.to_block(block.id),
             sender: self.to_node(sender),
             recipient: self.to_node(recipient),
         });
     }
 
     pub fn track_praos_block_received(&self, block: &Block, sender: NodeId, recipient: NodeId) {
         self.send(Event::RBReceived {
-            slot: block.slot,
+            id: self.to_block(block.id),
             sender: self.to_node(sender),
             recipient: self.to_node(recipient),
         });
@@ -458,6 +458,13 @@ impl EventTracker {
         }
     }
 
+    fn to_block(&self, id: BlockId) -> BlockId<Node> {
+        BlockId {
+            slot: id.slot,
+            producer: self.to_node(id.producer),
+        }
+    }
+
     fn to_input_block(&self, id: InputBlockId) -> InputBlockId<Node> {
         InputBlockId {
             slot: id.slot,
diff --git a/sim-rs/sim-core/src/model.rs b/sim-rs/sim-core/src/model.rs
@@ -41,10 +41,34 @@ impl<Node: Display> Display for CpuTaskId<Node> {
     }
 }
 
+#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
+pub struct BlockId<Node = NodeId> {
+    pub slot: u64,
+    pub producer: Node,
+}
+
+impl<Node: Display> Display for BlockId<Node> {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        f.write_fmt(format_args!("{}-{}", self.slot, self.producer))
+    }
+}
+
+impl<Node: Display + Serialize> Serialize for BlockId<Node> {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: serde::Serializer,
+    {
+        let mut obj = serializer.serialize_struct("BlockId", 3)?;
+        obj.serialize_field("id", &self.to_string())?;
+        obj.serialize_field("slot", &self.slot)?;
+        obj.serialize_field("producer", &self.producer)?;
+        obj.end()
+    }
+}
+
 #[derive(Clone, Debug)]
 pub struct Block {
-    pub slot: u64,
-    pub producer: NodeId,
+    pub id: BlockId,
     pub vrf: u64,
     pub header_bytes: u64,
     pub endorsement: Option<Endorsement>,
diff --git a/sim-rs/sim-core/src/sim/node.rs b/sim-rs/sim-core/src/sim/node.rs
@@ -22,7 +22,7 @@ use crate::{
     },
     events::EventTracker,
     model::{
-        Block, CpuTaskId, Endorsement, EndorserBlock, EndorserBlockId, InputBlock,
+        Block, BlockId, CpuTaskId, Endorsement, EndorserBlock, EndorserBlockId, InputBlock,
         InputBlockHeader, InputBlockId, NoVoteReason, Transaction, TransactionId, VoteBundle,
         VoteBundleId,
     },
@@ -692,8 +692,10 @@ impl Node {
         }
 
         let block = Block {
-            slot,
-            producer: self.id,
+            id: BlockId {
+                slot,
+                producer: self.id,
+            },
             vrf,
             header_bytes: self.sim_config.sizes.block_header,
             endorsement,
@@ -773,13 +775,13 @@ impl Node {
                 .praos
                 .peer_heads
                 .get(peer)
-                .is_none_or(|&s| s < block.slot)
+                .is_none_or(|&s| s < block.id.slot)
             {
-                self.send_to(*peer, SimulationMessage::RollForward(block.slot))?;
-                self.praos.peer_heads.insert(*peer, block.slot);
+                self.send_to(*peer, SimulationMessage::RollForward(block.id.slot))?;
+                self.praos.peer_heads.insert(*peer, block.id.slot);
             }
         }
-        self.praos.blocks.insert(block.slot, block);
+        self.praos.blocks.insert(block.id.slot, block);
         Ok(())
     }
 
@@ -858,18 +860,18 @@ impl Node {
     }
 
     fn finish_validating_block(&mut self, from: NodeId, block: Arc<Block>) -> Result<()> {
-        if let Some(old_block) = self.praos.blocks.get(&block.slot) {
+        if let Some(old_block) = self.praos.blocks.get(&block.id.slot) {
             // SLOT BATTLE!!! lower VRF wins
             if old_block.vrf <= block.vrf {
                 // We like our block better than this new one.
                 return Ok(());
             }
         }
-        self.praos.blocks.insert(block.slot, block.clone());
+        self.praos.blocks.insert(block.id.slot, block.clone());
 
         let head = self.praos.peer_heads.entry(from).or_default();
-        if *head < block.slot {
-            *head = block.slot
+        if *head < block.id.slot {
+            *head = block.id.slot
         }
         self.publish_block(block)?;
         Ok(())
