feat: Add block / tx 'end' events

src/bin/oura/watch.rs

@@ -80,19 +80,24 @@ pub fn run(args: &ArgMatches) -> Result<(), Error> {
         (false, BearerKind::Unix) => PeerMode::AsClient,
     };
 
+    let mapper = MapperConfig {
+        include_block_end_events: true,
+        ..Default::default()
+    };
+
     let source_setup = match mode {
         PeerMode::AsNode => WatchSource::N2N(N2NConfig {
             address: AddressArg(bearer, socket),
             magic,
             well_known: None,
-            mapper: MapperConfig::default(),
+            mapper,
             since,
         }),
         PeerMode::AsClient => WatchSource::N2C(N2CConfig {
             address: AddressArg(bearer, socket),
             magic,
             well_known: None,
-            mapper: MapperConfig::default(),
+            mapper,
             since,
         }),
     };

src/filters/fingerpint.rs

@@ -97,10 +97,18 @@ fn build_fingerprint(event: &Event, seed: u32) -> Result<String, Error> {
             .with_slot(&event.context.slot)
             .with_prefix("blck")
             .append_optional(&event.context.block_hash)?,
+        EventData::BlockEnd { .. } => b
+            .with_slot(&event.context.slot)
+            .with_prefix("blckend")
+            .append_optional(&event.context.block_hash)?,
         EventData::Transaction { .. } => b
             .with_slot(&event.context.slot)
             .with_prefix("tx")
             .append_optional(&event.context.tx_hash)?,
+        EventData::TransactionEnd { .. } => b
+            .with_slot(&event.context.slot)
+            .with_prefix("txend")
+            .append_optional(&event.context.tx_hash)?,
         EventData::TxInput { .. } => b
             .with_slot(&event.context.slot)
             .with_prefix("stxi")

src/framework.rs

@@ -158,18 +158,23 @@ pub enum StakeCredential {
     Scripthash(String),
 }
 
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
+pub struct BlockRecord {
+    pub body_size: usize,
+    pub issuer_vkey: String,
+    pub tx_count: usize,
+    pub slot: u64,
+    pub hash: String,
+    pub number: u64,
+}
+
 #[derive(Serialize, Deserialize, Display, Debug, Clone)]
 #[serde(rename_all = "snake_case")]
 pub enum EventData {
-    Block {
-        body_size: usize,
-        issuer_vkey: String,
-        tx_count: usize,
-        slot: u64,
-        hash: String,
-        number: u64,
-    },
+    Block(BlockRecord),
+    BlockEnd(BlockRecord),
     Transaction(TransactionRecord),
+    TransactionEnd(TransactionRecord),
     TxInput(TxInputRecord),
     TxOutput(TxOutputRecord),
     OutputAsset(OutputAssetRecord),

src/mapper/crawl.rs

@@ -3,7 +3,7 @@ use pallas::ledger::alonzo::{
     TransactionBodyComponent, TransactionInput, TransactionOutput, Value,
 };
 
-use crate::framework::{Error, EventContext};
+use crate::framework::{Error, EventContext, EventData};
 
 use super::{map::ToBech32, EventWriter};
 
@@ -121,7 +121,8 @@ impl EventWriter {
         aux_data: Option<&AuxiliaryData>,
     ) -> Result<(), Error> {
         let record = self.to_transaction_record(tx, aux_data)?;
-        self.append_from(record)?;
+
+        self.append_from(record.clone())?;
 
         for component in tx.iter() {
             match component {
@@ -173,12 +174,17 @@ impl EventWriter {
             self.crawl_auxdata(aux_data)?;
         }
 
+        if self.config.include_transaction_end_events {
+            self.append(EventData::TransactionEnd(record))?;
+        }
+
         Ok(())
     }
 
     fn crawl_block(&self, block: &Block, hash: &[u8]) -> Result<(), Error> {
-        let data = self.to_block_event(block, hash)?;
-        self.append(data)?;
+        let record = self.to_block_record(block, hash)?;
+
+        self.append(EventData::Block(record.clone()))?;
 
         for (idx, tx) in block.transaction_bodies.iter().enumerate() {
             let aux_data = block
@@ -204,6 +210,10 @@ impl EventWriter {
             child.crawl_transaction(tx, aux_data)?;
         }
 
+        if self.config.include_block_end_events {
+            self.append(EventData::BlockEnd(record))?;
+        }
+
         Ok(())
     }
 

src/mapper/map.rs

@@ -12,8 +12,8 @@ use bech32::{self, ToBase32};
 use serde_json::{json, Value as JsonValue};
 
 use crate::framework::{
-    EventData, MetadataRecord, MetadatumRendition, MintRecord, OutputAssetRecord, StakeCredential,
-    TransactionRecord, TxInputRecord, TxOutputRecord,
+    BlockRecord, EventData, MetadataRecord, MetadatumRendition, MintRecord, OutputAssetRecord,
+    StakeCredential, TransactionRecord, TxInputRecord, TxOutputRecord,
 };
 
 use crate::framework::Error;
@@ -349,8 +349,8 @@ impl EventWriter {
         Ok(record)
     }
 
-    pub fn to_block_event(&self, source: &Block, hash: &[u8]) -> Result<EventData, Error> {
-        Ok(EventData::Block {
+    pub fn to_block_record(&self, source: &Block, hash: &[u8]) -> Result<BlockRecord, Error> {
+        Ok(BlockRecord {
             body_size: source.header.header_body.block_body_size as usize,
             issuer_vkey: source.header.header_body.issuer_vkey.to_hex(),
             tx_count: source.transaction_bodies.len(),

src/mapper/prelude.rs

@@ -39,8 +39,14 @@ impl ChainWellKnownInfo {
 
 #[derive(Deserialize, Clone, Debug, Default)]
 pub struct Config {
+    #[serde(default)]
+    pub include_block_end_events: bool,
+
     #[serde(default)]
     pub include_transaction_details: bool,
+
+    #[serde(default)]
+    pub include_transaction_end_events: bool,
 }
 
 #[derive(Clone, Debug)]

src/sinks/terminal/format.rs

@@ -3,7 +3,7 @@ use std::fmt::{Display, Write};
 use crossterm::style::{Attribute, Color, Stylize};
 
 use crate::framework::{
-    CIP25AssetRecord, Event, EventData, MetadataRecord, MintRecord, OutputAssetRecord,
+    BlockRecord, CIP25AssetRecord, Event, EventData, MetadataRecord, MintRecord, OutputAssetRecord,
     TransactionRecord, TxInputRecord, TxOutputRecord,
 };
 
@@ -18,15 +18,15 @@ pub struct LogLine {
 impl LogLine {
     pub fn new(source: Event, max_width: usize) -> LogLine {
         match &source.data {
-            EventData::Block {
+            EventData::Block(BlockRecord {
                 body_size,
                 issuer_vkey,
                 tx_count,
                 slot,
                 hash,
                 number,
                 ..
-            } => {
+            }) => {
                 LogLine {
                     prefix: "BLOCK",
                     color: Color::Magenta,
@@ -44,6 +44,25 @@ impl LogLine {
                     max_width,
                 }
             }
+            EventData::BlockEnd(BlockRecord {
+                slot,
+                hash,
+                number,
+                ..
+            }) => {
+                LogLine {
+                    prefix: "ENDBLK",
+                    color: Color::DarkMagenta,
+                    content: format!(
+                    "{{ slot: {}, hash: {}, number: {} }}",
+                    slot,
+                    hash,
+                    number,
+                ),
+                    source,
+                    max_width,
+                }
+            }
             EventData::Transaction(TransactionRecord {
                 total_output,
                 fee,
@@ -59,6 +78,16 @@ impl LogLine {
                 source,
                 max_width,
             },
+            EventData::TransactionEnd(TransactionRecord { .. }) => LogLine {
+                prefix: "ENDTX",
+                color: Color::DarkBlue,
+                content: format!(
+                    "{{ hash: {:?} }}",
+                    &source.context.tx_hash
+                ),
+                source,
+                max_width,
+            },
             EventData::TxInput(TxInputRecord { tx_id, index }) => LogLine {
                 prefix: "STXI",
                 color: Color::Blue,